tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

UpdateService

最后更新时间：2024-04-08 15:10:53

    1. API Description

    Domain name for API request: apigateway.tencentcloudapi.com.

    u200dThis 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.

    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 Params. The value used for this API: UpdateService.
    Version Yes String Common Params. The value used for this API: 2018-08-08.
    Region No String Common Params. This parameter is not required for this API.
    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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 UpdateService

    u200dThis 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.

    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

    SDK

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

    Command Line Interface

    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
    FailedOperation.ServiceError Service error.
    FailedOperation.ServiceInOperation The service is in use. Please try again later.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款