ModifyBorderGatewaysAttribute

1. API Description

The API is used to modify the attributes of one or more border gateways. Only the border gateway name to be displayed can be modified for now.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

zbgIds

Yes

Array of String

Border gateway ID(s).

The maximum number of border gateways in each request is 100.

name

Yes

String

Border gateway name to be displayed.

This parameter must start and end with a number or a letter, containing 2 to 63 characters. Only letters, numbers, - and periods (.) are supported.

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

Modify border gateway name in batches.

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

Request:
{
  "zbgIds": [
    "xxx"
  ],
  "name": "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

404

INVALID_ZBG_NOT_FOUND

Border gateway does not exist.

Last updated