获取Prometheus实例信息列表。
接口说明
获取 Prometheus 实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:ListPrometheusInstances | list | *PrometheusInstance acs:cms:{#regionId}:{#accountId}:prometheusinstance/* |
| 无 |
请求语法
GET /prometheus-instances HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| prometheusInstanceIds | string | 否 | 实例 id 列表(以英文逗号分隔) | rw-00001,rw-00002,rw-00003 |
| prometheusInstanceName | string | 否 | 实例名称(支持部分匹配) | test |
| version | string | 否 | 实例版本:V1 或 V2 | V2 |
| resourceType | string | 否 | 实例的资源类型。 | Prometheus |
| filterRegionIds | string | 否 | 指定筛选的 regionId 列表(英文逗号分隔)。 | cn-shenzhen |
| resourceGroupId | string | 否 | 资源组 ID。 | rg-aek2bhocin5e2na |
| tag | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签。 | ||
| key | string | 否 | 标签键 | testKey |
| value | string | 否 | 标签值。 | testValue |
| maxResults | integer | 否 | 返回的最多记录数。 | 10 |
| nextToken | string | 否 | 查询令牌。 | xxxxxxxxxx |
返回参数
示例
正常返回示例
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
}错误码
访问错误中心查看更多错误码。
