ListResourceRelationships API の概要 - Resource Management

現在のアカウントがアクセス権限を持つリソース関係のリストをクエリします。

操作説明

この操作を呼び出して、現在のアカウントがアクセス権限を持つリソース関係のみをクエリできます。
デフォルトでは、この操作は最大 20 件のエントリを返します。MaxResults パラメーターを設定して、返すエントリの最大数を指定できます。
レスポンスに NextToken パラメーターが含まれていない場合、すべてのエントリが返されたことを示します。含まれている場合は、さらに多くのエントリが存在することを示します。残りのエントリを取得するには、この操作を再度呼び出して別のクエリリクエストを開始できます。リクエストでは、NextToken パラメーターを前回のレスポンスで返された NextToken の値に設定します。NextToken パラメーターを設定しない場合、デフォルトで最初のページのエントリが返されます。
1つ以上のフィルター条件を指定して、クエリ範囲を絞り込むことができます。サポートされるフィルターパラメーターと一致メソッドの詳細については、「サポートされるフィルターパラメーター」セクションをご参照ください。複数のフィルター条件は論理 AND 関係にあります。すべてのフィルター条件を満たすエントリのみが返されます。1つのフィルター条件内の複数の値は論理 OR 関係にあります。いずれかの値を満たすエントリが返されます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

resourcecenter:ListResourceRelationships

list

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リソースのリージョン ID。	cn-hangzhou
ResourceType	string	必須	リソースのタイプ。	ACS::ACK::Cluster
ResourceId	string	必須	リソースの ID。	m-eb3hji****
RelatedResourceFilter	array<object>	任意	リソースに関連付けられたリソースのフィルター条件。
	object	任意	リソースに関連付けられたリソースのフィルター条件。
Key	string	任意	フィルター条件のキー。詳細については、「`サポートされるフィルターパラメーター`」をご参照ください。	RelatedResourceRegionId
Value	array	任意	フィルター条件の値。
	string	任意	フィルター条件の値。	cb-shanghai
MatchType	string	任意	一致メソッド。	Equals
NextToken	string	任意	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResults	integer	任意	1ページあたりの最大エントリ数。有効値：1～500。デフォルト値：20。	10

サポートされるフィルターパラメーター

パラメーター	説明	サポートされる一致メソッド
RelatedResourceRegionId	関連リソースのリージョン ID。	Equals
RelatedResourceType	関連リソースのタイプ。	Equals
RelatedResourceId	関連リソースの ID。	Equals

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	682A3004-38E3-5122-9A11-CCDFAB9C3C4F
MaxResults	integer	1ページあたりの最大エントリ数。	10
NextToken	string	ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
ResourceRelationships	array<object>	リソース関係。
	object	リソース関係。
RegionId	string	リソースのリージョン ID。	cn-hangzhou
ResourceType	string	リソースのタイプ。	ACS::ACK::Cluster
ResourceId	string	リソースの ID。	m-eb3hji****
RelatedResourceRegionId	string	関連リソースのリージョン ID。	cn-shanghai
RelatedResourceType	string	関連リソースのタイプ。	ACS::VPC::VPC
RelatedResourceId	string	関連リソースの ID。	vpc-uf6m5okksddm6c9lh7***

例

成功レスポンス

JSONJSON

{
  "RequestId": "682A3004-38E3-5122-9A11-CCDFAB9C3C4F",
  "MaxResults": 10,
  "NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****",
  "ResourceRelationships": [
    {
      "RegionId": "cn-hangzhou",
      "ResourceType": "ACS::ACK::Cluster",
      "ResourceId": "m-eb3hji****",
      "RelatedResourceRegionId": "cn-shanghai",
      "RelatedResourceType": "ACS::VPC::VPC",
      "RelatedResourceId": "vpc-uf6m5okksddm6c9lh7***"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	You are not authorized to perform this operation.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
400	InvalidParameter.RelatedResourceFilterMatchType	The specified parameter RelatedResourceFilterMatchType.n.MatchType is not valid.
400	MissingParameter.RelatedResourceFilterValue	You must specify RelatedResourceFilterValue.n.Value.
400	InvalidParameter.RelatedResourceFilterKey	The specified parameter RelatedResourceFilterMatchType.n.RelatedResourceFilterKey is not valid.
404	MissingParameter.RegionId	The specified parameter RegionId is missing.
404	MissingParameter.ResourceType	The specified parameter ResourceType is missing.
404	MissingParameter.ResourceId	The specified parameter ResourceId is missing.
404	ExceedLimit.RelatedResourceFilter	The maximum length of RelatedResourceFilter is exceeded.
409	InvalidParameter.ResourceType	The specified parameter ResourceType is not valid.
409	ExceedLimit.RelatedResourceFilterValue	The number of objects specified in the RelatedResourceFilterValue parameter exceeds the upper limit.

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

変更履歴

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