Queries an access policy.

Function

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
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	Yes	String	User token. It can be obtained by calling the IAM API that is 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. This parameter is valid only for access through Direct Connect. PRIVATE_ACCESS: access through Direct Connect
blacklist_type	String	Blacklist type. The value can only be Internet. INTERNET: Internet
policy_id	String	Policy ID.
create_time	String	Time when a user's OTP device is bound.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

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	You do not have required permissions.
404	No resource 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	The service is unavailable.