DescribeResolverRule - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Call the DescribeResolverRule operation to retrieve the details of a forwarding rule.

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

get

*Rule

acs:pvtz::{#accountId}:rule/{#RuleId}

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
RuleId	string	Yes	The forwarding rule ID.	hr****

Response elements

Element	Type	Description	Example
	object
ForwardIps	array<object>	A list of destination IP addresses.
	object	The details.
Ip	string	The destination IP address.	172.16.XX.XX
Port	integer	The destination port.	80
RequestId	string	The unique request ID.	13D5113B-7E34-407F-A9C1-D96CD2B04277
CreateTime	string	The time when the rule was created.	2020-07-13 10:51:44
Name	string	The name of the forwarding rule.	Forward rule-test
ZoneName	string	The name of the forwarding zone.	example.com
Type	string	The type of the forwarding rule. The only valid value is OUTBOUND, which indicates that traffic is forwarded to an external IP address. OUTBOUND: Forwards to an external IP.	OUTBOUND
EndpointName	string	The name of the endpoint.	Endpoint-test
EndpointId	string	The endpoint ID.	hr****
UpdateTime	string	The time when the rule was last updated.	2020-07-13 10:51:44
UpdateTimestamp	integer	The timestamp that indicates when the rule was last updated.	1594608704000
Id	string	The forwarding rule ID.	hr****
CreateTimestamp	integer	The timestamp that indicates when the rule was created.	1594608704000
BindVpcs	array<object>	A list of Virtual Private Clouds (VPCs) that are associated with the forwarding rule.
	object	The details.
VpcId	string	The VPC ID.	vpc-f8zvrvr1payllgz38****
VpcName	string	The VPC name.	vpc-name-test
VpcType	string	The type of the VPC. Valid values: STANDARD: A standard VPC. EDS: An Elastic Desktop Service (EDS) workspace VPC.	STANDARD
RegionName	string	The name of the region.	Hangzhou
RegionId	string	The region ID.	cn-hangzhou
VpcUserId	string	The ID of the user to which the VPC belongs.	32454****
BindEdgeDnsClusters	array<object>
	object
ClusterId	string
ClusterName	string
ClusterUserId	integer

Examples

Success response

JSON format

{
  "ForwardIps": [
    {
      "Ip": "172.16.XX.XX",
      "Port": 80
    }
  ],
  "RequestId": "13D5113B-7E34-407F-A9C1-D96CD2B04277",
  "CreateTime": "2020-07-13 10:51:44",
  "Name": "转发规则-test",
  "ZoneName": "example.com",
  "Type": "OUTBOUND",
  "EndpointName": "终端节点-test",
  "EndpointId": "hr****",
  "UpdateTime": "2020-07-13 10:51:44",
  "UpdateTimestamp": 1594608704000,
  "Id": "hr****",
  "CreateTimestamp": 1594608704000,
  "BindVpcs": [
    {
      "VpcId": "vpc-f8zvrvr1payllgz38****",
      "VpcName": "vpc-name-test",
      "VpcType": "STANDARD",
      "RegionName": "杭州测试",
      "RegionId": "cn-hangzhou",
      "VpcUserId": "32454****"
    }
  ],
  "BindEdgeDnsClusters": [
    {
      "ClusterId": "",
      "ClusterName": "",
      "ClusterUserId": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.