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

リソース共有ユニットに関連付けられているリソースまたはプリンシパルのレコードをクエリします。

操作説明

このトピックでは、現在のアカウントによって 中国 (杭州) リージョンに作成されたリソース共有ユニットに関連付けられているリソースのレコードをクエリする方法の例を示します。応答には、アカウントが次の 2 つのリソースに関連付けられていることが示されます。

リソース共有ユニット rs-6GRmdD3X**** に、ID が vsw-bp1upw03qyz8n7us9**** の VSwitch リソースが追加されました。リソースは Associated (関連付け済み) 状態であり、共有中であることを意味します。
リソース共有ユニット rs-6GRmdD3X**** から、ID が vsw-bp183p93qs667muql**** の VSwitch リソースが削除されました。リソースは Disassociated (関連付け解除済み) 状態であり、共有されなくなったことを意味します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

resourcesharing:ListResourceShareAssociations

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceId	string	任意	リソース ID。説明 `AssociationType` が `Target` に設定されている場合、このパラメーターは使用できません。	vsw-bp183p93qs667muql****
ResourceArn	string	任意	リソースの Alibaba Cloud リソースネーム (ARN)。説明 `AssociationType` が `Target` に設定されている場合、このパラメーターは使用できません。	acs:vpc:cn-shanghai:103755469187**:vswitch/vsw-uf62b11ue4m8oz2di**
Target	string	任意	プリンシパルの ID。説明 `AssociationType` が `Resource` に設定されている場合、このパラメーターは使用できません。	172050525300****
AssociationType	string	必須	関連付けタイプ。有効な値： Resource：関連付けられたリソースのレコードをクエリします。 Target：関連付けられたプリンシパルのレコードをクエリします。	Resource
AssociationStatus	string	任意	関連付けステータス。有効な値： Associating：エンティティは関連付け中です。 Associated：エンティティは関連付け済みです。 Failed：関連付けに失敗しました。 Disassociating：エンティティは関連付け解除中です。 Disassociated：エンティティは関連付け解除済みです。説明システムは、`Failed` または `Disassociated` 状態のエンティティのレコードを 48～96 時間以内に削除します。	Associated
MaxResults	integer	任意	1 回のリクエストで返すエントリの最大数。有効な値：1～100。デフォルト値：20。	20
NextToken	string	任意	次のページの結果を取得するために使用されるトークン。現在のリクエストの応答が切り捨てられている場合、次のリクエストでこのトークンを使用して次のページの結果を取得できます。	TGlzdFJlc291cm****
ResourceShareIds	array	任意	リソース共有ユニットの ID。最大 5 つのリソース共有ユニット ID を指定できます。	rs-6GRmdD3X****
	string	任意	リソース共有ユニットの ID。	rs-6GRmdD3X****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
NextToken	string	次のページの結果を取得するために使用されるトークン。現在のリクエストの応答が切り捨てられている場合、次のリクエストでこのトークンを使用して次のページの結果を取得できます。	TGlzdFJlc291cm****
RequestId	string	リクエスト ID。	11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB
ResourceShareAssociations	array<object>	関連付けられたリソースまたはプリンシパルに関する情報。
	array<object>	関連付けられたリソースまたはプリンシパルに関する情報。
UpdateTime	string	関連付けが更新された時刻。次のシナリオがあります： `AssociationType` が `Resource` の場合、このパラメーターはリソースが更新された時刻を示します。 `AssociationType` が `Target` の場合、このパラメーターはプリンシパルが更新された時刻を示します。	2020-12-07T07:39:02.920Z
EntityId	string	関連付けられたエンティティの ID。有効な値： `AssociationType` が `Resource` の場合、このパラメーターはリソース ID です。 `AssociationType` が `Target` の場合、このパラメーターはプリンシパル ID です。	vsw-bp1upw03qyz8n7us9****
ResourceArn	string	関連付けられたリソースの ARN。説明 `AssociationType` が `Target` の場合、このパラメーターは使用できません。	acs:vpc:cn-shanghai:103755469187**:vswitch/vsw-uf62b11ue4m8oz2di**
ResourceShareName	string	リソース共有ユニットの名前。	example
CreateTime	string	関連付けが作成された時刻。次のシナリオがあります： `AssociationType` が `Resource` の場合、このパラメーターはリソースが追加または削除された時刻を示します。 `AssociationType` が `Target` の場合、このパラメーターはプリンシパルが追加または削除された時刻を示します。	2020-12-07T07:39:01.818Z
EntityType	string	関連付けられたエンティティのタイプ。有効な値：エンティティがリソースの場合、このパラメーターはリソースタイプです。詳細については、「リソース共有と連携するサービス」をご参照ください。エンティティがプリンシパルの場合、このパラメーターは `Account` です。	VSwitch
ResourceShareId	string	リソース共有ユニットの ID。	rs-6GRmdD3X****
AssociationStatusMessage	string	関連付けが失敗した理由。	The reason for the association failure.
AssociationType	string	関連付けタイプ。有効な値： Resource：エンティティはリソースです。 Target：エンティティはプリンシパルです。	Resource
AssociationStatus	string	関連付けステータス。有効な値： Associating：エンティティは関連付け中です。 Associated：エンティティは関連付け済みです。 Failed：関連付けに失敗しました。 Disassociating：エンティティは関連付け解除中です。 Disassociated：エンティティは関連付け解除済みです。説明システムは、`Failed` または `Disassociated` 状態のエンティティのレコードを 48～96 時間以内に削除します。	Failed
External	boolean	プリンシパルがリソースディレクトリ外のアカウントであるかどうかを示します。有効な値： true：プリンシパルはリソースディレクトリ外のアカウントです。 false：プリンシパルはリソースディレクトリのメンバーです。	false
AssociationFailedDetails	array<object>	関連付けまたは関連付け解除の失敗に関する詳細。
	object	関連付けまたは関連付け解除の失敗に関する詳細。
Status	string	このパラメーターは非推奨です。代わりに FailureReason を使用してください。	无
StatusMessage	string	このパラメーターは非推奨です。代わりに FailureDescription を使用してください。	无
AssociateType	string	このパラメーターは非推奨です。代わりに OperationType を使用してください。	无
ResourceArn	string	関連付けられたリソースの ARN。説明 `AssociationType` が `Resource` の場合、このパラメーターは使用できません。	acs:vpc:cn-shanghai:103755469187**:vswitch/vsw-uf62b11ue4m8oz2di**
EntityType	string	関連付けられたエンティティのタイプ。有効な値：エンティティがリソースの場合、このパラメーターはリソースタイプです。詳細については、「リソース共有と連携するサービス」をご参照ください。エンティティがプリンシパルの場合、このパラメーターは `ResourceDirectory`、`Folder`、`Account`、または `Service` になります。	Account
FailureReason	string	関連付けまたは関連付け解除が失敗した理由。有効な値： Unavailable：リソースが存在しないか、無効な状態です。 LimitExceeded：リソースを共有できるプリンシパルの数が上限を超えています。 ZonalResourceInaccessible：リージョンでリソースが利用できません。 InternalError：内部エラーが発生しました。 UnsupportedOperation：この操作はサポートされていません。	Unavailable
FailureDescription	string	失敗の詳細な説明。	You cannot access the specified resource at this time.
OperationType	string	操作タイプ。有効な値： Associate：エンティティを関連付けます。 Disassociate：エンティティの関連付けを解除します。	Associate
EntityId	string	関連付けられたエンティティの ID。有効な値： AssociationType が Resource の場合、このパラメーターはプリンシパル ID です。 AssociationType が Target の場合、このパラメーターはリソース ID です。	172050525300****
TargetProperty	string	プリンシパルのプロパティ。たとえば、リソースが共有される時間範囲などです。`timeRangeType` の有効な値： timeRange：指定された期間。 day：終日。説明このパラメーターは、プリンシパルが Alibaba Cloud サービスの場合にのみ返されます。	{ "timeRange":{ "timeRangeType":"timeRange", "beginAtTime":"00:00", "timezone":"UTC+8", "endAtTime":"19:59" } }
ResourceProperty	string		{"sharePrincipals":true,"shareTagOptions":false}

例

成功レスポンス

JSONJSON

{
  "NextToken": "TGlzdFJlc291cm****",
  "RequestId": "11BA57B5-7301-4E2F-BBA5-2AE4C2F4FCDB",
  "ResourceShareAssociations": [
    {
      "UpdateTime": "2020-12-07T07:39:02.920Z",
      "EntityId": "vsw-bp1upw03qyz8n7us9****",
      "ResourceArn": "acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****",
      "ResourceShareName": "example",
      "CreateTime": "2020-12-07T07:39:01.818Z",
      "EntityType": "VSwitch",
      "ResourceShareId": "rs-6GRmdD3X****",
      "AssociationStatusMessage": "The reason for the association failure. ",
      "AssociationType": "Resource",
      "AssociationStatus": "Failed",
      "External": false,
      "AssociationFailedDetails": [
        {
          "Status": "无",
          "StatusMessage": "无",
          "AssociateType": "无",
          "ResourceArn": "acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****",
          "EntityType": "Account",
          "FailureReason": "Unavailable",
          "FailureDescription": "You cannot access the specified resource at this time.",
          "OperationType": "Associate",
          "EntityId": "172050525300****"
        }
      ],
      "TargetProperty": "{\n    \"timeRange\":{\n        \"timeRangeType\":\"timeRange\",\n        \"beginAtTime\":\"00:00\",\n        \"timezone\":\"UTC+8\",\n        \"endAtTime\":\"19:59\"\n    }\n}",
      "ResourceProperty": "{\"sharePrincipals\":true,\"shareTagOptions\":false}"
    }
  ]
}

エラーコード

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

変更履歴

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

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter.AssociationType	You must specify AssociationType.	You must specify AssociationType.
400	InvalidParameter.AssociationType	The AssociationType is invalid.	The AssociationType is invalid.
400	InvalidParameter.AssociationStatus	The AssociationStatus is invalid.	The AssociationStatus is invalid.
400	InvalidParameter.MaxResults	The MaxResults is invalid.	The MaxResults is invalid.
400	InvalidParameter.NextToken	The NextToken is invalid.	The NextToken is invalid.
400	InvalidParameter.NextToken.Length	The maximum length of NextToken exceeds 256 characters.	The maximum length of NextToken exceeds 256 characters.
400	InvalidParameter.ResourceShareIds	The ResourceShareIds is invalid.	The ResourceShareIds is invalid.
400	InvalidParameter.ResourceShareIds.Duplicate	The ResourceShareIds contains duplicate values.	The ResourceShareIds contains duplicate values.
400	InvalidParameter.ResourceShareIds.Length	The maximum length of ResourceShareIds exceeds 5 characters.	The maximum length of ResourceShareIds exceeds 5 characters.
400	InvalidParameter.Target	The Target is invalid.	The Target is invalid.
400	InvalidParameter.ResourceId	The ResourceId is invalid.	The ResourceId is invalid.
400	ConflictedAssociationType	The specified ResourceId or Target conflicts with AssociationType.	The specified ResourceId or Target conflicts with AssociationType.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InvalidParameter.ResourceArn	The ResourceArn is invalid.
400	InvalidParameter.ResourceConflict	Both ResourceId and ResourceArn cannot be specified simultaneously. Please provide only one of these parameters.