接口功能介绍
编辑网关信息
接口约束
1、目前仅支持用户编辑网关的自命名名称
2、若该网关处在中间状态(部署中、删除中)时,无法进行编辑
URI
POST /v4/nfs/edit-gateway
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
gatewayID | 是 | String | 网关的ID | 参考请求示例 | |
gatewayName | 是 | String | 修改的网关名称,必须大小写字母或中文开头,支持中文,英文大小写,数字,“.”,“_”或“-”,长度不超过50个字符 | 参考请求示例 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中/失败) | 800 | |
message | String | 状态描述 | SUCCESS | |
description | String | 状态描述,一般为中文 | 成功 | |
returnObj | Object | 响应对象 | ||
error | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码大驼峰形式 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"gatewayID":"3eec97c8-b9bb-11ee-a46d-18022d1723b2",
"gatewayName":"testophm_edit"
}
响应示例
{
"returnObj":{
},
"details":"",
"message":"SUCCESS",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码