DescribeCustomLines - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of custom lines.

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

pvtz:read

list

*CustomLine

acs:pvtz::{#accountId}:customLine/*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language.	en
PageNumber	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. The maximum value is 100. The default value is 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60
PageNumber	integer	The page number of the returned page.	1
TotalPages	integer	The total number of pages returned.	5
TotalItems	integer	The total number of entries returned.	100
CustomLines	object
CustomLine	array<object>	The list of custom lines.
	object
LineId	string	The unique ID of the custom line.	160002
Name	string	The name of the custom line.	Test line
Ipv4s	object
Ipv4	array	The list of IPv4 address segments.
	string	The IPv4 address segment.	1.1.1.1
Creator	string	The creator.	21312421
CreatorType	string	The role of the creator. Valid values: USER: a user SYSTEM: the system	USER
CreatorSubType	string	The type of the creator. Valid values: CUSTOM: an Alibaba Cloud account SUB: a RAM user STS: a role assumed using Security Token Service (STS) OTHER: another role	SUB
CreateTime	string	The time when the custom line was created.	2022-03-25T08:07Z
CreateTimestamp	integer	The time when the custom line was created. This value is a UNIX timestamp.	1671174074000
UpdateTime	string	The time when the custom line was last updated.	2020-08-24T16:08Z
UpdateTimestamp	integer	The time when the custom line was last updated. This value is a UNIX timestamp.	1681879029000
DnsCategory	string

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60",
  "PageNumber": 1,
  "TotalPages": 5,
  "TotalItems": 100,
  "CustomLines": {
    "CustomLine": [
      {
        "LineId": "160002",
        "Name": "测试线路",
        "Ipv4s": {
          "Ipv4": [
            "1.1.1.1"
          ]
        },
        "Creator": "21312421",
        "CreatorType": "USER",
        "CreatorSubType": "SUB",
        "CreateTime": "2022-03-25T08:07Z",
        "CreateTimestamp": 1671174074000,
        "UpdateTime": "2020-08-24T16:08Z",
        "UpdateTimestamp": 1681879029000,
        "DnsCategory": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.