tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBanStatus

Last updated: 2024-08-27 11:39:13

1. API Description

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

This API is used to obtain the block button status.

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: DescribeBanStatus.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.

3. Output Parameters

Parameter Name Type Description
Status Integer Blocking enabling status:
0: disabled
1: advanced blocking
2: basic blocking (block only malicious IP addresses in the intelligence database)
ShowTips Boolean Whether to display the pop-up prompt. False: no; true: yes.
OpenSmartMode Boolean Whether to enable intelligent over-allowing mode
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 Obtaining the Status of Blocking Button

Input Example

https://cwp.tencentcloudapi.com/?Action=DescribeBanStatus
&<Common request parameters>

Output Example

{
    "Response": {
        "Status": 1,
        "ShowTips": false,
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
    }
}

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
InternalError Internal error
InvalidParameter Incorrect parameter.
InvalidParameter.InvalidFormat Incorrect parameter format.
InvalidParameter.MissingParameter Missing parameter.
InvalidParameter.ParsingError Incorrect parameter parsing.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter error.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy