文档

ListHandshakesForResourceDirectory - 查看资源目录下的所有邀请列表

更新时间:

调用ListHandshakesForResourceDirectory查看资源目录下的所有邀请列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

页码。

起始值:1。默认值:1。

1
PageSizeinteger

分页时每页显示的数据行数。

取值范围:1~100。默认值:10。

10

返回参数

名称类型描述示例值
object

返回结果。

TotalCountinteger

数据总条数。

2
RequestIdstring

请求 ID。

9B34724D-54B0-4A51-B34D-4512372FE1BE
PageSizeinteger

分页时每页显示的数据行数。

10
PageNumberinteger

页码。

1
Handshakesobject []

邀请信息。

Statusstring

邀请状态。

  • Pending:等待确认。
  • Accepted:已接受。
  • Cancelled:已取消。
  • Declined:已拒绝。
  • Expired:超时。
Pending
ExpireTimestring

邀请的过期时间(UTC 时间)。

2018-08-24T09:55:41Z
ResourceDirectoryIdstring

资源目录 ID。

rd-abcdef****
CreateTimestring

邀请的创建时间(UTC 时间)。

2018-08-10T09:55:41Z
Notestring

备注。

欢迎您加入
TargetEntitystring

被邀请账号 ID 或登录邮箱。

someone@example.com
MasterAccountIdstring

资源目录管理账号 ID。

172841235500****
MasterAccountNamestring

资源目录管理账号名称。

Alice
ModifyTimestring

邀请的修改时间(UTC 时间)。

2018-08-10T09:55:41Z
TargetTypestring

被邀请账号类型。

  • Account:账号 ID。
  • Email:账号登录邮箱。
Email
HandshakeIdstring

邀请 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错误码错误信息描述
404EntityNotExists.ResourceDirectoryThe resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.当前账号未启用资源目录,请先启用资源目录。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)