数据湖计算 DLC 查询 TKE 集群可绑定的 Promethe

1. 接口描述

接口请求域名： dlc.tencentcloudapi.com 。

查询 TKE 集群可绑定的托管 Prometheus 实例列表。若 TKE 已绑定，返回 Bound=true 与 BoundInstance；若未绑定，返回 Bound=false 与候选列表 Instances（同 VPC 实例前置）。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBindablePrometheus。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
ClusterId	是	String	TKE 集群 ID 示例值：cls-882vl2ia
InstanceId	否	String	Prometheus 实例 ID（用于列表精确搜索）示例值：prom-7edj1s60
Limit	否	Integer	分页大小，默认 20，最大 100 示例值：100
Offset	否	Integer	分页偏移，默认 0 示例值：0

3. 输出参数

参数名称	类型	描述
Bound	Boolean	TKE 集群是否已绑定 Prometheus 实例示例值：true
TotalCount	Integer	Prometheus 实例总数（未分页前）；Bound=false 时有意义示例值：1
Instances	Array of PrometheusInstanceItem	Prometheus 实例列表；Bound=false 时返回；已按同 VPC 优先稳定排序注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询可绑定 Prometheus

查询未绑定分支示例

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBindablePrometheus
<公共请求参数>

{
    "ClusterId": "cls-xxxxxxxx",
    "Limit": 20,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Bound": false,
        "TotalCount": 2,
        "Instances": [
            {
                "InstanceId": "prom-aaaaaaaa",
                "InstanceName": "prom-a",
                "VpcId": "vpc-xxxxxxxx",
                "SubnetId": "subnet-xxxxxxxx",
                "InstanceStatus": 2,
                "SameVpcWithTke": true
            },
            {
                "InstanceId": "prom-bbbbbbbb",
                "InstanceName": "prom-b",
                "VpcId": "vpc-yyyyyyyy",
                "SubnetId": "subnet-yyyyyyyy",
                "InstanceStatus": 2,
                "SameVpcWithTke": false
            }
        ],
        "RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.ExternalService	外部服务异常

查询 TKE 集群可绑定的 Prometheus 实例

本页目录：