DescribeResolverEndpoint - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call DescribeResolverEndpoint to retrieve the details of an endpoint by its ID.

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

get

*Endpoint

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

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
EndpointId	string	Yes	The ID of the endpoint.	hra0**

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the endpoint. Valid values: SUCCESS: The endpoint works 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: An exception occurred on the endpoint.	SUCCESS
RequestId	string	The unique request ID.	45020ED9-6319-4CA7-9475-6E8D6446E84F
SecurityGroupId	string	The ID of the security group. The rules in the security group are applied to the outbound VPC.	sg-8vb3sigz86xc-group-****
CreateTime	string	The time when the endpoint was created.	2020-07-13 10:45:56
Name	string	The name of the endpoint.	终端节点-test
VpcRegionName	string	The name of the region where the outbound VPC is located.	华北
VpcId	string	The ID of the outbound virtual private cloud (VPC). All outbound DNS query traffic from the Resolver is forwarded through this VPC.	vpc-0jl96awrjt75ezglc****
UpdateTime	string	The time when the endpoint was last updated.	2020-07-13 10:48:39
VpcRegionId	string	The ID of the region where the outbound VPC is located.	cn-hangzhou
VpcName	string	The name of the outbound VPC.	vpc-name-test
IpConfigs	array<object>	A list of IP address configurations for the outbound traffic source.
	object	The IP address configuration for the outbound traffic source.
VSwitchId	string	The vSwitch ID.	vsw-0jlgeyq4oazkh5xue****
CidrBlock	string	The IPv4 CIDR block of the vSwitch.	172.16.XX.XX/24
Ip	string	An IP address within the specified CIDR block. If you leave this parameter empty, the system automatically assigns an IP address.	172.16.XX.XX
AzId	string	The ID of the zone where the vSwitch is located.	cn-hangzhou-a
UpdateTimestamp	integer	The time when the endpoint was last updated. This is a UNIX timestamp.	1594608519000
Id	string	The ID of the endpoint.	hra0**
CreateTimestamp	integer	The time when the endpoint was created. This is a UNIX timestamp.	1594608356000

Examples

Success response

JSON format

{
  "Status": "SUCCESS",
  "RequestId": "45020ED9-6319-4CA7-9475-6E8D6446E84F",
  "SecurityGroupId": "sg-8vb3sigz86xc-group-****",
  "CreateTime": "2020-07-13 10:45:56",
  "Name": "终端节点-test",
  "VpcRegionName": "华北",
  "VpcId": "vpc-0jl96awrjt75ezglc****",
  "UpdateTime": "2020-07-13 10:48:39",
  "VpcRegionId": "cn-hangzhou",
  "VpcName": "vpc-name-test",
  "IpConfigs": [
    {
      "VSwitchId": "vsw-0jlgeyq4oazkh5xue****",
      "CidrBlock": "172.16.XX.XX/24",
      "Ip": "172.16.XX.XX",
      "AzId": "cn-hangzhou-a"
    }
  ],
  "UpdateTimestamp": 1594608519000,
  "Id": "hra0**",
  "CreateTimestamp": 1594608356000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.