ListGroupMembers - 查询用户组成员--云身份中心-火山引擎

文档中心

导航

ListGroupMembers - 查询用户组成员

最近更新时间：2025.03.21 11:14:43首次发布时间：2025.03.21 11:14:43

查询用户组成员

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListGroupMembers	要执行的操作，取值：ListGroupMembers。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
GroupId	String	是	1	用户组 id
PageNumber	Integer	否	1	页码，默认 1
PageSize	Integer	否	10	单页数量
QueryString	String	否	name	过滤参数。搜索用户名/显示名.

返回参数

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

参数	类型	示例值	描述
Total	Long	100	总数
PageSize	Integer	10	分页大小
PageNumber	Integer	1	页码
Members	Array of Object	[ { "UserId": "NxpcFXN", "UserName": "用户名称", "DisplayName": "FvQ5", "Description": "C8piPKkzJy", "Source": "H6Xk83FcMjq", "Email": "O", "Phone": "ySzjRlO1U", "IdentityType": "6Lakuqo", "JoinTime": "u1tZ" } ]	用户组成员列表

请求示例

POST /?Action=ListGroupMembers&Version=2023-01-01 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250310T123841Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250310/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "GroupId": "gzHeuo"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202503171432451671752081088EF28B",
    "Action": "ListGroupMembers",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 940,
    "PageSize": 864,
    "PageNumber": 779,
    "Members": [
      {
        "UserId": "NxpcFXN",
        "UserName": "用户名称",
        "DisplayName": "FvQ5",
        "Description": "C8piPKkzJy",
        "Source": "H6Xk83FcMjq",
        "Email": "O",
        "Phone": "ySzjRlO1U",
        "IdentityType": "6Lakuqo",
        "JoinTime": "u1tZ"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ParamMissing	Missing parameter %v	参数缺省
400	ServiceStatusException	Can not perform action[%s] when service is %s	企业身份中心实例不可用
400	PermissionError	No permission to perform action[%s] on resource %s	没有接口权限
404	UserGroupNotFound	User group is not found	用户组未找到
500	InternalError	Unknown internal error: %v	服务内部错误