AttachNetworkInterface

AttachNetworkInterface

1. API Description

This API is used to attach the vNIC to the instance.

Note

  • Up to 8 vNICs can be attached per instance.

  • vNICs can only be attached to instances in the running state.

  • vNIC state must be AVAILABLE.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

nicId

Yes

String

ID of the vNIC.

instanceId

Yes

String

ID of the instance.

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.

4. Code Example

Attach the vNIC to the instance.

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

Request:
{
  "nicId": "XXX",
  "instanceId": "xxx"
}

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

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

400

INVALID_NIC_STATUS

vNIC state is not supported.

403

OPERATION_DENIED_INSTANCE_STATUS_NOT_SUPPORT

The state of the instance is not supported.

400

INVALID_NIC_ATTACHED

The vNIC is already attached to another instance.

400

INVALID_INSTANCE_NIC_LIMIT

The number of vNICs under the instance exceeds limit.

400

INVALID_INSTANCE_PRECHECK_ABNORMAL

Instance pre-check.

404

OPERATION_FAILED_RESOURCE_NOT_FOUND

Resources are not found.

Last updated