Updated on 2025-08-19 GMT+08:00

Querying Line Groups

Function

This API is used to query the line groups. This API is not available in some regions. To use this API, submit a service ticket.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/linegroups

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

line_id

No

String

Line group ID.

Fuzzy search will work.

name

No

String

Line group name.

Fuzzy search will work.

limit

No

Integer

The number of records returned on each page during pagination query.

The value ranges from 0 to 500.

Commonly used values are 10, 20, and 50, and the default value is 500.

offset

No

Integer

The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data.

The value ranges from 0 to 2147483647.

The default value is 0.

If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, seeObtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

linegroups

Array of CreateLineGroupsResp objects

List object.

metadata

metadata object

Definition

Number of resources that meet the filter condition

Range

N/A

Table 4 CreateLineGroupsResp

Parameter

Type

Description

name

String

Line group name.

lines

Array of strings

List of lines contained in a line group (resolution line IDs are used here).

status

String

Resource status. The value can be PENDING_CREATE, ACTIVE, PENDING_DELETE, PENDING_UPDATE, ERROR, FREEZE, or DISABLE.

description

String

Line group description.

line_id

String

Line group ID

created_at

String

The creation time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

updated_at

String

The update time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Table 5 metadata

Parameter

Type

Description

total_count

Integer

Definition

Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying the line groups

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

Status Codes

Status Code

Description

200

Response to the request for querying the line groups

400

Error response

500

Error response

Error Codes

See Error Codes.