Queries the information about an endpoint.

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 DescribeResolverEndpoint

The operation that you want to perform. Set the value to DescribeResolverEndpoint.

Lang String No en

The language.
EndpointId String Yes hra0**

The ID of the endpoint.

Response parameters

Parameter Type Example Description
Status String SUCCESS

The status of the endpoint. Valid values:

  • SUCCESS: The endpoint is working as expected.
  • INIT: The endpoint is being created.
  • FAILED: The endpoint fails to be created.
  • CHANGE_INIT: The endpoint is being modified.
  • CHANGE_FAILED: The endpoint fails to be modified.
  • EXCEPTION: The endpoint encounters an exception.
RequestId String 45020ED9-6319-4CA7-9475-6E8D6446E84F

The ID of the request.
SecurityGroupId String sg-8vb3sigz86xc-group-test

The ID of the security group.
CreateTime String 2020-07-13 10:45:56

The time when the endpoint was created.
Name String Endpoint-test

The name of the endpoint.
VpcRegionName String North China

The region name of the virtual private cloud (VPC) where the endpoint resides.
VpcId String vpc-8vbl8mpum-vpc-id

The ID of the VPC.
UpdateTime String 2020-07-13 10:48:39

The time when the endpoint was last modified.
VpcRegionId String cn-hangzhou

The ID of the region where the VPC resides.
VpcName String vpc-name-test

The name of the VPC.
IpConfigs Array of IpConfig

The source IP address configuration for the outbound traffic.
VSwitchId String vsw-8vbmks7hzrmk-vswitch-id

The ID of the vSwitch.
CidrBlock String 172.16.0.0/24

The IPv4 CIDR block of the vSwitch.

Ip String 172.16.xx.xx

The IPv4 address.
AzId String cn-hangzhou-a

The ID of the zone where the vSwitch resides.
UpdateTimestamp Long 1594608519000

The timestamp when the endpoint 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 hra0**

The ID of the endpoint.
CreateTimestamp Long 1594608356000

The timestamp when the endpoint 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.

Examples

Sample request

http(s)://pvtz.aliyuncs.com/?Action=DescribeResolverEndpoint
&Lang=en
&EndpointId=hra0**
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeResolverEndpointResponse>
    <Status>SUCCESS</Status>
    <RequestId>45020ED9-6319-4CA7-9475-6E8D6446E84F</RequestId>
    <SecurityGroupId>sg-8vb3sigz86xc-group-test</SecurityGroupId>
    <CreateTime>2020-07-13 10:45:56</CreateTime>
    <Name>Endpoint-test</Name>
    <VpcRegionName>North China</VpcRegionName>
    <VpcId>vpc-8vbl8mpum-vpc-id</VpcId>
    <UpdateTime>2020-07-13 10:48:39</UpdateTime>
    <VpcRegionId>cn-hangzhou</VpcRegionId>
    <VpcName>vpc-name-test</VpcName>
    <IpConfigs>
        <VSwitchId>vsw-8vbmks7hzrmk-vswitch-id</VSwitchId>
        <CidrBlock>172.16.0.0/24</CidrBlock>
        <Ip>172.16.xx.xx</Ip>
        <AzId>cn-hangzhou-a</AzId>
    </IpConfigs>
    <UpdateTimestamp>1594608519000</UpdateTimestamp>
    <Id>hra0**</Id>
    <CreateTimestamp>1594608356000</CreateTimestamp>
</DescribeResolverEndpointResponse>

JSON format 

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

{
  "Status" : "SUCCESS",
  "RequestId" : "45020ED9-6319-4CA7-9475-6E8D6446E84F",
  "SecurityGroupId" : "sg-8vb3sigz86xc-group-test",
  "CreateTime" : "2020-07-13 10:45:56",
  "Name" : "Endpoint-test",
  "VpcRegionName" : "North China",
  "VpcId" : "vpc-8vbl8mpum-vpc-id",
  "UpdateTime" : "2020-07-13 10:48:39",
  "VpcRegionId" : "cn-hangzhou",
  "VpcName" : "vpc-name-test",
  "IpConfigs" : [ {
    "VSwitchId" : "vsw-8vbmks7hzrmk-vswitch-id",
    "CidrBlock" : "172.16.0.0/24",
    "Ip" : "172.16.xx.xx",
    "AzId" : "cn-hangzhou-a"
  } ],
  "UpdateTimestamp" : 1594608519000,
  "Id" : "hra0**",
  "CreateTimestamp" : 1594608356000
}

Error codes

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