CreateNetworkInterface

CreateNetworkInterface

1. API Description

This API is used to create an elastic vNIC.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

name

Yes

String

The name of the vNIC.

The length is 2 to 63 characters. Only letters, numbers, - and periods (.) are supported. The name must start and end with a number or a letter.

subnetId

Yes

String

ID of the subnet.

nicStackType

No

The IP stack type of the vNIC. If not specified, it will be determined by the subnet’s stack type: IPv4 for an IPv4 subnet, and IPv6 for an IPv6 subnet. Specify this parameter if you need IPv4_IPv6 vNIC IP stack type.

resourceGroupId

No

String

The resource group ID of the vNIC. If you do not specify a resource group, it is placed in the default resource group.

securityGroupId

No

String

ID of the security group deployed on the primary vNIC. Currently only one security group can be deployed. If not specified, the security group associated with global VPC will be used by default.

internetChargeType

No

String

Network billing model.

See InternetChargeType for available values. If the subnet stack type is IPv6 and the type is Public, this value is required.

bandwidth

No

Integer

Outbound public network bandwidth cap (Mbps). Unit: Mbps.

The value differs with different instance types. See bandwidth configuration for details.

packageSize

No

BigDecimal

Data transfer package size(TB).

The unit is TB.

This value takes effect only when internetChargeType is set to ByTrafficPackage.

The default value is 0. Maximum of one decimal place.

clusterId

No

String

Bandwidth cluster ID.

If the value of internetChargeType is BandwidthCluster , the parameter is required.

marketingOptions

No

Information on marketing campaigns.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

nicId

String

vNIC ID.

4. Code Example

Create an elastic vNIC.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: CreateNetworkInterface
<Common Request Params>

Request:
{
  "name": "XXX",
  "subnetId": "xxx",
  "packageSize": 10,
  "internetChargeType": "ByTrafficPackage",
  "resourceGroupId": "xxxx"
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "nicId": "xxx"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code
Error Code
Description

404

OPERATION_FAILED_RESOURCE_GROUP_NOT_FOUND

Resource group does not exist.

404

INVALID_SUBNET_NOT_FOUND

Subnet is not found.

403

OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT

Network billing model is not supported.

403

OPERATION_DENIED_STACK_TYPE_NOT_SUPPORT

IP stack type is not supported.

404

INVALID_SECURITY_GROUP_NOT_FOUND

Security group does not exist.

Last updated