调用ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
页码。 起始值:1。默认值:1。 |
1 |
| PageSize |
integer |
否 |
分页时每页显示的数据行数。 取值范围:1~100。默认值:10。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| TotalCount |
integer |
数据总条数。 |
2 |
| RequestId |
string |
请求 ID。 |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| PageSize |
integer |
分页时每页显示的数据行数。 |
10 |
| PageNumber |
integer |
页码。 |
1 |
| Handshakes |
object |
||
| Handshake |
array<object> |
邀请信息。 |
|
|
object |
邀请信息。 |
||
| Status |
string |
邀请状态。
|
Pending |
| ExpireTime |
string |
邀请的过期时间(UTC 时间)。 |
2018-08-24T09:55:41Z |
| ResourceDirectoryId |
string |
资源目录 ID。 |
rd-abcdef**** |
| CreateTime |
string |
邀请的创建时间(UTC 时间)。 |
2018-08-10T09:55:41Z |
| Note |
string |
备注。 |
欢迎您加入 |
| TargetEntity |
string |
被邀请账号 ID 或登录邮箱。 |
someone@example.com |
| MasterAccountId |
string |
资源目录管理账号 ID。 |
172841235500**** |
| MasterAccountName |
string |
资源目录管理账号名称。 |
Alice |
| ModifyTime |
string |
邀请的修改时间(UTC 时间)。 |
2018-08-10T09:55:41Z |
| TargetType |
string |
被邀请账号类型。
|
|
| HandshakeId |
string |
邀请 ID。 |
h-ycm4rp**** |
示例
正常返回示例
JSON格式
{
"TotalCount": 2,
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"PageSize": 10,
"PageNumber": 1,
"Handshakes": {
"Handshake": [
{
"Status": "Pending",
"ExpireTime": "2018-08-24T09:55:41Z",
"ResourceDirectoryId": "rd-abcdef****",
"CreateTime": "2018-08-10T09:55:41Z",
"Note": "欢迎您加入",
"TargetEntity": "someone@example.com",
"MasterAccountId": "172841235500****",
"MasterAccountName": "Alice",
"ModifyTime": "2018-08-10T09:55:41Z",
"TargetType": "Email",
"HandshakeId": "h-ycm4rp****"
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | EntityNotExists.ResourceDirectory | The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。