CreateNetworkInterface

1. 接口描述

本接口(CreateNetworkInterface)用于创建一张辅助网卡。

注意事项

  • 此操作为异步接口,调用成功后,辅助网卡并未立刻创建成功, 需要等待网卡的状态从PENDINGAvailable则为创建成功,如果状态变为CREATE_FAILED则创建失败。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

name

String

网卡名称。

范围2到63个字符。

仅支持输入字母、数字、-/_和英文句点(.)。

且必须以数字或字母开头和结尾。

subnetId

String

子网的ID。

nicStackType

网卡的IP堆栈类型。

如果不指定,会根据子网堆栈类型决定:如果子网是V4,则网卡为V4,如果子网是V6,则网卡为V6。

如果网卡要V4&V6,请指定该参数。

resourceGroupId

String

网卡创建所在的资源组ID,如不指定则放入默认资源组。

securityGroupId

String

指定安全组ID。

目前一个网卡只能关联1个安全组。

如果未指定,会默认用VPC关联下的安全组。

internetChargeType

公网IPv6的网络计费方式。

当子网的堆栈类型包括V6且为公网时,需要指定。

bandwidth

Integer

公网IPv6的带宽限速。

单位Mbps。

当子网的堆栈类型包括V6且为公网时,需要指定。

可选值范围:[1, +)。

packageSize

Float

公网IPv6的流量包大小。

单位为TB。

值要求为0或0.1的倍数。

当子网的堆栈类型包括V6且为公网时,且网络计费方式是流量计费(ByTrafficPackage)需要指定。

可选值范围:[0.0, +)。

clusterId

String

公网IPv6所指定的共享带宽包ID。

当子网的堆栈类型包括V6且为公网时,且网络计费方式是共享带宽包计费(BandwidthCluster)需要指定。

marketingOptions

市场营销相关的选项。

tags

创建网卡时关联的标签。

注意:·关联标签键不能重复。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

nicId

String

创建的辅助网卡ID。

4. 代码示例

1. 在IPv4堆栈类型的子网下创建一张辅助网卡。

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

Request:
{
  "name": "Test-NIC",
  "subnetId": "<subnetId>",
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "nicId": "<nicId>"
  }
}

2. 在IPv4&IPv6堆栈类型的子网下创建一张辅助网卡。且带有公网IPv6。该公网IPv6的计费方式为带宽包计费。

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

Request:
{
  "name": "Test-NIC",
  "subnetId": "<subnetId>",
  "internetChargeType": "BandwidthCluster",
  "bandwidth": 100,
  "clusterId": "<clusterId>"
}

Response:
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "nicId": "<nicId>"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集(SDK),未来会陆续支持更多开发语言,方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码,其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_EIP_NOT_FOUND

EIP不存在。

404

INVALID_INSTANCE_NOT_FOUND

服务器实例不存在。

400

INVALID_IP_BROADCAST_ADDRESS

IP为广播地址不可用。

400

INVALID_IP_FIRST_ADDRESS

IP为网关地址不可用。

400

INVALID_IP_NETWORK_ADDRESS

IP为网络地址不可用。

409

INVALID_NIC_INSTANCE_REGION_MISMATCH

实例和网卡不在同一个节点。

400

INVALID_NIC_IPV6_EXISTS

网卡已绑定IPv6,无法操作。

400

INVALID_PARAMETER_BANDWIDTH_ERROR

带宽限速值超过最小限制。

400

INVALID_PARAMETER_BANDWIDTH_EXCEED

带宽限速值超过最大限制。

400

INVALID_PARAMETER_FLOW_TRAFFIC_PACKAGE

流量包大小不合法。

400

INVALID_REGION_NOT_ON_SALE

指定的区域未开售。

404

INVALID_SECURITY_GROUP_NOT_FOUND

安全组不存在。

409

INVALID_SUBNET_IPV4_INSUFFICIENT

Subnet下可用的IPv4数量不足。

404

INVALID_SUBNET_NOT_FOUND

子网不存在。

400

OPERATION_DENIED_EIP_IS_DEFAULT

默认公网IP无法解绑。

400

OPERATION_DENIED_EIP_IS_NOT_UN_ASSIGN

EIP状态未解绑。

403

OPERATION_DENIED_EIP_NIC_NOT_ADAPTER

指定的网卡数量与需要创建的EIP数量不一致。

400

OPERATION_DENIED_EIP_NOT_ASSIGNED

EIP状态未绑定。

400

OPERATION_DENIED_EIP_NOT_SUPPORT_PASS_THROUGH_BIND_TYPE

EIP模式不支持高速模式。

403

OPERATION_DENIED_INSTANCE_NIC_NOT_ADAPTER

指定的实例数量与需要创建的网卡数量不一致。

400

OPERATION_DENIED_INSTANCE_STATUS_NOT_SUPPORT

实例状态不允许操作。

403

OPERATION_DENIED_INTERNET_CHARGE_TYPE_NOT_SUPPORT

IP网络计费方式不支持。

400

OPERATION_DENIED_SUBNET_TYPE_NOT_SUPPORT_IPV4

子网堆栈类型不包括IPv4。

403

OPERATION_DENIED_STACK_TYPE_NOT_SUPPORT

堆栈类型不支持。

最后更新于