tencent cloud

文档反馈

ModifyAppStatus

最后更新时间:2023-07-06 14:47:54

1. API Description

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

This API is used to change the status of an application.

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

3. Output Parameters

Parameter Name Type Description
Data ModifyAppStatusResp Returned data
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

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

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 Incorrect parameter.
MissingParameter Parameter missing.
ResourceNotFound The resource does not exist.
ResourceNotFound.BizidIsNotFound Incorrect application ID.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Operation unsupported.