Queries IP addresses in the whitelist of an Anti-DDoS Pro or Anti-DDoS Premium instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAutoCcWhitelist

The operation that you want to perform. Set the value to DescribeAutoCcWhitelist.

InstanceId String Yes ddoscoo-cn-mp91j1ao****

The ID of the instance.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.
PageNumber Integer Yes 1

The number of the page to return. For example, to query the returned results on the first page, set the value to 1.

PageSize Integer Yes 10

The number of entries to return on each page.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
KeyWord String No 138

The keyword for the query. This keyword is used to specify the prefix of the source IP address that you want to query.

Note It must be greater than three characters in length.

Response parameters

Parameter Type Example Description
AutoCcWhitelist Array

Details about the IP address in the whitelist of the instance.

DestIp String 203.***. ***.117

The IP address of the instance.

EndTime Long 0

The validity period of the IP address in the whitelist. Unit: seconds. 0 indicates that the whitelist takes effect all the time.

SourceIp String 2.2.2.2

The IP address in the whitelist.

Type String manual

The mode of how an IP address is added to the whitelist. Valid values:

  • manual: manually added
  • auto: automatically added
RequestId String F09D085E-5E0F-4FF2-B32E-F4A644049162

The ID of the request.

TotalCount Long 2

The total number of returned IP addresses in the whitelist.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAutoCcWhitelist
&InstanceId=ddoscoo-cn-mp91j1ao****
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

<DescribeAutoCcWhitelistResponse>
      <AutoCcWhitelist>
            <Type>manual</Type>
            <SourceIp>4.4.4.4</SourceIp>
            <EndTime>0</EndTime>
            <DestIp>203. ***. ***.117</DestIp>
      </AutoCcWhitelist>
      <AutoCcWhitelist>
            <Type>manual</Type>
            <SourceIp>2.2.2.2</SourceIp>
            <EndTime>0</EndTime>
            <DestIp>203. ***. ***.117</DestIp>
      </AutoCcWhitelist>
      <TotalCount>2</TotalCount>
      <RequestId>F09D085E-5E0F-4FF2-B32E-F4A644049162</RequestId>
</DescribeAutoCcWhitelistResponse>

JSON format

{
    "AutoCcWhitelist": [
        {
            "Type": "manual",
            "SourceIp": "4.4.4.4",
            "EndTime": "0",
            "DestIp": "203. ***. ***.117"
        },
        {
            "Type": "manual",
            "SourceIp": "2.2.2.2",
            "EndTime": "0",
            "DestIp": "203. ***. ***.117"
        }
    ],
    "TotalCount": 2,
    "RequestId": "F09D085E-5E0F-4FF2-B32E-F4A644049162"
}

Error codes

For a list of error codes, visit the API Error Center.