GetGroup - 查询用户组详情--访问控制-火山引擎

文档中心

立即注册

导航

GetGroup - 查询用户组详情

最近更新时间：2024.09.14 14:28:10首次发布时间：2023.09.04 17:27:46

查询指定用户组的详情信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetGroup	要执行的操作，取值：GetGroup。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserGroupName	String	是	dev-group	用户组名。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
UserGroup	Object	请参考数据结构内具体参数示例值。	用户组的数据结构。

请求示例

GET /?Action=GetGroup&Version=2018-01-01&UserGroupName=dev-group HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240911T102858Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240911/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240911182902107202198243732C25",
    "Action": "GetGroup",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "UserGroup": {
      "UserGroupID": 20000,
      "AccountID": 2000000000,
      "UserGroupName": "dev-group",
      "DisplayName": "开发组",
      "Description": "开发组",
      "CreateDate": "20150123T123318Z",
      "UpdateDate": "20150123T123318Z"
    }
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。