Querying EIP Pool Details
Function
This API is used to query EIP pool details.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
eip:publicipPools:get
Read
publicipPool *
-
vpc:publicIps:get
-
URI
GET /v3/{project_id}/eip/publicip-pools/{publicip_pool_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String |
Minimum: 32 Maximum: 32 |
| publicip_pool_id | Yes | String | EIP pool ID, which uniquely identifies the EIP pool. Minimum: 36 Maximum: 36 |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| publicip_pool | PublicipPoolShowResp object | EIP pool details. |
| request_id | String | Request ID. |
| Parameter | Type | Description |
|---|---|---|
| id | String | |
| name | String | |
| status | String | |
| type | String | |
| description | String | |
| project_id | String |
|
| size | Integer | |
| used | Integer | |
| created_at | String | |
| updated_at | String | |
| billing_info | BillingInfoDict object | Order information, which is available only for yearly/monthly resources. |
| public_border_group | String | |
| shared | Boolean | |
| tags | Array of TagsInfo objects | Array Length: 0 - 9999 |
| enterprise_project_id | String | |
| allow_share_bandwidth_types | Array of strings |
Maximum: 64 Array Length: 0 - 9999 |
Example Requests
Query details about the EIP pool with the ID of f588ccfa-8750-4d7c-bf5d-2ede24414706.
GET https://{Endpoint}/v3/{project_id}/eip/publicip-pools/f588ccfa-8750-4d7c-bf5d-2ede24414706 Example Responses
Status code: 200
{
"publicip_pool" : {
"id" : "f588ccfa-8750-4d7c-bf5d-2ede24414706",
"name" : "test_pool_xxx",
"status" : "active",
"shared" : true,
"enterprise_project_id" : 0,
"type" : "spec_bgp",
"project_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"size" : 100,
"used" : 20,
"billing_info" : {
"order_id" : "CS20081917179HW3H",
"product_id" : "00301-335034-0--0"
},
"created_at" : "2020-07-17T09:25:53Z",
"updated_at" : "2020-07-17T09:25:53Z",
"description" : "test",
"public_border_group" : "center",
"allow_share_bandwidth_types" : [ "share" ]
},
"request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
} SDK Sample Code
The SDK sample code is as follows.
Java
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.eip.v3.region.EipRegion; import com.huaweicloud.sdk.eip.v3.*; import com.huaweicloud.sdk.eip.v3.model.*; public class ShowPublicipPoolSolution { 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("<YOUR REGION>")) .build(); ShowPublicipPoolRequest request = new ShowPublicipPoolRequest(); request.withPublicipPoolId("{publicip_pool_id}"); try { ShowPublicipPoolResponse response = client.showPublicipPool(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
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 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("<YOUR REGION>")) \ .build() try: request = ShowPublicipPoolRequest() request.publicip_pool_id = "{publicip_pool_id}" response = client.show_publicip_pool(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
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 49 50 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ShowPublicipPoolRequest{} request.PublicipPoolId = "{publicip_pool_id}" response, err := client.ShowPublicipPool(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Normal response to the GET operation |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot