Querying Instances

Function

This API is used to query the instance list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/cnad/packages

Request Parameters

**Table 1** 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 2** Response body parameters
Parameter	Type	Description
total	Integer	Total
items	Array of PackageResponse objects	Data

**Table 3** PackageResponse
Parameter	Type	Description
package_id	String	Instance ID.
package_name	String	Instance name.
region_id	String	Region to which the resource belongs.
protection_type	Integer	Protection type.
instance_type	String	Instance type. 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
resourceId	String	Resource ID.
countDownCode	String	Countdown information.
countDownInfos	String	Countdown information.
countDownTips	String	Countdown information.
orderId	String	Order ID.
subscriptionId	String	Renewal ID.
ip_num	Integer	Number of IP addresses.
ip_num_now	Integer	Current IP addresses.
protection_num_now	Integer	Current protection times.
protection_num	Integer	Protection times. 9999 indicates unlimited protection times.
basic_bandwidth	Integer	Baseline bandwidth.
elastic_bandwidth	Integer	Elastic bandwidth.
service_bandwidth	Integer	Service bandwidth.
clean_bandwidth	Integer	Origin bandwidth
policy_num	Integer	Number of policy templates.
is_old	Boolean	Whether the instance is an old instance (old instances cannot be upgraded). If this parameter is not transferred, the value is no by default.
new_flag	Boolean	Product ID. The value is true for newly purchased products.
create_time	Long	Creation time.

Example Requests

None

Example Responses

Status code: 200

{
  "items" : [ {
    "package_id" : "0c613ff9-2b63-4aa2-9333-e03541fe0d9a",
    "package_name" : "name",
    "region_id" : "cn-north4",
    "protection_type" : 0,
    "instance_type" : "cnad_pro",
    "resourceId" : "0c613ff9-2b63-4aa2-9333-e03541fe0d9a",
    "countDownCode" : "hws_countdown_period_using",
    "countDownInfos" : {
      "status" : 2,
      "nextOperationPolicy" : 0,
      "nextOperationRemainingDay" : 10
    },
    "countDownTips" : {
      "effTime" : "2022-10-09T10:00:17Z",
      "expTime" : "2022-12-09T15:59:59Z"
    },
    "orderId" : "CS2211020327RKFEA",
    "subscriptionId" : "0c613ff9-2b63-4aa2-9333-e03541fe0d9a",
    "ip_num" : 100,
    "ip_num_now" : 100,
    "protection_num_now" : 1,
    "protection_num" : 9999,
    "basic_bandwidth" : 10,
    "elastic_bandwidth" : 200,
    "service_bandwidth" : 100,
    "clean_bandwidth" : 100,
    "policy_num" : 1,
    "is_old" : false,
    "new_flag" : true,
    "create_time" : 1665309611045
  } ],
  "total" : 1
}