Domain name for API request: apigateway.tencentcloudapi.com.
This API is used to switch the running version of a service published in an environment to a specified version. After you create a service by using API Gateway and publish it to an environment, multiple versions will be generated during development. In this case, you can call this API to switch versions.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: UpdateService. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-08-08. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| ServiceId | Yes | String | Unique ID of the service to be switch. |
| EnvironmentName | Yes | String | Name of the environment to be switched to. Valid values: test (test environment), prepub (pre-release environment), release (release environment). |
| VersionName | Yes | String | Number of the version to be switched to. |
| UpdateDesc | No | String | Switch description. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | Boolean | Whether the version is successfully switched. Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://apigateway.tencentcloudapi.com/?Action=UpdateService
&ServiceId=service-ody35h5e
&EnvironmentName=test
&VersionName=202002161926124aa59df4-7198-4f7a-acc7-887ab7ee0215
&UpdateDesc=test
&<Common request parameters>{
"Response": {
"Result": true,
"RequestId": "7787aa0e-be74-43c0-b6f6-7bf56995ce2d"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.OssException | OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnsupportedOperation.InvalidServiceTrade | The service is currently isolated and therefore the operation is not supported. |
Was this page helpful?