ListPolicies - 获取控制策略列表

更新时间:
复制 MD 格式

获取控制策略列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

堡垒机的实例 ID。

说明

您可以调用 DescribeInstances 接口获取该参数。

bastionhost-cn-5yd393wzk08

RegionId

string

堡垒机的区域 ID。

说明

区域 ID 和区域名称的对应关系,请参见地域和可用区

cn-hangzhou

PageNumber

string

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1

PageSize

string

指定分页查询时,每页显示的数据最大条数。
PageSize 参数最大取值为 100。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明

建议 PageSize 取值不要为空。

20

PolicyName

string

指定要查询的控制策略名称。仅支持精确查询。

123

返回参数

名称

类型

描述

示例值

object

Policies

array<object>

控制策略列表。

object

Comment

string

控制策略备注。

Comment

PolicyId

string

控制策略 ID。

2

PolicyName

string

控制策略名称。

test

Priority

integer

控制策略的优先级,数字越小优先级越高。

1

RequestId

string

阿里云为该请求生成的唯一标识符。

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

TotalCount

integer

查询到的控制策略总数量。

10

示例

正常返回示例

JSON格式

{
  "Policies": [
    {
      "Comment": "Comment\t",
      "PolicyId": "2",
      "PolicyName": "test",
      "Priority": 1
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 10
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter The argument is invalid. 参数错误
500 InternalError An unknown error occurred. 未知错误

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

变更历史

更多信息,参考变更详情