列出发送的邀请 - ListHandshakes
功能介绍
列出所属组织发送的邀请。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:handshakes:list
List
-
-
-
-
URI
GET /v1/organizations/handshakes
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 页面中最大结果数量。当未指定 Limit 参数情况下,系统默认值为 1000。 约束限制: 不涉及 取值范围: 最小值1、最大值2000。 默认取值: 200 |
| marker | 否 | String | 参数解释: 分页标记。 约束限制: 不涉及 取值范围: 符合正则表达式:^[A-Za-z0-9+/=-_.]+$ 最小长度4、最大长度400。 默认取值: 无默认值 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 最小长度0、最大长度32768。 默认取值: 无默认值 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| handshakes | Array of HandshakeDto objects | 参数解释: 邀请(握手)对象的列表,其中包含与指定账号关联的每个邀请(握手)的详细信息。 约束限制: 必填字段 取值范围: 不涉及 默认取值: 无默认值 |
| page_info | PageInfoDto object | 参数解释: 分页信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 无默认值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 邀请(握手)的唯一标识符(ID)。源账号在发起邀请(握手)时创建ID。 约束限制: 必填字段 取值范围: 符合正则表达式:^h-[0-9a-z]{8,32}$ 最大长度34。 默认取值: 无默认值 |
| urn | String | 参数解释: 邀请(握手)的统一资源名称。 约束限制: 必填字段 取值范围: 最小长度1、最大长度1500。 默认取值: 无默认值 |
| updated_at | String | 参数解释: 邀请(握手)请求被接受、取消、拒绝或到期的日期和时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
| created_at | String | 参数解释: 提出邀请(握手)请求的日期和时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
| expired_at | String | 参数解释: 邀请(握手)过期的日期和时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
| management_account_id | String | 参数解释: 组织管理账号的唯一标识符(ID)。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\w-]+$ 最大长度64。 默认取值: 无默认值 |
| management_account_name | String | 参数解释: 组织管理账号的名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最大长度64。 默认取值: 无默认值 |
| organization_id | String | 参数解释: 组织的唯一标识符(ID)。 约束限制: 必填字段 取值范围: 符合正则表达式:^o-[0-9a-z]{10,32}$ 最大长度34。 默认取值: 无默认值 |
| notes | String | 参数解释: 给收件账号所有者的邮件中的附加信息。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\s\S]*$ 最大长度1024。 默认取值: 无默认值 |
| target | TargetDto object | 参数解释: 要邀请加入组织的账号的信息。 约束限制: 必填字段 取值范围: 不涉及 默认取值: 无默认值 |
| status | String | 参数解释: 邀请(握手)的当前状态,pending:邀请中;accepted:接受邀请;cancelled:取消邀请;declined:拒绝邀请;expired:邀请过期。 约束限制: 必填字段 取值范围: 最小长度1、最大长度64。 默认取值: 无默认值 |
请求示例
列出发送的邀请
GET https://{endpoint}/v1/organizations/handshakes 响应示例
状态码:200
Successful.
{
"handshakes" : [ {
"id" : "h-2tnfkrhe64qokwripd2kqrhd7d3079u5",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv",
"updated_at" : "2022-09-23T07:38:15Z",
"created_at" : "2022-09-23T07:38:15Z",
"management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
"management_account_name" : "paas_iam_573331",
"organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
"notes" : "test-notes",
"target" : {
"type" : "account",
"entity" : "644c579bea6d473e8ce386e0e8ec449d"
},
"status" : "cancelled"
} ],
"page_info" : {
"next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"current_count" : 100
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Successful. |
错误码
请参见错误码。