ModifyAssistantCidr

Last updated: 2021-05-12 10:21:05

1. API Description

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

This API (ModifyAssistantCidr) is used to batch modify (e.g. add and delete) secondary CIDR blocks. (To use this API that is in Beta, please submit a ticket.)

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: ModifyAssistantCidr.
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 Array of the secondary CIDR blocks to be added, such as ["10.0.0.0/16", "172.16.0.0/16"]. Either or both of NewCidrBlocks and OldCidrBlocks must be specified.
OldCidrBlocks.N No Array of String Array of the secondary CIDR blocks to be deleted, such as ["10.0.0.0/16", "172.16.0.0/16"]. Either or both of NewCidrBlocks and OldCidrBlocks must be specified.

3. Output Parameters

Parameter Name Type Description
AssistantCidrSet Array of AssistantCidr A set of secondary CIDR blocks.
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying a secondary CIDR block

This example shows you how to add a secondary CIDR block: 172.16.1.0/24.

Input Example

https://vpc.tencentcloudapi.com/?Action=ModifyAssistantCidr
&VpcId=vpc-12345678
&NewCidrBlocks.0=172.16.0.0/24
&<Common request parameters>

Output Example

{
  "Response": {
    "AssistantCidrSet": [
      {
        "VpcId": "vpc-12345678",
        "CidrBlock": "172.16.0.0/24",
        "AssistantType": 0,
        "SubnetSet": [
          {
            "VpcId": "vpc-12345678",
            "SubnetId": "subnet-12345678",
            "SubnetName": "xxx",
            "CidrBlock": "10.0.4.0/24",
            "Ipv6CidrBlock": "",
            "IsDefault": false,
            "IsRemoteVpcSnat": false,
            "EnableBroadcast": false,
            "Zone": "xx",
            "RouteTableId": "rtb-xx",
            "NetworkAclId": "",
            "TotalIpAddressCount": "xx",
            "AvailableIpAddressCount": "xx",
            "CreatedTime": "xxxx-xx-xx xx:xx:xx",
            "TagSet": []
          }
        ]
      }
    ],
    "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
  }
}

Example2 Adding and deleting secondary CIDR blocks

This example shows you how to add a secondary CIDR block 172.16.1.0/24 while deleting 172.16.0.0/24.

Input Example

https://vpc.tencentcloudapi.com/?Action=ModifyAssistantCidr
&VpcId=vpc-12345678
&NewCidrBlocks.0=172.16.1.0/24
&OldCidrBlocks.0=172.16.0.0/24
&<Common request parameters>

Output Example

{
  "Response": {
    "AssistantCidrSet": [
      {
        "VpcId": "vpc-12345678",
        "CidrBlock": "172.16.1.0/24",
        "AssistantType": 0,
        "SubnetSet": [
          {
            "VpcId": "vpc-12345678",
            "SubnetId": "subnet-12345678",
            "SubnetName": "xxx",
            "CidrBlock": "10.0.4.0/24",
            "Ipv6CidrBlock": "",
            "IsDefault": false,
            "IsRemoteVpcSnat": false,
            "EnableBroadcast": false,
            "Zone": "xx",
            "RouteTableId": "rtb-xx",
            "NetworkAclId": "",
            "TotalIpAddressCount": "xx",
            "AvailableIpAddressCount": "xx",
            "CreatedTime": "xxxx-xx-xx xx:xx:xx",
            "TagSet": []
          }
        ]
      }
    ],
    "RequestId": "6aa316a4-07d2-4355-b87d-40b7f22972b0"
  }
}

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 Incorrect 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.
InvalidParameterValue.VpcCidrConflict Destination IP address range conflicts with CIDR of the current VPC.
LimitExceeded Quota limit is reached.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.