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.
Parameter | Type | Mandatory | Description |
---|---|---|---|
fields | String | No | Specifies the parameters expected to be returned. If you do not specify it, all parameters will be returned. |
Response¶
Table 2 lists the response parameter.
Parameter | Type | Description |
---|---|---|
dc_endpoint_groups | List | Specifies the Direct Connect endpoint group list. |
Parameter | Type | Description |
---|---|---|
id | String | Specifies the ID of the Direct Connect endpoint group. |
tenant_id | String | Specifies the project ID. |
name | String | Specifies the name of the Direct Connect endpoint group. |
description | String | Provides supplementary information about the Direct Connect endpoint group. |
endpoints | List<String> | Specifies the list of the endpoints in a Direct Connect endpoint group. |
type | String | Specifies the type of the Direct Connect endpoints. The value can only be cidr. Only IPv4 CIDR blocks are supported. |
Examples¶
Example request
Querying all Direct Connect endpoint groups
GET /v2.0/dcaas/dc-endpoint-groups
Querying a Direct Connect endpoint group by 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" }] }
Status Codes¶
For details, see Common Status Codes.