1. 接口描述
接口请求域名: tcm.tencentcloudapi.com 。
查询网格列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMeshList。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-13。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 否 | Array of Filter | 过滤条件 |
Limit | 否 | Integer | 分页限制 示例值:10 |
Offset | 否 | Integer | 分页偏移 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MeshList | Array of Mesh | 查询到的网格信息 注意:此字段可能返回 null,表示取不到有效值。 |
Total | Integer | 总数 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeMeshList
输入示例
POST / HTTP/1.1
Host: tcm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMeshList
<公共请求参数>
{
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"MeshList": [
{
"MeshId": "xxxxx",
"DisplayName": "test",
"Region": "sh",
"Type": "HOSTED",
"State": "pending",
"Version": "1.12.5",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"UpdatedTime": "2020-09-22T00:00:00+00:00",
"Config": {
"Istio": {
"OutboundTrafficPolicy": "ALLOW_ANY",
"Tracing": {
"Sampling": 1
},
"DisablePolicyChecks": true,
"EnablePilotHTTP": true,
"DisableHTTPRetry": true,
"SmartDNS": {
"IstioMetaDNSCapture": true,
"IstioMetaDNSAutoAllocate": true
}
}
},
"ClusterList": [
{
"ClusterId": "{{clusterId}}",
"DisplayName": "",
"Region": "sh",
"Role": "MASTER",
"VpcId": "{{vpcId}}",
"SubnetId": "{{subnetId}}",
"State": "RUNNING",
"HostedNamespaces": [],
"Type": "TKE",
"LinkedTime": "2020-09-22T00:00:00+00:00",
"Config": {
"AutoInjectionNamespaceList": [
"default"
]
},
"Status": {
"LinkState": "LINKED",
"LinkErrorDetail": ""
}
}
],
"Status": {
"CanaryVersion": "1.14.5",
"ServiceCount": 0,
"Prometheus": null
},
"TagList": [
{
"Key": "abc",
"Value": "abc",
"Passthrough": true
}
]
}
],
"Total": 1
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |