文档首页/ 云专线 DC/ API参考 (巴黎) / API/ 链路聚合组/ 查询链路聚合组列表
更新时间：2024-07-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询链路聚合组列表

功能介绍

查询链路聚合组详细信息列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页返回的个数。 取值范围：1~2000。

最小值：1

最大值：2000

缺省值：2000

marker

否

String

上一页最后一条资源记录的ID，为空时为查询第一页。 使用说明：必须与limit一起使用。

最小长度：0

最大长度：36

fields

否

Array

显示字段列表

数组长度：1 - 5

sort_dir

否

Array

返回结果按照升序(asc)或降序(desc)排列，默认为asc

sort_key

否

String

排序字段。

缺省值：id

最小长度：0

最大长度：36

enterprise_project_id

否

Array

根据企业项目ID过滤资源实例

数组长度：1 - 10

id

否

Array

根据资源ID过滤实例

数组长度：1 - 5

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：0

最大长度：10240

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

link_aggregation_groups

Array of LinkAggregationGroup objects

链路聚合组对象

page_info

PageInfo object

分页查询页的信息
表5 LinkAggregationGroup

参数

参数类型

描述

id

String

链路聚合组的ID

tenant_id

String

归属的租户的项目ID

name

String

链路聚合组的名字

最小长度：0

最大长度：64

description

String

链路聚合组的描述信息

最小长度：0

最大长度：128

work_mode

String

链路聚合组的协商模式,手工模式和LACP模式

枚举值：

  • Manual
  • Static

min_up_num

Integer

链路聚合组的活动的链路数的下限阈值，当前活动物理连接链路数目小于下限阈值时，链路聚合组的状态转为Down

最小长度：1

最大长度：16

device_id

String

链路聚合组归属的设备ID

status

String

链路聚合组的状态

admin_state_up

Boolean

链路聚合组的管理状态

enterprise_project_id

String

链路聚合组归属的企业项目ID

apply_time

String

链路聚合组申请时间。采用UTC时间格式，格式为：yyyy-MM-ddTHH:mm:ss.SSSZ

create_time

String

链路聚合组申请时间。采用UTC时间格式，格式为：yyyy-MM-ddTHH:mm:ss.SSSZ

delete_time

String

链路聚合组删除时间

public_border_group

String

链路聚合组归属的可用区对应的边界组(public border group)
表6 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的marker，值为资源的uuid

最小长度：0

最大长度：36

current_count

Integer

当前列表中资源数量

最小值：0

最大值：2000

next_marker

String

下一页的marker，值为资源的uuid，为空时表示最后一页

最小长度：0

最大长度：36

请求示例

查询链路聚合组列表

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

响应示例

状态码： 200

OK

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

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 链路聚合组