Help Center/ Direct Connect/ eu-west-0-api/ API/ LAGs/ Querying Details About a LAG

Updated on 2024-07-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Details About a LAG

Function

This API is used to query the details about a LAG.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/link-aggregation-groups/{dc_lag_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
dc_lag_id	Yes	String	Specifies the LAG ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
fields	No	Array	Specifies the list of fields to be displayed. Array Length: 1 - 5

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.
link_aggregation_group	LinkAggregationGroup object	LAG

**Table 5** LinkAggregationGroup
Parameter	Type	Description
id	String	Specifies the LAG ID.
tenant_id	String	Specifies the project ID.
name	String	Specifies the LAG name. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the LAG. Minimum: 0 Maximum: 128
work_mode	String	Specifies the negotiation mode of the LAG: static or LACP. Enumeration values: Manual Static
min_up_num	Integer	Specifies the lower threshold of active links in a LAG. When the number of active links is smaller than the lower threshold, the LAG status changes to Down. Minimum: 1 Maximum: 16
device_id	String	Specifies the ID of the device on which the LAG is used.
status	String	Specifies the LAG status.
admin_state_up	Boolean	Specifies the administrative status of the LAG.
enterprise_project_id	String	Specifies the ID of the enterprise project that the LAG belongs to.
apply_time	String	Specifies the time when the LAG was requested. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.
create_time	String	Specifies the time when the LAG was created. The UTC time format yyyy-MM-ddTHH:mm:ss.SSSZ is used.
delete_time	String	Specifies the time when the LAG was deleted.
public_border_group	String	Specifies the public border group corresponding to the AZ where the LAG is used.

Example Requests

Querying details about a LAG

GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/link-aggregation-groups/a7c5ce8a-62a8-433e-94af-d1894effce59

Example Responses

Status code: 200

{
  "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535",
  "link_aggregation_group" : {
    "id" : "a7c5ce8a-62a8-433e-94af-d1894effce59",
    "name" : "Lag01-02",
    "description" : "to idc1",
    "tenant_id" : "ed28c294165741faaeccab26913122a1",
    "min_up_num" : 1,
    "enterprise_project_id" : 0,
    "work_mode" : "Static",
    "device_id" : "26.151.63.100",
    "status" : "DOWN",
    "admin_state_up" : null,
    "public_border_group" : null,
    "apply_time" : "2023-06-14T07:29:25.000Z",
    "create_time" : "2023-06-14T07:29:25.000Z"
  }
}