接口功能介绍
该接口提供用户修改专属宿主机信息的功能。
接口约束
无
URI
POST /v4/dec/host/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 | |
azName | 是 | String | 可用区名称。您可以调用资源池可用区查询获取可用区信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | cn-huadong1-jsnj1A-public-ctcloud | |
hostID | 是 | String | 宿主机ID | 5da27c6c-0076-3955-bd2e-9c11162b62fb | |
displayName | 是 | String | 宿主机展示名称 | dec-test |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 成功返回空 | {} | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"hostID": "5da27c6c-0076-3955-bd2e-9c11162b62fb",
"displayName": "dec-test"
}
响应示例
{
"returnObj": {},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码