Updated on 2024-04-03 GMT+08:00

Querying the Customer Gateway List

Function

This API is used to query the customer gateway list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/customer-gateways

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

Table 2 Parameter in a query request

Parameter

Type

Mandatory

Description

limit

Integer

No

  • Specifies the number of records returned on each page during pagination query.
  • The value ranges from 0 to 200.
  • The default value is 200.

marker

String

No

  • Specifies the start flag for querying the current page. If this parameter is left blank, the first page is queried. The marker for querying the next page is the next_marker in the page_info object returned on the current page.
  • This parameter must be used together with limit.

Request

  • Request parameters

    None

  • Example request
    GET https://{Endpoint}/v5/{project_id}/customer-gateways?limit={limit}&marker={marker}

Response

  • Response parameters

    Returned status code 200: successful query

    Table 3 Parameters in the response body

    Parameter

    Type

    Description

    customer_gateways

    Array of

    ResponseCustomerGateway objects

    Specifies the customer gateway object.

    total_count

    Long

    Specifies the total number of a tenant's customer gateways.

    page_info

    PageInfo object

    Specifies pagination information.

    request_id

    String

    Specifies a request ID.

    Table 4 ResponseCustomerGateway

    Parameter

    Type

    Description

    id

    String

    • Specifies a customer gateway ID.
    • The value is a UUID containing 36 characters.

    name

    String

    • Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.
    • The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).

    id_type

    String

    • Specifies the identifier type of a customer gateway.
    • The value can be ip or fqdn.

    id_value

    String

    Specifies the identifier of a customer gateway.

    bgp_asn

    Long

    Specifies the BGP AS number of the customer gateway. This parameter is available only when id_type is set to ip.

    created_at

    String

    Specifies the time when the customer gateway is created.

    updated_at

    String

    Specifies the last update time.

    tags

    Array of VpnResourceTag objects

    Specifies a tag list.

    Table 5 VpnResourceTag

    Parameter

    Type

    Description

    key

    String

    • Specifies a tag key.
    • The value is a string of 1 to 128 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).

    value

    String

    • Specifies a tag value.
    • The value is a string of 0 to 255 characters that can contain digits, letters, Spanish characters, Portuguese characters, spaces, and special characters (_ . : = + - @).
    Table 6 PageInfo

    Parameter

    Type

    Description

    next_marker

    String

    Specifies the marker of the next page. The value is the time when the last resource in the last query response was created.

    current_count

    Integer

    Specifies the number of resources in the list. If the value of current_count is less than the value of limit in the query request, the current page is the last page.

  • Example response
    {
        "customer_gateways": [{
            "id": "e67d6e27-demo-a8df-va86-be9a0f0168e9",
            "name": "cgw-a45b",
            "id_type": "ip",
            "id_value": "100.***.***.81",
            "bgp_asn": 65588,
            "created_at": "2022-11-28T07:36:24.923Z",
            "updated_at": "2022-11-28T07:36:24.923Z"
        }, {
            "id": "312067bb-demo-a8df-va86-09dc941bbffc",
            "name": "cgw-21a3",
            "id_type": "fqdn",
            "id_value": "123******456",
            "created_at": "2022-11-28T06:25:01.937Z",
            "updated_at": "2022-11-28T06:25:01.937Z"
        }],
        "total_count": 2,
        "page_info": {
            "next_marker": "2022-11-28T06:25:01.937Z",
            "current_count": 2
        },
        "request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"
    }

Status Codes

For details, see Status Codes.