Tüm Ürünler
Search

Bu Ürün

    :GetPrometheusInstance

    Belge Merkezi

    :GetPrometheusInstance

    Son Güncelleme:Oct 02, 2026

    Belirtilen bir Prometheus örneği hakkındaki bilgileri getirir.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    arms:GetPrometheusInstance

    get

    *Prometheus

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    Bölge kimliği.

    cn-hangzhou
    ClusterId

    string

    Yes

    Prometheus örneği kimliği.

    c77f6f2397ea74672872acf5e31374a27

    Response elements

    Element

    Type

    Description

    Example

    object

    Yanıt şeması.

    RequestId

    string

    İstek kimliği.

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

    string

    Sonuç için döndürülen mesaj.

    message
    Code

    integer

    Durum kodu. 200 değeri başarıyı gösterir. Diğer değerler hataları gösterir.

    200
    Data

    object

    Döndürülen bilgiler.

    ClusterId

    string

    Prometheus örneği kimliği.

    c589a1b8db05c4561aefbb898ca8fb1cf
    RegionId

    string

    Bölge kimliği.

    cn-beijing
    UserId

    string

    Kullanıcı kimliği.

    167275301789****
    ClusterName

    string

    Küme adı.

    prom1
    ClusterType

    string

    • remote-write (Genel kullanım için Prometheus)

    • ecs (ECS için Prometheus)

    • cloud-monitor (Çin anakarasındaki Bulut Hizmetleri için Prometheus)

    • cloud-product (Çin anakarası dışındaki Bulut Hizmetleri için Prometheus)

    • global-view (GlobalView için Prometheus)

    • aliyun-cs (Konteyner Hizmeti için Prometheus).

    remote-write
    VpcId

    string

    Kümeyle ilişkili VPC. Bu parametre yalnızca ECS için Prometheus örnekleri için döndürülür.

    vpc-8vb02uk57qbcktqcvqqqj
    VSwitchId

    string

    vSwitch kimliği. Bu parametre yalnızca ECS için Prometheus örnekleri için döndürülür.

    vsw-f8z73vcja1tqnw90aav5a
    SecurityGroupId

    string

    Güvenlik grubu kimliği. Bu parametre yalnızca ECS için Prometheus örnekleri için döndürülür.

    sg-8vbdgmf4nraiqa9bx0jo
    SubClustersJson

    string

    GlobalView örneği için alt örneklerin JSON dizesi.

    [{"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

    Uzaktan okuma için dahili uç nokta.

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

    string

    Uzaktan okuma için genel uç nokta.

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

    string

    Uzaktan yazma için dahili uç nokta.

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

    string

    Uzaktan yazma için genel uç nokta.

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

    string

    Push gateway için dahili uç nokta.

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

    string

    Push gateway için genel uç nokta.

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

    string

    HttpApiIntraUrl

    string

    HTTP API için dahili uç nokta.

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

    string

    HTTP API için genel uç nokta.

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

    string

    Yetkilendirme belirteci dizesi.

    GciOiJIUzI1NiJ9***
    AccessType

    string

    İzin türü. Geçerli değerler:

    readWrite, readOnly, httpReadOnly.

    readWrite
    PaymentType

    string

    Faturalandırma yöntemi. Geçerli değerler:

    • PREPAY: Abonelik.

    • POSTPAY: Kullandıkça öde.

    PREPAY
    StorageDuration

    integer

    Gün cinsinden depolama süresi.

    90
    ArchiveDuration

    integer

    Depolama süresi dolduktan sonra verilerin otomatik olarak arşivlendiği gün sayısı. Geçerli değerler: 60, 90, 180 ve 365. 0 değeri verilerin arşivlenmediğini gösterir.

    60
    GrafanaInstanceId

    string

    Grafana çalışma alanı kimliği.

    grafana-rnggfvhlcdl6m71***
    ResourceGroupId

    string

    Örneğin ait olduğu kaynak grubunun kimliği.

    rg-aek2vezare****
    ResourceType

    string

    Sabit değer: PROMETHEUS.

    PROMETHEUS
    EnableAuthToken

    string

    Erişim belirteci kimlik doğrulamasının etkinleştirilip etkinleştirilmediğini gösterir.

    true
    SupportAuthTypes

    array

    Desteklenen kimlik doğrulama türleri.

    string

    Desteklenen kimlik doğrulama türleri.

    Valid values:

    • BasicAuth :

      HTTP temel kimlik doğrulaması.

    • AuthFree :

      Kimlik doğrulamasız.

    • AuthToken :

      Belirteç tabanlı kimlik doğrulaması.

    AuthFree
    EnableAuthFreeRead

    boolean

    Kimlik doğrulamasız okumanın etkinleştirilip etkinleştirilmediğini gösterir.

    AuthFreeReadPolicy

    string

    Kimlik doğrulamasız okuma adresleri için beyaz liste ilkesi.

    0.0.0.0/0
    EnableAuthFreeWrite

    boolean

    Kimlik doğrulamasız yazmanın etkinleştirilip etkinleştirilmediğini gösterir.

    AuthFreeWritePolicy

    string

    Kimlik doğrulamasız yazma adresleri için beyaz liste ilkesi.

    0.0.0.0/0
    Product

    string

    Prometheus örneğinin ait olduğu ürün (arms veya cms).

    arms
    DbInstanceStatus

    string

    Arka uç veri depolama durumu.

    RUNNING
    Version

    string

    Sürüm.

    V1
    PaymentTypeUpdateTime

    string

    Örneğin faturalandırma yönteminin en son değiştirildiği zaman.

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

    object

    Genişletilmiş bilgiler. Bu parametre yalnızca konsol istekleri için döndürülür.

    string

    Genişletilmiş bilgiler.

    extraKey
    Tags

    array<object>

    Örneğe bağlı etiketler.

    object

    Etiket.

    TagKey

    string

    Etiket anahtarı.

    tag1
    TagValue

    string

    Etiket değeri.

    tagValue1
    OpenTelemetryIntraUrl

    string

    Examples

    Success response

    JSON format

    {
  "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": ""
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.