• Direct Connect

dc
  1. Help Center
  2. Direct Connect
  3. API Reference
  4. API
  5. Direct Connect Endpoint Group
  6. Querying the Direct Connect Endpoint Group List

Querying the Direct Connect Endpoint Group List

Function

This API is used to query the Direct Connect endpoint group list.

URI

GET /v2.0/dcaas/dc-endpoint-groups

Request

Table 1 lists the request parameter.

Table 1 Request parameter

Parameter

Type

Mandatory

Description

fields

String

No

Indicates the parameters expected to be returned.

If you do not specify it, all parameters will be returned.

Response

Table 2 lists the response parameter.

Table 2 Response parameter

Parameter

Type

Description

dc_endpoint_groups

List data structure

Indicates the Direct Connect endpoint group list.

Description of field dc_endpoint_groups

Parameter

Type

Description

id

String

Indicates the ID of the Direct Connect endpoint group.

tenant_id

String

Indicates the project ID.

name

String

Indicates the name of the Direct Connect endpoint group.

description

String

Provides supplementary information about the Direct Connect endpoint group.

endpoints

List<String>

Indicates the list of the Direct Connect endpoints.

type

String

Indicates the type of the Direct Connect endpoint.

The value is cidr.

Examples

  • Example request
    1. All parameters are returned:
    GET /v2.0/dcaas/dc-endpoint-groups
    1. Filtered parameters are returned (for example, the filter is ID):
    GET /v2.0/dcaas/dc-endpoint-groups?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
  • Example response
    {
         "dc_endpoint_groups" : [{
             "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
             "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
             "name" : "endpoint group1",
             "description" : "",
             "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],      
             "type" : "cidr"
        }]
    }

Returned Value

For details, see section Common Returned Values.