查询邀请相关信息 - ShowHandshake
功能介绍
查询组织中已有账号邀请的相关信息。此接口可以由组织中的任何账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:handshakes:get
Read
handshake *
-
-
-
URI
GET /v1/organizations/handshakes/{handshake_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| handshake_id | 是 | String | 参数解释: 邀请的唯一标识符(ID)。账号在发起邀请时创建ID。 约束限制: 必填 取值范围: 符合正则表达式:^h-[0-9a-z]{8,32}$ 最大长度34。 默认取值: 无默认值 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 最小长度0、最大长度32768。 默认取值: 无默认值 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| handshake | HandshakeDto 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/{handshake_id} 响应示例
状态码:200
Successful.
{
"handshake" : {
"id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:handshake:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"updated_at" : "2022-08-25T08:11:53Z",
"created_at" : "2022-08-25T08:11:20Z",
"expired_at" : "2022-09-08T08:11:20Z",
"management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
"management_account_name" : "paas_iam_573331",
"organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv",
"notes" : "test-notes",
"target" : {
"type" : "account",
"entity" : "05c734152f00d4200f2bc0179ac6c5e0"
},
"status" : "pending"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Successful. |
错误码
请参见错误码。