SearchMultiAccountResources API による複数アカウント間のリソース検索 - Resource Management

リソースディレクトリの管理アカウントと複数のメンバーアカウントでリソースを検索します。

操作説明

Resource Center と連携するサービスのみを検索できます。
RAM ユーザーまたは RAM ロールとしてアカウント間でリソースを検索するには、resourcecenter:SearchMultiAccountResources ポリシーがアタッチされている必要があります。詳細については、「RAM ユーザーに Resource Center を使用する権限を付与する」をご参照ください。
デフォルトでは、この操作は最大 20 エントリを返します。返されるエントリの最大数を変更するには、MaxResults パラメーターを指定します。
レスポンスに NextToken が含まれていない場合、それ以上データはありません。結果の次のページをクエリするには、NextToken パラメーターを前回の呼び出しで返された値に設定します。NextToken パラメーターを指定しない場合、デフォルトで最初のページのデータが返されます。
検索範囲を絞り込むために、1 つ以上のフィルター条件を設定できます。サポートされているフィルターパラメーターとマッチング方法については、以下の情報をご参照ください。複数のフィルター条件は論理 AND で結合されます。すべてのフィルター条件を満たすリソースのみが返されます。単一のフィルター条件内の値は論理 OR で結合されます。フィルター条件のいずれかの値を満たすリソースが返されます。
その他のクエリ例については、「」または「OpenAPI Portal」をご参照ください。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Scope	string	必須	リソースを検索するアカウントの範囲。有効な値: リソースディレクトリの ID: 管理アカウントとそのすべてのメンバーアカウントでリソースを検索します。詳細については、「GetResourceDirectory」をご参照ください。 Root フォルダの ID: Root フォルダとそのサブフォルダ下のすべてのメンバーアカウントでリソースを検索します。詳細については、「ListFoldersForParent」をご参照ください。フォルダの ID: そのフォルダ下のすべてのメンバーアカウントでリソースを検索します。詳細については、「ListFoldersForParent」をご参照ください。メンバーアカウントの ID: そのメンバーアカウントでリソースを検索します。詳細については、「ListAccounts」をご参照ください。	rd-r4****
NextToken	string	任意	結果の新しいページを取得するために次のリクエストで使用されるページネーショントークン。最初のリクエストでは、このパラメーターを指定する必要はありません。前回のクエリから取得したトークンを `NextToken` の値として指定する必要があります。	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResults	integer	任意	各ページで返されるエントリの最大数。有効な値: 1～100。デフォルト値: 20。	10
Filter	array<object>	任意	フィルター条件。
	object	任意	フィルター条件。
Key	string	任意	フィルター条件のキー。詳細については、以下の「`サポートされているフィルターパラメーター`」セクションをご参照ください。	ResourceGroupId
MatchType	string	任意	マッチング方法。このパラメーターを `Equals` に設定すると、完全に一致することを意味します。	Equals
Value	array	任意	フィルター条件の値。
	string	任意	フィルター条件の値。	rg-aekzmrjn4ns****
SortCriterion	object	任意	ソートパラメーター。
Key	string	任意	ソートキー。このパラメーターを `CreateTime` に設定すると、リソース作成時刻で結果がソートされます。	CreateTime
Order	string	任意	ソート順。有効な値: ASC: 昇順。 DESC: 降順。デフォルト値: ASC。	ASC

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

パラメーター	説明	サポートされているマッチング方法
ResourceType	リソースタイプ。	Equals
RegionId	リージョン ID。	Equals
ResourceId	リソース ID。	Equals, Prefix
ResourceGroupId	リソースグループ ID。	Equals, Exists, NotExists
ResourceName	リソース名。	Equals, Contains
Tag	タグのキーと値のペア。値は `{ "key": $key, "value": $value }` 形式の JSON 文字列である必要があります。少なくともキーまたは値を指定する必要があります。たとえば、タグキー `foo` とタグ値 `bar` をクエリする場合は、このパラメーターを `{ "key": "foo", "value": "bar" }` に設定します。タグキー `foo` のみをクエリする場合は、このパラメーターを `{ "key": "foo" }` に設定します。	Contains, NotContains, NotExists
VpcId	VPC ID。	Equals
VSwitchId	vSwitch ID。	Equals

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Filters	array<object>	フィルター条件。
	object	フィルター条件。
Key	string	フィルター条件のキー。	RegionId
MatchType	string	マッチング方法。	Equals
Values	array	フィルター条件の値。
	string	フィルター条件の値。	cn-hangzhou
MaxResults	integer	1 ページあたりに返されるエントリの最大数。	10
NextToken	string	結果の次のページを取得するためのトークン。	查询返回结果下一页的令牌。
RequestId	string	リクエスト ID。	EFA806B9-7F36-55AB-8B7A-D680C2C5EE57
Resources	array<object>	リソースに関する情報。
	array<object>	リソースに関する情報。
AccountId	string	リソースディレクトリの管理アカウントまたはメンバーアカウントの ID。	151266687691****
CreateTime	string	リソースが作成された時刻。説明このパラメーターが返されるかどうかは、リソースを管理する Alibaba Cloud サービスによって異なります。	2021-06-30T09:20:08Z
ExpireTime	string	リソースの有効期限が切れる時刻。	2023-06-14T14:35:45Z
IpAddressAttributes	array<object>	IP アドレスの属性。
	object	IP アドレスの属性。
IpAddress	string	IP アドレス。	192.168.1.2
NetworkType	string	ネットワークタイプ。有効な値: Public: インターネット。 Private: プライベートネットワーク。	Public
Version	string	IP アドレスのバージョン。	Ipv4
IpAddresses	array	IP アドレス。説明このパラメーターが返されるかどうかは、リソースを管理する Alibaba Cloud サービスによって異なります。
	string	IP アドレス。説明このパラメーターが返されるかどうかは、リソースを管理する Alibaba Cloud サービスによって異なります。	192.168.1.2
RegionId	string	リージョン ID。	cn-hangzhou
ResourceGroupId	string	リソースグループ ID。	rg-acfmzawhxxc****
ResourceId	string	リソース ID。	vtb-bp11lbh452fr8940s****
ResourceName	string	リソース名。	group1
ResourceType	string	リソースタイプ。	ACS::VPC::RouteTable
Tags	array<object>	タグ。
	object	タグ。
Key	string	タグキー。	test_key
Value	string	タグ値。	test_value
ZoneId	string	ゾーン ID。説明このパラメーターが返されるかどうかは、リソースを管理する Alibaba Cloud サービスによって異なります。	cn-hangzhou-k
Scope	string	リソースが検索されたアカウントの範囲。有効な値: リソースディレクトリの ID。これは、管理アカウントとリソースディレクトリのすべてのメンバーアカウントでリソースが検索されたことを示します。 Root フォルダの ID。これは、Root フォルダとそのサブフォルダ下のすべてのメンバーアカウントでリソースが検索されたことを示します。フォルダの ID。これは、そのフォルダ下のすべてのメンバーアカウントでリソースが検索されたことを示します。メンバーアカウントの ID。これは、そのメンバーアカウントでリソースが検索されたことを示します。	rd-r4****

例

成功レスポンス

JSONJSON

{
  "Filters": [
    {
      "Key": "RegionId",
      "MatchType": "Equals",
      "Values": [
        "cn-hangzhou"
      ]
    }
  ],
  "MaxResults": 10,
  "NextToken": "查询返回结果下一页的令牌。",
  "RequestId": "EFA806B9-7F36-55AB-8B7A-D680C2C5EE57",
  "Resources": [
    {
      "AccountId": "151266687691****",
      "CreateTime": "2021-06-30T09:20:08Z",
      "ExpireTime": "2023-06-14T14:35:45Z",
      "IpAddressAttributes": [
        {
          "IpAddress": "192.168.1.2",
          "NetworkType": "Public",
          "Version": "Ipv4"
        }
      ],
      "IpAddresses": [
        "192.168.1.2"
      ],
      "RegionId": "cn-hangzhou",
      "ResourceGroupId": "rg-acfmzawhxxc****\t\n",
      "ResourceId": "vtb-bp11lbh452fr8940s****",
      "ResourceName": "group1",
      "ResourceType": "ACS::VPC::RouteTable",
      "Tags": [
        {
          "Key": "test_key",
          "Value": "test_value"
        }
      ],
      "ZoneId": "cn-hangzhou-k"
    }
  ],
  "Scope": "rd-r4****\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	You are not authorized to perform this operation.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
400	MultiAccountServiceNotEnabled	Multi account ResourceCenter service is not enabled.
400	InvalidParameter.Filter.ResourceType	The specified parameter value of Filter.ResourceType is not valid.
400	InvalidParameter.Filter.CreateTime	The specified parameter Filter.n.CreateTime is not valid.
400	InvalidParameter.Filter.IpAddress	The specified parameter Filter.n.IpAddress is not valid.
400	InvalidParameter.Filter.Tag	The specified parameter Filter.n.Tag is not valid.
403	NoPermission.AccountScope	The operator is not permitted for this account scope.
404	NotExists.Resource	The specified resource does not exist.
404	NotExists.ResourceDirectory	The resource directory for the account is not enabled.
404	NotExists.ResourceDirectory.FolderId	The specified folder does not exist.
409	InvalidParameter.Scope	The Scope is invalid.
409	NoPermission.ResourceDirectory.MemberAccount	ResourceDirectory Member Account is not authorized to perform this operation.
409	InvalidParameter.SortCriterion.Key	The specified parameter SortCriterion.Key is not valid.
409	ExceedLimit.Filter	The maximum length of Filters is exceeded.
409	ServiceNotEnabled.SpecifiedAccount	ResourceCenter service of the specified account is not enabled.

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

変更履歴

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