ListPrometheusInstances - 查询 Prometheus 实例列表

获取Prometheus实例信息列表。

接口说明

获取 Prometheus 实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:ListPrometheusInstanceslist
*PrometheusInstance
acs:cms:{#regionId}:{#accountId}:prometheusinstance/*

请求语法

GET /prometheus-instances HTTP/1.1

请求参数

名称类型必填描述示例值
prometheusInstanceIdsstring

实例 id 列表(以英文逗号分隔)

rw-00001,rw-00002,rw-00003
prometheusInstanceNamestring

实例名称(支持部分匹配)

test
versionstring

实例版本:V1 或 V2

V2
resourceTypestring

实例的资源类型。

Prometheus
filterRegionIdsstring

指定筛选的 regionId 列表(英文逗号分隔)。

cn-shenzhen
resourceGroupIdstring

资源组 ID。

rg-aek2bhocin5e2na
tagarray<object>

标签列表。

object

标签。

keystring

标签键

testKey
valuestring

标签值。

testValue
maxResultsinteger

返回的最多记录数。

10
nextTokenstring

查询令牌。

xxxxxxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

maxResultsinteger

返回的最多记录数。

10
nextTokenstring

下一次查询的令牌。

xxxxxxxxxx
prometheusInstancesarray<object>

Prometheus 实例列表。

prometheusInstanceobject

Prometheus 实例。

accessTypestring

权限类型: readWrite、readOnly、httpReadOnly

readWrite
createTimestring

实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ

2025-08-10T02:07:53Z
instanceTypestring

实例类型。

remote-write
paymentTypestring

POSTPAY:按指标量后付费。 POSTPAY_GB:按写入量后付费。 PREPAY:预付费。 FREE:免费。

POSTPAY_GB
productstring

prom 实例归属的产品

arms
prometheusInstanceIdstring

实例 id。

rw-63549e054ff596a4149927961dff
prometheusInstanceNamestring

实例名称。

test-prom-name
regionIdstring

区域 ID

cn-nanjing
resourceGroupIdstring

资源组 ID。

rg-aek2bhocin5e2na
resourceTypestring

资源类型。

Prometheus
statusstring

后端数据存储状态

Pending2Running
supportAuthTypesarray

支持的鉴权类型。

SupportAuthTypestring

鉴权类型。

BasicAuth
tagsarray<object>

标签键。

tagsobject

标签。

keystring

标签键

testKey
valuestring

标签值。

testValue
userIdstring

用户 ID。

17073812345
versionstring

版本

*
workspacestring

prom 实例归属工作空间

default-cms-115214006-cn-hangzhou
requestIdstring

Id of the request

264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
totalCountinteger

总实例数

66

示例

正常返回示例

JSON格式

{
  "maxResults": 10,
  "nextToken": "xxxxxxxxxx",
  "prometheusInstances": [
    {
      "accessType": "readWrite",
      "createTime": "2025-08-10T02:07:53Z",
      "instanceType": "remote-write",
      "paymentType": "POSTPAY_GB",
      "product": "arms",
      "prometheusInstanceId": "rw-63549e054ff596a4149927961dff",
      "prometheusInstanceName": "test-prom-name",
      "regionId": "cn-nanjing",
      "resourceGroupId": "rg-aek2bhocin5e2na",
      "resourceType": "Prometheus",
      "status": "Pending2Running",
      "supportAuthTypes": [
        "BasicAuth"
      ],
      "tags": [
        {
          "key": "testKey",
          "value": "testValue"
        }
      ],
      "userId": 17073812345,
      "version": "*",
      "workspace": "default-cms-115214006-cn-hangzhou"
    }
  ],
  "requestId": "264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC",
  "totalCount": 66
}

错误码

访问错误中心查看更多错误码。