1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取实例采集速率信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePrometheusScrapeStatistics。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceIds.N | 是 | Array of String | 实例ID列表 示例值:["prom-osje"] |
| ClusterId | 否 | String | 集群ID 示例值:cls-xxx |
| JobType | 否 | String | job 类型 示例值:podMonitor |
| Job | 否 | String | job 过滤,不写就是全部 job 示例值:cadvisor |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总个数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| InstanceResults | Array of PrometheusInstanceScrapeStatistics | 实例指标抓取速率详情 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例采集速率
获取实例采集速率
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusScrapeStatistics
<公共请求参数>
{
"Job": "test-job",
"ClusterId": "cls-oebw",
"InstanceIds": [
"prom-ejhf"
]
}
输出示例
{
"Response": {
"Total": 0,
"InstanceResults": [
{
"InstanceId": "prom-ejhf",
"ScrapedRate": 1.4,
"Clusters": [
{
"ClusterID": "cls-oebw",
"ScrapedRate": 0.1,
"Jobs": [
{
"JobName": "test-job",
"ScrapedRate": 0.1,
"Metrics": [
{
"MetricName": "countMetric",
"SamplesRate": 3.4,
"ScrapedRate": 0.1,
"IsRecommended": true
}
]
}
],
"SamplesRate": 3.4
}
],
"Global": [
{
"ClusterID": "non-cluster",
"ScrapedRate": 1.3,
"Jobs": [
{
"JobName": "ceph-test",
"ScrapedRate": 1.3,
"Metrics": [
{
"MetricName": "upTime",
"SamplesRate": 2.1,
"ScrapedRate": 1.3,
"IsRecommended": true
}
]
}
],
"SamplesRate": 2.1
}
],
"SamplesRate": 5.5
}
],
"RequestId": "6fc6a7e8-2a5c-40f2-bf0e-8cb807fa665d"
}
}
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.ComponentClientCommon | FailedOperation.ComponentClientCommon |
| FailedOperation.ComponentClientHttp | FailedOperation.ComponentClientHttp |
| FailedOperation.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
| FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
| FailedOperation.KubeCommon | FailedOperation.KubeCommon |
| InternalError | 内部错误。 |
| InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
| InvalidParameter.Param | InvalidParameter.Param |
| InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |