Queries the details of a handshake.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
resourcemanager:GetHandshake |
get |
*Handshake
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| HandshakeId |
string |
Yes |
The handshake ID. |
h-ycm4rp**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned result. |
||
| RequestId |
string |
The request ID. |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| Handshake |
object |
The handshake information. |
|
| Status |
string |
The handshake status. Valid values:
|
Pending |
| ExpireTime |
string |
The expiration time of the handshake in UTC. |
2018-08-24T09:55:41Z |
| CreateTime |
string |
The creation time of the handshake in UTC. |
2018-08-10T09:55:41Z |
| TargetEntity |
string |
The ID or logon email address of the invited account. |
someone@example.com |
| MasterAccountId |
string |
The ID of the management account for the resource directory. |
172841235500**** |
| HandshakeId |
string |
The handshake ID. |
h-ycm4rp**** |
| MasterAccountRealName |
string |
The real-name verification information of the management account for the resource directory. Note
This parameter is visible only when the invited account calls this operation. |
company |
| ResourceDirectoryId |
string |
The resource directory ID. |
rd-abcdef**** |
| InvitedAccountRealName |
string |
The real-name verification information of the invited account. Note
This parameter is visible only when the invited account calls this operation. |
Alice |
| Note |
string |
The note. |
Welcome aboard |
| MasterAccountName |
string |
The name of the management account for the resource directory. |
company@example.com |
| TargetType |
string |
The type of the invited account. Valid values:
|
|
| ModifyTime |
string |
The modification time of the handshake in UTC. |
2018-08-10T09:55:41Z |
Examples
Success response
JSON format
{
"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"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | MissingParameter.HandshakeId | You must specify HandshakeId. | |
| 400 | InvalidParameter.HandshakeId | The HandshakeId is invalid. | The value of the HandshakeId parameter is invalid. The value must start with h- followed by 16 letters or digits. |
| 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. | The name of the invited account is not specified. |
| 409 | NoRealNameAuthentication | The account invited has not passed real-name authentication. | The invited account does not pass real-name verification. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.