1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (CreateAndAttachNetworkInterface) is used to create ENIs and bind CVMs.
- When creating an ENI, you can specify a private IP and can designate a primary IP. The specified private IP must be within the subnet of the ENI and not already in use.
- When creating an ENI, you can specify the number of private IPs to apply for, and the system will generate private IP addresses randomly.
- There is a limit to the number of IP addresses to which an ENI can be bound. For more information on resource restrictions, see ENI Usage Limits.
- When an ENI is created, it can be bound to existing security groups.
- When an ENI is created, it can be bound to tags. The list of tags in the response represents the successfully added tags.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-04-30 17:12:07.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateAndAttachNetworkInterface |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| VpcId | Yes | No | String | VPC instance ID, which can be obtained through the VpcId returned by the DescribeVpcs API. Example: vpc-m0c2kcun |
| NetworkInterfaceName | Yes | No | String | ENI name, up to 60 bytes in length. Example: eni-ed3452de |
| SubnetId | Yes | No | String | Subnet instance ID of the ENI, e.g., subnet-0ap8nwca. Example: subnet-76r802pg |
| PrivateIpAddresses | No | No | Array of PrivateIpAddressSpecification | Specified VPC IP information, up to 10 can be specified at once. Example:View |
| SecondaryPrivateIpAddressCount | No | No | Uint64 | Number of newly applied private IP addresses. The total number of private IP addresses must not exceed the quota. Example: 1 |
| SecurityGroupIds | No | No | Array of String | Specifies the bound security group, e.g., ['sg-1dd51d']. Example: ['sg-75ww503r'] |
| InstanceId | Yes | No | String | CVM instance ID. Example: ins-demoag78 |
| NetworkInterfaceDescription | No | No | String | ENI description. The name can be given freely but must not exceed 60 characters. Example: uiui |
| Tags | No | No | Array of Tag | Specifies the list of tags for binding. For example, [{"Key": "city", "Value": "region"}]. Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| NetworkInterface | NetworkInterface | ENI instances. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| InvalidParameterValue.TooLong | Invalid input: Excessive length of the parameter. |