tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBasicDeviceStatus

Last updated: 2024-07-01 14:42:48

1. API Description

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

This API is used to querying the status of Anti-DDoS IP.

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: DescribeBasicDeviceStatus.
Version Yes String Common Params. The value used for this API: 2020-03-09.
Region No String Common Params. This parameter is not required for this API.
IpList.N No Array of String List of IP resources
IdList.N No Array of String
FilterRegion No Integer
CnameWafIdList.N No Array of String

3. Output Parameters

Parameter Name Type Description
Data Array of KeyValue Status of the specified Anti-DDoS resource. Valid values:
1: The IP is blocked.
2: The P is normal.
3: The IP is being attacked.
CLBData Array of KeyValue
CnameWafData Array of KeyValue
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 get basic protect status

get basic protect status

Input Example

POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBasicDeviceStatus
<Common request parameters>

{
    "IpList": [
        "abc"
    ],
    "IdList": [
        "abc"
    ],
    "FilterRegion": 1
}

Output Example

{
    "Response": {
        "Data": [
            {
                "Key": "abc",
                "Value": "abc"
            }
        ],
        "CLBData": [
            {
                "Key": "abc",
                "Value": "abc"
            }
        ],
        "CnameWafData": [
            {
                "Key": "1.1.1.1",
                "Value": "1"
            }
        ],
        "RequestId": "abc"
    }
}

Example2 Querying the status of an Anti-DDoS IP

Input Example

POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBasicDeviceStatus
<Common request parameters>

{
    "IpList": [
        "127.0.0.1"
    ]
}

Output Example

{
    "Response": {
        "Data": [
            {
                "Key": "1.1.1.1",
                "Value": "1"
            }
        ],
        "RequestId": "8f7a9451-2372-4a88-a69d-9868b8991076"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy