ModifyAppStatus

Last updated: 2020-04-17 14:22:49

    1. API Description

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

    This API is used to change the status of an application's master switch.

    A maximum of 20 requests can be initiated per second for this API.

    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: ModifyAppStatus.
    Version Yes String Common parameter. The value used for this API: 2018-07-11.
    Region No String Common parameter. This parameter is not required for this API.
    BizId Yes Integer Application ID, which is generated and returned by the backend after application creation.
    Status Yes String Application status. Valid values: open, close

    3. Output Parameters

    Parameter Name Type Description
    BizId Integer GME application ID
    Status String Application status. Valid values: open, close

    4. Example

    Example1 Turning off GME application 140000001

    Input Example

    https://gme.tencentcloudapi.com/?Action=ModifyAppStatus
    &BizId=140000001
    &Status=close
    &<common request parameters>

    Output Example

    {
      "Response": {
        "Data": {
          "BizId": 140000001,
          "Status": "close"
        },
        "RequestId": "e2900289-f21e-43a8-a3bf-0b439cdbbbb8"
      }
    }

    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.

    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 Operation failed.
    FailedOperation.UserFeeNegative Operation not allowed as your account is in arrears.
    InternalError Internal error
    InvalidParameter Invalid parameter
    MissingParameter. Missing parameter.
    ResourceNotFound The resource does not exist
    ResourceNotFound.BizidIsNotFound The application ID does not exist.
    UnauthorizedOperation Unauthorized operation
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation

    Was this page helpful?

    Was this page helpful?

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