GetPrometheusInstance - 获取Prometheus实例详细信息

查询指定Prometheus实例详情信息。

接口说明

获取 Prometheus 实例详情。

调试

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

授权信息

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

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

请求语法

GET /prometheus-instances/{prometheusInstanceId} HTTP/1.1

请求参数

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

实例 id。

rw-abc123
resourceGroupIdstring

资源组 ID。

rg-aek2bhocin5e2na
aliyunLangstring

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

zh

返回参数

名称类型描述示例值
object

Schema of Response

prometheusInstanceobject

Prometheus 实例详情。

accessTypestring

权限类型: readWrite、readOnly、httpReadOnly

readOnly
archiveDurationinteger

存储到期后,自动归档保存的天数,0 表示不归档保存,3650 表示永久保存。

90
authFreeReadPolicystring

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

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

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

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

authToken 串。

eJwixxxxx
createTimestring

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

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

是否开启读免密。

true
enableAuthFreeWriteboolean

是否开启写免密。

true
enableAuthTokenboolean

是否开启鉴权 Token。

true
extraInfoobject

扩展信息。

string

其他扩展信息。

value
httpApiInterUrlstring

HTTP 公网地址。

http://workspace-default-cms-xxxxxxx
httpApiIntraUrlstring

HTTP 内网地址。

http://workspace-default-cms-xxxxxxx
instanceTypestring

Prometheus 实例类型。

remote-write
paymentTypestring

计费方式: POSTPAY:按指标上报量后付费。 POSTPAY_GB:按指标写入量后付费。

POSTPAY
productstring

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

cms
prometheusInstanceIdstring

实例 ID。

rw-524ada714221af267c73122af2e1
prometheusInstanceNamestring

实例名称。

test-prom-name
pushGatewayInterUrlstring

PushGateway 公网地址。

http://workspace-default-cms-xxxxxxx
pushGatewayIntraUrlstring

PushGateway 内网地址。

http://workspace-default-cms-xxxxxxx
regionIdstring

地域 ID。

cn-heyuan
remoteReadInterUrlstring

公网读地址。

http://workspace-default-cms-xxxxxxx
remoteReadIntraUrlstring

内网读地址。

https://workspace-default-cms-1xxxxxxxxxx
remoteWriteInterUrlstring

公网写地址。

https://workspace-default-cms-xxxxxxxxxx
remoteWriteIntraUrlstring

内网写地址。

https://workspace-default-cms-xxxxxxxxxx
resourceGroupIdstring

资源组 ID。

rg-acfm3gn5i6bigbi
resourceTypestring

固定值:PrometheusInstance。

Prometheus
statusstring

实例状态。

Running
storageDurationinteger

存储时长(天)。

90
supportAuthTypesarray

支持的认证鉴权类型。

supportAuthTypestring

鉴权类型。

BasicAuth
tagsarray<object>

标签列表。

tagsobject

标签。

keystring

标签 Key。

openStorage
valuestring

匹配值。

130303196111114281
userIdstring

用户 ID。

170731234567
versionstring

版本。

V1
workspacestring

Prometheus 实例归属的工作空间。

ws1
folderUrlstring

可视化大盘目录 URL。

https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx
grafanaInstanceIdstring

绑定的托管 grafana 实例 ID。

SHARED
grafanaInstanceNamestring

绑定的托管 grafana 实例名称。

共享版
paymentTypeUpdateTimestring

实例计费方式修改时间。

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

请求唯一标识。

264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC

示例

正常返回示例

JSON格式

{
  "prometheusInstance": {
    "accessType": "readOnly",
    "archiveDuration": 90,
    "authFreeReadPolicy": {
      "SourceIp": [
        "192.168.1.0/24",
        "172.168.2.22"
      ],
      "SourceVpc": [
        "vpc-xx1",
        "vpc-xx2"
      ]
    },
    "authFreeWritePolicy": {
      "SourceIp": [
        "192.168.1.0/24",
        "172.168.2.22"
      ],
      "SourceVpc": [
        "vpc-xx1",
        "vpc-xx2"
      ]
    },
    "authToken": "eJwixxxxx",
    "createTime": "2025-08-10T02:07:53Z",
    "enableAuthFreeRead": true,
    "enableAuthFreeWrite": true,
    "enableAuthToken": true,
    "extraInfo": {
      "key": "value"
    },
    "httpApiInterUrl": " http://workspace-default-cms-xxxxxxx",
    "httpApiIntraUrl": " http://workspace-default-cms-xxxxxxx",
    "instanceType": "remote-write",
    "paymentType": "POSTPAY",
    "product": "cms",
    "prometheusInstanceId": "rw-524ada714221af267c73122af2e1",
    "prometheusInstanceName": "test-prom-name",
    "pushGatewayInterUrl": " http://workspace-default-cms-xxxxxxx",
    "pushGatewayIntraUrl": " http://workspace-default-cms-xxxxxxx\n",
    "regionId": "cn-heyuan",
    "remoteReadInterUrl": " http://workspace-default-cms-xxxxxxx",
    "remoteReadIntraUrl": "https://workspace-default-cms-1xxxxxxxxxx",
    "remoteWriteInterUrl": "https://workspace-default-cms-xxxxxxxxxx",
    "remoteWriteIntraUrl": "https://workspace-default-cms-xxxxxxxxxx",
    "resourceGroupId": "rg-acfm3gn5i6bigbi",
    "resourceType": "Prometheus",
    "status": "Running",
    "storageDuration": 90,
    "supportAuthTypes": [
      "BasicAuth"
    ],
    "tags": [
      {
        "key": "openStorage",
        "value": 130303196111114290
      }
    ],
    "userId": 170731234567,
    "version": "V1",
    "workspace": "ws1",
    "folderUrl": "https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx",
    "grafanaInstanceId": "SHARED",
    "grafanaInstanceName": "共享版",
    "paymentTypeUpdateTime": "2025-08-10T02:07:53Z"
  },
  "requestId": "264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC"
}

错误码

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