Queries custom lines.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCustomLines

The operation that you want to perform. Set the value to DescribeCustomLines.

DomainName String Yes example.com

The domain name for which the custom lines to be queried are configured.

PageNumber Long No 1

The number of the page to return.

PageSize Long No 10

The number of entries to return on each page.

Lang String No en

The language type.

Response parameters

Parameter Type Example Description
TotalPages Integer 1

The number of pages that were returned.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries that were returned on each page.

RequestId String B57C121B-A45F-44D8-A9B2-13E5A5044195

The ID of the request.

TotalItems Integer 1

The total number of custom lines.

CustomLines Array N/A

The list of custom lines.

Code String hra0yc-597

The code of the custom line.

Id Long 597

The unique ID of the custom line.

Name String hra0yd-597

The name of the custom line.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCustomLines
&<Common request parameters>

Sample success responses

XML format

<DescribeCustomLinesResponse>
  <customLines><code>hra0yd-598</code><id>598</id>
        <name>secLine</name>
  </customLines>
  <pageNumber>1</pageNumber>
  <pageSize>2</pageSize>
  <requestId>39AC4D3A-3B1E-4DC7-ACDB-B1A1E6A9C59C</requestId>
  <totalItems>1</totalItems>
  <totalPages>1</totalPages>
</DescribeCustomLinesResponse>

JSON format

{
	"requestId":"39AC4D3A-3B1E-4DC7-ACDB-B1A1E6A9C59C",
	"customLines":[
		{
			"id":598,
			"name":"secLine",
			"code":"hra0yd-598"
		}
	],
	"totalItems":1,
	"pageSize":2,
	"pageNumber":1,
	"totalPages":1
}

Error codes

For a list of error codes, visit the API Error Center.