接口功能介绍
该接口提供用户修改专属宿主机信息的功能。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
确保当前宿主机存在于当前资源池(即参数decHostID与regionID对应)
URI
POST /v4/dec/host/update-host
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
a39b0db2989140c79e6de8c21d50f132 | |
decHostID | 是 | String | 专属宿主机ID,获取: 查 查询专属宿主机列表 |
73f321ea-62ff-11ec-a8bc-005056898fe0 | |
decHostName | 是 | String | 专属宿主机展示名称,满足以下条件:名称长度为2-63字符。 获取: 查 查询专属宿主机列表 |
dec-test |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回{} |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:更新专属宿主机名称
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"decHostID": "5da27c6c-0076-3955-bd2e-9c11162b62fb",
"decHostName": "dec-test"
}
响应示例
{
"returnObj": {},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码