Querying a Line Group

Function

This API is used query a line group. 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/{linegroup_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
linegroup_id	Yes	String	Line group ID

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

Status code: 400

**Table 4** 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 5** 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 a line group

{
  "name" : "linegroup",
  "lines" : [ "LA", "ST" ],
  "status" : "ACTIVE",
  "description" : "123",
  "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
  "created_at" : "2019-07-29T08:41:38.096",
  "updated_at" : "2019-07-29T08:41:38.610"
}