容器安全服务查询集群网络策略列表-网络安全相关接口-API 中心-腾讯云

1. 接口描述

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

查询集群网络策略列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNetworkFirewallPolicyList。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
ClusterId	是	String	集群id 示例值：cls-test
Offset	否	Integer	偏移量示例值：0
Limit	否	Integer	每次查询的最大记录数量示例值：20
Filters.N	否	Array of ComplianceFilters	Name - String Name 可取值：ClusterName,ClusterId,ClusterType,Region,ClusterCheckMode,ClusterAutoCheck
By	否	String	排序字段
Order	否	String	排序方式 asc,desc 示例值：asc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	集群总数示例值：10
NetPolicy	Array of NetworkPolicyInfoItem	集群的详细信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 策略列表

输入示例

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

{
    "ClusterId": "cls-o9mfjg0i"
}

输出示例

{
    "Response": {
        "RequestId": "0f209045-f906-4ba4-9f61-105b73ecfcc6",
        "TotalCount": 0,
        "NetPolicy": [
            {
                "Id": 1,
                "Name": "backend-ingress-deny",
                "Description": "",
                "PolicySourceType": "System",
                "PodSelector": "new=roopingliu",
                "Namespace": "default",
                "FromPolicyRule": 0,
                "ToPolicyRule": 0,
                "NetworkPolicyPlugin": "KubeRouter",
                "PublishStatus": "PublishedNoConfirm",
                "PublishResult": "",
                "PolicyCreateTime": "2022-05-10 03:04:34"
            },
            {
                "Id": 8,
                "Name": "policy_test_add",
                "Description": "",
                "PolicySourceType": "Manual",
                "PodSelector": "good=labeld",
                "Namespace": "default",
                "FromPolicyRule": 3,
                "ToPolicyRule": 0,
                "NetworkPolicyPlugin": "KubeRouter",
                "PublishStatus": "unPublishEdit",
                "PublishResult": "",
                "PolicyCreateTime": "2022-06-23 05:40:13"
            },
            {
                "Id": 2,
                "Name": "test-network-policy",
                "Description": "",
                "PolicySourceType": "System",
                "PodSelector": "role=db",
                "Namespace": "default",
                "FromPolicyRule": 0,
                "ToPolicyRule": 0,
                "NetworkPolicyPlugin": "KubeRouter",
                "PublishStatus": "PublishedNoConfirm",
                "PublishResult": "",
                "PolicyCreateTime": "2022-06-13 08:33:35"
            }
        ]
    }
}

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. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
OperationDenied	操作被拒绝。
RequestLimitExceeded	请求的次数超过了频率限制。
UnauthorizedOperation	未授权操作。