DescribePolicyInstances - 查询策略实例列表

您可以在ACK集群中选择安全策略类型,配置相关实施动作、作用范围等,创建并部署一个策略实例。您可以调用DescribePolicyInstances接口,获取集群中指定策略规则实例的详细信息,例如策略描述、治理等级等。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribePolicyInstancesget
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

GET /clusters/{cluster_id}/policies HTTP/1.1

请求参数

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

目标集群 ID。

c8155823d057948c69a****
policy_namestring

策略治理规则名称。

ACKPSPCapabilities
instance_namestring

策略实例名称。

allowed-repos-cz4s2

返回参数

名称类型描述示例值
array<object>

策略实例列表。

Instanceobject

策略实例。

ali_uidstring

策略实例实施者 UID。

16298168****
cluster_idstring

目标集群 ID。

c8155823d057948c69a****
instance_namestring

规则实例名称。

no-env-var-secrets-****
policy_namestring

策略治理规则名称。

ACKPSPCapabilities
policy_categorystring

策略类型名称。

k8s-general
policy_descriptionstring

规则模板描述。

Restricts secrets used in pod envs
policy_parametersstring

当前规则实例的配置参数。

"restrictedNamespaces": [ "test" ]
policy_severitystring

规则实例治理等级。

low
policy_scopestring

策略实例实施范围:

默认"*"代表集群所有命名空间。

否则返回作用 Namespaces 名称,多个 Namespaces 以逗号(,)分隔。

*
policy_actionstring

规则治理动作,取值:

  • deny:拦截违规部署。

  • warn:告警。

deny
Createddeprecatedstring

创建时间(已废弃,请勿使用)。

2024-10-29T18:09:12+08:00
Updateddeprecatedstring

更新时间(已废弃,请勿使用)。

2024-10-29T18:09:12+08:00
resource_iddeprecatedstring

资源 ID(已废弃,请勿使用)。

123456***
total_violationsdeprecatedlong

集群中处理违规计数(已废弃,请勿使用)。

0
is_deleteddeprecatedlong

删除状态(已废弃,请勿使用)。

0

示例

正常返回示例

JSON格式

[
  {
    "ali_uid": "16298168****",
    "cluster_id": "c8155823d057948c69a****",
    "instance_name": "no-env-var-secrets-****",
    "policy_name": "ACKPSPCapabilities",
    "policy_category": "k8s-general",
    "policy_description": "Restricts secrets used in pod envs",
    "policy_parameters": "\"restrictedNamespaces\": [ \"test\" ]",
    "policy_severity": "low",
    "policy_scope": "*",
    "policy_action": "deny",
    "Created": "2024-10-29T18:09:12+08:00",
    "Updated": "2024-10-29T18:09:12+08:00",
    "resource_id": "123456***",
    "total_violations": 0,
    "is_deleted": 0
  }
]

错误码

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

变更历史

变更时间变更内容概要操作
2024-10-23OpenAPI 返回结构发生变更查看变更详情