Release Notes

Product Introduction

Overview

Strengths

Use Cases

Features and Versions

Purchase Guide

Applying for Trial

Purchasing Pro Edition

Purchasing Image Scan

Purchasing Log Analysis

Getting Started

Operation Guide

Security Overview

Asset Management

Vulnerability Detection

Image Risk Management

Cluster Risk Management

Baseline Management

Runtime Security

Advanced Defense

Policy Management

Protection Switch

Alarm Settings

Log Analysis

Hybrid Cloud Installation Guide

Compromised Container Isolation

Log Field Data Parsing

Practical Tutorial

Mirror Vulnerability Scanning and Vulnerability Management

Troubleshooting

Offline Linux Client

Troubleshooting for Cluster Access

API Documentation

History

Introduction

API Category

Making API Requests

Network Security APIs

Cluster Security APIs

Security Compliance APIs

Runtime security - High-risk syscalls

Runtime Security - Reverse Shell APIs

Runtime Security APIs

Alert Settings APIs

Advanced prevention - K8s API abnormal requests

Asset Management APIs

Security Operations - Log Analysis APIs

Runtime Security - Trojan Call APIs

Runtime Security - Container Escape APIs

Image Security APIs

Billing APIs

Data Types

Error Codes

FAQs

TCSS Policy

Data Processing And Security Agreement

Glossary

UpdateNetworkFirewallPolicyYamlDetail

PDF

Focus Mode

Font Size

Last updated: 2024-12-06 15:47:48

1. API Description

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

This API is used to create a task to update a YAML 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: UpdateNetworkFirewallPolicyYamlDetail.
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
Yaml	No	String	Base64-encoded NetworkPolicy YAML string
Description	No	String	Policy description

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 a YAML network policy in the container network

Input Example

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

{
    "Description": "xx",
    "ClusterId": "xx",
    "Id": 1,
    "Yaml": "xxx"
}

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

Tencent Cloud CLI 3.0

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.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Tencent Container Security Service