修改云网关描述
更新时间 2026-05-26 17:09:53
最近更新时间: 2026-05-26 17:09:53
接口功能介绍
修改云企业路由器描述
接口约束
无
URI
POST /v4/ec/cloud-gateway/update
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cgwID | 是 | String | 云企业路由器实例ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwName | 否 | String | 云企业路由器名称 | gateway_beijing | |
| cgwDescription | 否 | String | 云企业路由器描述 | 北京云企业路由器 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码 取值范围: 800:成功 900:失败 | 800 | |
| errorCode | String | 业务细分码,为product.module.code三段式码 | ||
| message | String | 失败时的错误描述,一般为英文描述 | ||
| description | String | 失败时的错误描述,一般为中文描述 | ||
| traceID | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| cgwID | String | 云企业路由器实例ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwName | String | 云企业路由器名称 | gateway_beijing | |
| cgwDescription | String | 云企业路由器描述 | 北京云企业路由器 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"cgwID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"cgwName": "gateway_beijing",
"description": "北京云企业路由器"
}
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"returnObj": {
"cgwID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"cgwName": "gateway_beijing",
"cgwDescription": "北京云企业路由器"
}
}
状态码
请参考 状态码
错误码
请参考 错误码