tencent cloud

UpdateAndPublishNetworkFirewallPolicyDetail
Download PDF
Last updated: 2024-12-06 15:47:50
UpdateAndPublishNetworkFirewallPolicyDetail
Last updated: 2024-12-06 15:47:50
Download PDF

1. API Description

Domain name for API request: tcss.intl.tencentcloudapi.com.

This API is used to create a task to update and publish a network policy in the container network.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: UpdateAndPublishNetworkFirewallPolicyDetail.
Version Yes String Common Params. The value used for this API: 2020-11-01.
Region No String Common Params. This parameter is not required.
ClusterId Yes String Cluster ID
Id Yes Integer Policy ID
FromPolicyRule Yes Integer Inbound rule

1: Allow all.

2: Reject all.

3: Custom.
ToPolicyRule Yes Integer Outbound rule

1: Allow all.

2: Reject all.

3: Custom.
PodSelector Yes String Pod selector
Namespace No String Namespace
Description No String Policy description
CustomPolicy.N No Array of NetworkCustomPolicy Custom rule

3. Output Parameters

Parameter Name Type Description
TaskId Integer ID of the created task. 0 indicates that the creation failed.
Result String Result of creating the task. Valid values: Succ, Failed.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating a task to update and publish a network policy in the container network

Input Example

POST / HTTP/1.1
Host: tcss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateAndPublishNetworkFirewallPolicyDetail
<Common request parameters>

{
    "Id": 22,
    "CustomPolicy": [
        {
            "Peer": "xx",
            "Direction": "xx",
            "Ports": "xx"
        }
    ],
    "Description": "xx",
    "ClusterId": "xx",
    "FromPolicyRule": 0,
    "Namespace": "xx",
    "ToPolicyRule": 0,
    "PodSelector": "xx"
}

Output Example

{
    "Response": {
        "RequestId": "345da107-dfdf-48f0-9796-e6723bdc102e",
        "TaskId": 32501,
        "Result": "Succ"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure A CAM signature/authentication error occurred.
FailedOperation The operation failed.
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
OperationDenied The operation was denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
UnauthorizedOperation The operation is unauthorized.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback