Updated on 2026-09-10 GMT+08:00

Querying Policy Details

Function

Query policy details.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/cnad/policies/{policy_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

policy_id

Yes

String

Policy ID.

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

id

String

Policy ID.

package_id

String

Instance ID.

name

String

Policy name.

clean_threshold

Integer

Cleaning threshold.

pop_policy

PopPolicy object

Policy threshold details.

Table 4 PopPolicy

Parameter

Type

Description

block_location

Array of strings

List of the restricted locations

block_protocol

Array of strings

Protocol blocking list

bw_list

Bw object

Blacklist/Whitelist details

connection_protection

Boolean

Whether to enable connection protection.

connection_protection_list

Array of strings

Connection protection list

fingerprint_count

Integer

Fingerprints

port_block_count

Integer

Number of blocked ports

watermark_count

Integer

Watermarks

if_exist_traffic

Boolean

Whether traffic exists.

pop

String

Fixed value: ALL

Table 5 Bw

Parameter

Type

Description

black_ip_list

Array of strings

Blacklists

white_ip_list

Array of strings

Whitelists

Example Requests

None

Example Responses

Status code: 200

{
  "clean_threshold" : 120,
  "id" : "798d8975-f7cf-490f-b990-747ebaf41248",
  "name" : "sadf",
  "package_id" : "09b5ae8e-ae05-49ff-80fc-8bdf68c16499",
  "pop_policy" : [ {
    "block_location" : [ ],
    "block_protocol" : [ ],
    "bw_list" : [ {
      "black_ip_list" : [ ],
      "white_ip_list" : [ ]
    } ],
    "connection_protection" : false,
    "connection_protection_list" : [ ],
    "fingerprint_count" : 0,
    "if_exist_traffic" : false,
    "pop" : "ALL",
    "port_block_count" : 0,
    "watermark_count" : 0
  } ]
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.