ListPolicyClasses - 获取策略模板_API 网关(API Gateway)-阿里云帮助中心

ListPolicyClasses。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apig:ListPolicyClasses	none	全部资源 ``	无	无

请求语法

GET /v1/policy-classes HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
type	string	否	策略模板类型。	FlowControl
direction	string	否	策略出入站方向。出站：OutBound。入栈：InBound。双方向：Both。	InBound
attachResourceType	string	否	策略支持挂载点类型。 HttpApi：HttpApi。 Operation：HttpApi 的 Operation。 GatewayRoute：网关路由。 GatewayService：网关服务。 GatewayServicePort：网关服务端口。 Domain：网关域名。 Gateway：网关。	Operation
pageNumber	integer	否	页码，默认 1	1
pageSize	integer	否	分页大小	10

返回参数

名称	类型	描述	示例值
	object	返回结构体。
requestId	string	请求 ID。	23B45FA9-7208-5E55-B5CE-B6B2567DD822
code	string	响应码。	Ok
message	string	响应消息。	success
data	object	策略模板信息。
pageNumber	integer	页码。	1
pageSize	integer	分页大小。	10
totalSize	integer	总条数。	10
items	array	策略模板列表。
policyClassInfo	PolicyClassInfo	策略模板信息。

示例

正常返回示例

JSON格式

{
  "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": "{}"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。