ListPolicyClasses Overview for AI Gateway Policy Templates - AI Gateway - Alibaba Cloud - API Gateway

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:ListPolicyClasses

none

*All Resource

*

None

Request syntax

GET /v1/policy-classes HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
type	string	No	The policy templatetype.	FlowControl
direction	string	No	The direction of the policy. Valid values: OutBound: outbound. InBound: inbound. Both: both directions.	InBound
attachResourceType	string	No	The type of resource that the policy can be attached to. Valid values: HttpApi: HttpApi. Operation: an operation of HttpApi. GatewayRoute: gateway route. GatewayService: gateway service. GatewayServicePort: gateway service port. Domain: gateway domain name. Gateway: gateway.	Operation
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page.	10
attachResourceId	string	No	The ID of the attached resource.	route-001
gatewayId	string	No	The gateway ID.	gw-001

Response elements

Element	Type	Description	Example
	object	The response struct.
requestId	string	The request ID.	23B45FA9-7208-5E55-B5CE-B6B2567DD822
code	string	The response code.	Ok
message	string	The response message.	success
data	object	The policy template information.
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	10
totalSize	integer	The total number of entries.	10
items	array	The list of policy templates.
	PolicyClassInfo	The policy template information.

Examples

Success response

JSON format

{
  "requestId": "23B45FA9-7208-5E55-B5CE-B6B2567DD822",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": [
      {
        "classId": "pc-cpqm0s94ckt1displ8ng",
        "name": "ConcurrencyLimit",
        "alias": "并发控制",
        "version": "1.0.0",
        "description": "通过控制并发线程数以保证系统的稳定性。适用于应用内部或下游依赖出现不稳定的场景，例如慢SQL、下游应用响应时间变长等。",
        "type": "FlowControl",
        "direction": "InBound",
        "attachableResourceTypes": [
          "Gateway"
        ],
        "executeStage": "POST",
        "executePriority": "1",
        "enableLog": true,
        "deprecated": false,
        "configExample": "{}"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.