ListPolicies - 查询策略列表

查询策略列表。

调试

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

授权信息

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

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

请求语法

GET /v1/policies HTTP/1.1

请求参数

名称类型必填描述示例值
withAttachmentsboolean

是否返回挂载信息。

false
attachResourceIdstring

挂载点 id。

api-cq7l5s5lhtgi6qasrdc0
attachResourceTypestring

策略支持挂载点类型。

  • HttpApi:HttpApi。
  • Operation:HttpApi 的 Operation。
  • GatewayRoute:网关路由。
  • GatewayService:网关服务。
  • GatewayServicePort:网关服务端口。
  • Domain:网关域名。
  • Gateway:网关。
HttpApi
environmentIdstring

环境 id。

env-cq7l5s5lhtgi6qasrdc0
gatewayIdstring

网关 id。

gw-cq2fm65lhtgm9nrrl7ag
withSystemPolicyboolean

是否是系统策略。

true

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,用于追溯 API 调用链路。

393E2630-DBE7-5221-AB35-9E740675491A
codestring

响应码。

Ok
messagestring

响应消息。

success
dataobject

响应数据。

pageNumberinteger

页码。

1
pageSizeinteger

每页条数。

10
totalSizeinteger

总条数。

18
itemsarray

策略信息列表。

policyInfoPolicyInfo

策略信息。

示例

正常返回示例

JSON格式

{
  "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",
            "attachResourceIds": [
              "api-cq7l5s5lhtgi6qasrdc0"
            ],
            "attachResourceType": "HttpApi",
            "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
            "gatewayId": "gw-cpr4f9dlhtgq5ksfgmb0"
          }
        ],
        "name": "test-policy",
        "type": "策略类型",
        "executeStage": "PluginPost",
        "executePriority": 310
      }
    ]
  }
}

错误码

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