ListPolicies-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:ListPolicies

none

*All Resource

*

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 elements

Element	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	The details of a policy.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.