tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ReleaseService

Last updated: 2024-04-08 15:10:54

    1. API Description

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

    This API is used to publish a service.
    An API Gateway service can only be called when it is published to an environment and takes effect after creation. This API is used to publish a service to an environment such as the release environment.

    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: ReleaseService.
    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 published.
    EnvironmentName Yes String Name of the environment to be published. Valid values: test (test environment), prepub (pre-release environment), release (release environment).
    ReleaseDesc Yes String Release description.
    ApiIds.N No Array of String apiId list, which is reserved. Full API release is used by default.

    3. Output Parameters

    Parameter Name Type Description
    Result ReleaseService Release information.
    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 ReleaseService

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=ReleaseService
&ServiceId=service-ody35h5e
&EnvironmentName=prepub
&ReleaseDesc=xx
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Result": {
            "ReleaseDesc": "xx",
            "ReleaseVersion": "2020022502411672fae6e9-9726-4caa-8867-6366cd3f1ba5"
        },
        "RequestId": "c5b4711b-8044-43eb-97cc-e755c5df1420"
    }
}

    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.
    FailedOperation.TaskAlreadyExist
    InternalError.ApigwException API Gateway internal request error. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket.
    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.
    InvalidParameterValue.InvalidRegion Incorrect region.
    LimitExceeded.RequestLimitExceeded The request frequency has reached the limit. Please try again later.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.InvalidService The corresponding service is invisible.
    UnauthorizedOperation The operation is unauthorized.
    UnsupportedOperation.UnpackError
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy