DescribeMonitorGroupInstances によるアプリケーショングループ内リソースのクエリ - CMS

アプリケーショングループ内のリソースを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeMonitorGroupInstances

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
GroupId	integer	必須	アプリケーショングループの ID。	123****
Category	string	任意	クラウドサービスの略称。N の有効値：1～200。説明クラウドサービス名の略称を取得する方法の詳細については、「DescribeProjectMeta」操作のレスポンスパラメーター `Labels` 内の `metricCategory` をご参照ください。	ecs
Keyword	string	任意	インスタンスの検索に使用されるキーワード。インスタンス名に基づくあいまい検索がサポートされています。	test-s1
InstanceIds	string	任意	インスタンス ID。複数の ID を指定することで、複数のインスタンスを照会できます。	i-bp12g4xbl4i0brkn****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	97F2A410-9412-499C-9AD1-76EF7EC02DF2
Success	boolean	リクエストが成功したかどうかを示します。	true
Code	integer	レスポンスコード。説明ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージ。	success
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
Total	integer	返されたエントリの総数。	12
Resources	object
Resource	array<object>	アプリケーショングループ内のリソースに関する情報。
	object
Category	string	サービス名の略称。	ecs
InstanceId	string	インスタンス ID。	i-bp12g4xbl4i0brkn****
InstanceName	string	インスタンス名。	test-s1
Id	integer	リソース ID。	123****
RegionId	string	インスタンスが存在するリージョンの ID。	cn-hangzhou

例

成功レスポンス

JSONJSON

{
  "RequestId": "97F2A410-9412-499C-9AD1-76EF7EC02DF2",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 10,
  "Total": 12,
  "Resources": {
    "Resource": [
      {
        "Category": "ecs",
        "InstanceId": "i-bp12g4xbl4i0brkn****",
        "InstanceName": "test-s1",
        "Id": 0,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	AccessForbidden	The X.509 certificate or cms access key ID provided does not exist in our records.
206	%s	%s
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
503	%s	%s
406	%s	%s
429	Throttli∂ngException	The request was denied due to request throttling.
409	%s	%s

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

変更履歴

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