tencent cloud

Feedback

CheckEdgeClusterCIDR

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

    1. API Description

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

    This API is used to check if the CIDR block of a TKE Edge cluster conflicts with other CIDR blocks.

    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: CheckEdgeClusterCIDR.
    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. This API only supports: ap-beijing, ap-guangzhou, ap-nanjing, ap-shanghai, ap-singapore.
    VpcId Yes String Cluster VPC ID
    PodCIDR Yes String Cluster Pod CIDR block
    ServiceCIDR Yes String Cluster service CIDR block

    3. Output Parameters

    Parameter Name Type Description
    ConflictCode Integer Return code. Valid values:
    -1: Internal error
    0: No conflict
    1: Conflict between VPC and serviceCIDR
    2: Conflict between VPC and podCIDR
    3: Conflict between serviceCIDR and podCIDR
    ConflictMsg String CIDR block conflict description
    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 Checking CIDR block conflict for an edge computing cluster

    Input Example

    https://tke.tencentcloudapi.com/?Action=CheckEdgeClusterCIDR
    &VpcId=vpc-xxx
    &PodCIDR=10.0.1.10/24
    &ServiceCIDR=192.168.0.0/16
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
            "ConflictCode": 0,
            "ConflictMsg": "OK"
        }
    }
    

    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.VpcCommon VPC error.
    InternalError Internal error.
    InternalError.CamNoAuth You do not have permissions.
    InternalError.CidrConflictWithOtherCluster CIDR conflicts with the CIDR of another cluster.
    InternalError.CidrConflictWithOtherRoute CIDR conflicts with another route.
    InternalError.CidrConflictWithVpcCidr CIDR conflicts with VPC.
    InternalError.CidrConflictWithVpcGlobalRoute CIDR conflicts with global route.
    InternalError.CidrInvali Invalid CIDR.
    InternalError.CidrMaskSizeOutOfRange Invalid CIDR mask.
    InternalError.CmdTimeout Command execution timeout.
    InternalError.InvalidPrivateNetworkCidr Invalid CIDR.
    InternalError.UnexceptedInternal Internal error.
    InternalError.VpcCommon VPC error
    InternalError.VpcPeerNotFound Peering connection does not exist
    InternalError.VpcRecodrNotFound VPC record not found
    InternalError.VstationError VstationError.
    InvalidParameter Parameter error.
    InvalidParameter.Param Invalid parameter.
    InvalidParameter.RouteTableNotEmpty Route table is not empty.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    ResourceUnavailable Resource is unavailable
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.