LBDC Instance Related Interfaces

Updated at：2025-10-16

Create LBDC

Request structure

Plain Text

1POST /v{version}/lbdc?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4 {
5	"name": name,
6	"type": type,
7	"ccuCount": ccuCount,
8    "desc": desc,
9    "billing": {
10        "paymentTiming": paymentTiming,  
11		"reservation" : {
12        	"reservationLength": reservationLength
13         }
14    },
15	"renewReservation":{
16    	"reservationLength": reservationLength
17    },
18    "tags": [
19        {
20          "tagKey": "hikwnf",
21          "tagValue": "nwklwmflk"
22        }
23    ]
24 }

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
clientToken	String	No	Query	Idempotence Token, an ASCII string with a length not exceeding 64 bits.
name	String	Yes	RequestBody	Cluster name. Length: 1 – 65 bytes, starting with a letter. It can contain letters, numbers and the characters -_/.
type	String	Yes	RequestBody	Cluster type, values: "4Layer" or "7Layer".
ccuCount	int	Yes	RequestBody	The Cluster Capacity Unit (CCU) is a measurement used to evaluate various metrics related to BLB cluster traffic processing.
desc	String	No	RequestBody	LBDC description, supporting up to 200 characters.
billing	[BillingForCreate](BLB/API Reference/Appendix.md#BillingForCreate)	Yes	RequestBody	Order information
renewReservation	[ReservationForCreate](BLB/API Reference/Appendix.md#ReservationForCreate)	No	RequestBody	Auto-renewal information, indicating whether the auto-renewal task is enabled
tags	List<[TagModel](BLB/API Reference/Appendix.md#TagModel)>	No	RequestBody	Tag

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name	Types	Description
id	String	Cluster ID
type	String	Cluster type
desc	String	Description

Request example

Plain Text

1POST /v1/lbdc?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5    "name": "abc",
6	"type": "4Layer",
7	"ccuCount": 1,
8    "desc": "",
9    "billing": {
10        "paymentTiming": "Prepaid",  
11		"reservation" : {
12        	"reservationLength": 1
13         }
14     },
15	"renewReservation":{
16    	"reservationLength": 1
17    },
18    "tags": [
19        {
20          "tagKey": "hikwnf",
21          "tagValue": "nwklwmflk"
22        }
23    ]
24}

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7 {
8    "id": "bgw_group-a3t786p1",
9	"name": "abc",
10	"type": "4Layer",
11	"desc":""
12 }

Upgrade LBDC

Request structure

Plain Text

1PUT /v{version}/lbdc/{id}?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4 {
5	"ccuCount": ccuCount
6 }

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
id	String	Yes	URL parameter	Upgraded cluster ID
clientToken	String	No	Query	Idempotence Token, an ASCII string with a length not exceeding 64 bits.
action	String	Yes	Query	Parameter value for this API: resize
ccuCount	int	Yes	RequestBody	The Cluster Capacity Unit (CCU) is a measurement used to evaluate various metrics related to BLB cluster traffic processing.

Response headers

No special headers are required beyond the standard ones.

Response parameters

There are no special response parameters

Request example

Plain Text

1PUT /v1/lbdc/bgw_group-a3t786p1?resize&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6	"ccuCount": 1
7}

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

Renew LBDC

Request structure

Plain Text

1PUT /v{version}/lbdc/{id}?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4 {
5	"billing":{
6    	"reservation":{
7        	"reservationLength": reservationLength
8    	}
9	}
10 }

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
id	String	Yes	URL parameter	Renewed cluster ID
clientToken	String	No	Query	Idempotence Token, an ASCII string with a length not exceeding 64 bits.
action	String	Yes	Query	Parameter value for this API: purchaseReserved
billing	[BillingForRenew](BLB/API Reference/Appendix.md#BillingForRenew)	Yes	RequestBody	Order information

Response headers

No special headers are required beyond the standard ones.

Response parameters

There are no special response parameters

Request example

Plain Text

1PUT /v1/lbdc/bgw_group-a3t786p1?purchaseReserved&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6	"billing":{
7    	"reservation":{
8        	"reservationLength":1
9    	}
10	}
11}

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

LBDC list

Request structure

Plain Text

1GET /v{version}/lbdc?id={id}&name={name} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
id	String	No	Query	Cluster ID to be queried
name	String	No	Query	The name of the cluster to be queried

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name	Types	Description
marker	String	Mark the starting position of the query.
isTruncated	boolean	true indicates there is more data later, false indicates it is the last page
nextMarker	String	The marker value needed to fetch the next page. This field is absent when isTruncated is false.
maxKeys	int	Maximum number of items included per page
clusterList	List<[ClusterModel](BLB/API Reference/Appendix.md#ClusterModel)>	LBDC list containing query results

Request example

Plain Text

1GET /v1/lbdc?id=bgw_group-a3t786p1 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7
8{
9	"clusterList": [
10    	{
11        	"id": "bgw_group-a3t786p1",
12        	"name": "abc",
13        	"type": "4Layer",
14			"status": "available",
15        	"ccuCount": 1,
16        	"createTime": "2021-08-25T06:13:09Z",
17        	"expireTime": "2021-09-25T06:13:09Z",
18        	"desc": ""
19    	}
20	],
21	"marker": "bgw_group-a3t786p1",
22	"nextMarker": null,
23	"isTruncated": false,
24	"maxKeys": 1000
25}

LBDC details

Request structure

Plain Text

1GET /v{version}/lbdc/{id} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
id	String	Yes	URL parameter	Cluster ID to be queried

Response headers

No special headers are required beyond the standard ones.

Layer 4 Response Parameters

Parameter name	Types	Description
id	String	Cluster ID
name	String	Cluster name
type	String	Cluster type
status	String	Cluster status
ccuCount	String	Cluster performance capacity
createTime	String	Cluster creation time
expireTime	String	Cluster expiration time
totalConnectCount	long	Concurrent connections
newConnectCps	long	New connection speed
networkInBps	long	Network inbound bandwidth
networkOutBps	long	Network outbound bandwidth
tags	List<[TagModel](BLB/API Reference/Appendix.md#TagModel)>	Tag

Layer 7 Response Parameters

Parameter name	Types	Description
id	String	Cluster ID
name	String	Cluster name
type	String	Cluster type
status	String	Cluster status
ccuCount	String	Cluster performance capacity
createTime	String	Cluster creation time
expireTime	String	Cluster expiration time
totalConnectCount	long	Concurrent connections
networkInBps	long	Network inbound bandwidth
networkOutBps	long	Network outbound bandwidth
httpsQps	long	HTTPS QPS
httpQps	long	HTTP QPS
httpNewConnectCps	long	HTTP new speed
httpsNewConnectCps	long	HTTP new speed
sslNewConnectCps	long	SSL new speed
tags	List<[TagModel](BLB/API Reference/Appendix.md#TagModel)>	Tag

Request example

Plain Text

1GET /v1/lbdc/bgw_group-a3t786p1 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7
8{
9	"id": "bgw_group-a3t786p1",
10    "name": "abc",
11    "type": "4Layer",
12	"status": "available",
13    "ccuCount": 1,
14    "createTime": "2021-08-25T06:13:09Z",
15    "expireTime": "2021-09-25T06:13:09Z",
16    "desc": "",
17	"totalConnectCount":100,
18	"newConnectCps":100,
19	"networkInBps":100,
20	"networkOutBps":100,
21    "tags": [
22        {
23          "tagKey": "hikwnf",
24          "tagValue": "nwklwmflk"
25        }
26    ]
27}

Update LBDC

Request structure

Plain Text

1PUT /v{version}/lbdc/{id}?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "name":name,
7    "desc":desc
8}

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
id	String	Yes	URL parameter	Cluster ID
clientToken	String	No	Query	Idempotence Token, an ASCII string with a length not exceeding 64 bits.
name	String	No	RequestBody	Cluster name length must be between 1 and 65 bytes, starting with a letter. It can include letters, numbers, and the characters -_/.
desc	String	No	RequestBody	Cluster description, supporting up to 200 characters

Response headers

No special headers are required beyond the standard ones.

Response parameters

No response parameters

Request example

Plain Text

1PUT /v1/lbdc/bgw_group-a3t786p1?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6	"name":"abc",
7    "desc":""
8}

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS

List of BLBs associated with LBDC

Request structure

Plain Text

1GET /v{version}/lbdc/{id}/blb HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

Request headers

There are no special headers required beyond the common headers.

Request parameters

Parameter name	Types	Whether required	Parameter location	Description
version	String	Yes	URL parameter	API version number, current value is 1.
id	String	No	URL parameter	Cluster ID to be queried

Response headers

No special headers are required beyond the standard ones.

Response parameters

Parameter name	Types	Description
blbList	List<[AssociateBlbModel](BLB/API Reference/Appendix.md#AssociateBlbModel)>	BLB list containing query results

Request example

Plain Text

1GET /v1/lbdc/bgw_group-a3t786p1/blb HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2020-07-14T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

Response example

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Tus, 14 Jul 2020 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7
8{
9	"blbList": [
10    	{
11        	"blbId": "lb-1c791997",
12        	"name": "abc",
13			"status": "available",
14        	"blbType": "normal",
15			"publicIp": "10.10.10.10",
16        	"eipRouteType": "bgp",
17        	"bandwidth": 20,
18        	"address": "192.168.0.7",
19        	"ipv6": "2400:da00:e003:1820::4",
20        	"vpcId": "vpc-0n1hhh8759b0",
21			"subnetId": "sbn-p09p0ihp7498"
22    	}
23	]
24}

Introduction

Service Publishing Point Interface

BLB BLB

BLB BLB

LBDC Instance Related Interfaces

Create LBDC

Upgrade LBDC

Renew LBDC

LBDC list

LBDC details

Update LBDC

List of BLBs associated with LBDC