1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
获取TMP实例关联集群列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePrometheusClusterAgents。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例id 示例值:prom-xxxxxx |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:1 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。 示例值:1 |
ClusterIds.N | 否 | Array of String | 用于通过集群id过滤被绑定集群 示例值:["cls-12345"] |
ClusterTypes.N | 否 | Array of String | 用于通过集群类型过滤被绑定集群 示例值:["eks"] |
ClusterName | 否 | String | 用于通过名称搜索被绑定集群 示例值:测试集群 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Agents | Array of PrometheusAgentOverview | 被关联集群信息 |
Total | Integer | 被关联集群总量 示例值:1 |
IsFirstBind | Boolean | 是否为首次绑定,如果是首次绑定则需要安装预聚合规则 示例值:false |
ImageNeedUpdate | Boolean | 实例组件是否需要更新镜像版本 示例值:false |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 拉取agent信息
拉取agent信息
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusClusterAgents
<公共请求参数>
{
"InstanceId": "prom-abc",
"Limit": 1,
"Offset": 1
}
输出示例
{
"Response": {
"Agents": [
{
"ClusterId": "cls-abc",
"ClusterName": "abc",
"ClusterType": "tke",
"EnableExternal": false,
"ExternalLabels": [
{
"Name": "cluster",
"Value": "cls-cde"
},
{
"Name": "cluster_type",
"Value": "tke"
}
],
"FailedReason": "",
"Name": "",
"ReadyAgentNum": 1,
"Region": "ap-guangzhou",
"Status": "normal",
"VpcId": "vpc-abc"
}
],
"IsFirstBind": false,
"RequestId": "56ce7-sdsd",
"ImageNeedUpdate": false,
"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.ComponentClientCommon | FailedOperation.ComponentClientCommon |
FailedOperation.ComponentClientHttp | FailedOperation.ComponentClientHttp |
FailedOperation.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
FailedOperation.Db | FailedOperation.Db |
FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
FailedOperation.InstanceNotFound | 实例不存在。 |
FailedOperation.KubeCommon | FailedOperation.KubeCommon |
InternalError | 内部错误。 |
InternalError.Db | InternalError.Db |
InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
InvalidParameter | 参数错误。 |
InvalidParameter.ClusterNotFound | InvalidParameter.ClusterNotFound |
InvalidParameter.Param | InvalidParameter.Param |
InvalidParameter.PromClusterNotFound | InvalidParameter.PromClusterNotFound |
InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |
InvalidParameter.ResourceNotFound | InvalidParameter.ResourceNotFound |