DescribeCustomLines - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the custom lines for a domain name.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeCustomLines

get

*domain

acs:alidns::{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese en: English Default value: en	en
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
DomainName	string	Yes	The domain name that is added to Alibaba Cloud DNS.Call DescribeDomains to get the domain name.	example.com

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	B57C121B-A45F-44D8-A9B2-13E5A5044195
PageNumber	integer	The page number.	1
TotalPages	integer	The total number of pages.	1
CustomLines	array<object>	The list of custom lines.
	object
Code	string	The code of the custom line.	hra0yc-5********
Name	string	The name of the line.	hra0yd-5********
Id	integer	The unique ID of the custom line.	5*********
IpSegmentList	array<object>	The list of IP address range. Use a hyphen (-) to separate the start and end IP address ranges. Enter one range per line. You can specify 1 to 50 lines. For a single IP address, enter it as IP1-IP1. IP address ranges cannot overlap.
	object	The list of IP address ranges.
EndIp	string	The end IP address.	1.1.XX.XX
StartIp	string	The start IP address.	1.2.XX.XX
TotalItems	integer	The total number of custom lines.	1

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "B57C121B-A45F-44D8-A9B2-13E5A5044195",
  "PageNumber": 1,
  "TotalPages": 1,
  "CustomLines": [
    {
      "Code": "hra0yc-5********",
      "Name": "hra0yd-5********",
      "Id": 0,
      "IpSegmentList": [
        {
          "EndIp": "1.1.XX.XX",
          "StartIp": "1.2.XX.XX"
        }
      ]
    }
  ],
  "TotalItems": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.