ListPrivateDNS - API Gateway - Alibaba Cloud Documentation Center

Queries private DNS resolution. You can filter the results by private domain name or resolution type.

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

apigateway:ListPrivateDNS

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IntranetDomain	string	No	The private domain name.	api.demo.com
Type	string	No	The type of private DNS resolution. VPC: Authorizes resolution for a VPC. This type supports binding only dedicated instances of the classic type. A: Supports creating A records. This type supports binding only dedicated instances of the VPC-integrated type. Valid values: A : A VPC : VPC	A
PageSize	integer	No
PageNumber	integer	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ016
TotalCount	integer	The total number of entries returned.	2
PageNumber	integer	The returned page number.	1
PageSize	integer	The number of entries returned per page.	10
PrivateDNSList	array<object>	The list of private DNS resolutions.
	array<object>	The private DNS resolution.
IntranetDomain	string	The private domain name.	api.demo.com
Type	string	The type of private DNS resolution. VPC: Authorizes resolution for a VPC. This type supports binding only dedicated instances of the classic type. A: Supports creating A records. This type supports binding only dedicated instances of the VPC-integrated type. Valid values: A : A VPC : VPC	A
CreatedTime	string	The creation time. The time is in UTC.	2023-05-10T08:17:00Z
Records	array<object>	The list of DNS records.
	object	A list of DNS records.
Record	string	The value of the DNS record.	192.168.0.1
Weight	integer	The weight.	100
BindInstances	array	The list of dedicated instances that are associated with the private DNS resolution.
	string	The ID of the dedicated instance.	apigateway-hz-ead4f4b0bac8

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ016",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10,
  "PrivateDNSList": [
    {
      "IntranetDomain": "api.demo.com",
      "Type": "A",
      "CreatedTime": "2023-05-10T08:17:00Z",
      "Records": [
        {
          "Record": "192.168.0.1",
          "Weight": 100
        }
      ],
      "BindInstances": [
        "apigateway-hz-ead4f4b0bac8"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.