Help & DocumentationAPI GatewayAPI DocumentationService APIsSwitch service version

Switch service version

Last updated: 2020-02-21 16:16:51

PDF

Contents：

Interface description

This API (UpdateService) is used to switch from the running version of the service publish to a specific version. This API can be called after users create a service using API gateway and implement publish service to a certain environment, mostly because multiple versions will be generated in the development process.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters .

Parameter name Required Type Description
ServiceId Yes String The unique Id of the service to be switched.
EnvironmentalName Yes Boolean The name of the environment to be rolled back. Three environments are currently supported. Test: Test, advance: Pre, online: release
VersionName Yes String The version number of the switch.
UpdateDesc No String The description of this switch.

Output Parameter

Parameter name Type Description
Code Int Common error code, 0 indicates success, other values indicate failure. For more information, please see the error code page Common error code .
CodeDesc String Error code on the business side. If a Success, error is returned on success, the cause of the business error is returned.
Message String Module error message description, related to the interface.
UpdateDesc String The description of this switch.

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=UpdateService
&serviceId=service-XX
&environmentalName=release
&versionName=xxxxx
&updateDesc=updateDesc

The returned results are as below:

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",    
    "updateDesc":"updateDesc"
}