调用GetHandshake获取邀请信息。
接口说明
本文将提供一个示例，获取 ID 为h-ycm4rp****的邀请信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| resourcemanager:GetHandshake | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| HandshakeId | string | 是 | 邀请 ID。 | h-ycm4rp**** |
返回参数
示例
正常返回示例
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. | 邀请ID缺失，请指定目标ID。 |
| 400 | InvalidParameter.HandshakeId | The HandshakeId is invalid. | 邀请ID无效，邀请ID应以“h-”开头+16位数字或英文字母。 |
| 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. | 被邀请账号无实名认证。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史