文档

DescribePolicyInstances - 查询主控实例关联集群的策略实例

更新时间:

查询主控实例关联集群的策略实例。

调试

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

授权信息

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

请求参数

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

策略治理规则名称。

ACKNoEnvVarSecrets
ClusterIdstring

主控实例 ID。

c102fe5f1ee5d4c87a68121a77d8b****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

5BE4C329-DCC2-5B61-8F66-112B7D7FC712
Policiesobject []

策略实例列表。

PolicyNamestring

策略治理规则名称

ACKPSPCapabilities
InstanceNamestring

规则实例名称。

no-env-var-secrets-****
PolicyCategorystring

策略类型名称。

k8s-general
PolicyDescriptionstring

规则模板描述。

Restricts secrets used in pod envs
PolicySeveritystring

规则实例治理等级。

low
PolicyScopestring

策略实例实施范围:

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

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

*
PolicyActionstring

规则治理动作,取值:

  • deny:拦截违规部署
  • warn:告警
warn
TotalViolationslong

关联集群中当前被拦截和告警两种处理类型下不同治理等级的违规计数。

2
ClusterIdstring

关联集群 ID。

cd0e6882394f7496589837cac3585****
PolicyParametersobject

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

string

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

"restrictedNamespaces": [ "test" ]

示例

正常返回示例

JSON格式

{
  "RequestId": "5BE4C329-DCC2-5B61-8F66-112B7D7FC712",
  "Policies": [
    {
      "PolicyName": "ACKPSPCapabilities",
      "InstanceName": "no-env-var-secrets-****\n",
      "PolicyCategory": "k8s-general\n",
      "PolicyDescription": "Restricts secrets used in pod envs\n",
      "PolicySeverity": "low",
      "PolicyScope": "*",
      "PolicyAction": "warn",
      "TotalViolations": 2,
      "ClusterId": "cd0e6882394f7496589837cac3585****",
      "PolicyParameters": {
        "key": "\"restrictedNamespaces\": [ \"test\" ]\n"
      }
    }
  ]
}

错误码

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