tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CheckAssistantCidr

Last updated: 2024-11-25 20:07:27

    1. API Description

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

    This API is used to check whether the secondary CIDR block conflicts with existing routes, peering connections (peer VPC CIDR blocks), and other resources.

    • Check whether the secondary CIDR block overlaps with the primary/secondary CIDR block of the current VPC.
    • Check whether the secondary CIDR block overlaps with the routing destination of the current VPC.
    • If the current VPC is used in a peering connection, check whether the secondary CIDR block overlaps with the primary/secondary CIDR block of the peer VPC.

    A maximum of 100 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: CheckAssistantCidr.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    VpcId Yes String VPC instance ID, e.g. vpc-6v2ht8q5.
    NewCidrBlocks.N No Array of String Load CIDR blocks to add. CIDR block set; format: e.g. ["10.0.0.0/16", "172.16.0.0/16"]
    OldCidrBlocks.N No Array of String Load CIDR blocks to delete. CIDR block set; Format: e.g. ["10.0.0.0/16", "172.16.0.0/16"]

    3. Output Parameters

    Parameter Name Type Description
    ConflictSourceSet Array of ConflictSource Array of conflict resources.
    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 secondary CIDR block conflicts

    In this example, the secondary CIDR block conflicts with the existing VPC information.

    Input Example

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

{
    "VpcId": "vpc-12345678",
    "NewCidrBlocks": [
        "172.16.0.0/24"
    ]
}

    Output Example

    {
    "Response": {
        "ConflictSourceSet": [
            {
                "ConflictSourceId": "vpcd-122d5678",
                "SourceItem": "172.16.0.0/16",
                "ConflictItemSet": [
                    {
                        "ConfilctId": "vpc-12345678",
                        "DestinationItem": "172.16.0.0/24"
                    }
                ]
            }
        ],
        "RequestId": "e906fed4-29ew-44ba-a240-f5bde9fd84c7"
    }
}

    Example2 Checking secondary CIDR block conflicts-2

    In this example, the secondary CIDR block does not conflict with the existing VPC information.

    Input Example

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

{
    "VpcId": "vpc-12345678",
    "NewCidrBlocks": [
        "172.16.0.0/24"
    ]
}

    Output Example

    {
    "Response": {
        "ConflictSourceSet": [],
        "RequestId": "e906fed4-292c-44ba-a240-f5bde9fd84c7"
    }
}

    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
    InvalidParameterValue The parameter value is invalid.
    InvalidParameterValue.Duplicate The input parameter already exists.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    InvalidParameterValue.SubnetConflict Subnet CIDR conflict.
    LimitExceeded Quota limit is reached.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy