ListPrometheusViews - 获取Prometheus视图实例列表

获取Prometheus视图实例信息列表。

接口说明

获取 Prometheus 视图实例信息列表。

调试

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

授权信息

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

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

请求语法

GET /prometheus-views HTTP/1.1

请求参数

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

Prometheus 视图实例 Id 列表。

view-xxx
prometheusViewNamestring

Prometheus 视图名称。

view1
workspacestring

工作空间名称

workspace-test
versionstring

实例版本:V1 或 V2

V2
resourceTypestring

资源类型。

PROMETHEUSVIEW
filterRegionIdsstring

通过 RegionID 进行过滤。

cn-zhangjiakou,cn-beijing
resourceGroupIdstring

资源组 ID。

rg-acfm3gn5i6bigbi
tagarray<object>

标签列表。

object

标签列表。

valuestring

匹配值。

value1
keystring

标签键

key1
maxResultsinteger

返回的最多记录数。

100
nextTokenstring

查询令牌。

44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE

返回参数

名称类型描述示例值
object

Schema of Response

maxResultsinteger

返回的最多记录数。

10
nextTokenstring

下一次查询的令牌。

2-ba4d-4b9f-aa24-dcb067a30f1c
prometheusViewsarray<object>

Prometheus 视图实例列表。

prometheusViewobject

Prometheus 视图实例。

prometheusInstanceCountinteger

视图包含的 prometheus 实例的数量。

2
productstring

prom 实例归属的产品(arms 或 cms)。

cms
workspacestring

prom 实例归属工作空间。

default-cms-1490404746278495-cn-hangzhou
instanceTypestring

实例类型: prom-view:新版本聚合视图 global-view:老版本聚合视图

prom-view
userIdstring

用户 ID。

123xxx
versionstring

版本。

V2
paymentTypestring

付费类型。目前固定值 FREE(免费)。

FREE
prometheusViewNamestring

Prometheus 视图名称。

view1
tagsarray<object>

标签值。

tagsobject

标签值。

valuestring

匹配值。

value1
keystring

标签键

key1
createTimestring

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

2025-07-12T02:18:36Z
regionIdstring

区域 ID。

cn-zhangjiakou
resourceGroupIdstring

资源组 ID。

rg-acfm3gn5i6bigbi
prometheusViewIdstring

Prometheus 视图 ID。

view-xxx
resourceTypestring

固定值:PrometheusView。

PrometheusView
statusstring

后端数据存储状态。

Running
requestIdstring

Id of the request

0CEC5375-C554-562B-A65F-9A629907C1F0
totalCountinteger

总实例数

66

示例

正常返回示例

JSON格式

{
  "maxResults": 10,
  "nextToken": "2-ba4d-4b9f-aa24-dcb067a30f1c",
  "prometheusViews": [
    {
      "prometheusInstanceCount": 2,
      "product": "cms",
      "workspace": "default-cms-1490404746278495-cn-hangzhou",
      "instanceType": "prom-view",
      "userId": "123xxx",
      "version": "V2",
      "paymentType": "FREE",
      "prometheusViewName": "view1",
      "tags": [
        {
          "value": "value1",
          "key": "key1"
        }
      ],
      "createTime": "2025-07-12T02:18:36Z",
      "regionId": "cn-zhangjiakou",
      "resourceGroupId": "rg-acfm3gn5i6bigbi",
      "prometheusViewId": "view-xxx",
      "resourceType": "PrometheusView",
      "status": "Running"
    }
  ],
  "requestId": "0CEC5375-C554-562B-A65F-9A629907C1F0",
  "totalCount": 66
}

错误码

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