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

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

接口说明

查询指定 Prometheus 视图实例。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

实例 ID。

rw-xxxxxx
resourceGroupIdstring

资源组 ID。

rg-aek2bhocin5e2na
aliyunLangstring

语言环境, 默认为中文 zh | en

zh

返回参数

名称类型描述示例值
object

Schema of Response

prometheusViewobject

视图实例。

authFreeReadPolicystring

免密读策略(支持 IP 段和 VpcId)。

{ "SourceIp": [ "192.168.1.0/24", "172.168.2.22" ], "SourceVpc": [ "vpc-xx1", "vpc-xx2" ] }
authTokenstring

authToken 串。

eJxxxxxx
createTimestring

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

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

是否开启读免密。

true
enableAuthTokenboolean

是否开启 authToken。

true
httpApiInterUrlstring

公网 HTTP 地址。

http://xxxxxxxx
httpApiIntraUrlstring

内网 HTTP 地址。

http://xxxxxxxx
instanceTypestring

实例类型,固定值 prom-view。

prom-view
paymentTypestring

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

FREE
productstring

prom 实例归属的产品。

cms
prometheusInstancesarray<object>

Prometheus 实例列表。

PrometheusInstanceobject

Prometheus 实例列表。

prometheusInstanceIdstring

实例 id。

rw-63549e054ff596a4149927961dff
regionIdstring

地域 ID

cn-north-2-gov-1
userIdstring

用户 ID。

122xxxxx
prometheusViewIdstring

Prometheus 视图 ID。

view-xxx
prometheusViewNamestring

Prometheus 视图名称。

view1
regionIdstring

地域 ID

cn-shanghai
remoteReadInterUrlstring

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
remoteReadIntraUrlstring

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
resourceGroupIdstring

资源组 ID。

rg-acfm3gn5i6bigbi
resourceTypestring

固定值:PrometheusView

RegistryModule
statusstring

后端数据存储状态

Pending2Running
supportAuthTypesarray

支持的认证类型。

SupportAuthTypestring

支持的认证类型。

BasicAuth
tagsarray<object>

实例的标签键。

tagsobject

标签。

keystring

pagerDuty 的集成 key。

global_score_series
valuestring

标签 Value。

371293199010092839
userIdstring

用户 ID。

11222
versionstring

版本。

V1
workspacestring

环境归属的工作空间

cms-monitor-test-aysls-pub-cn-fuzhou-monitor
folderUrlstring

可观测大盘 URL。

https://xxxx
grafanaInstanceIdstring

绑定的托管 grafana 实例 ID。

g-xxx
grafanaInstanceNamestring

绑定的托管 grafana 实例名称。

gxxx
requestIdstring

Id of the request

0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8

示例

正常返回示例

JSON格式

{
  "prometheusView": {
    "authFreeReadPolicy": {
      "SourceIp": [
        "192.168.1.0/24",
        "172.168.2.22"
      ],
      "SourceVpc": [
        "vpc-xx1",
        "vpc-xx2"
      ]
    },
    "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": 371293199010092860
      }
    ],
    "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"
}

错误码

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