Creating a Line Group

Function

This API is used to create 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

POST /v2.1/linegroups

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Line group name. The name cannot be the same as the custom line name or preconfigured line name. The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.).
description	No	String	Line group description. A maximum of 255 characters are allowed. It is left blank by default.
lines	Yes	Array of strings	List of lines contained in a line group. At least two lines are required. Resolution line IDs are used here.

Response Parameters

Status code: 202

**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. Value options: PENDING_CREATE, ACTIVE, PENDING_DELETE, PENDING_UPDATE, ERROR, FREEZE, and DISABLE
description	String	Line group description
line_id	String	Line group ID
created_at	String	Time when the line group was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS.
updated_at	String	Time when the line group was updated. Format: yyyy-MM-dd'T'HH:mm:ss.SSS.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Status code: 500

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Example Requests

Creating a line group that contains the lines ST and LA

POST https://{endpoint}/v2.1/linegroups

{
  "name" : "linegroup",
  "description" : "123",
  "lines" : [ "ST", "LA" ]
}

Example Responses

Status code: 202

Response to the request for creating a line group

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