Modifying a Line Group

Function

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

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Line group name. The name cannot be the same as that of any custom line or the preconfigured line name. The name can contain 1 to 64 characters. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
description	No	String	Line group description. The value can contain a maximum of 255 characters and is left blank by default.
lines	Yes	Array of strings	Line list.

Response Parameters

Status code: 202

**Table 4** 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 5** 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 6** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Example Requests

Modifying the name and description of the line group that contains the lines ST and LA

PUT https://{endpoint}/v2.1/linegroups/{linegroup_id}

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

Example Responses

Status code: 202

Response to the request for updating a line group

{
  "name" : "linegroup",
  "lines" : [ "ST", "LA" ],
  "status" : "PENDING_UPDATE",
  "description" : "456",
  "line_id" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
  "created_at" : "2019-07-29T08:41:38.096",
  "updated_at" : "2019-07-29T09:19:40.364"
}