Help Center/ Direct Connect/ API Reference/ API/ Global EIPs/ Querying the Global EIPs Bound to a Connect Gateway
Updated on 2024-12-24 GMT+08:00

Querying the Global EIPs Bound to a Connect Gateway

Function

This API is used to query the global EIPs bound to a connect gateway.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/connect-gateways/{connect_gateway_id}/binding-global-eips

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 0

Maximum: 36

connect_gateway_id

Yes

String

Specifies the connect gateway ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the number of records returned on each page.

Value range: 1 to 2000

Minimum: 1

Maximum: 2000

Default: 2000

offset

No

Integer

Specifies the pagination offset.

Minimum: 1

Maximum: 1000

marker

No

String

Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried.

This parameter must be used together with limit.

Minimum: 0

Maximum: 36

page_reverse

No

Boolean

Specifies the pagination parameter.

fields

No

Array of strings

Specifies the list of fields to be displayed.

Array Length: 1 - 5

ext_fields

No

Array of strings

show response ext-fields

Array Length: 0 - 5

sort_key

No

String

Specifies the sorting field.

Default: id

Minimum: 0

Maximum: 36

sort_dir

No

Array of strings

Specifies the sorting order of returned results. There are two options: asc (default) and desc.

status

No

Array of strings

Specifies the status by which instances are filtered.

Array Length: 1 - 5

global_eip_id

No

Array of strings

Specifies the global EIP ID.

global_eip_segment_id

No

Array of strings

Specifies the ID of the global EIP range.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header.

Minimum: 0

Maximum: 10240

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

global_eips

Array of ListBindingGeip objects

Lists the bound global EIPs.

total_count

Integer

Total count.

page_info

PageInfo object

Specifies the pagination query information.

Table 5 ListBindingGeip

Parameter

Type

Description

global_eip_id

String

Specifies the global EIP ID.

global_eip_segment_id

String

Specifies the ID of the global EIP range.

status

String

Specifies whether the global EIP has been bound.

type

String

Specifies the global EIP type. The value can be IP_ADDRESS or IP_SEGMENT.

error_message

String

Specifies the cause of the failure to bind the global EIP.

cidr

String

Specifies the global EIP and its subnet mask.

address_family

String

Specifies the address family of the global EIP.

ie_vtep_ip

String

Specifies the VTEP IP address of the CloudPond cluster.

created_time

String

Specifies the time when the global EIP was bound.

gcb_id

String

Specifies the global connection bandwidth ID.

Table 6 PageInfo

Parameter

Type

Description

previous_marker

String

Specifies the marker of the previous page. The value is the resource UUID.

Minimum: 0

Maximum: 36

current_count

Integer

Specifies the number of resources in the current list.

Minimum: 0

Maximum: 2000

next_marker

String

Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.

Minimum: 0

Maximum: 36

Example Requests

Querying List of Bind GEIPs

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways/934aa302-5f1a-44c8-855b-20f715e2dbf3/binding-global-eips

Example Responses

Status code: 200

OK

  • The bound global EIPs that have been queried
    {
      "request_id" : "7609b2aa4ca77535aec53255a249b640",
      "global_eips" : [ {
        "created_time" : "2024-12-12T07:23:07.000Z",
        "global_eip_segment_id" : "d9157a57-95f7-4183-b0d3-a3897d3587b0",
        "status" : "BIND_SUCCESSFULLY",
        "type" : "IP_SEGMENT",
        "error_message" : null,
        "address_family" : "ipv4",
        "ie_vtep_ip" : "26.150.134.64",
        "cidr" : "215.255.202.176/28"
      } ],
      "total_count" : 1,
      "page_info" : {
        "previous_marker" : null,
        "current_count" : 1
      }
    }

SDK Sample Code

The SDK sample code is as follows.

 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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;


public class ListGlobalEipsSolution {

    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);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListGlobalEipsRequest request = new ListGlobalEipsRequest();
        request.withConnectGatewayId("{connect_gateway_id}");
        try {
            ListGlobalEipsResponse response = client.listGlobalEips(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 huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.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 = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListGlobalEipsRequest()
        request.connect_gateway_id = "{connect_gateway_id}"
        response = client.list_global_eips(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"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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 := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListGlobalEipsRequest{}
	request.ConnectGatewayId = "{connect_gateway_id}"
	response, err := client.ListGlobalEips(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

OK

Error Codes

See Error Codes.