全部產品
Search

搜尋本產品

    Application Real-Time Monitoring Service：CreatePrometheusInstance

    文件中心

    Application Real-Time Monitoring Service：CreatePrometheusInstance

    更新時間：Jun 24, 2026

    新建 Prometheus 執行個體。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    arms:CreatePrometheusInstance

    create

    *Prometheus

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    實際 Region。

    cn-shanghai
    ClusterType

    string

    是

    類型有：

    • remote-write：Prometheus for Remote Write

    • ecs（不再支援）：Prometheus for ECS

    • global-view：Prometheus for GlobalView

    • aliyun-cs（不再支援）：Prometheus for 容器服務

    • cloud-product（不再支援）：Prometheus for 雲端服務

    • cloud-monitor（不再支援）：Prometheus for 企業雲端監控

    • flink（不再支援）: Prometheus for Flink。

    remote-write
    VpcId

    string

    否

    使用者專有網路 VPC。當 clusterType 為 ecs 或者 aliyun-cs 的託管版 ask 容器叢集時，需要傳此參數。

    vpc-rpn**********
    VSwitchId

    string

    否

    使用者專有網路交換機 VSwitch。當 clusterType 為 ecs 或者 aliyun-cs 的託管版 ask 容器叢集時，需要傳此參數。

    vsw-bp1*********
    SecurityGroupId

    string

    否

    使用者專有網路安全性群組 SecurityGroup。當 clusterType 為 ecs 或者 aliyun-cs 的託管版 ask 容器叢集時，需要傳此參數。

    sg-bp1********
    ClusterId

    string

    否

    使用者容器服務叢集 ID。當 clusterType 為 aliyun-cs 時，需要傳此參數。

    cc7a37ee31aea4ed1a059eff8034b****
    ClusterName

    string

    否

    使用者新建叢集的名稱。當 clusterType 為 remote-write、ecs、global-view 時，需要傳此參數。

    若是 ecs 類型執行個體，ClusterName 的命名規則為「name-vpc-id」，且 name 部分的長度不允許超過 24 個字元，例如「mytest1-vpc-xxxxxxxxxxx」。

    clusterNameOfTest
    SubClustersJson

    string

    否

    globalView 執行個體的子執行個體 JSON 串。

    当clusterType为global-view时，需要传此参数：需要聚合的集群的信息列表；示例： [ { "headers":{ }, "regionId":"cn-hangzhou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c39a1048921e04f***********", "sourceName":"arms-luyao-test", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-beijing", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c6b6485496d5b40***********", "sourceName":"agent-321-测试", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-zhangjiakou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c261a4f3200c446***********", "sourceName":"zaifeng-cardinality-01", "dataSource":"", "userId":"1672753***********" } ]
    AllSubClustersSuccess

    boolean

    否

    建立 GlobalView 時，是否要求所有子執行個體都校驗成功時，才建立 GlobalView 執行個體。預設是 false，即可以部分成功。

    true
    GrafanaInstanceId

    string

    否

    繫結的 Grafana 工作區 ID。使用共享版 Grafana 時，值為「free」。

    grafana-bp1*****
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-acfmxyexli2****
    Tags

    array<object>

    否

    使用者自訂標籤。

    [ { "labelName":"labelValue" }, { "testName":"clusterA" } ]

    object

    否

    標籤列表。

    Key

    string

    否

    標籤的鍵（Key）。

    TestKey
    Value

    string

    否

    標籤的值（Value）。

    TestValue
    Duration

    integer

    否

    資料儲存時長（天）。

    90
    ArchiveDuration

    integer

    否

    儲存到期後，自動歸檔保存的天數（可選值：60、90、180、365）。0 表示不歸檔保存。

    90
    PaymentType

    string

    否

    計費方式： POSTPAY：按指標上報量後付費。 POSTPAY_GB：按指標寫入量後付費。 空：則使用使用者的預設計費方式配置。若使用者未配置預設值，則系統預設是按指標上報量計費。

    POSTPAY

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Data

    string

    新建執行個體成功後的執行個體 ID。

    • 如果是 aliyun-cs 執行個體，則 Prometheus 執行個體 ID 就是 CS 的叢集 ID。

    • 如果是 ecs 執行個體，則 Prometheus 執行個體 ID 就是 VPCID。

    qduukd****
    RequestId

    string

    請求 ID。

    70675725-8F11-4817-8106-CFE0AD71****
    Message

    string

    返回資訊。

    message
    Code

    integer

    介面狀態碼：

    • 2XX：成功

    • 3XX：重新導向

    • 4XX：請求錯誤

    • 5XX：伺服器錯誤。

    200

    樣本

    正常返回樣本

    JSON格式

    {
  "Data": "qduukd****",
  "RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
  "Message": "message",
  "Code": 200
}

    錯誤碼

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

    變更歷史

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