Querying the LAG List

Function

This API is used to query the LAG list.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project 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
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
fields	No	Array	Specifies the list of fields to be displayed. Array Length: 1 - 5
sort_dir	No	Array	Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.
sort_key	No	String	Specifies the sorting field. Default: id Minimum: 0 Maximum: 36
enterprise_project_id	No	Array	Filters resource instances by enterprise project ID. Array Length: 1 - 10
id	No	Array	Specifies the resource ID by which instances are filtered. 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_groups	Array of LinkAggregationGroup objects	LAG
page_info	PageInfo object	Specifies the pagination query information.

**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.

**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 the LAG list

GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/link-aggregation-groups

Example Responses

Status code: 200

{
  "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535",
  "link_aggregation_groups" : [ {
    "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"
  } ]
}