RegisterBackend

1. API Description

This API (RegisterBackend) is used to create a backend server (vm or bmc instance) and add it to a load balance listener.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
listenerId	Yes	String	The listener ID.
backendName	Yes	String	Backend server name. This parameter can contain up to 64 characters. Only letters, numbers, - and periods (.) are supported.
instanceId	Yes	String	Bare metal or Virtual machine instance ID.
clientToken	Yes	String	Used to ensure the idempotency of the request.
instanceType	No	InstanceProductType	Instance type. Default value: BM
portList	No	Array of Integer	Port list.
weight	No	Integer	Weight of the instance. Value range: [1, 100]

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.
backendId	String	Backend server ID.

4. Code Example

Example

Add a bare metal instance as a backend server to a load balance listener.

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

Request:
{
  "listenerId": "xxxx",
  "backendName": "xxxx",
  "portList": [80],
  "clientToken": "xxxx",
  "weight": 100,
  "instanceId": "xxxx"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "backendId": "xxxx"
  }
}

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