概要 - Resource Management

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

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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	招待の説明。	Welcome
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": "Welcome\n",
    "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.
409	MissingAccountRealName	The name of the invited account is not specified.
409	NoRealNameAuthentication	The account invited has not passed real-name authentication.

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

変更履歴

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