Querying Public Zone Lines

Function

This API is used to query all resolution lines of a public zone after adding a record set to the zone.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/zones/{zone_id}/lines

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Definition Zone ID Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition The number of records returned on each page during pagination query. Constraints N/A Range 0 to 500 Default Value 500
offset	No	Integer	Definition 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. Constraints If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect. Range 0 to 2147483647 Default Value 0

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
links	pageLink object	Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A
lines	Array of PublicZoneLines objects	Definition Response to the request for querying public zone lines Range N/A
metadata	metadata object	Definition Number of resources that meet the filter condition Range N/A

**Table 5** pageLink
Parameter	Type	Description
self	String	Definition The link to the current page. Range N/A
next	String	Definition The link to the next page. Range N/A

**Table 6** PublicZoneLines
Parameter	Type	Description
line	String	Definition Line ID Range N/A
line_name	String	Definition Line name Range N/A
create_time	String	Definition The creation time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A

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

Example Requests

Querying public zone lines

GET https://{endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/lines?limit=10&offset=0

Example Responses

Status code: 200

Successful request

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/lines?limit=10&offset=0"
  },
  "lines" : [ {
    "line" : "default_view",
    "line_name" : null,
    "create_time" : "2016-11-17T12:03:17.827"
  }, {
    "line" : "custom_2ce45ef669fc87870169fcbada7a0007",
    "line_name" : "customline",
    "create_time" : "2019-04-10T12:03:17.827"
  }, {
    "line" : "lgroup_ff8080826c33046a016c3ce46a3322cf",
    "line_name" : "linegroup",
    "create_time" : "2019-07-29T08:41:38.096"
  } ],
  "metadata" : {
    "total_count" : 3
  }
}