1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
容器网络创建网络策略添加任务
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AddNetworkFirewallPolicyDetail。 | 
| Version | 是 | String | 公共参数,本接口取值:2020-11-01。 | 
| Region | 否 | String | 公共参数,此参数为可选参数。 | 
| ClusterId | 是 | String | 集群Id 示例值:cls-new | 
| PolicyName | 是 | String | 策略名 示例值:rptest | 
| FromPolicyRule | 是 | Integer | 入站规则 全部允许:1 全部拒绝 :2 自定义:3 示例值:2 | 
| ToPolicyRule | 是 | Integer | 出站规则 全部允许:1 全部拒绝 :2 自定义:3 示例值:3 | 
| PodSelector | 是 | String | pod选择器 示例值:a=b | 
| Namespace | 否 | String | 命名空间 示例值:default | 
| Description | 否 | String | 策略描述 示例值:describe content | 
| CustomPolicy.N | 否 | Array of NetworkCustomPolicy | 自定义规则 示例值:{"Peer":["unPublishEdit"],"Direction":"FROM","Ports":[{"Protocol":"TCP","Port":"80"}]} | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TaskId | Integer | 返回创建的任务的ID,为0表示创建失败。 示例值:678798 | 
| Result | String | 创建任务的结果,"Succ"为成功,"Failed"为失败 示例值:Succ | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 容器网络创建网络策略添加任务示例
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddNetworkFirewallPolicyDetail
<公共请求参数>
{
    "PolicyName": "test-2",
    "CustomPolicy": [
        {
            "Peer": [],
            "Direction": "FROM",
            "Ports": []
        }
    ],
    "Description": "description1",
    "ClusterId": "cls-fsdfw",
    "FromPolicyRule": 0,
    "Namespace": "default",
    "ToPolicyRule": 0,
    "PodSelector": "a=b"
}输出示例
{
    "Response": {
        "RequestId": "345da107-dfdf-48f0-9796-e6723bdc102e",
        "TaskId": 32501,
        "Result": "Succ"
    }
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| AuthFailure | CAM签名/鉴权错误。 | 
| FailedOperation | 操作失败。 | 
| InternalError | 内部错误。 | 
| InvalidParameter | 参数错误。 | 
| OperationDenied | 操作被拒绝。 | 
| RequestLimitExceeded | 请求的次数超过了频率限制。 | 
| UnauthorizedOperation | 未授权操作。 |