获取Prometheus实例信息列表。
接口说明
获取 Prometheus 实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cms:ListPrometheusInstances |
list |
*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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| maxResults |
integer |
返回的最多记录数。 |
10 |
| nextToken |
string |
下一次查询的令牌。 |
xxxxxxxxxx |
| prometheusInstances |
array<object> |
Prometheus 实例列表。 |
|
|
array<object> |
Prometheus 实例。 |
||
| accessType |
string |
权限类型： readWrite、readOnly、httpReadOnly |
readWrite |
| createTime |
string |
实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ |
2025-08-10T02:07:53Z |
| instanceType |
string |
实例类型。 |
remote-write |
| paymentType |
string |
POSTPAY：按指标量后付费。 POSTPAY_GB：按写入量后付费。 PREPAY：预付费。 FREE：免费。 |
POSTPAY_GB |
| product |
string |
prom 实例归属的产品 |
arms |
| prometheusInstanceId |
string |
实例 id。 |
rw-63549e054ff596a4149927961dff |
| prometheusInstanceName |
string |
实例名称。 |
test-prom-name |
| regionId |
string |
区域 ID |
cn-nanjing |
| resourceGroupId |
string |
资源组 ID。 |
rg-aek2bhocin5e2na |
| resourceType |
string |
资源类型。 |
Prometheus |
| status |
string |
后端数据存储状态 |
Pending2Running |
| supportAuthTypes |
array |
支持的鉴权类型。 |
|
|
string |
鉴权类型。 |
BasicAuth |
|
| tags |
array<object> |
标签键。 |
|
|
object |
标签。 |
||
| key |
string |
标签键 |
testKey |
| value |
string |
标签值。 |
testValue |
| userId |
string |
用户 ID。 |
17073812345 |
| version |
string |
版本 |
* |
| workspace |
string |
prom 实例归属工作空间 |
default-cms-115214006-cn-hangzhou |
| requestId |
string |
Id of the request |
264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC |
| totalCount |
integer |
总实例数 |
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
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。