# 查询GEIP与实例绑定关系的租户列表 - ListProjectGeipBindings #### 功能介绍 查询GEIP与实例绑定关系的租户列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ListProjectGeipBindings&version=v3)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET https://www.example.com/v3/{project_id}/geip/bindings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | GEIP的租户id 最小长度：**1** 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fields | 否 | String | 形式为"fields=geip_id\&fields=geip_ip_address\&..."，支持字段：geip_id/geip_ip_address/instance_type/instance_id/vnic/vn_list/public_border_group/gcbandwidth/version/created_at/updated_at/instance_vpc_id 最小长度：**0** 最大长度：**1024** | | geip_id | 否 | String | GEIP的uuid 最小长度：**1** 最大长度：**36** | | geip_ip_address | 否 | String | GEIP的ip地址 最小长度：**1** 最大长度：**64** | | public_border_group | 否 | String | GEIP所处的出口位置 最小长度：**1** 最大长度：**36** | | instance_type | 否 | String | - 参数解释：GEIP支持绑定的实例类型。 - 约束限制：不涉及 - 取值范围： - DC-CONNECT-GATEWAY：云专线。 - IPV6-DC-CONNECT-GATEWAY:IPV6云专线。 - ECS：弹性云服务器。 - IPV6-ECS：IPV6弹性云服务器。 - PORT：弹性网卡。 - IPV6-PORT：IPV6弹性网卡。 - VIP:虚拟IP。 - IPV6-VIP：IPV6虚拟IP。 - ELB：弹性负载均衡。 - IPV6-ELB：IPV6弹性负载均衡。 - NATGW：NAT网关。 - 默认取值：不涉及 最小长度：**0** 最大长度：**64** | | instance_id | 否 | String | 绑定的实例id 最小长度：**0** 最大长度：**36** | | instance_vpc_id | 否 | String | 绑定的实例vpcid 最小长度：**0** 最大长度：**36** | | gcbandwidth.id | 否 | String | 骨干带宽的uuid 最小长度：**0** 最大长度：**36** | | gcbandwidth.admin_state | 否 | String | - 参数解释：根据骨干带宽状态过滤。 - 约束限制：不涉及 - 取值范围： - NORMAL：正常带宽状态。 - FREEZED：带宽被冻结。 - 默认取值：不涉及 最小长度：**0** 最大长度：**64** | | gcbandwidth.size | 否 | Integer | 骨干带宽的大小 最小值：**0** 最大值：**999999** | | gcbandwidth.sla_level | 否 | String | 描述网络等级，从高到低分为铂金、金、银、铜 最小长度：**0** 最大长度：**64** | | gcbandwidth.dscp | 否 | Integer | 线路质量金银铜对应的DSCP值 最小值：**0** 最大值：**63** | | vnic.private_ip_address | 否 | String | 绑定实例的ip地址 最小长度：**0** 最大长度：**64** | | vnic.vpc_id | 否 | String | 绑定实例所在的vpcid 最小长度：**0** 最大长度：**36** | | vnic.port_id | 否 | String | 绑定实例port的uuid 最小长度：**0** 最大长度：**36** | | vnic.device_id | 否 | String | 端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。 最小长度：**0** 最大长度：**36** | | vnic.device_owner | 否 | String | 端口所属的设备，表示使用子网内私有IP地址的云服务资源。 最小长度：**0** 最大长度：**256** | | vnic.device_owner_prefixlike | 否 | String | 绑定实例port对应的实例所有者的前缀 最小长度：**0** 最大长度：**256** | | vnic.instance_type | 否 | String | - 功能说明：port的实例类型。 - 约束限制：不涉及 - 取值范围： - ECS：弹性云服务器。 - IPV6-ECS：IPV6弹性云服务器。 - PORT：弹性网卡。 - IPV6-PORT：IPV6弹性网卡。 - VIP:虚拟IP。 - IPV6-VIP：IPV6虚拟IP。 - ELB：弹性负载均衡。 - IPV6-ELB：IPV6弹性负载均衡。 - NATGW：NAT网关。 - 默认取值：不涉及 最小长度：**0** 最大长度：**64** | | vnic.instance_id | 否 | String | 绑定实例port对应的实例id 最小长度：**0** 最大长度：**36** | | sort_key | 否 | String | - 参数解释：排序，形式为"sort_key=geip_id\&sort_dir=asc\\。 - 约束限制：不涉及 - 取值范围： - geip_id：全域弹性公网IP的id。 - version：全域弹性公网IP的版本。 - public_border_group：表示中心站点资源或者边缘站点资源。 - geip_ip_address：全域弹性公网IP的IP地址。 - created_at：全域弹性公网IP的创建时间。 - updated_at：全域弹性公网IP的更新时间。 - 默认取值：不涉及 最小长度：**0** 最大长度：**1024** | | sort_dir | 否 | String | 排序方向 取值范围：asc、desc 最小长度：**0** 最大长度：**1024** | | limit | 否 | Integer | - 功能说明：每页返回的个数 - 取值范围：0\~2000 最小值：**0** 最大值：**2000** | | offset | 否 | Integer | 分页起始点 | | marker | 否 | String | 分页起始点 最小长度：**0** 最大长度：**36** | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | geip_bindings | Array of [GeipBindingsInternalResp] objects | geip绑定关系对象 数组长度：**0 - 999999** | | request_id | String | 本次请求编号 最小长度：**0** 最大长度：**36** | 表4GeipBindingsInternalResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | geip_id | String | GEIP的uuid 最小长度：**0** 最大长度：**36** | | geip_ip_address | String | GEIP的ip地址 最小长度：**0** 最大长度：**64** | | public_border_group | String | 中心站点or边缘站点，默认展示 最小长度：**0** 最大长度：**64** | | created_at | String | 创建时间 最小长度：**0** 最大长度：**64** | | updated_at | String | 更新时间 最小长度：**0** 最大长度：**64** | | instance_type | String | - 参数解释：geip支持绑定的实例类型。 - 约束限制：不涉及 - 取值范围： - DC-CONNECT-GATEWAY：云专线。 - IPV6-DC-CONNECT-GATEWAY:IPV6云专线。 - ECS：弹性云服务器。 - IPV6-ECS：IPV6弹性云服务器。 - PORT：弹性网卡。 - IPV6-PORT：IPV6弹性网卡。 - VIP:虚拟IP。 - IPV6-VIP：IPV6虚拟IP。 - ELB：弹性负载均衡。 - IPV6-ELB：IPV6弹性负载均衡。 - NATGW：NAT网关。 - 默认取值：不涉及 最小长度：**0** 最大长度：**64** | | instance_id | String | 绑定实例的id 最小长度：**0** 最大长度：**36** | | version | Integer | GEIP的版本号 最小值：**0** 最大值：**9223372036854775807** | | gcbandwidth | [BackboneBandwidthResp] object | 骨干带宽对象 | | vnic | [InstanceVnicResp] object | 实例port的信息 | | vn_list | Array of [InstancevirtualListResp] objects | GEIP实例的vn信息 数组长度：**0 - 9999** | 表5BackboneBandwidthResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 骨干带宽的uuid 最小长度：**0** 最大长度：**36** | | admin_state | String | - 参数解释：骨干带宽状态。 - 约束限制：不涉及 - 取值范围： - NORMAL：正常带宽状态。 - FREEZED：带宽被冻结。 - 默认取值：不涉及 最小长度：**0** 最大长度：**64** | | size | Integer | 骨干带宽的大小 最小值：**0** 最大值：**2000** | | short_id | String | 骨干带宽的short_id 最小长度：**0** 最大长度：**36** | | sla_level | String | 描述网络等级，从高到低分为铂金、金、银、铜 | | dscp | Integer | 线路质量金银铜对应的DSCP值 最小值：**0** 最大值：**63** | 表6InstanceVnicResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | private_ip_address | String | 实例port的ip地址 最小长度：**0** 最大长度：**64** | | device_id | String | 端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。 最小长度：**0** 最大长度：**36** | | device_owner | String | 端口所属的设备，表示使用子网内私有IP地址的云服务资源。 最小长度：**0** 最大长度：**64** | | vpc_id | String | port的vpc_id 最小长度：**0** 最大长度：**36** | | port_id | String | port的uuid 最小长度：**0** 最大长度：**36** | | mac | String | port的mac地址 最小长度：**0** 最大长度：**256** | | vtep | String | port的vtep地址 最小长度：**0** 最大长度：**256** | | vni | Integer | port的vni 最小值：**0** 最大值：**999999** | | instance_id | String | port的实例id 最小长度：**0** 最大长度：**36** | | instance_type | String | - 功能说明：port的实例类型。 - 约束限制：不涉及 - 取值范围： - ECS：弹性云服务器。 - IPV6-ECS：IPV6弹性云服务器。 - PORT：弹性网卡。 - IPV6-PORT：IPV6弹性网卡。 - VIP:虚拟IP。 - IPV6-VIP：IPV6虚拟IP。 - ELB：弹性负载均衡。 - IPV6-ELB：IPV6弹性负载均衡。 - NATGW：NAT网关。 - 默认取值：不涉及 最小长度：**0** 最大长度：**64** | | port_profile | String | port的profile 最小长度：**0** 最大长度：**1024** | 表7InstancevirtualListResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | virtualnexthop的uuid 最小长度：**0** 最大长度：**36** | | owner | String | virtualnexthop的所有者 最小长度：**0** 最大长度：**256** | | location | String | 标识网关所在位置POD、AZ、REGION、GLOBAL 最小长度：**0** 最大长度：**256** | | forward_mode | String | 功能说明：nexthops的转发模式 取值范围：'ACTIVE-ACTIVE'多活模式、'ACTIVE-STANDBY'主备模式 最小长度：**0** 最大长度：**256** | | cluster_id | String | 功能说明：网关所在集群信息，可为空 取值范围：0-36长度的字符串 最小长度：**0** 最大长度：**36** | | hash_mode | String | 功能说明：nexthops在底层的负载均衡策略 取值范围：'2_TUPLE'二元组、'3_TUPLE'三元组、'5_TUPLE'五元组 缺省值：**5_TUPLE** 最小长度：**0** 最大长度：**256** | | type | String | - 参数解释：下一跳所属网络类型。 - 约束限制：不涉及 - 取值范围： - VXLAN：虚拟扩展局域网。 - VLAN：虚拟局域网。 - 默认取值：VXLAN 缺省值：**VXLAN** 最小长度：**0** 最大长度：**256** | | vni | Integer | 功能说明：网络id标识，与type组合使用 取值范围：type=VXLAN时取值0-16777215,type=VLAN时取值0-4095 最小值：**0** 最大值：**999999** | | nexthops | Array of [NexthopDict] objects | 下一跳信息列表 数组长度：**0 - 999999** | | created_at | String | 功能说明：VirtualNexthop对象创建时间，UTC格式 最小长度：**0** 最大长度：**256** | | updated_at | String | 功能说明：VirtualNexthop对象更新时间，UTC格式 最小长度：**0** 最大长度：**256** | 表8NexthopDict | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip_address | String | 功能说明：下一跳的实际地址 约束与限制：同一virtualnexthop中的nexthops列表，不同下一跳之间的地址不允许重复 最小长度：**0** 最大长度：**256** | | mode | String | 功能说明：标识主备模式，与virtualnexthop的forward_mode配合使用 取值范围：'ACTIVE'主、'STANDBY'备 最小长度：**0** 最大长度：**256** | #### 请求示例 查询GEIP与实例绑定关系的租户列表 ``` GET https://{Endpoint}/v3/{project_id}/geip/bindings ``` #### 响应示例 **状态码：200** ``` { "geip_bindings" : [ { "geip_id" : "33866d83-e3eb-4380-b58d-525a47031435", "geip_ip_address" : "15.12.10.45", "public_border_group" : "center", "created_at" : "2021-07-07T13:10:19", "updated_at" : "2021-07-07T13:10:19", "instance_type" : "PORT", "instance_id" : "c88b8567-bd23-4e75-9257-b3052bd51bc1", "version" : 1637893479433, "gcbandwidth" : { "id" : "45866d83-e3eb-4380-b58d-525a47031435", "admin_state" : "active", "size" : 100, "short_id" : "45866d83", "sla_level" : "Ag", "dscp" : 0 }, "vnic" : { "private_ip_address" : "172.16.1.49", "device_id" : "aa4c1bb3-7a61-4f1b-a828-bd41b742d4f4", "device_owner" : "compute:br-iaas-odin1a", "vpc_id" : "4ec81e96-7d45-488b-833f-792c8f1e679a", "port_id" : "b52eec78-271d-48fa-a6df-fc9761416f56", "mac" : "fa:16:3e:25:db:02", "vtep" : null, "vni" : null, "instance_id" : "", "instance_type" : "", "port_profile" : null }, "vn_list" : [ { "id" : "7cc3ccb1-877f-46bf-9225-ce1df80288cf", "owner" : "br2gw", "location" : "br-iaas-odin1b", "forward_mode" : "ACTIVE-STANDBY", "cluster_id" : "br-iaas-odin1b", "hash_mode" : "5_TUPLE", "type" : "VXLAN", "vni" : 4000, "created_at" : "2021-07-15T09:44:40Z", "updated_at" : "2021-07-15T09:44:40Z", "nexthops" : [ { "ip_address" : "18.9.203.100", "mode" : "ACTIVE" } ] } ] } ], "request_id" : "6d81f3f0-1c4a-4fba-aaca-1b9e762125d4" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.eip.v3.region.EipRegion; import com.huaweicloud.sdk.eip.v3.*; import com.huaweicloud.sdk.eip.v3.model.*; public class ListProjectGeipBindingsSolution { 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); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .build(); ListProjectGeipBindingsRequest request = new ListProjectGeipBindingsRequest(); try { ListProjectGeipBindingsResponse response = client.listProjectGeipBindings(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()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v3.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.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 = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .build() try: request = ListProjectGeipBindingsRequest() response = client.list_project_geip_bindings(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ListProjectGeipBindingsRequest{} response, err := client.ListProjectGeipBindings(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=ListProjectGeipBindings&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。