全部產品
Search

搜尋本產品

    Application Real-Time Monitoring Service：GetPrometheusInstance

    文件中心

    Application Real-Time Monitoring Service：GetPrometheusInstance

    更新時間：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": false,
    "AuthFreeReadPolicy": "0.0.0.0/0",
    "EnableAuthFreeWrite": false,
    "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": ""
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。