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

招待の情報を照会します。

操作説明

この例では、ID が h-ycm4rp**** の招待の情報を照会します。

今すぐお試しください

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

get

*Handshake

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
HandshakeId	string	必須	招待の ID です。	h-ycm4rp****

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

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	9B34724D-54B0-4A51-B34D-4512372FE1BE
Handshake	object	招待の情報です。
Status	string	招待のステータスです。有効な値は以下のとおりです。 Pending：招待は承認待ちの状態です。 Accepted：招待は承認済みです。 Cancelled：招待はキャンセルされています。 Declined：招待は拒否されています。 Expired：招待の有効期限が切れています。	Pending
ExpireTime	string	招待の有効期限です。時刻は協定世界時 (UTC) で表示されます。	2018-08-24T09:55:41Z
CreateTime	string	招待が作成された時刻です。時刻は協定世界時 (UTC) で表示されます。	2018-08-10T09:55:41Z
TargetEntity	string	招待されたアカウントの ID またはログイン用メールアドレスです。	someone@example.com
MasterAccountId	string	リソースディレクトリの管理アカウントの ID です。	172841235500****
HandshakeId	string	招待の ID です。	h-ycm4rp****
MasterAccountRealName	string	リソースディレクトリの管理アカウントの実名登録情報です。説明このパラメーターは、招待されたアカウントが本操作を呼び出した場合にのみ利用可能です。	company
ResourceDirectoryId	string	リソースディレクトリの ID です。	rd-abcdef****
InvitedAccountRealName	string	招待されたアカウントの実名登録情報です。説明このパラメーターは、招待されたアカウントが本操作を呼び出した場合にのみ利用可能です。	Alice
Note	string	招待に対するコメントです。	欢迎您加入
MasterAccountName	string	リソースディレクトリの管理アカウントの名前です。	company@example.com
TargetType	string	招待されたアカウントの種別です。有効な値は以下のとおりです。 Account：アカウントの ID を示します。 Email：アカウントのログイン用メールアドレスを示します。	Email
ModifyTime	string	招待が変更された時刻です。時刻は協定世界時 (UTC) で表示されます。	2018-08-10T09:55:41Z

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter.HandshakeId	You must specify HandshakeId.
400	InvalidParameter.HandshakeId	The HandshakeId is invalid.
404	EntityNotExists.Handshake	The specified handshake does not exist.
409	HandshakeStatusMismatch	The invitation is invalid.	The invitation is invalid.
409	MissingAccountRealName	The name of the invited account is not specified.
409	NoRealNameAuthentication	The account invited has not passed real-name authentication.

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

変更履歴

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