すべてのプロダクト
Search
ドキュメントセンター

Application Real-Time Monitoring Service:ListPrometheusIntegration

最終更新日:Apr 11, 2026

Prometheus インスタンスに統合されているエクスポーターのリストをクエリします。 aliyun-cs および ecs インスタンスのみがサポートされています。

説明

この API は、代替案なしで廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。継続的な機能を確保するため、移行を計画し、アカウントマネージャーにお問い合わせください。

今すぐお試しください

この 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:GetPrometheusIntegration

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

cn-hangzhou

ClusterId

string

必須

Prometheus インスタンスの ID。 aliyun-cs および ecs インスタンスのみがサポートされています。

c77f6f2397ea74672872acf5e31******

IntegrationType

string

必須

統合タイプ。 有効な値:kafka、mysql、redis、snmp、emr、nubela、tidb。

kafka

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID。

1F1D8840-5330-5804-A8DB-C3C5C5******

Data

array<object>

クエリされたエクスポーター。

object

返された構造体。

ClusterId

string

Prometheus インスタンスの ID。

c77f6f2397ea74672872acf5e31******

ShowDescribe

boolean

説明を表示するかどうかを示します。

true

NeedUpgrade

boolean

アップグレードが必要かどうかを示します。

true

InstanceName

string

エクスポーターの名前。

inet

ExporterType

string

エクスポーターのタイプ。

kafka-exporter

IntegrationType

string

統合タイプ。 有効な値:kafka、mysql、redis、snmp、emr、nubela、tidb。

kafka

InstanceId

integer

エクスポーターの ID。

293**

Version

string

バージョン番号。

1.0.0

Target

string

モニタリング対象の IP アドレス。

121.40.XX.XX:3342

CanDelete

boolean

エクスポーターを削除できるかどうかを示します。

true

CanEditor

boolean

エクスポーターを編集できるかどうかを示します。

true

Status

string

エクスポーターのステータス。

installed

ContainerName

string

コンテナの名前。

container-1

Namespace

string

名前空間。

arms-prom

PodName

string

エクスポーターの Pod 名。

kafka-exporter-1

Describe

string

エクスポーターの説明。

"{}"

ShowLog

boolean

エクスポーターのログを表示するかどうかを示します。

true

Param

string

エクスポーターの設定。 値は JSON 文字列です。

{ "port": "5554", "name": "kafka-test12", "kafka_instance": "kafka-test", "__label_value": "kafka-test", "scrape_interval": 33, "metrics_path": "/metrics", "__label_key": "kafka-test" }

Message

string

返されたメッセージ。

message

Code

integer

応答コード。 ステータスコード 200 は、リクエストが成功したことを示します。

200

成功レスポンス

JSONJSON

{
  "RequestId": "1F1D8840-5330-5804-A8DB-C3C5C5******",
  "Data": [
    {
      "ClusterId": "c77f6f2397ea74672872acf5e31******",
      "ShowDescribe": true,
      "NeedUpgrade": true,
      "InstanceName": "inet",
      "ExporterType": "kafka-exporter",
      "IntegrationType": "kafka",
      "InstanceId": 0,
      "Version": "1.0.0",
      "Target": "121.40.XX.XX:3342",
      "CanDelete": true,
      "CanEditor": true,
      "Status": "installed",
      "ContainerName": "container-1",
      "Namespace": "arms-prom",
      "PodName": "kafka-exporter-1",
      "Describe": "\"{}\"",
      "ShowLog": true,
      "Param": "{\n      \"port\": \"5554\",\n      \"name\": \"kafka-test12\",\n      \"kafka_instance\": \"kafka-test\",\n      \"__label_value\": \"kafka-test\",\n      \"scrape_interval\": 33,\n      \"metrics_path\": \"/metrics\",\n      \"__label_key\": \"kafka-test\"\n}"
    }
  ],
  "Message": "message",
  "Code": 200
}

エラーコード

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

変更履歴

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