Querying a Custom Line

Function

This API is used to query a custom line.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/customlines

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
line_id	No	String	Resolution line ID.
name	No	String	Resolution line name.
limit	No	Integer	The number of records returned on each page during pagination query. When you query detailed information, the value ranges from 0 to 100. Commonly used values are 10, 20, and 50, and the default value is 100. When you query the brief information, the value ranges from 0 to 3000, and the default value is 3000.
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.
show_detail	No	Boolean	Whether to query detailed information. Value options: true (default): Detailed information is queried. false: Detailed information is not queried.
status	No	String	Resource status.
ip	No	String	IP address range.

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
lines	Array of line objects	Line list.
metadata	metadata object	Number of resources that meet the query condition.

**Table 4** line
Parameter	Type	Description
line_id	String	Resolution line ID.
name	String	Custom line name.
ip_segments	Array of strings	IP address range.
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	String	Resource status.
description	String	Custom line description.

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

Example Requests

None

Example Responses

Status code: 200

Successful request

{
  "lines" : [ {
    "line_id" : "custom_2ce45ef669fc87870169fcbada7a0007",
    "name" : "customline",
    "ip_segments" : [ "1.1.1.1-1.1.1.1", "1.1.1.2-1.1.1.3" ],
    "status" : "ACTIVE",
    "created_at" : "2019-04-10T10:03:17.827",
    "updated_at" : "2019-04-10T10:03:57.207",
    "description" : "1234"
  } ],
  "metadata" : {
    "total_count" : 1
  }
}