查询账号信息 - ShowAccount

功能介绍

查询有关指定账号的信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

organizations:accounts:get

Read

account *

g:ResourceTag/<tag-key>

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
organizations:accounts:get	Read	account *	g:ResourceTag/<tag-key>	-	-

URI

GET /v1/organizations/accounts/{account_id}

表1 路径参数
参数	是否必选	参数类型	描述
account_id	是	String	参数解释：账号的唯一标识符（ID）。约束限制：必填取值范围：符合正则表达式：^[\w-]+$ 最大长度64。默认取值：无默认值

表2 Query参数
参数	是否必选	参数类型	描述
with_register_contact_info	否	Boolean	参数解释：是否返回账号邮箱、手机号信息。若此参数为True，Limit最多200。约束限制：必填字段取值范围：布尔值：true/false 默认取值：无

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	参数解释：如果正在使用临时安全凭据，则此 header 是必需的，该值是临时安全凭据的安全令牌（会话令牌）。约束限制：不涉及取值范围：最小长度0、最大长度32768。默认取值：无默认值

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
account	AccountDto object	参数解释：账号的详细信息。约束限制：必填字段取值范围：不涉及默认取值：无默认值

表5 AccountDto
参数	参数类型	描述
id	String	参数解释：账号的唯一标识符（ID）。约束限制：必填字段取值范围：符合正则表达式：^[\w-]+$ 最大长度64。默认取值：无默认值
urn	String	参数解释：账号的统一资源名称。约束限制：必填字段取值范围：最小长度1、最大长度1500。默认取值：无默认值
join_method	String	参数解释：账号加入组织的方式。invited：邀请加入，created：创建加入。约束限制：必填字段取值范围：最小长度1、最大长度64。默认取值：无默认值
status	String	参数解释：账号当前的状态。active：有效； suspended：已关闭； pending_closure：关闭中。约束限制：必填字段取值范围：最小长度1、最大长度64。默认取值：无默认值
joined_at	String	参数解释：账号加入组织的日期。约束限制：必填字段取值范围：符合ISO 8601日期时间格式。默认取值：无默认值
name	String	参数解释：账号名称约束限制：必填字段取值范围：符合正则表达式：^[a-zA-Z][0-9a-zA-Z_-]+$ 最大长度64。默认取值：无默认值
mobile_phone	String	参数解释：手机号码约束限制：无取值范围：符合正则表达式：^1[3456789]\d{9}$ 最小长度1、最大长度32。默认取值：无
intl_number_prefix	String	参数解释：手机号前缀。约束限制：无取值范围：最小长度1、最大长度10。默认取值：无
email	String	参数解释：与此账号关联的电子邮件地址。约束限制：无取值范围：符合正则表达式：^[\s][\w+=.#\|!&-]+@[\w.-]+.[\w]+[\s]$ 最小长度1、最大长度64。默认取值：无
description	String	参数解释：描述信息。约束限制：不涉及取值范围：最小长度0、最大长度128。默认取值：无默认值

请求示例

查询账号信息

GET https://{endpoint}/v1/organizations/accounts/{account_id}

响应示例

状态码：200

Successful.

{
  "account" : {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
    "join_method" : "invited",
    "status" : "active",
    "joined_at" : "2022-08-24T06:41:15Z",
    "name" : "paas_iam_573331",
    "description" : "string",
    "mobile_phone" : "null,",
    "intl_number_prefix" : "null,",
    "email" : null
  }
}