查询负载均衡器状态树
功能介绍
查询负载均衡器状态树,包括负载均衡器及其关联的子资源的状态信息。
注意:该接口中的operating_status不一定与对应资源的operating_status相同。
如:当Member的admin_state_up=false且operating_status=OFFLINE时,
该接口返回member的operating_status=DISABLE。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/statuses
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。获取方式请参见获取项目ID。 约束限制:不涉及 取值范围:长度为32个字符,由小写字母和数字组成。 默认取值:不涉及 |
loadbalancer_id |
是 |
String |
参数解释:负载均衡器ID。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
statuses |
LoadBalancerStatusResult object |
参数解释:负载均衡器状态树信息。 默认取值:不涉及 |
request_id |
String |
参数解释:请求ID。 取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。 |
参数 |
参数类型 |
描述 |
---|---|---|
loadbalancer |
LoadBalancerStatus object |
参数解释:负载均衡器及其子资源的状态信息。 默认取值:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:负载均衡器名称。 取值范围:不涉及 |
provisioning_status |
String |
参数解释:负载均衡器的配置状态。 取值范围:
|
listeners |
Array of LoadBalancerStatusListener objects |
参数解释:负载均衡器关联的所有监听器的状态信息。 取值范围:不涉及 |
pools |
Array of LoadBalancerStatusPool objects |
参数解释:负载均衡器关联的所有后端服务器组的状态信息。 取值范围:不涉及 |
id |
String |
参数解释:负载均衡器ID。 取值范围:不涉及 |
operating_status |
String |
参数解释:负载均衡器的操作状态。 取值范围:
DEGRADED和DISABLED状态仅在当前接口中返回,查询负载均衡器详情等其他接口不会返回这两个状态值。
|
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释:监听器的名称。 取值范围:不涉及 |
provisioning_status |
String |
参数解释:监听器的配置状态。 取值范围:
|
pools |
Array of LoadBalancerStatusPool objects |
参数解释:监听器下的所有后端服务器组的状态信息。 取值范围:不涉及 |
l7policies |
Array of LoadBalancerStatusPolicy objects |
参数解释:监听器下的7层转发策略的状态信息。 默认取值:不涉及 |
id |
String |
参数解释:监听器ID。 取值范围:不涉及 |
operating_status |
String |
参数解释:监听器的操作状态。 取值范围:
DEGRADED和DISABLED状态仅在当前接口返回,查询监听器详情等其他接口返回字段operating_status不存在这两个状态值。
|
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
参数解释:匹配后动作。 取值范围:
|
id |
String |
参数解释:转发策略ID。 取值范围:不涉及 |
provisioning_status |
String |
参数解释:转发策略的配置状态。 取值范围:
|
name |
String |
参数解释:转发策略名称。 取值范围:不涉及 |
rules |
Array of LoadBalancerStatusL7Rule objects |
参数解释:当前转发策略下的所有转发规则状的态信息。 取值范围:不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释:L7转发规则ID。 取值范围:不涉及 |
type |
String |
参数解释:匹配内容类型。 取值范围:
|
provisioning_status |
String |
参数解释:转发规则的配置状态。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
provisioning_status |
String |
参数解释:后端服务器组的配置状态。 取值范围:
|
name |
String |
参数解释:后端服务器组名称。 取值范围:不涉及 |
healthmonitor |
参数解释:LB状态树的后端服务器组健康检查器状态信息。 默认取值:不涉及 |
|
members |
Array of LoadBalancerStatusMember objects |
参数解释:当前后端服务器组下所有后端服务器的状态信息。 取值范围:不涉及 |
id |
String |
参数解释:后端服务器组ID。 取值范围:不涉及 |
operating_status |
String |
参数解释:后端服务器组的操作状态。 取值范围:
DEGRADED和DISABLED仅在当前接口返回,
查询后端服务器组详情等其他接口返回的operating_status字段不存在这两个状态值。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
参数解释:健康检查器协议类型。 取值范围:TCP、UDP_CONNECT、HTTP。 |
id |
String |
参数解释:健康检查器ID。 取值范围:不涉及 |
name |
String |
参数解释:健康检查器名称。 取值范围:不涉及 |
provisioning_status |
String |
参数解释:健康检查器的配置状态。 取值范围:ACTIVE表示使用中。 |
参数 |
参数类型 |
描述 |
---|---|---|
provisioning_status |
String |
参数解释:后端服务器配置状态。 取值范围:ACTIVE表示使用中。 |
address |
String |
参数解释:后端服务器的IP地址。 取值范围:不涉及 |
protocol_port |
Integer |
参数解释:后端服务器的端口号。 取值范围:1-65535 |
id |
String |
参数解释:后端服务器ID。 取值范围:不涉及 |
operating_status |
String |
参数解释:后端服务器的操作状态。 取值范围:
|
请求示例
查询负载均衡器的状态树
GET https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/38278031-cfca-44be-81be-a412f618773b/statuses
响应示例
状态码:200
操作成功正常返回。
{
"statuses" : {
"loadbalancer" : {
"name" : "lb-jy",
"provisioning_status" : "ACTIVE",
"listeners" : [ {
"name" : "listener-jy-1",
"provisioning_status" : "ACTIVE",
"pools" : [ {
"name" : "pool-jy-1",
"provisioning_status" : "ACTIVE",
"healthmonitor" : {
"type" : "TCP",
"id" : "7422b51a-0ed2-4702-9429-4f88349276c6",
"name" : "",
"provisioning_status" : "ACTIVE"
},
"members" : [ {
"protocol_port" : 80,
"address" : "192.168.44.11",
"id" : "7bbf7151-0dce-4087-b316-06c7fa17b894",
"operating_status" : "ONLINE",
"provisioning_status" : "ACTIVE"
} ],
"id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
"operating_status" : "ONLINE"
} ],
"l7policies" : [ ],
"id" : "eb84c5b4-9bc5-4bee-939d-3900fb05dc7b",
"operating_status" : "ONLINE"
} ],
"pools" : [ {
"name" : "pool-jy-1",
"provisioning_status" : "ACTIVE",
"healthmonitor" : {
"type" : "TCP",
"id" : "7422b51a-0ed2-4702-9429-4f88349276c6",
"name" : "",
"provisioning_status" : "ACTIVE"
},
"members" : [ {
"protocol_port" : 80,
"address" : "192.168.44.11",
"id" : "7bbf7151-0dce-4087-b316-06c7fa17b894",
"operating_status" : "ONLINE",
"provisioning_status" : "ACTIVE"
} ],
"id" : "c54b3286-2349-4c5c-ade1-e6bb0b26ad18",
"operating_status" : "ONLINE"
} ],
"id" : "38278031-cfca-44be-81be-a412f618773b",
"operating_status" : "ONLINE"
}
}
}
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;
public class ShowLoadBalancerStatusSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
ElbClient client = ElbClient.newBuilder()
.withCredential(auth)
.withRegion(ElbRegion.valueOf("<YOUR REGION>"))
.build();
ShowLoadBalancerStatusRequest request = new ShowLoadBalancerStatusRequest();
request.withLoadbalancerId("{loadbalancer_id}");
try {
ShowLoadBalancerStatusResponse response = client.showLoadBalancerStatus(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = ElbClient.new_builder() \
.with_credentials(credentials) \
.with_region(ElbRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowLoadBalancerStatusRequest()
request.loadbalancer_id = "{loadbalancer_id}"
response = client.show_load_balancer_status(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := elb.NewElbClient(
elb.ElbClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowLoadBalancerStatusRequest{}
request.LoadbalancerId = "{loadbalancer_id}"
response, err := client.ShowLoadBalancerStatus(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;
public class ShowLoadBalancerStatusSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
ElbClient client = ElbClient.newBuilder()
.withCredential(auth)
.withRegion(ElbRegion.valueOf("<YOUR REGION>"))
.build();
ShowLoadBalancerStatusRequest request = new ShowLoadBalancerStatusRequest();
request.withLoadbalancerId("{loadbalancer_id}");
try {
ShowLoadBalancerStatusResponse response = client.showLoadBalancerStatus(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.v3 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = ElbClient.new_builder() \
.with_credentials(credentials) \
.with_region(ElbRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowLoadBalancerStatusRequest()
request.loadbalancer_id = "{loadbalancer_id}"
response = client.show_load_balancer_status(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := elb.NewElbClient(
elb.ElbClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowLoadBalancerStatusRequest{}
request.LoadbalancerId = "{loadbalancer_id}"
response, err := client.ShowLoadBalancerStatus(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作成功正常返回。 |
错误码
请参见错误码。