すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:GetPrometheusInstance

    ドキュメントセンター

    Application Real-Time Monitoring Service:GetPrometheusInstance

    最終更新日:Jun 24, 2026

    指定された Prometheus インスタンスの情報を取得します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    arms:GetPrometheusInstance

    get

    *Prometheus

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    ClusterId

    string

    必須

    Prometheus インスタンス ID。

    c77f6f2397ea74672872acf5e31374a27

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

    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 リモート Write)

    • ecs (Prometheus for ECS)

    • cloud-monitor (中国本土向け Prometheus for クラウドモニター)

    • cloud-product (中国本土以外向け Prometheus for クラウドプロダクト)

    • global-view (Prometheus for グローバルビュー)

    • aliyun-cs (Prometheus for コンテナサービス)。

    remote-write
    VpcId

    string

    クラスターに関連付けられた VPC。このパラメーターは Prometheus for ECS インスタンスの場合にのみ返されます。

    vpc-8vb02uk57qbcktqcvqqqj
    VSwitchId

    string

    vSwitch 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

    リモート読み取り用の内部エンドポイント。

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

    string

    リモート読み取り用のパブリックエンドポイント。

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

    string

    リモート書き込み用の内部エンドポイント。

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

    string

    リモート書き込み用のパブリックエンドポイント。

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

    string

    プッシュゲートウェイ用の内部エンドポイント。

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

    string

    プッシュゲートウェイ用のパブリックエンドポイント。

    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

    権限付与トークン文字列。

    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

    アクセストークン認証が有効かどうかを示します。

    true
    SupportAuthTypes

    array

    サポートされている認証タイプ。

    string

    サポートされている認証タイプ。

    列挙値:

    • BasicAuth :

      HTTP ベーシック認証。

    • AuthFree :

      認証不要アクセス。

    • AuthToken :

      トークンベース認証。

    AuthFree
    EnableAuthFreeRead

    boolean

    認証不要の読み取りアクセスが有効かどうかを示します。

    AuthFreeReadPolicy

    string

    認証不要の読み取りアクセスのホワイトリストポリシー。

    0.0.0.0/0
    EnableAuthFreeWrite

    boolean

    認証不要の書き込みアクセスが有効かどうかを示します。

    AuthFreeWritePolicy

    string

    認証不要の書き込みアクセスのホワイトリストポリシー。

    0.0.0.0/0
    Product

    string

    Prometheus インスタンスが属するプロダクト (arms または cms)。

    arms
    DbInstanceStatus

    string

    バックエンドデータストレージのステータス。

    RUNNING
    Version

    string

    バージョン。

    V1
    PaymentTypeUpdateTime

    string

    インスタンスの課金方法が最後に変更された時間。

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

    object

    拡張情報。このパラメーターはコンソールリクエストの場合にのみ返されます。

    string

    Extended information.

    extraKey
    Tags

    array<object>

    インスタンスにバインドされたタグ。

    object

    タグ。

    TagKey

    string

    タグキー。

    tag1
    TagValue

    string

    タグ値。

    tagValue1
    OpenTelemetryIntraUrl

    string

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。