分页查询 vArmor 策略及集群、命名空间、策略类型、启用状态和更新时间;筛选条件不传时查询全部可见策略。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | ListVarmorPolicies | 要执行的操作,取值:ListVarmorPolicies。 |
Version | String | 是 | 2024-05-08 | API的版本,取值:2024-05-08。 |
ClusterName | String | 否 | example-name | 集群名称,支持模糊搜索 可选 |
PageSize | Long | 是 | 20 | 每页记录数,取值范围为 1~5000 |
PolicyName | String | 否 | example-name | 策略名称,支持模糊搜索,可选 |
Region | String | 否 | cn-beijing | 地域ID,可选 |
SortBy | String | 否 | LastHeartbeatTime | 排序字段;不传时使用接口默认排序 |
Status | Array of String | 否 | ["running"] | 策略状态列表,可选 |
TargetWorkload | String | 否 | target-workload-sample | 目标工作负载,可选 |
ClusterID | String | 否 | cluster-id-001 | 集群ID,支持模糊搜索 可选 |
Enforcer | String | 否 | Enforcer | 执行器:Enforcer |
Namespace | String | 否 | example-name | 命名空间,支持模糊搜索 可选 |
PolicyIds | Array of String | 否 | ["policy-id-001"] | 策略id筛选 |
PageNumber | Long | 是 | 1 | 翻页页码,取值范围为 1 及以上 |
PolicyMode | String | 否 | EnhanceProtect | 执行模式:策略模式 |
PolicyType | String | 否 | VarmorPolicy | 策略类型:VarmorPolicy或VarmorClusterPolicy,可选 |
SortOrder | String | 否 | Desc | 排序顺序
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Data | Array of Object | -- | 分页业务数据,具体元素结构见各接口响应声明 |
PageNumber | Long | 1 | 当前页面 |
PageSize | Long | 20 | 页面大小 |
TotalCount | Long | 1 | 全部数据条数 |
POST /?Action=ListVarmorPolicies&Version=2024-05-08 HTTP/1.1 Host: seccenter.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241120T080538Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "ClusterID": "cluster-id-001", "ClusterName": "example-name", "Enforcer": "Enforcer", "Namespace": "example-name", "PageNumber": 1, "PageSize": 20, "PolicyIds": [ "policy-id-001" ], "PolicyMode": "EnhanceProtect", "PolicyName": "example-name", "PolicyType": "VarmorPolicy", "Region": "cn-beijing", "SortBy": "LastHeartbeatTime", "SortOrder": "Desc", "Status": [ "running" ], "TargetWorkload": "target-workload-sample" }
{ "ResponseMetadata": { "RequestId": "20241120165538010234567890", "Action": "ListVarmorPolicies", "Version": "2024-05-08", "Service": "seccenter", "Region": "cn-beijing" }, "Result": { "Data": [ { "ArmorProfileInfo": { "ArmorProfileName": "example-name", "ArmorProfileYaml": "profile: runtime-default", "CurrentNumber": 1, "DesiredNumber": 1, "Enforcer": "AppArmor" }, "ArmorProfileName": "example-name", "ClusterID": "cluster-id-001", "ClusterName": "example-name", "CreatedAt": "created-at-sample", "EnforcementMode": "AlwaysAllow", "ErrorMessage": "example description", "Namespace": "example-name", "PolicyId": "policy-id-001", "PolicyName": "example-name", "PolicyType": "default", "PolicyYAML": "apiVersion: crd.varmor.org/v1beta1, kind: VarmorPolicy", "Region": "cn-beijing", "Status": "Pending" } ], "PageNumber": 1, "PageSize": 20, "TotalCount": 1 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | MissingParameter | 请求参数缺失,请检查参数是否已正确传入。 |
400 | InvalidParameter | 请求参数错误,请检查参数传递内容是否正确。 |
400 | OperationDenied | 不允许的操作,请检查当前资源是否被占用 |
500 | InternalError | 服务器内部错误,请稍后重试或联系技术支持。 |
500 | DBOperateError | 数据库操作异常,请稍后重试或联系技术支持。 |