tencent cloud

Feedback

DescribeVpcCniPodLimits

Last updated: 2024-11-14 14:52:55

    1. API Description

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

    This API is used to query the maximum number of Pods in the VPC-CNI network mode supported by the models in the specified availability zone of the current user and region.

    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: DescribeVpcCniPodLimits.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Zone No String The availability zone of the model to query, for example, ap-guangzhou-3. This field is left empty by default, that is, do not filter by the availability zone.
    InstanceFamily No String The instance family to query, for example, S5. This field is left empty by default, that is, do not filter by the instance family.
    InstanceType No String The instance model to query, for example, S5.LARGE8. This field is empty by default, that is, do not filter by instance type.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of the models
    Note: this field may return null, indicating that no valid value can be obtained.
    PodLimitsInstanceSet Array of PodLimitsInstance The model information and the maximum supported number of Pods in the VPC-CNI mode
    Note: this field may return null, indicating that no valid value 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 Querying the number of Pods in VPC-CNI mode supported by the S5 instance family in Guangzhou Zone 3

    Input Example

    https://tke.tencentcloudapi.com/?Action=DescribeVpcCniPodLimits
    &Zone=ap-guangzhou-3,
    &InstanceFamily=S5,
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "TotalCount": 4,
            "PodLimitsInstanceSet": [
                {
                    "Zone": "ap-guangzhou-3",
                    "InstanceFamily": "S5",
                    "InstanceType": "S5.SMALL2",
                    "PodLimits": {
                        "TKERouteENINonStaticIP": 60,
                        "TKERouteENIStaticIP": 59,
                        "TKEDirectENI": 1
                    }
                },
                {
                    "Zone": "ap-guangzhou-3",
                    "InstanceFamily": "S5",
                    "InstanceType": "S5.SMALL4",
                    "PodLimits": {
                        "TKERouteENINonStaticIP": 60,
                        "TKERouteENIStaticIP": 59,
                        "TKEDirectENI": 1
                    }
                },
                {
                    "Zone": "ap-guangzhou-3",
                    "InstanceFamily": "S5",
                    "InstanceType": "S5.MEDIUM4",
                    "PodLimits": {
                        "TKERouteENINonStaticIP": 60,
                        "TKERouteENIStaticIP": 59,
                        "TKEDirectENI": 3
                    }
                },
                {
                    "Zone": "ap-guangzhou-3",
                    "InstanceFamily": "S5",
                    "InstanceType": "S5.MEDIUM8",
                    "PodLimits": {
                        "TKERouteENINonStaticIP": 60,
                        "TKERouteENIStaticIP": 59,
                        "TKEDirectENI": 3
                    }
                }
            ],
            "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
        }
    }
    

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.Db DB error.
    InternalError.Param Parameter error.
    InternalError.UnexceptedInternal Internal error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter Parameter error.
    InvalidParameter.Param Invalid parameter.
    MissingParameter Missing parameter.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.