DescribeResolverRule - Alibaba Cloud DNS PrivateZone

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeResolverRule	The operation that you want to perform. Set the value to DescribeResolverRule.
Lang	String	No	en	The language.
RuleId	String	Yes	hra1**	The ID of the forwarding rule.

Response parameters


Parameter	Type	Example	Description
ForwardIps	Array of ForwardIp		The information about each destination external server.
Ip	String	172.16.xx.xx	The IP address.
Port	Integer	8080	The port number.
RequestId	String	13D5113B-7E34-407F-A9C1-D96CD2B04277	The ID of the request.
CreateTime	String	2020-07-13 10:51:44	The time when the forwarding rule was created.
Name	String	Forwarding rule-test	The name of the forwarding rule.
ZoneName	String	example.com	The domain name that requires Domain Name System (DNS) traffic forwarding.
Type	String	OUTBOUND	The type of the forwarding rule. Valid value: OUTBOUND: forwards DNS traffic to one or more external IP addresses.
EndpointName	String	Endpoint-test	The name of the endpoint.
EndpointId	String	hra0**	The ID of the endpoint.
UpdateTime	String	2020-07-13 10:51:44	The time when the forwarding rule was last modified.
UpdateTimestamp	Long	1594608704000	The timestamp when the forwarding rule was last modified. The timestamp follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 Thursday, January 1, 1970.
Id	String	hra1**	The ID of the forwarding rule.
CreateTimestamp	Long	1594608704000	The timestamp when the forwarding rule was created. The timestamp follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 Thursday, January 1, 1970.
BindVpcs	Array of Vpc		The information about each virtual private cloud (VPC) that is associated with the forwarding rule.
VpcId	String	vpc-8vbl8m-vpc-id	The ID of the VPC.
VpcName	String	vpc-name-test	The name of the VPC.
RegionName	String	Hangzhou-test	The name of the region.
RegionId	String	cn-hangzhou	The ID of the region.

Examples

Sample request

http(s)://pvtz.aliyuncs.com/?Action=DescribeResolverRule
&Lang=en
&RuleId=hra1**
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeResolverRuleResponse>
    <ForwardIps>
        <Ip>172.16.xx.xx</Ip>
        <Port>8080</Port>
    </ForwardIps>
    <RequestId>13D5113B-7E34-407F-A9C1-D96CD2B04277</RequestId>
    <CreateTime>2020-07-13 10:51:44</CreateTime>
    <Name>Forwarding rule-test</Name>
    <ZoneName>example.com</ZoneName>
    <Type>OUTBOUND</Type>
    <EndpointName>Endpoint-test</EndpointName>
    <EndpointId>hra0**</EndpointId>
    <UpdateTime>2020-07-13 10:51:44</UpdateTime>
    <UpdateTimestamp>1594608704000</UpdateTimestamp>
    <Id>hra1**</Id>
    <CreateTimestamp>1594608704000</CreateTimestamp>
    <BindVpcs>
        <VpcId>vpc-8vbl8m-vpc-id</VpcId>
        <VpcName>vpc-name-test</VpcName>
        <RegionName>Hangzhou-test</RegionName>
        <RegionId>cn-hangzhou</RegionId>
    </BindVpcs>
</DescribeResolverRuleResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ForwardIps" : [ {
    "Ip" : "172.16.xx.xx",
    "Port" : 8080
  } ],
  "RequestId" : "13D5113B-7E34-407F-A9C1-D96CD2B04277",
  "CreateTime" : "2020-07-13 10:51:44",
  "Name" : "Forwarding rule-test",
  "ZoneName" : "example.com",
  "Type" : "OUTBOUND",
  "EndpointName" : "Endpoint-test",
  "EndpointId" : "hra0**",
  "UpdateTime" : "2020-07-13 10:51:44",
  "UpdateTimestamp" : 1594608704000,
  "Id" : "hra1**",
  "CreateTimestamp" : 1594608704000,
  "BindVpcs" : [ {
    "VpcId" : "vpc-8vbl8m-vpc-id",
    "VpcName" : "vpc-name-test",
    "RegionName" : "Hangzhou-test",
    "RegionId" : "cn-hangzhou"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.