Updated on 2025-07-14 GMT+08:00

Query access policies

Function

Queries an access policy.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/access-policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

access_control_type

No

String

Access control policy type.

  • ACCESS_TYPE: access type

  • IP_WHITE_LIST: IP address whitelist

limit

No

Integer

Number of records on each page. The value ranges from 0 to 100 and defaults to 100.

offset

No

Integer

Offset. The value ranges from 0 to 99 and defaults to 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

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

MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

policies

Array of AccessPolicyDetailInfo objects

Response for querying an access policy.

total

Integer

Total number of policies.

Table 5 AccessPolicyDetailInfo

Parameter

Type

Description

policy_name

String

Policy name.

blacklist_type

String

Blacklist type. Currently, the blacklist supports only the Internet.

  • INTERNET: Internet

access_control_type

String

Access control type, which defaults to ACCESS_TYPE.

  • ACCESS_TYPE: access type

  • IP_WHITE_LIST: IP address whitelist

ip_list

Array of IpInfo objects

IP addresses of a policy.

is_enable

Boolean

Whether the IP address whitelist takes effect. This value can be updated only separately. This value has the highest priority. If this value is transferred, only the policy's activation status will be changed.

is_block_all

Boolean

Whether the IP address whitelist prohibits access from all IP addresses. If is_enable is set to false, this value cannot be changed. This value can be updated only separately.

ip_total_count

Integer

Total number of policies.

policy_id

String

Specifies the policy ID.

create_time

String

Time when a user's OTP device is bound.

Table 6 IpInfo

Parameter

Type

Description

ip_address

String

IP address.

subnet_mask

String

Subnet mask.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

get /v2/{project_id}/access-policy

Example Responses

Status code: 200

Normal.

{
  "policies" : [ {
    "policy_id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "create_time" : "2022-10-24T17:24:56.000+00:00",
    "policy_name" : "PRIVATE_ACCESS",
    "blacklist_type" : "INTERNET"
  } ],
  "total" : 1
}

Status Codes

Status Code

Description

200

Normal.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No operation permission.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details about the error code, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.