Documentation|Tencent Cloud

Recent Pages

UpdateService

Last updated: 2020-07-17 09:42:04

1. API Description

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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.

3. Output Parameters

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.

4. Example

Example1 UpdateService

Input Example

https://apigateway.tencentcloudapi.com/?Action=UpdateService
&ServiceId=service-ody35h5e
&EnvironmentName=test
&VersionName=202002161926124aa59df4-7198-4f7a-acc7-887ab7ee0215
&UpdateDesc=test
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": true,
    "RequestId": "7787aa0e-be74-43c0-b6f6-7bf56995ce2d"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
ResourceNotFound	The resource does not exist.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation.InvalidServiceTrade	As the service is isolated, the operation is not supported currently.