Use DetachResourceFromVpcEndpointService to remove a service resource from an endpoint service - PrivateLink - Alibaba Cloud - PrivateLink

Operation description

Before you remove a service resource from an endpoint service, make sure that the endpoint service is in the Active state. You can call the GetVpcEndpointServiceAttribute operation to query the endpoint service status.
The DetachResourceFromVpcEndpointService operation does not support concurrent removal of service resources from the same endpoint service instance.

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:DetachResourceFromVpcEndpointService

update

*VpcEndpointService

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

LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint service from which you want to remove a service resource. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ResourceType	string	No	The type of the service resource. Valid values: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer (NLB). gwlb: Gateway Load Balancer (GWLB).	slb
ResourceId	string	Yes	The service resource ID.	lb-hp32z1wp5peaoox2q****
ZoneId	string	No	The zone of the endpoint service from which you want to remove a service resource. You can call the DescribeRegions operation to query the region ID. ZoneId is required when the service resource type is ALB, NLB, or GWLB.	cn-hangzhou-c
ServiceId	string	Yes	The ID of the endpoint service from which you want to remove a service resource.	epsrv-hp3vpx8yqxblby3i****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without removing the service resource. The system checks the required parameters, request syntax, and business restrictions. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned. false (default): performs a dry run and sends the request. If the check succeeds, an HTTP 2xx 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. ClientToken supports only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	Yes	The ID of the region where the endpoint service is deployed. Call the DescribeRegions operation to get a region ID.	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	EndpointServiceResourceNotFound	The specified service resource is not found.
400	EndpointServiceResourceCannotRemove	The service resource cannot be removed.
400	EndpointServiceConnectionDependence	You cannot delete EndpointService with Endpoint connected.	Cannot delete an EndpointService with Endpoint connected.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.