Queries endpoints.

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 DescribeResolverEndpoints

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

Keyword String No Endpoint-test

The keyword used to filter endpoints in %keyword% mode.
Lang String No en

The language.
PageNumber Integer No 1

The number of the page to return. Default value: 1.
PageSize Integer No 20

The number of entries to return on each page. Default value: 20. Maximum value: 100.
Status String No SUCCESS

The status of the endpoints that you want to query. If you do not specify this parameter, all endpoints are returned. Valid values:

  • SUCCESS: working as expected
  • INIT: being created
  • FAILED: fail to be created
  • CHANGE_INIT: being modified
  • CHANGE_FAILED: fail to be modified
  • EXCEPTION: encounter an exception

Response parameters

Parameter Type Example Description
Endpoints Array of Endpoint

The information about each returned endpoint.
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.
VpcId String vpc-8vbl8mpum-test-vpc-id

The ID of the virtual private cloud (VPC) where the endpoint resides.
UpdateTime String 2020-07-13 10:38:24

The time when the endpoint was last modified.
SecurityGroupId String sg-8vb3sigz86xc-test-group

The ID of the security group.
CreateTime String 2020-07-13 10:36:26

The time when the endpoint was created.
VpcRegionId String cn-zhangjiakou

The ID of the region where the VPC resides.
IpConfigs Array of IpConfig

The source IP address configuration for the outbound traffic.
VSwitchId String vsw-8vbmks7h-test-vswitchId

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-zhangjiakou-a

The ID of the zone where the vSwitch resides.
VpcName String vpc-test-name

The name of the VPC.
UpdateTimestamp Long 1594607904000

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.

VpcRegionName String Hangzhou-VPC-test

The name of the region where the VPC resides.
Name String Endpoint-test

The name of the endpoint.
Id String hra0**

The ID of the endpoint.
CreateTimestamp Long 1594607786000

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.

PageSize Integer 2

The number of entries returned per page.
RequestId String 83D1682B-B69A-4060-9FA8-2907C2A35600

The ID of the request.
PageNumber Integer 1

The page number of the returned page.
TotalPages Integer 1

The total number of pages.
TotalItems Integer 1

The total number of entries.

Examples

Sample request

http(s)://pvtz.aliyuncs.com/?Action=DescribeResolverEndpoints
&Keyword=Endpoint-test
&Lang=en
&PageNumber=1
&PageSize=20
&Status=SUCCESS
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeResolverEndpointsResponse>
    <Endpoints>
        <Status>SUCCESS</Status>
        <VpcId>vpc-8vbl8mpum-test-vpc-id</VpcId>
        <UpdateTime>2020-07-13 10:38:24</UpdateTime>
        <SecurityGroupId>sg-8vb3sigz86xc-test-group</SecurityGroupId>
        <CreateTime>2020-07-13 10:36:26</CreateTime>
        <VpcRegionId>cn-zhangjiakou</VpcRegionId>
        <IpConfigs>
            <VSwitchId>vsw-8vbmks7h-test-vswitchId</VSwitchId>
            <CidrBlock>172.16.0.0/24</CidrBlock>
            <Ip>172.16.xx.xx</Ip>
            <AzId>cn-zhangjiakou-a</AzId>
        </IpConfigs>
        <VpcName>vpc-test-name</VpcName>
        <UpdateTimestamp>1594607904000</UpdateTimestamp>
        <VpcRegionName>Hangzhou-VPC-test</VpcRegionName>
        <Name>Endpoint-test</Name>
        <Id>hra0**</Id>
        <CreateTimestamp>1594607786000</CreateTimestamp>
    </Endpoints>
    <PageSize>2</PageSize>
    <RequestId>83D1682B-B69A-4060-9FA8-2907C2A35600</RequestId>
    <PageNumber>1</PageNumber>
    <TotalPages>1</TotalPages>
    <TotalItems>1</TotalItems>
</DescribeResolverEndpointsResponse>

JSON format 

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

{
  "Endpoints" : [ {
    "Status" : "SUCCESS",
    "VpcId" : "vpc-8vbl8mpum-test-vpc-id",
    "UpdateTime" : "2020-07-13 10:38:24",
    "SecurityGroupId" : "sg-8vb3sigz86xc-test-group",
    "CreateTime" : "2020-07-13 10:36:26",
    "VpcRegionId" : "cn-zhangjiakou",
    "IpConfigs" : [ {
      "VSwitchId" : "vsw-8vbmks7h-test-vswitchId",
      "CidrBlock" : "172.16.0.0/24",
      "Ip" : "172.16.xx.xx",
      "AzId" : "cn-zhangjiakou-a"
    } ],
    "VpcName" : "vpc-test-name",
    "UpdateTimestamp" : 1594607904000,
    "VpcRegionName" : "Hangzhou-VPC-test",
    "Name" : "Endpoint-test",
    "Id" : "hra0**",
    "CreateTimestamp" : 1594607786000
  } ],
  "PageSize" : 2,
  "RequestId" : "83D1682B-B69A-4060-9FA8-2907C2A35600",
  "PageNumber" : 1,
  "TotalPages" : 1,
  "TotalItems" : 1
}

Error codes

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