接口功能介绍
查询指定集群中的用户列表
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示1000条数据
匹配查找：可以通过部分字段进行匹配筛选数据，无符合条件的为空
接口约束
无
URI
GET /v4/cthpc/list-user
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 查询支持超算的地域列表 |
8e3a382e241d11ed957c0242ac110006 | |
| clusterUUID | 是 | String | 集群UUID 获取： 查 查询集群列表 创 创建集群 |
cl-zhqloubcsmycabomouuuwhgahwit | |
| userUUIDList | 否 | String | 用户UUID， 多个以逗号分隔，如有userNameList则取交集 | uuid-1,uuid-2 | |
| userNameList | 否 | String | 用户名称，多个以逗号分隔，如有userUUIDList则取交集 | name-1,name-2 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围:[1, 1000]，默认值:10，单页最大记录不超过1000 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code 三段式码 | Hpc.ListUsers.NotValid | |
| error | String | 错误码，为product.module.code 三段式码 | Hpc.ListUsers.NotValid | |
| message | String | 失败时的英文错误描述 | Param is null | |
| description | String | 失败时的中文错误描述 | 请求为空 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 1 | |
| totalPage | Integer | 总页数 | 1 | |
| resultList | Array of Objects | 分页明细,元素类型是result,定义请参考result对象结构 | result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| userName | String | 用户名称 | jdc | |
| userOperateStatus | String | 用户操作状态，取值范围： operate_creating：创建用户操作中 operate_create_success：创建用户操作成功 operate_create_failed：创建用户操作失败 operate_deleting：删除用户操作中 operate_delete_success：删除用户操作成功 operate_delete_failed：删除用户操作失败 operate_resetting_password：重置密码操作中 operate_reset_password_success：重置密码操作成功 operate_reset_password_failed：重置密码操作失败 |
operate_create_success | |
| userStatus | String | 用户状态，取值范围： creating：创建中 create_failed：创建失败 enabled：可用 resetting_password：重置密码中 deleting：删除中 |
enabled | |
| userUUID | String | 用户UUID | us-tcwpzdazo4bq0m5asiklginzqocb | |
| isReserved | Boolean | 是否是保留用户，true-保留用户，false-非保留用户 | true |
枚举参数
无
请求示例
请求url
示例：查询内蒙6资源池某个集群的用户列表
/v4/cthpc/list-user?regionID=6019b5007a0b11eab5db0242ac110002&clusterUUID=cl-wfvs2pgkwyvsflszb5ohdrfokvwu
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 2,
"totalCount": 2,
"totalPage": 1,
"resultList": [
{
"userName": "weidong",
"userStatus": "deleting",
"userOperateStatus": "operate_deleting",
"userUUID": "us-tcwpzdazo4bq0m5asiklginzqocb",
"isReserved": false
},
{
"userName": "galaxy",
"userStatus": "enabled",
"userOperateStatus": "operate_create_success",
"userUUID": "us-5ewu3vyw7rml8hzcq57mrybf90ff",
"isReserved": true
}
]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
