API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心

获取2.0实例列表

最近更新时间：2024-03-12 01:57:20

我的收藏

本页目录：

1. 接口描述

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

获取与云监控融合实例列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribePrometheusInstancesOverview。
Version 是 String 公共参数，本接口取值：2018-05-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, na-toronto, sa-saopaulo 。
Offset 否 Integer 用于分页
示例值：1
Limit 否 Integer 用于分页
示例值：20
Filters.N 否 Array of Filter 过滤实例，目前支持：
ID: 通过实例ID来过滤
Name: 通过实例名称来过滤

3. 输出参数

参数名称 类型 描述
Instances Array of PrometheusInstancesOverview 实例列表
Total Integer 实例总数
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例列表

输入示例

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

{
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "xx"
            ],
            "Name": "xx"
        }
    ],
    "Offset": 1
}

输出示例

{
    "Response": {
        "Instances": [
            {
                "InstanceStatus": 0,
                "BoundNormal": 0,
                "VpcId": "xx",
                "AutoRenewFlag": 0,
                "InstanceId": "xx",
                "BoundTotal": 0,
                "ExpireTime": "xx",
                "SpecName": "xx",
                "InstanceChargeType": 0,
                "EnableGrafana": 0,
                "DataRetentionTime": 0,
                "GrafanaURL": "xx",
                "SubnetId": "xx",
                "InstanceName": "xx",
                "ChargeStatus": 0
            }
        ],
        "Total": 1,
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ComponentClientCommon 内部Client错误。
FailedOperation.ComponentClientUnpack 内部HTTP解包失败。
InternalError 内部错误。
InternalError.Param Param。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.Param 参数错误。
中国站