文档中心>API 中心

查看 Prometheus 实例列表

最近更新时间:2024-03-12 01:40:55

我的收藏

1. 接口描述

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

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePrometheusInstances。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 按照一个或者多个实例ID查询。实例ID形如:prom-xxxxxxxx。请求的实例的上限为100。
示例值:["prom-xxxxx"]
InstanceStatus.N Array of Integer 按照【实例状态】进行过滤。

  • 1:正在创建
  • 2:运行中
  • 3:异常
  • 4:重建中
  • 5:销毁中
  • 6:已停服
  • 8:欠费停服中
  • 9:欠费已停服


示例值:[1,2]
InstanceName String 按照【实例名称】进行过滤。
示例值:1
Zones.N Array of String 按照【可用区】进行过滤。可用区形如:ap-guangzhou-1。
示例值:["ap-guangzhou-1"]
TagFilters.N Array of PrometheusTag 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。
IPv4Address.N Array of String 按照【实例的IPv4地址】进行过滤。
示例值:["1.1.1.1"]
Limit Integer 返回数量,默认为20,最大值为100。
示例值:1
Offset Integer 偏移量,默认为0。
示例值:1
InstanceChargeType Integer 按照【计费类型】进行过滤。
  • 2:包年包月
  • 3:按量

  • 示例值:2

    3. 输出参数

    参数名称 类型 描述
    InstanceSet Array of PrometheusInstancesItem 实例详细信息列表。
    注意:此字段可能返回 null,表示取不到有效值。
    TotalCount Integer 符合条件的实例数量。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    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。

    命令行工具

    6. 错误码

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

    错误码 描述
    AuthFailure.AccessCAMFail 访问鉴权失败。
    AuthFailure.UnauthorizedOperation 请求未授权。请参考 CAM 文档对鉴权的说明。
    FailedOperation 操作失败。
    FailedOperation.AccessTagFail 访问标签服务失败。
    FailedOperation.DbQueryFailed 数据库查询失败。
    FailedOperation.DbRecordCreateFailed 创建数据库记录失败。
    FailedOperation.InternalError 内部服务错误。
    FailedOperation.ResourceNotFound 资源不存在。
    FailedOperation.SendRequest 发送授权请求失败。
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。