DsgUserGroupQueryList
调用DsgUserGroupQueryList接口,查询数据保护伞的用户组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
|
名称 |
类型 |
是否必选 |
示例值 |
描述 |
| Action | String | 是 | DsgUserGroupQueryList | 系统规定参数。取值:DsgUserGroupQueryList。 |
| PageNumber | Integer | 是 | 1 | 分页的页码数。 |
| PageSize | Integer | 是 | 10 | 每页显示的条数,最大为100。 |
| Name | String | 否 | yun_group | 用户组名称关键字。平台会根据该关键字模糊匹配,查询相关用户组信息。 |
| Owner | String | 否 | user1 | 用户组的负责人。 |
| ProjectName | String | 否 | dev_project | 引擎名称。如需查询MaxCompute用户组信息,可配置该参数。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
| Success | Boolean | true | 调用是否成功。取值如下:
|
| ErrorCode | String | 1029030003 | 错误码。 |
| ErrorMessage | String | param error | 错误信息。 |
| HttpStatusCode | Integer | 400 | HTTP状态码。 |
| PageData | Object | 分页数据查询结果。 |
|
| PageNumber | Integer | 1 | 分页的页码数。 |
| PageSize | Integer | 10 | 每页显示的条数,最大为100。 |
| TotalCount | Integer | 100 | 返回的用户组总条数。 |
| Data | Array of Datas | 用户组列表。 |
|
| Accounts | Array of String | user1 | 用户名。 |
| Id | Integer | 123 | 用户组ID。 |
| GmtCreate | String | 2024-05-10 17:14:44 | 用户组的创建时间。 |
| GmtModified | String | 2024-05-10 17:14:44 | 用户组的修改时间。 |
| Name | String | test_group | 用户组名称。 |
| Owner | String | user1 | 用户组负责人。 |
| RequestId | String | 102400001 | 请求的ID。用于定位日志,排查问题。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DsgUserGroupQueryList
&PageNumber=1
&PageSize=10
&Name=yun_group
&Owner=user1
&ProjectName=dev_project
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DsgUserGroupQueryListResponse>
<Success>true</Success>
<ErrorCode>1029030003</ErrorCode>
<ErrorMessage>param error</ErrorMessage>
<HttpStatusCode>400</HttpStatusCode>
<PageData>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>100</TotalCount>
<Data>
<Accounts>user1</Accounts>
<Id>123</Id>
<GmtCreate>2024-05-10 17:14:44</GmtCreate>
<GmtModified>2024-05-10 17:14:44</GmtModified>
<Name>test_group</Name>
<Owner>user1</Owner>
</Data>
</PageData>
<RequestId>102400001</RequestId>
</DsgUserGroupQueryListResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Success" : true,
"ErrorCode" : "1029030003",
"ErrorMessage" : "param error",
"HttpStatusCode" : 400,
"PageData" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 100,
"Data" : [ {
"Accounts" : [ "user1" ],
"Id" : 123,
"GmtCreate" : "2024-05-10 17:14:44",
"GmtModified" : "2024-05-10 17:14:44",
"Name" : "test_group",
"Owner" : "user1"
} ]
},
"RequestId" : "102400001"
}
错误码
|
HttpCode |
错误码 |
错误信息 |
描述 |
| 400 | PARAMS.ERROR | param error. | 参数错误。 |
| 400 | USERGROUP.ACCOUNTLISTSIZE.ERROR | The number of account exceeds the limit. | 用户数量超限。 |
| 400 | USERGROUP.ID.ERROR | The user group ID does not match the tenant or does not exist. | 用户组ID不存在或不属于该租户。 |
| 400 | USERGROUP.LISTSIZE.ERROR | The number of user groups exceeds the limit. | 用户组数量超限。 |
| 400 | USERGROUP.PAGESIZE.ERROR | Page size is too large, maximum of 100. | 页大小超限,最大为100。 |
| 400 | USERACCOUNT.OWNER.ERROR | User list or owner user does not exist. | 用户列表或负责人用户不存在。 |
| 403 | PERMISSION.DENIED.ERROR | Permission denied | 权限不足。 |
| 500 | UNKNOWN.ERROR | unknown error. | 未知错误。 |
访问错误中心查看更多错误码。