1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
查询网关监控数据
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeGatewayCurveData。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EnvId | 是 | String | 环境id 示例值:env-xxx |
GatewayId | 是 | String | 网关id 示例值:gate-xxx |
MetricName | 是 | String | 监控类型 GWQps GWBandwidth GwHttpError GwHttp404 GwHttp502 GwConnect GwCircuit 示例值:GWQps |
StartTime | 是 | String | 监控起始时间 示例值:2022-02-22 20:08:10 |
EndTime | 是 | String | 监控结束时间 示例值:2022-02-22 20:08:10 |
GatewayVersion | 否 | String | 网关版本 示例值:version-xxx |
GatewayRoute | 否 | String | 网关路由名称 示例值:xxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MetricName | String | 监控类型 示例值:GWQps |
StartTime | String | 监控起始时间 示例值:2022-02-22 20:08:10 |
EndTime | String | 监控结束时间 示例值:2022-02-22 20:08:10 |
Period | Integer | 监控数据间隔 示例值:10 |
Values | Array of Float | 监控值 示例值:[10,20,30] |
Time | Array of Integer | 监控时间 示例值:[1640253400,1640253401,1640253402] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询网关监控数据实例
查询网关监控数据实例
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGatewayCurveData
<公共请求参数>
{
"EnvId": "envId",
"GatewayId": "gatewayId",
"GatewayVersion": "version-001",
"GatewayRoute": "route",
"MetricName": "GwHttp404",
"StartTime": "2022-02-22 20:08:10",
"EndTime": "2022-02-22 20:18:10"
}
输出示例
{
"Response": {
"Period": 1,
"Values": [
0,
0
],
"RequestId": "req",
"StartTime": "2022-02-22 20:08:10",
"Time": [
1640845840,
1640845841
],
"EndTime": "2022-02-22 20:18:10",
"MetricName": "GwHttp404"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ServiceNotExist | 服务不存在。 |
MissingParameter | 缺少参数错误。 |
ResourceUnavailable | 资源不可用。 |