ListEnvServiceMonitors - Cloud Monitor - Alibaba Cloud ドキュメントセンター

環境の ServiceMonitor を照会します。

今すぐお試しください

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

list

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
EnvironmentId	string	必須	環境 ID。	env-xxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	1A474FF8-7861-4D00-81B5-5BC3DA4E****
Code	integer	HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。	200
Data	array<object>	返される構造体。
	array<object>	返されるデータ。
RegionId	string	リージョン ID。	cn-beijing
EnvironmentId	string	環境 ID。	env-xxxxx
Namespace	string	名前空間。	arms-prom
ServiceMonitorName	string	ServiceMonitor の名前。	sm1
ConfigYaml	string	YAML 設定文字列。	参见补充说明。
Status	string	ServiceMonitor のステータス。	run
CreationTimestamp	string	ServiceMonitor が作成された時間。このパラメーターの値はタイムスタンプです。	2011-10-11T22:32:11Z
AddonName	string	ServiceMonitor が属するアドオンの名前。	mysql
AddonReleaseName	string	アドオンのインスタンス名。	mysql1
AddonVersion	string	アドオンのバージョン。	1.1.0
MatchedServiceCount	integer	一致したサービスの数。	1
Endpoints	array<object>	ServiceMonitor のエンドポイント。
	object	ServiceMonitor のエンドポイントのリスト。
Port	string	外部ポート。	9101
TargetPort	integer	宛先ポート。	443
Path	string	収集パス。	/metrics
Interval	string	収集間隔。	30s
MatchedTargetCount	integer	ServiceMonitor エンドポイントに一致する Pod の数。	1
Message	string	返されるメッセージ。	success

例

成功レスポンス

JSONJSON

{
  "RequestId": "1A474FF8-7861-4D00-81B5-5BC3DA4E****",
  "Code": 200,
  "Data": [
    {
      "RegionId": "cn-beijing",
      "EnvironmentId": "env-xxxxx",
      "Namespace": "arms-prom",
      "ServiceMonitorName": "sm1",
      "ConfigYaml": "参见补充说明。",
      "Status": "run",
      "CreationTimestamp": "2011-10-11T22:32:11Z",
      "AddonName": "mysql",
      "AddonReleaseName": "mysql1",
      "AddonVersion": "1.1.0",
      "MatchedServiceCount": 1,
      "Endpoints": [
        {
          "Port": "9101",
          "TargetPort": 443,
          "Path": "/metrics",
          "Interval": "30s",
          "MatchedTargetCount": 1
        }
      ]
    }
  ],
  "Message": "success"
}

エラーコード

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

変更履歴

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