查询线路分组列表
功能介绍
查询线路分组列表。该接口部分区域未上线、如需使用请提交工单申请开通。
调用方法
请参见如何调用API。
URI
GET /v2.1/linegroups
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
line_id |
否 |
String |
线路分组ID。 模糊匹配。 |
name |
否 |
String |
线路分组名称。 模糊匹配。 |
limit |
否 |
Integer |
每页返回的资源个数。 当查询详细信息时：取值范围：0~100取值一般为10，20，50默认为100。 当查询概要信息时：取值范围：0~3000默认为3000。 |
offset |
否 |
Integer |
分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 取值范围：0~2147483647 默认值为0。 当前设置marker不为空时，以marker为分页起始标识。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
linegroups |
Array of CreateLineGroupsResp objects |
列表对象。 |
metadata |
metadata object |
返回满足过滤条件的资源总数。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
线路分组名称。 |
lines |
Array of strings |
线路分组包含的线路列表。 解析线路ID。 |
status |
String |
资源状态。 取值范围：PENDING_CREATE，ACTIVE，PENDING_DELETE，PENDING_UPDATE，ERROR，FREEZE，DISABLE。 |
description |
String |
线路分组的描述信息 |
line_id |
String |
线路分组的id。 |
created_at |
String |
创建时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS。 |
updated_at |
String |
更新时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
code |
String |
错误码 最小长度：8 最大长度：36 |
message |
String |
错误描述 最小长度：2 最大长度：512 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
code |
String |
错误码 最小长度：8 最大长度：36 |
message |
String |
错误描述 最小长度：2 最大长度：512 |
请求示例
无
响应示例
状态码： 200
查询线路分组列表响应。
{
"linegroups" : [ {
"name" : "linegroup",
"lines" : [ "ST", "LA" ],
"status" : "ACTIVE",
"description" : "123",
"line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
"created_at" : "2019-07-29T08:41:38.096",
"updated_at" : "2019-07-29T08:41:38.610"
}, {
"name" : "20190729034848812group",
"lines" : [ "Liantong", "Dianxin_Guangdong" ],
"status" : "ACTIVE",
"description" : "auto create",
"line_id" : "lgroup_4011afa26c33050b016c3cbeaf650f84",
"created_at" : "2019-07-29T08:00:25.443",
"updated_at" : "2019-07-29T08:00:26.040"
} ],
"metadata" : {
"total_count" : 2
}
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询线路分组列表响应。 |
400 |
接口错误响应。 |
500 |
接口错误响应。 |
错误码
请参见错误码。
