Queries zones of 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 ListVpcEndpointZones

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

RegionId String Yes cn-huhehaote

The ID of the region that you want to query.

You can call the DescribeRegions operation to query the most recent region list.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
MaxResults Integer No 50

The number of entries to return on each page. Valid values:1 to 50. Default value: 50.

EndpointId String Yes ep-hp33b2e43fays7s8****

The ID of the endpoint for which you want to query zones.

After you specify an endpoint ID, the system queries the zones of the specified endpoint.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token that is used for the next query. The value of this parameter depends on the value of the AssociationType parameter:

  • If the value returned of NextToken is empty, it indicates that no next query is to be sent.
  • If the value returned of NextToken is not empty, the value indicates the token that is used for the next query.
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

MaxResults String 50

The number of entries returned per page.

Zones Array of Zone

The information about the zones.

VSwitchId String vsw-hjkshjvdkdvd****

The vSwitch of the zone. The system automatically creates an endpoint elastic network interface (ENI) in the vSwitch.

EniIp String 192.XX.XX.23

The IP address of the endpoint ENI.

ZoneStatus String Wait

The status of the zone. Valid values:

  • Creating: being created
  • Wait: to be connected
  • Connected: connected
  • Deleting: being deleted
  • Disconnecting: disconnecting
  • Disconnected: disconnected
  • Connecting: connecting
ZoneId String cn-huhehaote-a

The ID of the zone.

ServiceStatus String Active

The status of the endpoint service. Valid values:

  • Creating: being created
  • Pending: being modified
  • Active: available
  • Deleting: being deleted
EniId String eni-hp3c8qj1tyct8aqy****

The ID of the endpoint ENI.

ZoneDomain String ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com

The domain name of the zone.

After an endpoint is connected to an endpoint service, you can access the service resources in the endpoint service by using the domain name of the zone.

RegionId String cn-huhehaote

The region ID of the endpoint.

Examples

Sample requests

https://[Endpoint]/?Action=ListVpcEndpointZones
&EndpointId=ep-hp33b2e43fays7s8****
&RegionId=cn-huhehaote
&<Common request parameters>

Sample success responses

XML format 

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

<ListVpcEndpointZonesResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    <MaxResults>50</MaxResults>
    <Zones>
        <VSwitchId>vsw-hjkshjvdkdvd****</VSwitchId>
        <EniIp>192.XX.XX.23</EniIp>
        <ZoneStatus>Wait</ZoneStatus>
        <ZoneId>cn-huhehaote-a</ZoneId>
        <ServiceStatus>Active</ServiceStatus>
        <EniId>eni-hp3c8qj1tyct8aqy****</EniId>
        <ZoneDomain>ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com</ZoneDomain>
        <RegionId>cn-huhehaote</RegionId>
    </Zones>
</ListVpcEndpointZonesResponse>

JSON format 

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

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults" : "50",
  "Zones" : [ {
    "VSwitchId" : "vsw-hjkshjvdkdvd****",
    "EniIp" : "192.XX.XX.23",
    "ZoneStatus" : "Wait",
    "ZoneId" : "cn-huhehaote-a",
    "ServiceStatus" : "Active",
    "EniId" : "eni-hp3c8qj1tyct8aqy****",
    "ZoneDomain" : "ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com",
    "RegionId" : "cn-huhehaote"
  } ]
}

Error codes

HttpCode Error code Error message Description
400 EndpointNotFound The specified Endpoint does not exist. The error message returned because the specified endpoint is not found.

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