ListHandshakesForResourceDirectory - Resource Management - Alibaba Cloud ドキュメントセンター

リソースディレクトリ内の招待状を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

resourcemanager:ListHandshakesForResourceDirectory

list

*Handshake

acs:resourcemanager:*:{#accountId}:handshake/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	返されるページ番号です。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	各ページに表示するエントリ数です。有効な値：1～100。デフォルト値：10。	10

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの合計数です。	2
RequestId	string	リクエストの ID です。	9B34724D-54B0-4A51-B34D-4512372FE1BE
PageSize	integer	1 ページあたりに返されるエントリ数です。	10
PageNumber	integer	返されたページのページ番号です。	1
Handshakes	object
Handshake	array<object>	招待状の情報です。
	object	招待状の情報です。
Status	string	招待状のステータスです。有効な値は以下のとおりです。 Pending：招待状が承認待ちの状態です。 Accepted：招待状が承認済みです。 Cancelled：招待状がキャンセル済みです。 Declined：招待状が拒否済みです。 Expired：招待状の有効期限が切れた状態です。	Pending
ExpireTime	string	招待状の有効期限切れ時刻です。時刻は協定世界時 (UTC) で表示されます。	2018-08-24T09:55:41Z
ResourceDirectoryId	string	リソースディレクトリの ID です。	rd-abcdef****
CreateTime	string	招待状の作成時刻です。時刻は協定世界時 (UTC) で表示されます。	2018-08-10T09:55:41Z
Note	string	招待状へのコメントです。	欢迎您加入
TargetEntity	string	招待対象アカウントの ID またはログイン用メールアドレスです。	someone@example.com
MasterAccountId	string	リソースディレクトリの管理アカウントの ID です。	172841235500****
MasterAccountName	string	リソースディレクトリの管理アカウントの名前です。	Alice
ModifyTime	string	招待状の更新時刻です。時刻は協定世界時 (UTC) で表示されます。	2018-08-10T09:55:41Z
TargetType	string	招待対象アカウントの種別です。有効な値は以下のとおりです。 Account：アカウント ID を示します。 Email：アカウントのログイン用メールアドレスを示します。	Email
HandshakeId	string	招待状の ID です。	h-ycm4rp****

例

成功レスポンス

JSONJSON

{
  "TotalCount": 2,
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "PageSize": 10,
  "PageNumber": 1,
  "Handshakes": {
    "Handshake": [
      {
        "Status": "Pending",
        "ExpireTime": "2018-08-24T09:55:41Z",
        "ResourceDirectoryId": "rd-abcdef****",
        "CreateTime": "2018-08-10T09:55:41Z",
        "Note": "欢迎您加入",
        "TargetEntity": "someone@example.com",
        "MasterAccountId": "172841235500****",
        "MasterAccountName": "Alice",
        "ModifyTime": "2018-08-10T09:55:41Z",
        "TargetType": "Email",
        "HandshakeId": "h-ycm4rp****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	EntityNotExists.ResourceDirectory	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.

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

変更履歴

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