Creating a LAG

Function

This API is used to create a LAG. Before creating a LAG, you need to request connections.

Calling Method

For details, see Calling APIs.

URI

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

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

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
link_aggregation_group	No	CreateLinkAggregationGroup object	Specifies the LAG.

**Table 4** CreateLinkAggregationGroup
Parameter	Mandatory	Type	Description
tenant_id	No	String	Specifies the project ID.
name	No	String	Specifies the LAG name. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the LAG. Minimum: 0 Maximum: 128
region_id	No	String	Specifies the ID of the region where the LAG is created.
work_mode	Yes	String	Specifies the negotiation mode of the LAG. If this parameter is set to Manual, you need to manually specify the load configuration. If this parameter is set to Static, the two ends negotiate with each other through LACP. Enumeration values: Manual Static
min_up_num	No	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
admin_state_up	No	Boolean	Specifies the administrative status of the LAG.
direct_connect_ids	Yes	Array of strings	Lists the IDs of connections added to the LAG.
ies_id	No	String	Specifies the ID of the IES edge site where the LAG is used. If there is no IES edge site ID, the value is left blank.
enterprise_project_id	No	String	Specifies the ID of the enterprise project that the LAG belongs to.
tags	No	Array of Tag objects	Lists the tags.

**Table 5** Tag
Parameter	Mandatory	Type	Description

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
link_aggregation_group	LinkAggregationGroup object	LAG

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

Creating a LAG with the lower threshold of active links set to 1 and the negotiation mode to Static

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

{
  "link_aggregation_group" : {
    "name" : "Lag01-02",
    "description" : "to idc1",
    "min_up_num" : 1,
    "work_mode" : "Static",
    "direct_connect_ids" : [ "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a" ]
  }
}

Example Responses

Status code: 201

Created

{
  "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"
  }
}