1. 接口描述
接口请求域名： monitor.tencentcloudapi.com 。
查询对外指标
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeExtMetric。 |
| Version | 是 | String | 公共参数，本接口取值：2023-06-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-shanghai 。 |
| ExtNamespace | 是 | String | 对外命名空间 示例值：QCE/LB |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ExtMetricList | Array of ExtMetric | 对外指标 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询对外指标
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExtMetric
<公共请求参数>
{
"ExtNamespace": "QCE/LB"
}输出示例
{
"Response": {
"ExtMetricList": [
{
"CNMeaning": "连接数量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "VConnum",
"Unit": "count"
},
{
"CNMeaning": "新建连接",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "VNewConn",
"Unit": "count"
},
{
"CNMeaning": "入包量",
"EnMeaning": "Inpkg",
"MetricCName": "入包量",
"MetricName": "VInpkg",
"Unit": "count"
},
{
"CNMeaning": "入带宽",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "VIntraffic",
"Unit": "bps"
},
{
"CNMeaning": "出包量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "VOutpkg",
"Unit": "count/s"
},
{
"CNMeaning": "出带宽",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "VOuttraffic",
"Unit": "bps"
},
{
"CNMeaning": "出带宽",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "TotalOuttraffic",
"Unit": "Mbps"
},
{
"CNMeaning": "出包量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvOutpkg",
"Unit": "count"
},
{
"CNMeaning": "入包量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvInpkg",
"Unit": "count"
},
{
"CNMeaning": "出带宽",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvOuttraffic",
"Unit": "bps"
},
{
"CNMeaning": "入带宽",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvIntraffic",
"Unit": "bps"
},
{
"CNMeaning": "连接数量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvConnum",
"Unit": "count"
},
{
"CNMeaning": "不活跃连接",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvInactiveConn",
"Unit": "count"
},
{
"CNMeaning": "新建连接",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "PvvNewConn",
"Unit": "count"
},
{
"CNMeaning": "出包量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvOutpkg",
"Unit": "count"
},
{
"CNMeaning": "入包量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvInpkg",
"Unit": "count"
},
{
"CNMeaning": "出带宽",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvOuttraffic",
"Unit": "bps"
},
{
"CNMeaning": "入流量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvIntraffic",
"Unit": "bps"
},
{
"CNMeaning": "连接数量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvConnum",
"Unit": "count"
},
{
"CNMeaning": "不活跃连接",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvInactiveConn",
"Unit": "count"
},
{
"CNMeaning": "新建连接",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "RvNewConn",
"Unit": "count"
},
{
"CNMeaning": "外网入包量",
"EnMeaning": "VipInpkg",
"MetricCName": "外网入包量",
"MetricName": "VipInpkg",
"Unit": "count/s"
},
{
"CNMeaning": "外网入带宽",
"EnMeaning": "VipIntraffic",
"MetricCName": "外网入带宽",
"MetricName": "VipIntraffic",
"Unit": "Mbps"
},
{
"CNMeaning": "外网出包量",
"EnMeaning": "VipOutpkg",
"MetricCName": "外网出包量",
"MetricName": "VipOutpkg",
"Unit": "count/s"
},
{
"CNMeaning": "外网出带宽",
"EnMeaning": "VipOuttraffic",
"MetricCName": "外网出带宽",
"MetricName": "VipOuttraffic",
"Unit": "Mbps"
},
{
"CNMeaning": "外网出流量",
"EnMeaning": "",
"MetricCName": "",
"MetricName": "AccOuttraffic",
"Unit": "MB"
},
{
"CNMeaning": "公网入带宽利用率",
"EnMeaning": "vip_in_traffic_ratio",
"MetricCName": "公网入带宽利用率",
"MetricName": "IntrafficVipRatio",
"Unit": "%"
},
{
"CNMeaning": "公网出带宽利用率",
"EnMeaning": "vip_out_traffic_ratio",
"MetricCName": "公网出带宽利用率",
"MetricName": "OuttrafficVipRatio",
"Unit": "%"
},
{
"CNMeaning": "丢弃的入向包量",
"EnMeaning": "Dropped packets in",
"MetricCName": "外网入向丢包量",
"MetricName": "Vipindroppkts",
"Unit": "pps"
},
{
"CNMeaning": "丢弃的出向包量",
"EnMeaning": "Dropped packets out",
"MetricCName": "外网出向丢包量",
"MetricName": "Vipoutdroppkts",
"Unit": "pps"
}
],
"RequestId": "f64026ab-1153-411e-859b-c2b2ad64ab41"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.Db | FailedOperation.Db |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |