1. 接口描述
接口请求域名： tcm.tencentcloudapi.com 。
查询网格详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMesh。 |
| Version | 是 | String | 公共参数，本接口取值：2021-04-13。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| MeshId | 是 | String | 需要查询的网格 Id 示例值：mesh-xxxxxxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Mesh | Mesh | Mesh详细信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeMesh
输入示例
POST / HTTP/1.1
Host: tcm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMesh
<公共请求参数>
{
"MeshId": "mesh-351lvuec"
}输出示例
{
"Response": {
"Mesh": {
"ClusterList": [
{
"ClusterId": "cls-i3wbzkfl",
"Config": {
"AutoInjectionNamespaceList": [],
"AutoInjectionNamespaceStateList": [],
"DeployConfig": {
"NodeSelectType": "",
"Nodes": []
},
"EgressGatewayList": [],
"IngressGatewayList": [],
"Istiod": null
},
"DisplayName": "cluster-1",
"HostedNamespaces": [],
"LinkedTime": "2025-01-02T20:18:13+08:00",
"Region": "ap-shanghai",
"Role": "REMOTE",
"State": "RUNNING",
"Status": {
"LinkErrorDetail": "",
"LinkState": "LINKED"
},
"SubnetId": "subnet-c1nuvmu7",
"VpcId": "vpc-5x1y65ok",
"Type": "TKE"
}
],
"Config": {
"AccessLog": {
"Address": "http://10.10.10.10",
"CLS": {
"Enable": true,
"NeedDelete": false,
"LogSet": "mesh-351lvuec",
"Region": "ap-shanghai",
"Topic": "mesh-351lvuec-accesslog"
},
"Enable": true,
"EnableServer": false,
"EnableStdout": true,
"Encoding": "JSON",
"Format": "{\n\t\"authority\": \"%REQ(:AUTHORITY)%\",\n\t\"bytes_received\": \"%BYTES_RECEIVED%\",\n\t\"bytes_sent\": \"%BYTES_SENT%\",\n\t\"downstream_local_address\": \"%DOWNSTREAM_LOCAL_ADDRESS%\",\n\t\"downstream_remote_address\": \"%DOWNSTREAM_REMOTE_ADDRESS%\",\n\t\"duration\": \"%DURATION%\",\n\t\"istio_policy_status\": \"%DYNAMIC_METADATA(istio.mixer:status)%\",\n\t\"method\": \"%REQ(:METHOD)%\",\n\t\"path\": \"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%\",\n\t\"protocol\": \"%PROTOCOL%\",\n\t\"request_id\": \"%REQ(X-REQUEST-ID)%\",\n\t\"requested_server_name\": \"%REQUESTED_SERVER_NAME%\",\n\t\"response_code\": \"%RESPONSE_CODE%\",\n\t\"response_flags\": \"%RESPONSE_FLAGS%\",\n\t\"route_name\": \"%ROUTE_NAME%\",\n\t\"start_time\": \"%START_TIME%\",\n\t\"upstream_cluster\": \"%UPSTREAM_CLUSTER%\",\n\t\"upstream_host\": \"%UPSTREAM_HOST%\",\n\t\"upstream_local_address\": \"%UPSTREAM_LOCAL_ADDRESS%\",\n\t\"upstream_service_time\": \"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%\",\n\t\"upstream_transport_failure_reason\": \"%UPSTREAM_TRANSPORT_FAILURE_REASON%\",\n\t\"user_agent\": \"%REQ(USER-AGENT)%\",\n\t\"x_forwarded_for\": \"%REQ(X-FORWARDED-FOR)%\"\n}\n",
"SelectedRange": {
"All": true
},
"Template": "istio"
},
"Inject": {
"ExcludeIPRanges": [],
"HoldApplicationUntilProxyStarts": false,
"HoldProxyUntilApplicationEnds": false
},
"Istio": {
"DisableHTTPRetry": false,
"DisablePolicyChecks": true,
"EnablePilotHTTP": false,
"OutboundTrafficPolicy": "ALLOW_ANY",
"SmartDNS": {
"IstioMetaDNSAutoAllocate": true,
"IstioMetaDNSCapture": true
},
"Tracing": {
"Sampling": 0
}
},
"Prometheus": {
"InstanceId": "prom-63ad12yj",
"Region": "ap-shanghai",
"VpcId": "vpc-5x1y65ok",
"SubnetId": "subnet-c1nuvmu7",
"CustomProm": null
},
"SidecarResources": {
"Limits": [
{
"Name": "cpu",
"Quantity": "2"
},
{
"Name": "memory",
"Quantity": "1Gi"
}
],
"Requests": [
{
"Name": "cpu",
"Quantity": "100m"
},
{
"Name": "memory",
"Quantity": "128Mi"
}
]
},
"Tracing": {
"APM": {
"Region": "ap-shanghai",
"InstanceId": "apm-KlX5JAaaq",
"Enable": false
},
"Enable": false
}
},
"CreatedTime": "2025-01-02T10:50:01+08:00",
"DisplayName": "mesh-for-test",
"MeshId": "mesh-351lvuec",
"Region": "ap-shanghai",
"State": "RUNNING",
"Status": {
"ActiveOperationList": null,
"CanaryVersion": "",
"Prometheus": null,
"ServiceCount": 43,
"StateMessage": "",
"TPS": {
"DisplayName": "mesh-351lvuec-prom-63ad12yj",
"Grafana": {
"Enabled": false,
"InternalURL": "",
"PublicFailedMessage": "",
"PublicFailedReason": "",
"PublicURL": ""
},
"InstanceId": "prom-63ad12yj",
"PrometheusId": "mesh-351lvuec-prom-63ad12yj",
"Region": "ap-shanghai",
"State": "RUNNING",
"Type": "tmp",
"VpcId": "vpc-5x1y65ok"
}
},
"TagList": [],
"Type": "HOSTED",
"UpdatedTime": "2025-01-02T20:50:08+08:00",
"Version": "1.16.5"
},
"RequestId": "ffc3123e-07a1-4488-9bd0-465549d61f25"
}
}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 | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
