View a list of load balancers
- Print
- PDF
View a list of load balancers
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It can be used in a VPC environment.
Description
View a list of load balancers.
Request
Request URL
GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getLoadBalancerInstanceList/{service-group-instance-no} [KR]
GET https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getLoadBalancerInstanceList/{service-group-instance-no} [SGN]
GET https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getLoadBalancerInstanceList/{service-group-instance-no} [JPN]
Request header
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | Number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Value of access key ID issued on NAVER Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specifies the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Requirement status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | Cluster number to search a list of load balancers |
Request example
GET https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getLoadBalancerInstanceList/1714400
HOST: clouddatastreamingservice.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
curl -X GET "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getLoadBalancerInstanceList/1714400" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4="
Response parameters
public class GetLoadBalancerListsResponseVo {
List<LoadBalancerInstance> loadBalancerInstanceList;
}
public class LoadBalancerInstance {
String loadBalancerIp;
String loadBalancerName;
String loadBalancerDomain;
Integer instanceNo;
String permission;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| loadBalancerIp | String | Load balancer IP |
| loadBalancerName | String | Load balancer name |
| loadBalancerDomain | String | Load balancer domain |
| instanceNo | Integer | Load balancer instance number |
| permission | String | Load balancer availability status |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"loadBalancerInstanceList": [{
"loadBalancerIp": "1.1.1.1",
"loadBalancerName": "cdss-pubic-endpoint",
"loadBalancerDomain": "aa.kr.lb.naverncp.com",
"instanceNo": 1714401,
"permission": "allow"
}]
},
"requestId": "fa1129d7-2e79-4064-bbf7-5f9155d1c142"
}
Was this article helpful?