tencent cloud

All product documents
APIs
ConfigureChcAssistVpc
Last updated: 2024-11-27 10:20:37
ConfigureChcAssistVpc
Last updated: 2024-11-27 10:20:37

1. API Description

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

This API is used to configure the out-of-band network and deployment network of a CHC host.

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: ConfigureChcAssistVpc.
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.
ChcIds.N Yes Array of String CHC host IDs
BmcVirtualPrivateCloud Yes VirtualPrivateCloud Out-of-band network information
BmcSecurityGroupIds.N No Array of String Out-of-band network security group list
DeployVirtualPrivateCloud No VirtualPrivateCloud Deployment network information
DeploySecurityGroupIds.N No Array of String Deployment network security group list

3. Output Parameters

Parameter Name Type 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 Configuring the out-of-band network and deployment network of a CHC

This example shows you how to configure the out-of-band network and deployment network of a CHC host.

Input Example

GET https://cvm.intl.tencentcloudapi.com/?Action=ConfigureChcAssistVpc
&ChcIds.0=chc-1a2b3c4d
&ChcIds.1=chc-adf34aft
&BmcVirtualPrivateCloud.SubnetId="subnet-12345678"
&BmcVirtualPrivateCloud.VpcId="vpc-12345678"
&BmcVirtualPrivateCloud.PrivateIpAddresses.0=10.0.0.2
&BmcVirtualPrivateCloud.PrivateIpAddresses.1=10.0.0.3
&BmcSecurityGroupIds.0=sg-12345678
&DeployVirtualPrivateCloud.SubnetId="subnet-1234abcd"
&DeployVirtualPrivateCloud.VpcId="vpc-1234abcd8"
&DeployVirtualPrivateCloud.PrivateIpAddresses.0=10.0.1.2
&DeployVirtualPrivateCloud.PrivateIpAddresses.1=10.0.1.3
&DeploySecurityGroupIds.0=sg-8a7f6d5s
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
    }
}

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
AccountQualificationRestrictions Your account failed the qualification verification.
InvalidHost.NotSupported The specified operation on this CDH instance is not support .
InvalidInstance.NotSupported This instance is not supported.
InvalidParameter A parameter error occurred.
InvalidParameterValue.AmountNotEqual The number of request parameters are not equal.
InvalidParameterValue.ChcHostsNotFound Corresponding CHC hosts not found.
InvalidParameterValue.IPAddressMalformed Invalid IP format
InvalidParameterValue.IncorrectFormat Incorrect request parameter format.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
InvalidParameterValue.MustDhcpEnabledVpc The parameter value must be a DHCP-enabled VPC.
InvalidParameterValue.SubnetIdMalformed Invalid subnet ID. Please provide a subnet ID in the format of subnet-xxxxxxxx, where “x” can be a lowercase letter or number.
LimitExceeded.VpcSubnetNum Insufficient subnet IPs.
VpcAddrNotInSubNet The VPC IP address is not in the subnet.
VpcIpIsUsed The VPC IP address is already occupied.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon