# 查询弹性公网IP - ShowInstanceEip #### 功能介绍 查询弹性公网IP。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:instance:getPublicIp | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:instance:list | - | #### URI GET /v3/{project_id}/instances/{instance_id}/eip 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 通过调用[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)接口获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | can_enable_public_access | Boolean | **参数解释**： 是否能访问公网。 **取值范围**： - true：能访问。 - false: 不能访问。 | | id | String | **参数解释**： 弹性公网ID。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 弹性公网IP的网络类型。 **取值范围**： - 5_bgp：全动态BGP。 - 5_sbgp：静态BGP。 - 5_youxuanbgp：优选BGP。 | | port_id | String | **参数解释**： 端口ID。 **取值范围**： 不涉及。 | | public_ip_address | String | **参数解释**： 弹性公网IP地址。 **取值范围**： 不涉及。 | | private_ip_address | String | **参数解释**： 绑定弹性公网IP的私有IP地址。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 弹性公网IP状态。 **取值范围**： - FREEZED：冻结。 - BIND_ERROR：绑定失败。 - BINDING：绑定中。 - PENDING_DELETE：释放中。 - PENDING_CREATE：创建中。 - NOTIFYING：创建中。 - NOTIFY_DELETE：释放中。 - PENDING_UPDATE：更新中。 - DOWN：未绑定。 - ACTIVE：绑定。 - ELB：绑定ELB。 - VPN：绑定VPN。 - ERROR：失败。 | | tenant_id | String | **参数解释**： 租户ID。 **取值范围**： 不涉及。 | | create_time | String | **参数解释**： 弹性公网IP申请时间。 **取值范围**： 不涉及。 | | bandwidth_id | String | **参数解释**： 带宽ID。 **取值范围**： 不涉及。 | | bandwidth_name | String | **参数解释**： 带宽名称。 **取值范围**： 不涉及。 | | bandwidth_size | Integer | **参数解释**： 带宽大小，单位为Mbit/s。 **取值范围**： 不涉及。 | | bandwidth_share_type | String | **参数解释**： 带宽类型。 **取值范围**： - PER：独享带宽。 - WHOLE：共享带宽。 | | profile | Object | **参数解释**： 额外参数，包括订单id、产品id等信息。如果profile不为空，说明是包周期的弹性公网IP。 **取值范围**： 不涉及。 | **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 查询弹性公网IP。 ``` GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/12a49c2dc32648df8dd25e2976f70180in07/eip ``` #### 响应示例 **状态码：200** ``` { "can_enable_public_access" : true, "id" : "45a0ed37-cfa7-4403-8aeb-d720b4e831cf", "type" : "5_bgp", "port_id" : "2c02dc5b-a136-4921-b7ad-27e084548616", "public_ip_address" : "10.83.35.151", "private_ip_address" : "172.16.1.137", "status" : "ACTIVE", "tenant_id" : "23a50154cf494ec9ad6883979a12db0a", "create_time" : "2024-04-09 13:42:11", "bandwidth_id" : "2a4b2bc5-2a0a-42df-8f13-2fbe3d8bbbb2", "bandwidth_name" : "bandwidth-d3f4", "bandwidth_size" : 1, "bandwidth_share_type" : "PER", "profile" : { } } ``` #### 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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ShowInstanceEipSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); ShowInstanceEipRequest request = new ShowInstanceEipRequest(); request.withInstanceId("{instance_id}"); try { ShowInstanceEipResponse response = client.showInstanceEip(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 huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = ShowInstanceEipRequest() request.instance_id = "{instance_id}" response = client.show_instance_eip(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" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/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 := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.ShowInstanceEipRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowInstanceEip(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=ShowInstanceEip)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。