AssociateSubnetInstances

1. 接口描述

本接口用于将一台或多台实例加入同一个子网并分配内网IP。

注意事项

本接口属于异步接口，即系统会先返回一个请求ID，并不表示实例绑定Subnet完成，系统后台的绑定任务仍在进行。您可以调用DescribeSubnets 查询Subnet 下实例绑定状态：
- 当privateIpStatus 处于BINDED状态时，表示实例已成功绑定Subnet
- 当privateIpStatus 处于BINDING状态时，表示实例正在绑定Subnet
- 当privateIpStatus 处于UNBINDING状态时，表示实例正在解绑Subnet
实例状态需为RUNNING才能够绑定Subnet 。
Subnet与实例的可用区需一致。
Subnet状态需为AVAILABLE且Subnet还有剩余可用IP。
通常情况下，一台实例只允许加入一个子网如果实例已经加入其他子网，则操作将会失败。如果有特殊场景需要加入多个子网，请联系Support。
支持批量操作，每次请求批量实例上限为100。

2. 请求参数

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

参数名称

必选

类型

描述

subnetId

是

String

Subnet ID。

subnetInstanceList

是

Array of AssociateSubnetInstance

Subnet绑定实例集合。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

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

4. 代码示例

1. 实例绑定Subnet。

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

Request:
{
  "subnetId": "your-subnet-id",
  "subnetInstanceList": [
    {
      "instanceId": "your-instance-id",
      "privateIpAddress": "10.0.0.2"
    }
  ]
}

Response:
{
  "requestId": "TD3AA7771-C9C1-4EC2-A743-FD934710CEB6",
  "response": {
    "requestId": "TD3AA7771-C9C1-4EC2-A743-FD934710CEB6"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码

错误码

说明

403

OPERATION_DENIED_INSTANCE_NOT_SUPPORT_SUBNET

实例不支持绑定Subnet。

403

OPERATION_DENIED_INSTANCE_NOT_RUNNING

实例状态不是Running。

404

INVALID_SUBNET_NOT_FOUND

Subnet不存在。

403

OPERATION_DENIED_SUBNET_STATUS_NOT_SUPPORT

Subnet状态不支持。

403

OPERATION_DENIED_DIFFERENT_ZONE

Subnet与实例有不一致的可用区。

403

OPERATION_DENIED_SUBNET_EXIST_INSTANCE

Subnet存在实例。

400

INVALID_PARAMETER_DUPLICATE_LAN_IP

Subnet分配重复的内网IP给实例。

400

INVALID_PARAMETER_LAN_IP_NOT_SUPPORT

.1结尾的内网IP不支持。

403

OPERATION_DENIED_IP_ASSOCIATED_INSTANCE

内网IP已经绑定实例。

403

OPERATION_DENIED_SUBNET_NOT_REPEAT_INSTANCE

Subnet下实例不能重复。

最后更新于11个月前