All Products
Search

This Product

    Application Real-Time Monitoring Service:GetPrometheusInstance

    Document Center

    Application Real-Time Monitoring Service:GetPrometheusInstance

    Last Updated:Jun 24, 2026

    Mengambil informasi tentang instans Prometheus tertentu.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    arms:GetPrometheusInstance

    get

    *Prometheus

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah.

    cn-hangzhou
    ClusterId

    string

    Yes

    ID instans Prometheus.

    c77f6f2397ea74672872acf5e31374a27

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Tanggapan.

    RequestId

    string

    ID permintaan.

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

    string

    Paket yang dikembalikan untuk hasil.

    message
    Code

    integer

    Kode status. Nilai 200 menunjukkan keberhasilan. Nilai lain menunjukkan error.

    200
    Data

    object

    Informasi yang dikembalikan.

    ClusterId

    string

    ID instans Prometheus.

    c589a1b8db05c4561aefbb898ca8fb1cf
    RegionId

    string

    ID wilayah.

    cn-beijing
    UserId

    string

    ID pengguna.

    167275301789****
    ClusterName

    string

    Nama kluster.

    prom1
    ClusterType

    string

    • remote-write (Prometheus untuk Remote Write)

    • ecs (Prometheus untuk ECS)

    • cloud-monitor (Prometheus untuk Cloud Service di Tiongkok daratan)

    • cloud-product (Prometheus untuk Cloud Service di luar Tiongkok daratan)

    • global-view (Prometheus untuk GlobalView)

    • aliyun-cs (Prometheus untuk Container Service).

    remote-write
    VpcId

    string

    VPC yang terkait dengan kluster. Parameter ini hanya dikembalikan untuk instans Prometheus for ECS.

    vpc-8vb02uk57qbcktqcvqqqj
    VSwitchId

    string

    ID vSwitch. Parameter ini hanya dikembalikan untuk instans Prometheus for ECS.

    vsw-f8z73vcja1tqnw90aav5a
    SecurityGroupId

    string

    ID grup keamanan. Parameter ini hanya dikembalikan untuk instans Prometheus for ECS.

    sg-8vbdgmf4nraiqa9bx0jo
    SubClustersJson

    string

    String JSON sub-instans untuk instans GlobalView.

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

    Titik akhir internal untuk remote read.

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

    string

    Titik akhir publik untuk remote read.

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

    string

    Titik akhir internal untuk remote write.

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

    string

    Titik akhir publik untuk remote write.

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

    string

    Titik akhir internal untuk push gateway.

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

    string

    Titik akhir publik untuk push gateway.

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

    string

    HttpApiIntraUrl

    string

    Titik akhir internal untuk HTTP API.

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

    string

    Titik akhir publik untuk HTTP API.

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

    string

    String token otorisasi.

    GciOiJIUzI1NiJ9***
    AccessType

    string

    Jenis izin. Nilai valid:

    • readWrite

    • readOnly

    • httpReadOnly.

    readWrite
    PaymentType

    string

    Metode penagihan. Nilai valid:

    • PREPAY: langganan.

    • POSTPAY: bayar sesuai pemakaian.

    PREPAY
    StorageDuration

    integer

    Durasi penyimpanan, dalam hari.

    90
    ArchiveDuration

    integer

    Jumlah hari data secara otomatis diarsipkan setelah periode penyimpanan berakhir. Nilai valid: 60, 90, 180, dan 365. Nilai 0 menunjukkan bahwa data tidak diarsipkan.

    60
    GrafanaInstanceId

    string

    ID ruang kerja Grafana.

    grafana-rnggfvhlcdl6m71***
    ResourceGroupId

    string

    ID kelompok sumber daya tempat instans berada.

    rg-aek2vezare****
    ResourceType

    string

    Nilai tetap: PROMETHEUS.

    PROMETHEUS
    EnableAuthToken

    string

    Apakah otentikasi token akses diaktifkan.

    true
    SupportAuthTypes

    array

    Jenis otentikasi yang didukung.

    string

    Jenis otentikasi yang didukung.

    Valid values:

    • BasicAuth :

      Otentikasi dasar HTTP.

    • AuthFree :

      Akses tanpa otentikasi.

    • AuthToken :

      Otentikasi berbasis token.

    AuthFree
    EnableAuthFreeRead

    boolean

    Apakah akses baca tanpa otentikasi diaktifkan.

    AuthFreeReadPolicy

    string

    Kebijakan daftar putih untuk akses baca tanpa otentikasi.

    0.0.0.0/0
    EnableAuthFreeWrite

    boolean

    Apakah akses tulis tanpa otentikasi diaktifkan.

    AuthFreeWritePolicy

    string

    Kebijakan daftar putih untuk akses tulis tanpa otentikasi.

    0.0.0.0/0
    Product

    string

    Produk tempat instans Prometheus berada (arms atau cms).

    arms
    DbInstanceStatus

    string

    Status penyimpanan data Backend.

    RUNNING
    Version

    string

    Versi.

    V1
    PaymentTypeUpdateTime

    string

    Waktu ketika metode penagihan instans terakhir diubah.

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

    object

    Informasi tambahan. Parameter ini hanya dikembalikan untuk permintaan Konsol.

    string

    Extended information.

    extraKey
    Tags

    array<object>

    Tag yang terikat pada instans.

    object

    Tag.

    TagKey

    string

    Kunci tag.

    tag1
    TagValue

    string

    Nilai tag.

    tagValue1
    OpenTelemetryIntraUrl

    string

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.