全部产品
Search

搜索本产品

    应用实时监控服务ARMS：GetPrometheusInstance - 获取指定Prometheus实例信息

    文档中心

    应用实时监控服务ARMS：GetPrometheusInstance - 获取指定Prometheus实例信息

    更新时间：Jun 24, 2026

    获取指定Prometheus实例信息。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    arms:GetPrometheusInstance

    get

    *Prometheus

    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    RegionId

    string

    是

    地域 ID。

    cn-hangzhou
    ClusterId

    string

    是

    Prometheus 实例 ID。

    c77f6f2397ea74672872acf5e31374a27

    返回参数

    名称

    类型

    描述

    示例值

    object

    Schema of Response

    RequestId

    string

    Id of the request

    52C422FD-6B43-524D-B8A1-A4693294318C
    Message

    string

    返回结果的提示信息。

    message
    Code

    integer

    状态码。200 为成功，其他状态码为异常。

    200
    Data

    object

    返回信息。

    ClusterId

    string

    Prometheus 实例 ID。

    c589a1b8db05c4561aefbb898ca8fb1cf
    RegionId

    string

    地域 ID。

    cn-beijing
    UserId

    string

    用户 ID。

    167275301789****
    ClusterName

    string

    集群名称。

    prom1
    ClusterType

    string

    • remote-write（Prometheus for 通用）

    • ecs（Prometheus for ECS）

    • cloud-monitor（Prometheus for 云服务中国内地）

    • cloud-product（Prometheus for 云服务国外）

    • global-view（Prometheus for GlobalView）

    • aliyun-cs（Prometheus for 容器服务）

    remote-write
    VpcId

    string

    集群所对应的 VPC。（仅 Prometheus for ECS 透出）

    vpc-8vb02uk57qbcktqcvqqqj
    VSwitchId

    string

    交换机 ID。（仅 Prometheus for ECS 透出）

    vsw-f8z73vcja1tqnw90aav5a
    SecurityGroupId

    string

    安全组 ID。（仅 Prometheus for ECS 透出）

    sg-8vbdgmf4nraiqa9bx0jo
    SubClustersJson

    string

    globalView 实例的子实例 JSON 串。

    [{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73***","sourceName":"arms-luyao-test","dataSource":"","userId":"167275301789***"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5****","sourceName":"agent-321-测试","dataSource":"","userId":"1672753017899***"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"167275301789***"}]
    RemoteReadIntraUrl

    string

    remote read 内网地址

    http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read
    RemoteReadInterUrl

    string

    remote read 公网地址

    http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read
    RemoteWriteIntraUrl

    string

    remote write 内网地址

    http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write
    RemoteWriteInterUrl

    string

    remote write 公网地址

    https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write
    PushGatewayIntraUrl

    string

    push gateway 内网地址

    http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2
    PushGatewayInterUrl

    string

    push gateway 公网地址

    https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2
    OpenTelemetryInterUrl

    string

    HttpApiIntraUrl

    string

    http api 内网地址

    http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx
    HttpApiInterUrl

    string

    http api 公网地址

    https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx
    AuthToken

    string

    授权 token 串

    GciOiJIUzI1NiJ9***
    AccessType

    string

    权限类型： readWrite、readOnly、httpReadOnly

    readWrite
    PaymentType

    string

    付费类型。

    • PREPAY-包年包月

    • POSTPAY-按量付费

    PREPAY
    StorageDuration

    integer

    存储时长（天）。

    90
    ArchiveDuration

    integer

    存储到期后，自动归档保存的天数（可选值：60、90、180、365）。0 表示不归档保存。

    60
    GrafanaInstanceId

    string

    Grafana 工作区 ID。

    grafana-rnggfvhlcdl6m71***
    ResourceGroupId

    string

    实例所属的资源组 ID。

    rg-aek2vezare****
    ResourceType

    string

    固定值：PROMETHEUS。

    PROMETHEUS
    EnableAuthToken

    string

    是否开启访问 Token 鉴权

    true
    SupportAuthTypes

    array

    支持的认证鉴权类型。

    string

    支持的认证鉴权类型。

    枚举值：

    • BasicAuth :

      http 基础鉴权

    • AuthFree :

      免密

    • AuthToken :

      token 鉴权

    AuthFree
    EnableAuthFreeRead

    boolean

    是否开启读免密。

    AuthFreeReadPolicy

    string

    读免密地址白名单策略。

    0.0.0.0/0
    EnableAuthFreeWrite

    boolean

    是否开启写免密。

    AuthFreeWritePolicy

    string

    写免密地址白名单策略。

    0.0.0.0/0
    Product

    string

    prom 实例归属的产品（arms 或 cms）

    arms
    DbInstanceStatus

    string

    后端数据存储状态

    RUNNING
    Version

    string

    版本

    V1
    PaymentTypeUpdateTime

    string

    实例计费方式修改时间

    2025-02-26T06:05:01Z
    ExtraInfo

    object

    扩展信息（仅控制台请求才返回）

    string

    扩展信息。

    extraKey
    Tags

    array<object>

    实例所绑定的标签。

    object

    标签。

    TagKey

    string

    标签键。

    tag1
    TagValue

    string

    标签值。

    tagValue1
    OpenTelemetryIntraUrl

    string

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "52C422FD-6B43-524D-B8A1-A4693294318C",
  "Message": "message",
  "Code": 200,
  "Data": {
    "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
    "RegionId": "cn-beijing",
    "UserId": "167275301789****",
    "ClusterName": "prom1",
    "ClusterType": "remote-write",
    "VpcId": "vpc-8vb02uk57qbcktqcvqqqj",
    "VSwitchId": "vsw-f8z73vcja1tqnw90aav5a",
    "SecurityGroupId": "sg-8vbdgmf4nraiqa9bx0jo",
    "SubClustersJson": "[{\"headers\":{},\"regionId\":\"cn-hangzhou\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c39a1048921e04fceb039db2fbb73***\",\"sourceName\":\"arms-luyao-test\",\"dataSource\":\"\",\"userId\":\"167275301789***\"},{\"headers\":{},\"regionId\":\"cn-beijing\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c6b6485496d5b400abde22cb47b5****\",\"sourceName\":\"agent-321-测试\",\"dataSource\":\"\",\"userId\":\"1672753017899***\"},{\"headers\":{},\"regionId\":\"cn-zhangjiakou\",\"sourceType\":\"AlibabaPrometheus\",\"extras\":{},\"clusterId\":\"c261a4f3200c446659133f1ade789b15e\",\"sourceName\":\"zaifeng-cardinality-01\",\"dataSource\":\"\",\"userId\":\"167275301789***\"}]",
    "RemoteReadIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read",
    "RemoteReadInterUrl": "http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read",
    "RemoteWriteIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write",
    "RemoteWriteInterUrl": "https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write",
    "PushGatewayIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2",
    "PushGatewayInterUrl": "https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2",
    "OpenTelemetryInterUrl": "",
    "HttpApiIntraUrl": "http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx",
    "HttpApiInterUrl": "https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx",
    "AuthToken": "GciOiJIUzI1NiJ9***",
    "AccessType": "readWrite",
    "PaymentType": "PREPAY",
    "StorageDuration": 90,
    "ArchiveDuration": 60,
    "GrafanaInstanceId": "grafana-rnggfvhlcdl6m71***",
    "ResourceGroupId": "rg-aek2vezare****",
    "ResourceType": "PROMETHEUS",
    "EnableAuthToken": "true",
    "SupportAuthTypes": [
      "AuthFree"
    ],
    "EnableAuthFreeRead": true,
    "AuthFreeReadPolicy": "0.0.0.0/0",
    "EnableAuthFreeWrite": true,
    "AuthFreeWritePolicy": "0.0.0.0/0",
    "Product": "arms",
    "DbInstanceStatus": "RUNNING",
    "Version": "V1",
    "PaymentTypeUpdateTime": "2025-02-26T06:05:01Z",
    "ExtraInfo": {
      "key": "extraKey"
    },
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "tagValue1"
      }
    ],
    "OpenTelemetryIntraUrl": ""
  }
}

    错误码

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

    变更历史

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