Call the DescribeVpcEndpointZones API to query the availability zones added to the specified endpoint.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Action String required Example: DescribeVpcEndpointZones

Action to execute. Set the value to DescribeVpcEndpointZones.

Version String required Example: 2020-04-01

API version. The current version is 2020-04-01.

EndpointId String required Example: ep-273yuq6q7bgn47fap8squ****

The ID of the endpoint.

You can call the DescribeVpcEndpoints API to obtain the ID of the endpoint.

PageNumber Integer optional Example: 1

Page number of the list. Default: 1.

PageSize Integer optional Example: 10

The number of entries per page in a pagination query. Maximum: 100. Default: 10.

Response parameters

RequestId String optional Example: 0ED8D006-F706-4D23-88ED-E11ED28D****

Request ID.

PageNumber Integer optional Example: 1

The current page number.

PageSize Integer optional Example: 10

Number of entries per page in the current pagination.

TotalCount Integer optional Example: 2

The total number of endpoint services matching the specified conditions.

EndpointZones Object[] optional Example: -

Details of the endpoint availability zone.

ZoneId String optional Example: cn-guangzhou-a

ID of the endpoint availability zone.

ZoneDomain String optional Example: ep-273yuq6q7bgn47fap8squ****.cn-guangzhou-a.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com

Domain name of the endpoint availability zone. Format: <Endpoint ID>.<Availability zones ID>.<Endpoint Service ID>.<region ID>.privatelink.volces.com.

ZoneStatus String optional Example: Connected

Status of the endpoint availability zone.

PendingAcceptance: Waiting for connection

Connecting: Connecting.

Connected: Connected.

Disconnecting: Disconnecting.

rejected: connection denied.

Failed: Connection failed.

ServiceStatus String optional Example: Active

Service status of the endpoint IPv4 address.

Active: Normal.

Inactive: Abnormal.

Ipv6ServiceStatus String optional Example: Active

Service status of the endpoint IPv6 address.

Active: Normal.

Inactive: Abnormal.

tip

This parameter is not returned if the endpoint only supports IPv4.

SubnetId String optional Example: subnet-2744ts087kglc7fap8tu6****

The ID of the subnet to which the endpoint network interface belongs.

NetworkInterfaceId String optional Example: eni-273w2q67fwq9s7fap8t1a****

ID of the endpoint network interface.

If undergoing seamless service resource replacement, this represents the ID of the endpoint network interface connected to the service resource being replaced.

NetworkInterfaceIP String optional Example: 192.XX.XX.3

Private IPv4 address of the endpoint network interface.

If undergoing seamless service resource replacement, this represents the IPv4 address of the endpoint network interface connected to the service resource being replaced.

NetworkInterfaceIpv6 String optional Example: 2408::153:3921:XX:XX:7b12:1c5f

Private IPv6 address of the endpoint network interface.

If undergoing seamless service resource replacement, this represents the IPv6 address of the endpoint network interface connected to the service resource being replaced.

tip

This parameter is not returned if the endpoint only supports IPv4.

ReplacedNetworkInterfaceId String optional Example: eni-273w2q67fwq9s7fap8t1a****

The ID of the endpoint network interface used to connect to the new service resource.

If the endpoint is not undergoing seamless service resource replacement, this parameter returns empty.

ReplacedNetworkInterfaceIp String optional Example: 192.XX.XX.4

The IPv4 address of the endpoint network interface used to connect to the new service resource.

If the endpoint is not undergoing seamless service resource replacement, this parameter returns empty.

ReplacedNetworkInterfaceIpv6 String optional Example: 2408::153:3921:XX:XX:7b12:1acc

The IPv6 address of the endpoint network interface used to connect to the new service resource.

If the endpoint is not undergoing seamless service resource replacement, this parameter returns empty.

tip

This parameter is not returned if the endpoint only supports IPv4.

Request examples

Response examples

Error codes

This section displays only the error codes of the current API. For more error codes, see Common error codes.

Status code	Error codes	Error message	Notes
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.	This request does not contain required parameters. Ensure that your request includes all required parameters, such as XXX. tip Here, XXX represents the name of the missing parameter.
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	The format of specified pagination parameter is invalid.
404	InvalidEndpoint.NotFound	The specified endpoint does not exist.	The specified endpoint does not exist.

PrivateLink