Querying the List of Protected Objects That Can Be Bound

Function

Querying the list of protected objects that can be bound

Calling Method

For details, see Calling APIs.

URI

GET /v1/cnad/packages/{package_id}/unbound-protected-ips

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
package_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Query offset. The default value is 0.
limit	No	Integer	Number of items displayed on each page. The default value is 2000.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	Content-Type

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total
ips	Array of ProtectedIpResponse objects	Protected IP address list

**Table 5** ProtectedIpResponse
Parameter	Type	Description
id	String	Protection IP address ID
ip	String	Protection IP addresses.
type	String	Type. VPN, NAT, VIP, CCI, EIP, ELB, REROUTING_IP, SubEni, and NetInterFace.
name	String	Name
status	Integer	Status. The options are 0 (normal), 1 (cleaning), and 2 (blackhole).
status_detail	IpStatusDetail object	Blocking information
policy_name	String	Policy name.
region	String	Region.
package_id	String	Instance ID.
package_name	String	Instance name
tags	String	TMS tags.
tag	String	Local tag.
is_resale	Boolean	The default value is false, indicating whether the IP address is a resale IP address. Policies and reports modules should not be displayed.
package_version	String	package_version. cnad_pro: CNAD Unlimited Protection Basic Edition; cnad_ip: CNAD Standard Edition; cnad_full_high: CNAD Unlimited Protection Advanced Edition; cnad_v2: CNAD Native Protection 2.0; cnad_vic: CNAD Pay-per-Use Edition

**Table 6** IpStatusDetail
Parameter	Type	Description
block_time	Long	Blocking time
unblock_time	Long	Unblocking time

Example Requests

None

Example Responses

Status code: 200

{
  "ips" : [ {
    "id" : "2b93b3ed-7aed-4b73-be77-d04318cbda5e",
    "ip" : "100.85.112.111",
    "is_resale" : false,
    "tags" : "{}",
    "type" : "EIP"
  } ],
  "total" : 1
}