接口功能介绍
编辑集群信息
接口约束
无
URI
POST /v4/cthpc/modify-cluster
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域ID | 8e3a382e241d11ed957c0242ac110006 | |
clusterUUID | 是 | String | 集群实例UUID | cl-drggwgpe6zevs133eubdlnt3psgg | |
clusterDescription | 是 | String | 集群描述,不超过256位 | test-desc-modify01 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
errorCode | String | 业务细分码,为 product.module.code 三段式码 | 参考错误码 | |
message | String | 失败时的英文错误描述 | Param is null | |
description | String | 失败时的中文错误描述 | 请求为空 | |
returnObj | Object | 返回参数,值为空 | {} |
请求示例
请求头 header
无
请求体 body
{
"regionID": "8e3a382e241d11ed957c0242ac110006",
"clusterUUID": "cl-drggwgpe6zevs133eubdlnt3psgg",
"clusterDescription": "test-desc-modify01"
}
响应示例
{
"returnObj": {},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Hpc.ModifyCluster.NotValid | 请求参数非法 |
Hpc.ModifyCluster.NotFound | 集群不存在 |
Hpc.Common.CheckError | 内部错误,请重试 |