GetPrometheusIntegration - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

Container Service または ECS 向けの Prometheus インスタンスに統合されたエクスポーターに関する情報を照会します。

説明

この 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`。	cc7a37ee31aea4ed1a059eff8034b****
IntegrationType	string	必須	統合タイプ。有効な値： `kafka`、`mysql`、`redis`、`snmp`、`emr`、`nubela`、`tidb`。	tidb
InstanceId	integer	必須	エクスポーターの ID。	28**

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。	9BEF2832-9D95-5E3E-9B10-74887C******
Data	object	返される構造体。
ClusterId	string	Prometheus インスタンスの ID。	cc7a37ee31aea4ed1a059eff8034b****
InstanceId	integer	エクスポーターの ID。	28**
ShowDescribe	boolean	説明を表示するかどうかを示します。	true
NeedUpgrade	boolean	アップグレードが必要かどうかを示します。	True
InstanceName	string	エクスポーターの名前。	lpd-skyeye
IntegrationType	string	統合タイプ。有効な値： `kafka`、`mysql`、`redis`、`snmp`、`emr`、`nubela`、`tidb`。	tidb
ExporterType	string	エクスポーターのタイプ。	tidb-exporter
Version	string	バージョン情報。	1.0.0
Target	string	モニター対象の IP アドレス。	127.0.XX.XX:3422
CanDelete	boolean	エクスポーターを削除できるかどうかを示します。	true
CanEditor	boolean	エクスポーターを変更できるかどうかを示します。	true
Status	string	エクスポーターのステータス。	installed
Describe	string	エクスポーターの説明。	"{}"
ShowLog	string	エクスポーターのログを表示するかどうかを示します。	true
Namespace	string	名前空間。	arms-prom
ContainerName	string	コンテナ名。	kafka-exporter-1
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" }
Code	integer	ステータスコード。ステータスコード 200 はリクエストが成功したことを示します。他のステータスコードが返された場合は、リクエストは失敗です。	200
Message	string	返されるメッセージ。	message

例

成功レスポンス

JSONJSON

{
  "RequestId": "9BEF2832-9D95-5E3E-9B10-74887C******",
  "Data": {
    "ClusterId": "cc7a37ee31aea4ed1a059eff8034b****",
    "InstanceId": 0,
    "ShowDescribe": true,
    "NeedUpgrade": true,
    "InstanceName": "lpd-skyeye",
    "IntegrationType": "tidb",
    "ExporterType": "tidb-exporter",
    "Version": "1.0.0",
    "Target": "127.0.XX.XX:3422",
    "CanDelete": true,
    "CanEditor": true,
    "Status": "installed",
    "Describe": "\"{}\"",
    "ShowLog": "true",
    "Namespace": "arms-prom",
    "ContainerName": "kafka-exporter-1",
    "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}"
  },
  "Code": 200,
  "Message": "message"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

変更履歴

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