All Products
Document Center


Last Updated:Feb 18, 2024

Adds a zone to an endpoint.

Operation description

  • AddZoneToVpcEndpoint is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListVpcEndpointZones operation to query the state of the zone.

    • If the zone is in the Creating state, the zone is being added.
    • If the zone is in the Wait state, the zone is added.
  • You cannot repeatedly call the AddZoneToVpcEndpoint operation to add a zone to an endpoint within a specified period of time.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
  • VpcEndpoint

Request parameters


The region ID of the endpoint.

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


The ID of the zone that you want to add.


The ID of the vSwitch in the zone that you want to add. The system automatically creates an endpoint ENI in the vSwitch.


The IP address of the endpoint elastic network interface (ENI) in the zone that you want to add.


The ID of the endpoint to which you want to add the zone.


Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.


Response parameters


The request ID.



Sample success responses


  "RequestId": "0c593ea1-3bea-11e9-b96b-88e9fe637760"

Error codes

HTTP status codeError codeError messageDescription
400OperationDenied.EndpointProtectedThe operation is not allowed because of EndpointProtected.-
400EndpointNotFoundThe specified Endpoint does not exist.The specified Endpoint does not exist.
400EndpointOperationDeniedThe specified operation of endpoint is not allowed.The specified operation of endpoint is not allowed.
400EndpointLockedThe specified Endpoint is locked.The specified Endpoint is locked.
400EndpointConnectionOperationDeniedThe endpoint is being connected.The endpoint is being connected.
400EndpointZoneDuplicatedThe zone is duplicated for the Endpoint.The zone is duplicated for the Endpoint.
400EndpointServiceNotSupportedZoneThe specified endpoint service does not support the zone.The specified endpoint service does not support the zone.
400QuotaMisMatchedThe resource you applied for has exceeded the quota.The resource you applied for has exceeded the quota.
400EndpointDuplicatedThe endpoint of the service already exists and cannot be created again.-
400EndpointServiceDeletedThe specified Service is already deleted.The specified Service is already deleted.
400EndpointServiceResourceNotFoundThe specified service resource is not found.-
400VSwitchNotFoundThe specified VSwitch does not exist.The vSwitch is not found.
400EniIpUnavailableThe specified IP address is unavailable.The specified IP address is unavailable.
400EndpointProtectedThe specified Endpoint is protected.-
400VSwitchStatusNotAllowedThe specified vswitch status is not Available.The status of the vSwitch is not available.
400VpcNatServiceExceptionThe vpcNat service is busy-
400ResourceNotEnough.VSwitchIpThe specified resource of VSwitchIp is not enough.The number of vSwitch IP addresses is insufficient.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-05-16The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change