查看 Prometheus 实例列表

1. 接口描述

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

本接口 (DescribePrometheusInstances) 用于查询一个或多个实例的详细信息。

• 可以根据实例ID、实例名称或者实例状态等信息来查询实例的详细信息
• 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的实例。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查看 Prometheus 实例列表

输入示例

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

{
    "InstanceIds": [
        "prom-ncxkwqr8"
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "InstanceSet": [
            {
                "InstanceName": "name",
                "InstanceChargeType": 1,
                "InstanceId": "prom-xxxxx",
                "InstanceStatus": 1,
                "RegionId": 1,
                "Zone": "ap-guangzhou-1",
                "GrafanaInstanceId": "abc",
                "AuthToken": "abc",
                "RecordingRuleLimit": 0,
                "VpcId": "vpcID",
                "SubnetId": "subnetid",
                "MigrationType": 0,
                "IPv4Address": "",
                "RemoteWrite": "abc",
                "DataRetentionTime": 30,
                "EnableGrafana": 0,
                "ExpireTime": "abc",
                "SpecName": "abc",
                "Grant": {
                    "HasChargeOperation": 0,
                    "HasVpcDisplay": 0,
                    "HasGrafanaStatusChange": 0,
                    "HasAgentManage": 0,
                    "HasTkeManage": 0,
                    "HasApiOperation": 0
                },
                "ProxyAddress": "abc",
                "IsNearExpire": 0,
                "GrafanaStatus": 0,
                "GrafanaIpWhiteList": "abc",
                "ApiRootPath": "abc",
                "TagSpecification": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "AutoRenewFlag": 0,
                "AlertRuleLimit": 0,
                "ChargeStatus": 0,
                "GrafanaURL": "",
                "CreatedAt": "2020-07-07T10:39:18Z"
            }
        ],
        "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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