更新服务版本
最近更新时间: 2024-10-18 10:38:33
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（UpdateService）用于从服务发布的环境中运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后，多因为开发过程会产生多个版本，此时可调用本接口。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-08-02 19:50:16。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：UpdateService |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| ServiceId | 是 | 否 | String | 待切换服务的唯一 Id。 |
| EnvironmentName | 是 | 否 | String | 待切换的环境名称，当前支持三个环境，test（测试环境）、prepub（预发布环境）和 release（发布环境）。 |
| VersionName | 是 | 否 | String | 切换的版本号。 |
| UpdateDesc | 否 | 否 | String | 本次的切换描述。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 切换版本操作是否成功。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound | |
| InvalidParameter.FormatError | |
| UnauthorizedOperation | |
| UnsupportedOperation.InvalidServiceTrade | |
| FailedOperation.ServiceError | |
| InternalError.OssException | |
| FailedOperation.ServiceInOperation |