Queries IP addresses that are protected by Anti-DDoS Origin Enterprise.

Note Anti-DDoS Origin API operations are available for only Anti-DDoS Origin Enterprise users.

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 DescribePackIpList

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

DdosRegionId String Yes cn-hangzhou

The ID of the region where the Anti-DDoS Origin Enterprise instance resides.
InstanceId String Yes ddosbgp-cn-x1

The ID of the Anti-DDoS Origin Enterprise instance.
PageNo Integer Yes 1

The number of the page to return. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

Ip String No 1.1.1.1

The IP address of the protection target. Returns the details of only the protection target to which the specified IP address points.

ProductName String No ECS

The type of service that is under protection. Valid values:

Note Returns the details of only the protection target to which the specified IP address points.
  • ECS
  • SLB
  • EIP
  • WAF
ResourceGroupId String No test

The ID of the resource group.

Response parameters

Parameter Type Example Description
Code String 200

The response status code.
IpList

The list of IP addresses.
Ip String 1.1.1.1

The IP address that is protected.
Product String ECS

The type of protection target to which the specified IP address points. Valid values:

  • ECS
  • SLB
  • EIP
  • WAF
Remark String test

The remarks about the protection target. For example, remarks about an ECS instance.
Status String normal

The status of the protection target. Valid values:

  • normal: indicates that the protection target is in the running state
  • hole_begin: indicates that the protection target is in the blackhole state
RequestId String B479FE9B-F0EB-423B-81E5-ECE2167BCF40

The ID of the request.
Success Boolean true

Indicates whether the API operation is successfully called.
Total Integer 1

The total number of entries returned.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribePackIpList
&DdosRegionId=cn-hangzhou
&InstanceId=ddosbgp-cn-x1
&PageNo=1
&PageSize=10
& <Common request parameters>

Sample success responses

XML format 

<DescribePackIpListResponse>
     <RequestId>8584D3B6-BB3C-441E-B1D6-E154ED25C032</RequestId>
     <IpList>
           <Ipitem>
                 <Status>normal</Status>
                 <Ip>1.1.1.1</Ip>
                 <Product>ECS</Product>
                 <Remark>test</Remark>
           </Ipitem>
     </IpList>
     <Success>true</Success>
     <Code>200</Code>
     <Total>1</Total>
</DescribePackIpListResponse>

JSON format 

{
	"RequestId": "B479FE9B-F0EB-423B-81E5-ECE2167BCF40",
	"IpList": [
		{
			"IP":"1.1.1.1",
			"Status":"normal",
			"Product":"ECS",
			"Remark": "test"
		}
	],
	"Success":true,
	"Code":"200",
	"Total":1
}

Error codes

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