接口功能介绍
批量删除指定集群内的用户
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 一次请求最多删除100个用户
URI
POST /v4/cthpc/delete-users
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 查询支持超算的地域列表 |
8e3a382e241d11ed957c0242ac110006 | |
clusterUUID | 是 | String | 集群UUID 获取: 查 查询集群列表 创 创建集群 |
cl-zhqloubcsmycabomouuuwhgahwit | |
userList | 是 | Array of Objects | 被删除的用户列表数组,数组大小为[1, 100] | userList |
表 userList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
userUUID | 是 | String | 用户UUID 获取: 查 查询集群中的用户列表 创 批量增加用户 |
us-yinty8juta8bno3ogxxvbzcnd6bk | |
isHomeReserved | 是 | Boolean | 是否保留用户家目录,取值范围: true:保留 false:不保留 |
true |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
errorCode | String | 错误码,为product.module.code 三段式码 | Hpc.DeleteUsers.NotValid | |
error | String | 错误码,为product.module.code 三段式码 | Hpc.DeleteUsers.NotValid | |
message | String | 失败时的英文错误描述 | Param is null | |
description | String | 失败时的中文错误描述 | 请求为空 | |
returnObj | Object | 返回参数,值为空 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:删除内蒙6资源池某个集群下的2个用户
用户us-yinty8juta8bno3ogxxvbzcnd6bk保留家目录,用户us-tcwpzdazo4bq0m5asiklginzqocb不保留家目录
{
"clusterUUID": "cl-zhqloubcsmycabomouuuwhgahwit",
"regionID": "6019b5007a0b11eab5db0242ac110002",
"userList": [
{
"userUUID": "us-yinty8juta8bno3ogxxvbzcnd6bk",
"isHomeReserved" : true
},
{
"userUUID": "us-tcwpzdazo4bq0m5asiklginzqocb",
"isHomeReserved" : false
}
]
}
响应示例
{
"returnObj": {},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码