查询有关组织单元的信息 - ShowOrganizationalUnit
功能介绍
查询有关组织单元的信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:ous:get
Read
ou *
g:ResourceTag/<tag-key>
-
-
URI
GET /v1/organizations/organizational-units/{organizational_unit_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| organizational_unit_id | 是 | String | 参数解释: 与组织单元关联的唯一标识符(ID)。 约束限制: 必填 取值范围: 符合正则表达式:^ou-[0-9a-z]{8,32}$ 最大长度35。 默认取值: 无默认值 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 最小长度0、最大长度32768。 默认取值: 无默认值 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| organizational_unit | OrganizationalUnitDto object | 参数解释: 组织单元的详细信息。 约束限制: 必填字段 取值范围: 不涉及 默认取值: 无默认值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 与组织单元关联的唯一标识符(ID)。 约束限制: 必填字段 取值范围: 符合正则表达式:^ou-[0-9a-z]{8,32}$ 最小长度1、最大长度35。 默认取值: 无默认值 |
| urn | String | 参数解释: 组织单元的统一资源名称。 约束限制: 必填字段 取值范围: 最小长度1、最大长度1500。 默认取值: 无默认值 |
| name | String | 参数解释: 组织单元的名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。 默认取值: 无默认值 |
| created_at | String | 参数解释: 组织单元的创建时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
请求示例
查询有关组织单元的信息
GET https://{endpoint}/v1/organizations/organizational-units/{organizational_unit_id} 响应示例
状态码:200
Successful
{
"organizational_unit" : {
"id" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"name" : "autoOU0923152729270Pkgk",
"created_at" : "2022-09-23T07:27:28Z"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Successful |
错误码
请参见错误码。