CheckAssistantCidr

Last updated: 2020-06-24 12:18:55

1. API Description

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

This API (CheckAssistantCidr) is used to check overlapping of a secondary CIDR block with inventory routing, peering connection (opposite VPC CIDR block), and any other resources. If an overlap is present, the overlapped resources are returned. (To use this API that is in Beta, please submit a ticket.)

  • Check whether the secondary CIDR block overlaps with a primary or secondary CIDR block of the current VPC.
  • Check whether the secondary CIDR block overlaps with the routing destination of the current VPC.
  • Check whether the secondary CIDR block is peer-connected to the current VPC, and whether it overlaps with a main or secondary CIDR block of the opposite VPC.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CheckAssistantCidr.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. 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
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Checks secondary CIDR block conflicts

CIDR block does not conflict with the existing VPC information.

Input Example

https://vpc.tencentcloudapi.com/?Action=CheckAssistantCidr
&Version=2017-03-12
&VpcId=vpc-12345678
&NewCidrBlocks.0=172.16.0.0/24
&<Common request parameter>

Output Example

{
  "Response": {
    "ConflictSourceSet": [
      {
        "ConflictSourceId": "vpc-12345678",
        "SourceItem": "172.16.0.0/24",
        "ConflictItemSet": [
          {
            "ConflictId": "pcx-12345678",
            "DestinationItem": "172.16.0.0/16"
          }
        ]
      }
    ],
    "RequestId": "6e57b8db-4307-4135-b513-8c3d0e12aa4e"
  }
}

Example2 Checks secondary CIDR block conflicts-2

CIDR block conflicts with the existing VPC information.

Input Example

https://vpc.tencentcloudapi.com/?Action=CheckAssistantCidr
&Version=2017-03-12
&VpcId=vpc-12345678
&NewCidrBlocks.0=172.16.0.0/24
&<Common request parameter>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Invalid parameter value
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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help