> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/zlb/load-balancer-instance/assignloadbalanceripv6.md).

# AssignLoadBalancerIpv6

## 1. 接口描述

本接口(AssignLoadBalancerIpv6)用于为负载均衡实例分配公网IPv6。

{% hint style="info" %}
**注意事项**

* 负载均衡实例状态需为`RUNNING`。
* 公网IPv6从负载均衡实例创建时指定的子网中分配，**本接口不接受子网参数**。该子网需含公网IPv6网段。
* 本接口为异步接口，接口成功返回后地址尚未就绪，可通过负载均衡实例详情查询分配结果。
* 公网IPv6网段本身不计费，仅按带宽计费。
* 单个负载均衡实例可分配的公网IP数量受配额`VIPs_per_LB`限制。
  {% endhint %}

## 2. 请求参数

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

| 参数名称               | 必选 | 类型                                                                              | 描述                                                                                                                                                                                                               |
| ------------------ | -- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| loadBalancerId     | 是  | String                                                                          | <p>要分配公网IPv6的负载均衡实例ID。</p><p>仅<code>ipStackType</code>为<code>IPv6</code>的负载均衡实例可用。</p><p>可通过调用 <a href="/api-reference/cn/zlb/load-balancer-instance/describeloadbalancers.md">DescribeLoadBalancers</a> 获取。</p> |
| internetChargeType | 是  | [InternetChargeType](/api-reference/cn/zlb/datastructure.md#internetchargetype) | 公网IPv6的网络计费方式。                                                                                                                                                                                                   |
| vipCount           | 否  | Integer                                                                         | <p>本次分配的公网IPv6数量。</p><p>子网剩余可用公网IPv6不足时将返回<code>INVALID\_SUBNET\_IPV6\_INSUFFICIENT</code>。</p><p>可选值范围：\[1, 20]</p><p>默认值：1</p>                                                                                 |
| bandwidth          | 否  | Integer                                                                         | <p>公网IPv6的带宽限速。</p><p>单位Mbps。</p><p>网络计费方式为固定带宽(<code>ByBandwidth</code>)时必填。</p><p>可选值范围：\[1, +)</p>                                                                                                            |
| packageSize        | 否  | Float                                                                           | <p>公网IPv6的流量包大小。</p><p>单位为TB。</p><p>值要求为0或0.1的倍数。</p><p>网络计费方式为流量计费(<code>ByTrafficPackage</code>)时必填，且仅计费周期为月时支持设置。</p><p>可选值范围：\[0.0, +)</p>                                                                   |
| clusterId          | 否  | String                                                                          | <p>公网IPv6所指定的共享带宽包ID。</p><p>网络计费方式为共享带宽包计费(<code>BandwidthCluster</code>)时必填。</p>                                                                                                                                |
| rateLimitMode      | 否  | [RateLimitMode](/api-reference/cn/zlb/datastructure.md#ratelimitmode)           | <p>限速模式。</p><p>严格模式(<code>STRICT</code>)必须同时指定<code>bandwidth</code>，否则返回<code>INVALID\_RATE\_LIMIT\_MODE\_REQUIRES\_BANDWIDTH</code>。</p><p>默认值：LOOSE</p>                                                       |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 为负载均衡实例分配1个公网IPv6。计费类型为固定带宽计费，带宽限速设置为100Mbps。**

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

Request：
{
  "loadBalancerId": "<loadBalancerId>",
  "internetChargeType": "ByBandwidth",
  "bandwidth": 100,
  "rateLimitMode": "LOOSE"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

**2. 为负载均衡实例一次分配3个公网IPv6。计费类型为共享带宽包计费。**

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

Request：
{
  "loadBalancerId": "<loadBalancerId>",
  "vipCount": 3,
  "internetChargeType": "BandwidthCluster",
  "clusterId": "<clusterId>",
  "rateLimitMode": "LOOSE"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](/api-reference/cn/api-introduction/toolkit.md)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](/api-reference/cn/api-introduction/instruction/commonerrorcode.md)

| HTTP状态码 | 错误码                                                            | 说明                        |
| ------- | -------------------------------------------------------------- | ------------------------- |
| 404     | INVALID\_LB\_NOT\_FOUND                                        | 负载均衡器不存在。                 |
| 400     | INVALID\_LB\_STATUS                                            | 当前负载均衡器状态无法进行操作。          |
| 400     | INVALID\_PARAMETER\_BANDWIDTH\_ERROR                           | 带宽限速值超过最小限制。              |
| 400     | INVALID\_PARAMETER\_BANDWIDTH\_EXCEED                          | 带宽限速值超过最大限制。              |
| 400     | INVALID\_PARAMETER\_FLOW\_TRAFFIC\_PACKAGE                     | 流量包大小不合法。                 |
| 400     | INVALID\_PARAMETER\_TRAFFIC\_PACKAGE\_EXCEED                   | 流量包大小超过最大限制。              |
| 400     | INVALID\_RATE\_LIMIT\_MODE\_REQUIRES\_BANDWIDTH                | 限速模式为STRICT时必须指定带宽。       |
| 409     | INVALID\_SUBNET\_IPV6\_INSUFFICIENT                            | Subnet下可用的IPv6数量不足。       |
| 404     | INVALID\_SUBNET\_NOT\_FOUND                                    | 子网不存在。                    |
| 400     | OPERATION\_DENIED\_FLOW\_PACKAGE\_NOT\_SUPPORTED\_HOUR\_PERIOD | 当前产品周期为小时计费，不支持设置保底流量包大小。 |
| 400     | OPERATION\_DENIED\_INTERNET\_CHARGE\_TYPE\_NOT\_SUPPORT        | IP网络计费方式不支持。              |
| 400     | OPERATION\_DENIED\_SUBNET\_NOT\_SUPPORT\_PUBLIC\_IPV6          | 子网没有公网IPv6网段。             |
