ListAccessControlPolicies--云堡垒机-火山引擎

文档中心

立即注册

导航

ListAccessControlPolicies

最近更新时间：2025.05.23 17:57:33首次发布时间：2023.12.15 10:45:22

获取指定实例的访问控制策略列表，可根据策略名称关键字查询云堡垒机的访问控制策略列表，并且能够按字段进行排序。

请求说明

请求方式：POST
请求地址：https://vbh.{RegionID}.volcengineapi.com/?Action=ListAccessControlPolicies&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListAccessControlPolicies	接口名称。当前 API 的名称为 `ListAccessControlPolicies`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	2	分页查询时每页显示的记录数。最小值：1 最大值：100 默认值：10
Filter	Object of PolicyFilter	否	{"Keyword": "word"}	过滤条件。
InstanceId	String	是	vbh-14****0042-bhjml9w7	云堡垒机实例 ID。
OrderBy	Object of OrderBy	否	{"Key": "some key", "Desc": true}	排序条件。

PolicyFilter

参数	类型	是否必选	示例值	描述
Keyword	String	否	test	模糊查询参数名称

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	否	key	字段
Desc	Boolean	否	true or false	倒序

请求示例

POST https://vbh.{RegionID}.volcengineapi.com/?Action=ListAccessControlPolicies&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 2,
    "Filter": {
        "Keyword": "policy"
    },
    "InstanceId": "vbh-14****0042-bhjml9w7",
    "OrderBy": {
        "Key": "Name",
        "Desc": true
    }
}

返回参数

参数	类型	示例值	描述
Items	Array of AccessControlPolicy	[{"Id":"8926e78f-59d5-402c-9919-7fca42df8549","Name":"test","Priority":1,"Effect":"Deny","Ips":["0.0.0.1"],"TimeRange":[0,0,0,0,0,0,0],"FileManager":127,"RdpFlag":0}]	策略信息列表。
TotalCount	Long	2	返回数据列表的总量。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	每页显示的数量。

AccessControlPolicy

参数	类型	示例值	描述
Id	String	id	ID
CreatedAt	String	2022-12-12 22:22:22	创建时间
UpdatedAt	String	2022-12-12 22:22:22	修改时间
Name	String	test	策略名称
Description	String	description	策略描述
Priority	Integer	1	优先级
Kind	Integer	1	IP限制类型
Ips	Array of String	["2.2.2.2"]	IP列表
FileManager	Array of String	["READ"]，取值可为 "DOWNLOAD"、"UPLOAD"、"RENAME"、"DELETE"、"READ"、"WRITE"、"WRITE_DIRECTORY"。	文件管理
RdpFlag	Array of String	["COPY"]，可取值为"DOWNLOAD"、"UPLOAD"、"PASTE"、"COPY	RDP 控制策略
TimeRange	Array of String	[[true,false]]	登陆时间段限制
UserCount	Integer	2	关联用户数量
UserGroupCount	Integer	2	关联用户组数量
InstanceId	String	vbh-1400000042-m2bkmjcc	关联堡垒机Id
TimeRangeKind	Integer	0	登陆时间段限制类型

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListAccessControlPolicies",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "7f****fc-c0b7-11ec-b792-e*****1bf10a",
                "CreatedAt": "2023-09-12 10:34:30",
                "UpdatedAt": "2023-09-12 10:34:30",
                "Name": "policy-mlt",
                "Description": "This is a description",
                "Priority": ,
                "Kind": 1,
                "Ips": ["192.168.3.123"],
                "FileManager": ,
                "RdpFlag": ,
                "TimeRange": [[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false],[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false],[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false],[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false],[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false],[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false],[true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,true,false]],
                "UserCount": 2,
                "UserGroupCount": 2,
                "InstanceId": "vbh-14****0042-wdk****z"
            }
        ],
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。