查询策略列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:ListPolicies |
none |
*全部资源
|
无 | 无 |
请求语法
GET /v1/policies HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| withAttachments |
boolean |
否 |
是否返回挂载信息。 |
false |
| attachResourceId |
string |
否 |
挂载点 id。 |
api-cq7l5s5lhtgi6qasrdc0 |
| attachResourceType |
string |
否 |
策略支持挂载点类型。
|
HttpApi |
| environmentId |
string |
否 |
环境 id。 |
env-cq7l5s5lhtgi6qasrdc0 |
| gatewayId |
string |
否 |
网关 id。 |
gw-cq2fm65lhtgm9nrrl7ag |
| withSystemPolicy |
boolean |
否 |
是否是系统策略。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 id，用于追溯 API 调用链路。 |
393E2630-DBE7-5221-AB35-9E740675491A |
| code |
string |
响应码。 |
Ok |
| message |
string |
响应消息。 |
success |
| data |
object |
响应数据。 |
|
| pageNumber |
integer |
页码。 |
1 |
| pageSize |
integer |
每页条数。 |
10 |
| totalSize |
integer |
总条数。 |
18 |
| items |
array |
策略信息列表。 |
|
| PolicyInfo |
策略信息。 |
示例
正常返回示例
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",
"attachResourceId": "",
"attachResourceType": "HttpApi",
"environmentId": "env-cq7l5s5lhtgi6qasrdc0",
"gatewayId": "gw-cpr4f9dlhtgq5ksfgmb0",
"attachResourceIds": [
"api-cq7l5s5lhtgi6qasrdc0"
],
"attachResourceParentIds": [
""
]
}
],
"name": "test-policy",
"type": "策略类型",
"executeStage": "PluginPost",
"executePriority": "310"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。