AddZoneToVpcEndpoint - PrivateLink - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

privatelink:AddZoneToVpcEndpoint

create

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ZoneId	string	Yes	The ID of the zone that you want to add.	cn-hangzhou-b
VSwitchId	string	Yes	The ID of the vSwitch in the zone that you want to add. The system automatically creates an endpoint ENI in the vSwitch.	vsw-hjkshjvdkdvd****
ip	string	No	The IP address of the endpoint elastic network interface (ENI) in the zone that you want to add.	192.XX.XX.32
EndpointId	string	Yes	The ID of the endpoint to which you want to add the zone.	ep-hp33b2e43fays7s8****
DryRun	boolean	No	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.	false
ClientToken	string	No	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.	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	Yes	The region ID of the endpoint. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Ipv6Address	string	No	The IPv6 address of the endpoint ENI in the zone that you want to add.	2408:4005:3b6:**:6955:c3cb:34c:**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0c593ea1-3bea-11e9-b96b-88e9fe637760

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	OperationDenied.EndpointProtected	The operation is not allowed because of EndpointProtected.	Managed protection is enabled for the endpoint. Operation is not allowed.
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.
400	EndpointOperationDenied	The specified operation of endpoint is not allowed.	The specified operation of endpoint is not allowed.
400	EndpointLocked	The specified Endpoint is locked.	The specified Endpoint is locked.
400	EndpointConnectionOperationDenied	The endpoint is being connected.	The endpoint is being connected.
400	EndpointZoneDuplicated	The zone is duplicated for the Endpoint.	The zone is duplicated for the Endpoint.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	The specified endpoint service does not support the zone.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	The resource you applied for has exceeded the quota.
400	EndpointDuplicated	The endpoint of the service already exists and cannot be created again.
400	EndpointServiceDeleted	The specified Service is already deleted.	The specified Service is already deleted.
400	EndpointServiceResourceNotFound	The specified service resource is not found.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	EniIpUnavailable	The specified IP address is unavailable.	The specified IP address is unavailable.
400	EndpointProtected	The specified Endpoint is protected.
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.	The status of the vSwitch is not available.
400	VpcNatServiceException	The vpcNat service is busy
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	The number of vSwitch IP addresses is insufficient.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.	The specified VSwitch does not support dualstack.
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.	The AddressIpVersion of the endpoint does not support specifying an IPv6 address.
400	IllegalParam.Ip	The specified parameter IP is invalid.	The specified parameter IP is invalid.
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.	The specified parameter Ipv6Address is invalid.