调用GetPrometheusView接口查询Prometheus视图实例详情-云监控-阿里云

查询指定Prometheus视图实例详情。

接口说明

查询指定 Prometheus 视图实例。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cms:GetPrometheusView

get

*PrometheusView

acs:cms:{#regionId}:{#accountId}:prometheusview/{#prometheusViewId}

无

请求语法

GET /prometheus-views/{prometheusViewId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
prometheusViewId	string	是	实例 ID。	rw-xxxxxx

请求参数

名称	类型	必填	描述	示例值
resourceGroupId	string	否	资源组 ID。	rg-aek2bhocin5e2na
aliyunLang	string	否	语言环境, 默认为中文 zh \| en。	zh

返回参数

名称	类型	描述	示例值
	object	Schema of Response
prometheusView	object	视图实例。
authFreeReadPolicy	string	免密读策略（支持 IP 段和 VpcId）。	{ "SourceIp": [ "192.168.1.0/24", "172.168.2.22" ], "SourceVpc": [ "vpc-xx1", "vpc-xx2" ] }
authToken	string	authToken 串。	eJxxxxxx
createTime	string	实例创建时间，使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。	2025-08-10T02:07:53Z
enableAuthFreeRead	boolean	是否开启读免密。	true
enableAuthToken	boolean	是否开启 authToken。	true
httpApiInterUrl	string	公网 HTTP 地址。	http://xxxxxxxx
httpApiIntraUrl	string	内网 HTTP 地址。	http://xxxxxxxx
instanceType	string	实例类型，固定值 prom-view。	prom-view
paymentType	string	付费类型。目前固定值 FREE（免费）。	FREE
product	string	prom 实例归属的产品。	cms
prometheusInstances	array<object>	Prometheus 实例列表。
	object	Prometheus 实例列表。
prometheusInstanceId	string	实例 id。	rw-63549e054ff596a4149927961dff
regionId	string	地域 ID	cn-north-2-gov-1
userId	string	用户 ID。	122xxxxx
prometheusViewId	string	Prometheus 视图 ID。	view-xxx
prometheusViewName	string	Prometheus 视图名称。	view1
regionId	string	地域 ID	cn-shanghai
remoteReadInterUrl	string	remote read 公网 URL。	http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read
remoteReadIntraUrl	string	remote read 内网 URL。	http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read
resourceGroupId	string	资源组 ID。	rg-acfm3gn5i6bigbi
resourceType	string	固定值：PrometheusView	RegistryModule
status	string	后端数据存储状态	Pending2Running
supportAuthTypes	array	支持的认证类型。
	string	支持的认证类型。	BasicAuth
tags	array<object>	实例的标签键。
	object	标签。
key	string	pagerDuty 的集成 key。	global_score_series
value	string	标签 Value。	371293199010092839
userId	string	用户 ID。	11222
version	string	版本。	V1
workspace	string	环境归属的工作空间	cms-monitor-test-aysls-pub-cn-fuzhou-monitor
folderUrl	string	可观测大盘 URL。	https://xxxx
grafanaInstanceId	string	绑定的托管 grafana 实例 ID。	g-xxx
grafanaInstanceName	string	绑定的托管 grafana 实例名称。	gxxx
requestId	string	Id of the request	0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8

示例

正常返回示例

JSON格式

{
  "prometheusView": {
    "authFreeReadPolicy": "{\n  \"SourceIp\": [\n    \"192.168.1.0/24\",\n    \"172.168.2.22\"\n  ],\n  \"SourceVpc\": [\n    \"vpc-xx1\",\n    \"vpc-xx2\"\n  ]\n}",
    "authToken": "eJxxxxxx",
    "createTime": "2025-08-10T02:07:53Z",
    "enableAuthFreeRead": true,
    "enableAuthToken": true,
    "httpApiInterUrl": "http://xxxxxxxx",
    "httpApiIntraUrl": "http://xxxxxxxx",
    "instanceType": "prom-view",
    "paymentType": "FREE",
    "product": "cms",
    "prometheusInstances": [
      {
        "prometheusInstanceId": "rw-63549e054ff596a4149927961dff",
        "regionId": "cn-north-2-gov-1",
        "userId": "122xxxxx"
      }
    ],
    "prometheusViewId": "view-xxx",
    "prometheusViewName": "view1",
    "regionId": "cn-shanghai",
    "remoteReadInterUrl": "http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read",
    "remoteReadIntraUrl": "http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read",
    "resourceGroupId": "rg-acfm3gn5i6bigbi",
    "resourceType": "RegistryModule",
    "status": "Pending2Running",
    "supportAuthTypes": [
      "BasicAuth"
    ],
    "tags": [
      {
        "key": "global_score_series",
        "value": "371293199010092839"
      }
    ],
    "userId": "11222",
    "version": "V1",
    "workspace": "cms-monitor-test-aysls-pub-cn-fuzhou-monitor",
    "folderUrl": "https://xxxx",
    "grafanaInstanceId": "g-xxx ",
    "grafanaInstanceName": "gxxx"
  },
  "requestId": "0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8"
}

错误码

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

变更历史

更多信息，参考变更详情。