接口功能介绍
修改云网关描述
接口约束
无
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 | 云网关描述 | 北京云网关 |
请求示例
请求头header
请求体body
{
"cgwID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"cgwName": "gateway_beijing",
"cgwDescription": "北京云网关"
}
响应示例
{
"description": "",
"errorCode": "",
"message": "",
"statusCode": 800,
"traceID": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"returnObj": {
"cgwID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"cgwName": "gateway_beijing",
"cgwDescription": "北京云网关"
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.CloudGatewayEc.UpdateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
