查询负载均衡器占用的下联面子网端口列表
功能介绍
查询负载均衡器占用的下联面子网端口和IP地址信息。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}/local-ports
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目ID。获取方式请参见获取项目ID。 约束限制:不涉及 取值范围:长度为32个字符,由小写字母和数字组成。 默认取值:不涉及 |
loadbalancer_id |
是 |
String |
参数解释:负载均衡器ID。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
port_id |
否 |
Array of strings |
参数解释:负载均衡器占用的端口ID。 支持多值查询,查询条件格式:port_id=xxx&port_id=xxx。 |
ip_address |
否 |
Array of strings |
参数解释:负载均衡器占用的私有IPv4地址。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 支持多值查询,查询条件格式:ip_address=xxx&ip_address=xxx。 |
ipv6_address |
否 |
Array of strings |
参数解释:负载均衡器占用的IPv6地址。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 支持多值查询,查询条件格式:ipv6_address=xxx&ipv6_address=xxx。 |
type |
否 |
Array of strings |
参数解释:子网端口类型。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 支持多值查询,查询条件格式:type=xxx&type=xxx。 |
virsubnet_id |
否 |
Array of strings |
参数解释:子网端口所在下联面子网网络ID。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 支持多值查询,查询条件格式:virsubnet_id=xxx&virsubnet_id=xxx。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
ports |
Array of LocalPort objects |
参数解释:当前ELB占用的子网端口列表。 |
request_id |
String |
参数解释:请求ID。 取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。 |
参数 |
参数类型 |
描述 |
---|---|---|
port_id |
String |
参数解释:负载均衡器占用的端口ID。 取值范围:不涉及 |
ip_address |
String |
参数解释:负载均衡器占用的私有IPv4地址。 取值范围:不涉及 |
ipv6_address |
String |
参数解释:负载均衡器占用的IPv6地址。 取值范围:不涉及 |
type |
String |
参数解释:子网端口类型。 取值范围:
|
virsubnet_id |
String |
参数解释:子网端口所在下联面子网网络ID。 取值范围:不涉及 |
请求示例
查询负载均衡器占用的port列表
GET https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/38278031-cfca-44be-81be-a412f618773b/local-ports
响应示例
状态码:200
操作成功正常返回。
{ "ports" : [ { "port_id" : "b796e55e-988a-429e-a132-9245beb046e5", "ip_address" : "192.168.1.2", "ipv6_address" : "2420:2023:410:151:49c:7163:342a:3e3", "type" : "l4_hc", "virsubnet_id" : "4507af92-719f-4878-9394-6a6a6ba1dcbb" } ] }
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 ShowLoadBalancerPortsSolution { 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(); ShowLoadBalancerPortsRequest request = new ShowLoadBalancerPortsRequest(); request.withLoadbalancerId("{loadbalancer_id}"); try { ShowLoadBalancerPortsResponse response = client.showLoadBalancerPorts(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 = ShowLoadBalancerPortsRequest() request.loadbalancer_id = "{loadbalancer_id}" response = client.show_load_balancer_ports(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.ShowLoadBalancerPortsRequest{} request.LoadbalancerId = "{loadbalancer_id}" response, err := client.ShowLoadBalancerPorts(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作成功正常返回。 |
错误码
请参见错误码。