DisableVpcEndpointZoneConnection - PrivateLink - Alibaba Cloud Documentation Center

Closes connections in an endpoint zone.

Operation description

You can call this operation only when the state of the endpoint is Connected and the state of the zone associated with the endpoint is Connected or Migrated.
DisableVpcEndpointZoneConnection is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListVpcEndpointZones operation to query the status of the task.
- If the zone is in the Disconnecting state, the task is running.
- If the zone is in the Disconnected state, the task is successful.
You cannot repeatedly call the DisableVpcEndpointZoneConnection operation to allow an endpoint service to reject a connection request from the endpoint in the zone 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:DisableVpcEndpointZoneConnection

update

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the connection request from the endpoint is rejected. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
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
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
ServiceId	string	Yes	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
EndpointId	string	Yes	The endpoint ID.	ep-hp33b2e43fays7s8****
ZoneId	string	Yes	The ID of the zone that is associated with the endpoint.	cn-hangzhou-b
ReplacedResource	boolean	No	Specifies whether to close connections in the endpoint zone after migration. Valid values: true: yes false (default): no Note Set the value to true if you want to close connections in the endpoint zone after migration.	false
RegionId	string	Yes	The ID of the region where the connection request from the endpoint is rejected. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	EndpointConnectionNotFound	The specified endpoint connection does not exist.	The specified endpoint connection does not exist.
400	EndpointConnectionOperationDenied	The endpoint is being connected.	The endpoint is being connected.
400	IncorrectBusinessStatus.VpcEndpoint	The business status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.VpcEndpointService	The business status of %s [%s] is incorrect.
400	IncorrectStatus.VpcEndpoint	The status of %s [%s] is incorrect.
400	IncorrectStatus.VpcEndpointConnection	The status of %s [%s] is incorrect.
400	IncorrectStatus.VpcEndpointService	The status of %s [%s] is incorrect.
400	IncorrectStatus.VpcEndpointZone	The status of %s [%s] is incorrect.
400	GatewayLoadBalancerNotSupportZoneConnection	The gateway load balancer not support zone connection.	Gateway-based load balancing type does not support operational zone connection
404	ResourceNotFound.VpcEndpoint	The specified resource %s is not found.
404	ResourceNotFound.VpcEndpointConnection	The specified resource %s is not found.
404	ResourceNotFound.VpcEndpointService	The specified resource %s is not found.
404	ResourceNotFound.VpcEndpointZone	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.