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.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
privatelink:DisableVpcEndpointZoneConnection	update	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}	none	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

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.	-

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

Change history

Change time	Summary of changes	Operation
2024-09-18	The Error code has changed	View Change Details