调用GetHandshake获取邀请信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| HandshakeId |
string |
是 |
邀请 ID。 |
h-ycm4rp**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| Handshake |
object |
邀请信息。 |
|
| Status |
string |
邀请状态。
|
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 |
被邀请账号类型。
|
|
| ModifyTime |
string |
邀请的修改时间（UTC 时间）。 |
2018-08-10T09:55:41Z |
示例
正常返回示例
JSON格式
{
"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 status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。