Updated on 2026-01-06 GMT+08:00

Querying the AAD Instance List

Function

This API is used to query the AAD instance list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/aad/instances

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

instance_access_type

No

String

Access type. 0: website instance; 1: IP access instance.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

items

Array of Instance objects

items

Table 4 Instance

Parameter

Type

Description

instance_id

String

Instance ID.

instance_name

String

Instance name.

enterprise_project_id

String

Enterprise project ID.

instance_access_type

String

Access type. 0: website instance; 1: IP access instance.

pp_support

Integer

Whether the PP is supported. 1: supported; 0: not supported.

pp_enable

Integer

Whether the PP is enabled. 1: enabled; 0: disabled.

overseas_type

Integer

Protection region. 0: regions in the Chinese mainland. 1: regions outside the Chinese mainland.

vips

Array of InstanceIp objects

Advanced Anti-DDoS IP address information

Table 5 InstanceIp

Parameter

Type

Description

ip

String

ip

isp

String

Line

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Error response

Error Codes

See Error Codes.