tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeNetworkFirewallPolicyDetail

Last updated: 2024-07-22 11:06:27

    1. API Description

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

    This API is used to view the details of a policy in the container network cluster.

    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: DescribeNetworkFirewallPolicyDetail.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    Id Yes Integer Policy ID

    3. Output Parameters

    Parameter Name Type Description
    ClusterId String Cluster ID
    PolicyName String Policy name
    Namespace String Namespace
    Note: This field may return null, indicating that no valid values can be obtained.
    FromPolicyRule Integer Inbound type
    ToPolicyRule Integer Outbound type
    CustomPolicy Array of NetworkCustomPolicy Custom rule
    Note: This field may return null, indicating that no valid values can be obtained.
    PodSelector String Pod selector
    Description String Policy description
    Note: This field may return null, indicating that no valid values can be obtained.
    PolicyCreateTime String Policy creation time
    PolicySourceType String Policy source type. Valid values: System (synched from the cluster); Manual (added manually).
    NetworkPolicyPlugin String Network plugin of the network policy
    Note: This field may return null, indicating that no valid values can be obtained.
    PublishStatus String Network policy status
    PublishResult String Policy publishing result
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Viewing the details of a policy in the container network cluster

    Input Example

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

{
    "Id": 1
}

    Output Example

    {
    "Response": {
        "PolicyName": "xx",
        "CustomPolicy": [
            {
                "Peer": [
                    {
                        "NamespaceSelector": "xx",
                        "PeerType": "xx",
                        "PodSelector": "xx",
                        "IPBlock": "xx"
                    }
                ],
                "Direction": "xx",
                "Ports": [
                    {
                        "Protocol": "xx",
                        "Port": "xx"
                    }
                ]
            }
        ],
        "Description": "xx",
        "ClusterId": "xx",
        "FromPolicyRule": 0,
        "PublishResult": "xx",
        "Namespace": "xx",
        "NetworkPolicyPlugin": "xx",
        "PodSelector": "xx",
        "PublishStatus": "xx",
        "ToPolicyRule": 0,
        "RequestId": "xx",
        "PolicyCreateTime": "xx",
        "PolicySourceType": "xx"
    }
}

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy