查询用户组详情 - ShowGroupV5

功能介绍

该接口可以用于查询用户组详情。

调试

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

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
iam:groups:getGroupV5	Read	group *	-	-	-

URI

GET /v5/groups/{group_id}

表1 路径参数
参数	是否必选	参数类型	描述
group_id	是	String	参数解释：用户组ID。约束限制：长度为1到64个字符，只包含字母、数字和"-"的字符串。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
group	group object	参数解释：用户组。取值范围：不涉及。

表3 group
参数	参数类型	描述
group_id	String	参数解释：用户组ID。取值范围：不涉及。
group_name	String	参数解释：用户组名。取值范围：不涉及。
created_at	String	参数解释：用户组创建时间。取值范围：不涉及。
urn	String	参数解释： URN(Uniform Resource Name)统一资源名称, 参考链接。取值范围：不涉及。
description	String	参数解释：用户组描述信息。取值范围：不涉及。

状态码：403

表4 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误消息。取值范围：不涉及。
request_id	String	参数解释： API请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。
encoded_authorization_message	String	参数解释：认证失败时返回的加密详细信息，用于定位认证问题。可以通过STS5解密接口进行解密，请参见接口链接。取值范围：不涉及。

状态码：404

表5 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

请求示例

查询用户组详情。

GET https://{endpoint}/v5/groups/{group_id}

响应示例

状态码：200

请求成功。

{
  "group" : {
    "group_id" : "string",
    "group_name" : "name",
    "created_at" : "2023-09-11T10:13:25.414Z",
    "urn" : "iam::accountid:group:name",
    "description" : "description"
  }
}