DescribeResolverEndpoints - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call DescribeResolverEndpoints to retrieve a list of endpoints.

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:DescribeResolverEndpoints

list

*Endpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword for the endpoint name. A fuzzy search is performed.	终端节点-test
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en	en
PageNumber	integer	No	The page number for a paged query. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries per page. The maximum value is 100. The default value is 20.	20
Status	string	No	The status of the endpoint. Valid values: SUCCESS: The endpoint is working as expected. INIT: The endpoint is being created. FAILED: The endpoint failed to be created. CHANGE_INIT: The endpoint is being modified. CHANGE_FAILED: The endpoint failed to be modified. EXCEPTION: The endpoint is not working as expected. Note If you do not specify this parameter, endpoints in all states are returned. If you specify this parameter, only endpoints in the specified state are returned.	SUCCESS
VpcRegionId	string	No	The ID of the region where the outbound virtual private cloud (VPC) is located.	cn-zhangjiakou

Response elements

Element	Type	Description	Example
	object
Endpoints	array<object>	The list of endpoints.
	object	The endpoint information.
Status	string	The status of the endpoint. Description: SUCCESS: The endpoint is working as expected. INIT: The endpoint is being created. FAILED: The endpoint failed to be created. CHANGE_INIT: The endpoint is being modified. CHANGE_FAILED: The endpoint failed to be modified. EXCEPTION: The endpoint is not working as expected.	SUCCESS
VpcId	string	The ID of the outbound VPC. All outbound DNS query traffic from the Resolver is forwarded through this VPC.	vpc-0jlxhpfnj5bfu0bsd****
UpdateTime	string	The time when the endpoint was last updated.	2020-07-13 10:38:24
SecurityGroupId	string	The ID of the security group.	sg-0jld3m9yq7l2cw12****
CreateTime	string	The time when the endpoint was created.	2020-07-13 10:36:26
VpcRegionId	string	The ID of the region where the outbound VPC is located.	cn-zhangjiakou
IpConfigs	array<object>	The list of source IP addresses for outbound traffic.
	object	The information about a source IP address for outbound traffic.
VSwitchId	string	The ID of the vSwitch.	vsw-0jlgeyq4oazkh5xue****
CidrBlock	string	The subnet mask, which is the IPv4 CIDR block of the vSwitch.	172.16.XX.XX/24
Ip	string	The IP address within the CIDR block.	172.16.XX.XX
AzId	string	The ID of the zone where the vSwitch is located.	cn-zhangjiakou-a
VpcName	string	The name of the outbound VPC.	vpc-test-name
UpdateTimestamp	integer	The time when the endpoint was last updated. This is a UNIX timestamp.	1594607904000
VpcRegionName	string	The name of the region where the outbound VPC is located.	杭州VPC测试
Name	string	The name of the endpoint.	终端节点-test
Id	string	The ID of the endpoint.	hr****
CreateTimestamp	integer	The time when the endpoint was created. This is a UNIX timestamp.	1594607786000
PageSize	integer	The number of entries returned per page.	2
RequestId	string	The unique ID of the request.	83D1682B-B69A-4060-9FA8-2907C2A35600
PageNumber	integer	The page number of the returned data.	1
TotalPages	integer	The total number of pages returned.	1
TotalItems	integer	The total number of endpoints.	1

Examples

Success response

JSON format

{
  "Endpoints": [
    {
      "Status": "SUCCESS",
      "VpcId": "vpc-0jlxhpfnj5bfu0bsd****",
      "UpdateTime": "2020-07-13 10:38:24",
      "SecurityGroupId": "sg-0jld3m9yq7l2cw12****",
      "CreateTime": "2020-07-13 10:36:26",
      "VpcRegionId": "cn-zhangjiakou",
      "IpConfigs": [
        {
          "VSwitchId": "vsw-0jlgeyq4oazkh5xue****",
          "CidrBlock": "172.16.XX.XX/24",
          "Ip": "172.16.XX.XX",
          "AzId": "cn-zhangjiakou-a"
        }
      ],
      "VpcName": "vpc-test-name",
      "UpdateTimestamp": 1594607904000,
      "VpcRegionName": "杭州VPC测试",
      "Name": "终端节点-test",
      "Id": "hr****",
      "CreateTimestamp": 1594607786000
    }
  ],
  "PageSize": 2,
  "RequestId": "83D1682B-B69A-4060-9FA8-2907C2A35600",
  "PageNumber": 1,
  "TotalPages": 1,
  "TotalItems": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.