Domain name for API request: csip.intl.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.
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: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| MemberId.N | No | Array of String | Group account member id. |
| Parameter Name | Type | Description |
|---|---|---|
| Status | Integer | (Abandoned) Block switch status: 0 -- Off 1 -- Advanced blocking 2 -- Basic block (blocklist IPs in the intelligence database only) |
| ShowTips | Boolean | Whether to display pop-up prompt information. false: turn off, true: turn on |
| OpenSmartMode | Boolean | Whether intelligent over-whitening mode is enabled |
| BanBlackIp | Boolean | Whether intelligence IP blocking is enabled |
| BanVulIp | Boolean | Enable vulnerability IP blocking or not |
| BanByRule | Boolean | Whether to enable rule blocking |
| 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. |
This example shows you how to get the new BanStatus.
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBanStatus
<Common request parameters>
{}{
"Response": {
"BanBlackIp": true,
"BanByRule": false,
"BanVulIp": true,
"OpenSmartMode": true,
"RequestId": "b76c888e-31cf-4dfe-b40a-0e3d30ee555e",
"ShowTips": false,
"Status": 2
}
}https://cwp.tencentcloudapi.com/?Action=DescribeBanStatus
&<Common request parameters>{
"Response": {
"Status": 1,
"ShowTips": false,
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Parameter error. |
| InvalidParameter.InvalidFormat | InvalidParameter.InvalidFormat |
| InvalidParameter.MissingParameter | InvalidParameter.MissingParameter |
| InvalidParameter.ParsingError | InvalidParameter.ParsingError |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback