查询用户组信息

最近更新时间:2024-08-14 02:14:43

我的收藏

1. 接口描述

接口请求域名: organization.tencentcloudapi.com 。

查询用户组信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetGroup。
Version String 公共参数,本接口取值:2021-03-31。
Region String 公共参数,此参数为可选参数。
ZoneId String 空间 ID。
示例值:z-23s8xh7sd***
GroupId String 用户组的 ID。
示例值:g-sd8sh8sdno***

3. 输出参数

参数名称 类型 描述
GroupInfo GroupInfo 用户组信息
示例值:{"GroupName": "testGroup", "Description": "this is group", "CreateTime": "2024-01-01 12:12:12", "GroupType": "Manual", "UpdateTime": "2024-01-01 12:12:12", "GroupId": "g-sushsia7s8", "MemberCount": 20}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询用户组信息

查询用户组信息

输入示例

POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetGroup
<公共请求参数>

{
    "ZoneId": "z-ws9sdj8****",
    "GroupId": "g-sushsia7s8"
}

输出示例

{
    "Response": {
        "GroupInfo": {
            "GroupName": "testGroup",
            "Description": "this is group",
            "CreateTime": "2024-01-01 12:12:12",
            "GroupType": "Manual",
            "UpdateTime": "2024-01-01 12:12:12",
            "GroupId": "g-sushsia7s8",
            "MemberCount": 20
        },
        "RequestId": "e297543a-80de-4039-83c8-9d324545"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.IdentityCenterNotOpen CIC服务没有开通
FailedOperation.ZoneIdNotExist CIC服务的用户zoneId不存在
InvalidParameter.GroupNotExist 用户组不存在