ListPolicies - API Gateway - Alibaba Cloud Documentation Center

Queries policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apig:ListPolicies	none	All Resources ``	none	none

Request syntax

GET /v1/policies HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
withAttachments	boolean	No	Specifies whether to return attachment information.	false
attachResourceId	string	No	The attachment point ID.	api-cq7l5s5lhtgi6qasrdc0
attachResourceType	string	No	The types of attachment points supported by the policy. Valid values: HttpApi Operation GatewayRoute GatewayService GatewayServicePort Domain Gateway	HttpApi
environmentId	string	No	The environment ID.	env-cq7l5s5lhtgi6qasrdc0
gatewayId	string	No	The gateway ID.	gw-cq2fm65lhtgm9nrrl7ag
withSystemPolicy	boolean	No	Specifies whether it is a system policy.	true

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID for API call tracing.	393E2630-DBE7-5221-AB35-9E740675491A
code	string	The status code.	Ok
message	string	The status message.	success
data	object	The response payload.
pageNumber	integer	The page number.	1
pageSize	integer	The page size.	10
totalSize	integer	The total number of entries returned.	18
items	array	The list of policies.
policyInfo	PolicyInfo	The details of a policy.

Examples

Sample success responses

JSONformat

{
  "requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 18,
    "items": [
      {
        "policyId": "p-cq7l5s5lhtgi6qasrdc0",
        "direction": "InBound",
        "className": "",
        "classAlias": "",
        "config": {
          "enable": false
        },
        "attachments": [
          {
            "policyAttachmentId": "pr-cq7l5s5lhtgi6qasrdc0",
            "attachResourceIds": [
              "api-cq7l5s5lhtgi6qasrdc0"
            ],
            "attachResourceType": "HttpApi",
            "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
            "gatewayId": "gw-cpr4f9dlhtgq5ksfgmb0"
          }
        ],
        "name": "test-policy",
        "type": "",
        "executeStage": "PluginPost",
        "executePriority": 310
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.