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.

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.

RegionId String Yes eu-west-1

The ID of the region that you want to query. You can call the DescribeRegions operation to query region IDs.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The query token. Set this parameter to the NextToken parameter value that is returned in the last API call. If no subsequent queries are to be sent, you can leave the parameter empty.

MaxResults Integer No 50

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

Response parameters

Parameter Type Example Description
MaxResults String 50

The number of entries returned per page.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token required by the next query. If the NextToken parameter is empty, this indicates that no subsequent query will be sent.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Zones Array of Zone

The details of zones.

EniId String eni-hp3c8qj1tyct8aqy****

The elastic network interface (ENI) of the endpoint.

EniIp String 192.xx.xx.23

The IP address of the endpoint ENI.

RegionId String eu-west-1

The ID of the region where the endpoint is deployed.

VSwitchId String vsw-hjkshjvdkdvd****

The VSwitch of the zone. The system automatically creates an endpoint ENI and associates it with the VSwitch.

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

The name of the zone.

After an endpoint is connected to an endpoint service, you can access the service resources from the zone.

ZoneId String eu-west-1a

The ID of the zone.

ZoneStatus String Wait

The status of the zone. Valid values:

  • Creating: The zone is being added.
  • Wait: The zone is pending for connecting to the endpoint service.
  • Connected: The zone is connected to the endpoint service.
  • Deleting: The zone is being deleted.
  • Disconnecting: The zone is being disconnected from the endpoint service.
  • Disconnected: The zone is disconnected from the endpoint service.
  • Connecting: The zone is being connected to the endpoint service.

Examples

Sample requests

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

Sample success responses

XML format

<ListVpcEndpointZonesResponse> 
      <RequestId>B40660B0-A67C-43B4-8C30-83BDBB541CFC</RequestId>
      <MaxResults>50</MaxResults>
      <Zones>
            <EniId>eni-hp3c8qj1tyct8aqy****</EniId>
            <ZoneId>cn-huhehaote-a</ZoneId>
            <VSwitchId>vsw-hp3rdstfpu35g24ey****</VSwitchId>
            <EniIp>192.xx.xx.58</EniIp>
            <ZoneStatus>Wait</ZoneStatus>
            <RegionId>cn-huhehaote</RegionId>
            <ZoneDomain>ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com</ZoneDomain>
      </Zones>
</ListVpcEndpointZonesResponse>

JSON format

{
  "RequestId": "B40660B0-A67C-43B4-8C30-83BDBB541CFC",
  "MaxResults": 50,
  "Zones": [
    {
      "EniId": "eni-hp3c8qj1tyct8aqy****",
      "ZoneId": "cn-huhehaote-a",
      "VSwitchId": "vsw-hp3rdstfpu35g24ey****",
      "EniIp": "192.xx.xx.58",
      "ZoneStatus": "Wait",
      "RegionId": "cn-huhehaote",
      "ZoneDomain": "ep-hp3f033dp24c5yc9****-cn-huhehaote.epsrv-hp3itcpowf37m3d5****.cn-huhehaote-a.privatelink.aliyuncs.com"
    }
  ]
}

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.