# AssignBorderGateway

## 1. API Description

This API (AssignBorderGateway) is used to bind a NAT gateway to a border gateway.

{% hint style="info" %}
**Note**

* A border gateway can be bound to only one NAT gateway. If the border gateway is already bound to another NAT gateway, the binding will fail.
  {% endhint %}

## 2. Input Parameters

The following request parameter list only provides API request parameters.

| Parameter Name | Required | Type   | Description        |
| -------------- | -------- | ------ | ------------------ |
| zbgId          | Yes      | String | Border gateway ID. |
| natId          | Yes      | String | NAT gateway ID.    |

## 3. Output Parameters

| Parameter Name | Type   | Description                                                                                                           |
| -------------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
| requestId      | String | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Bind a NAT gateway to a border gateway.**

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

Request:
{
  "zbgId": "xxx",
  "natId": "xxx"
}

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

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk)，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](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).

| HTTP Status Code | Error Code                          | Description                                                            |
| ---------------- | ----------------------------------- | ---------------------------------------------------------------------- |
| 404              | INVALID\_NAT\_NOT\_FOUND            | NAT gateway does not exist.                                            |
| 400              | INVALID\_ZBG\_NAT\_ASSOCIATE        | The border gateway has already been bound to a NAT gateway.            |
| 404              | INVALID\_ZBG\_NOT\_FOUND            | Border gateway does not exist.                                         |
| 409              | OPERATION\_DENIED\_VPC\_MISMATCH    | The specified border gateway and NAT gateway belong to different VPCs. |
| 400              | UNSUPPORTED\_OPERATION\_NAT\_STATUS | NAT gateway state is not supported.                                    |