Deactivate service

Last updated: 2020-06-09 14:55:06

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new API Gateway API 3.0 which is standardized and faster.

    Interface description

    This API (UnReleaseService) is used for deactivate service.
    The API in the service can only be called by the caller after the user publish service reaches a certain environment. When the user needs to transfer the service from the publish environment, deactivate can call this API. The service after deactivate cannot be called.

    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 only ID to be served by deactivate.
    EnvironmentName Yes Boolean The name of the environment to be used by deactivate. Three environments are currently supported. Test: test, advance: prepub, online: release
    UnReleaseDesc No String This time deactivate described.

    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.

    Example

    https://apigateway.api.qcloud.com/v2/index.php?
    &<Common request parameters>
    &Action=UnReleaseService
    &serviceId=service=XX
    &environmentName=Online
    &unReleaseDesc=Deactivation description

    The returned results are as below:

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

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help