容器服务查询opa策略列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

查询opa策略列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeOpenPolicyList。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：cls-abcd1234
Category	否	String	策略分类基线：baseline 优选：priority 可选：optional 示例值：baseline

3. 输出参数

参数名称	类型	描述
OpenPolicyInfoList	Array of OpenPolicyInfo	策略信息列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询策略列表

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOpenPolicyList
<公共请求参数>

{
    "ClusterId": "cls-gzzr1v5t",
    "Category": "baseline"
}

输出示例

{
    "Response": {
        "OpenPolicyInfoList": [
            {
                "EnforcementAction": "deny",
                "EventNums": 0,
                "Kind": "blockclusterdeletion",
                "Name": "block-cluster-deletion-rule",
                "PolicyCategory": "cluster",
                "PolicyDesc": "集群中存在任意节点（普通节点、原生节点、注册节点），需先下线节点后方可删除",
                "PolicyName": "存在节点的集群不允许删除"
            },
            {
                "EnforcementAction": "dryrun",
                "EventNums": 0,
                "Kind": "blocknamespacedeletion",
                "Name": "block-namespace-deletion-rule",
                "PolicyCategory": "namespace",
                "PolicyDesc": "命名空间内如果存在pod、service、ingress、pvc，需清空上述资源后方可删除",
                "PolicyName": "存在workload、服务与路由、存储对象的命名空间不允许删除"
            },
            {
                "EnforcementAction": "dryrun",
                "EventNums": 0,
                "Kind": "blockcrddeletion",
                "Name": "block-crd-deletion-rule",
                "PolicyCategory": "configuration",
                "PolicyDesc": "crd定义的apiversion下如果有创建cr资源，则清空cr后方可删除crd",
                "PolicyName": "存在cr的crd不允许删除"
            },
            {
                "EnforcementAction": "dryrun",
                "EventNums": 0,
                "Kind": "blockpvdeletion",
                "Name": "block-pv-deletion-rule",
                "PolicyCategory": "storage",
                "PolicyDesc": "pv如果处于bound状态，则不允许被删除",
                "PolicyName": "绑定状态的pv不允许删除"
            },
            {
                "EnforcementAction": "dryrun",
                "EventNums": 0,
                "Kind": "blockservicewithingressdeletion",
                "Name": "block-service-with-ingress-deletion-rule",
                "PolicyCategory": "network",
                "PolicyDesc": "ingress-controller前端svc，如果存在ingress配置，则svc不允许删除",
                "PolicyName": "应用了ingress规则的svc不允许删除"
            }
        ],
        "RequestId": "224782f1-c990-4383-8f21-bb369c9ca396"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。