Add a service resource to an endpoint service - PrivateLink - Alibaba Cloud - PrivateLink

Adds a service resource to an endpoint service by calling the AttachResourceToVpcEndpointService operation.

Operation description

Before you add a service resource to 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 AttachResourceToVpcEndpointService operation does not support concurrently adding service resources to 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:AttachResourceToVpcEndpointService

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 to which you want to add a service resource. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
ResourceType	string	Yes	The EPS resource type. Valid values: slb: The service resource type is Classic Load Balancer (CLB). alb: The service resource type is Application Load Balancer (ALB). nlb: The service resource type is Network Load Balancer (NLB). gwlb: The service resource type is Gateway Load Balancer (GWLB).	slb
ResourceId	string	Yes	The service resource ID.	lb-hp32z1wp5peaoox2q****
ZoneId	string	No	The zone of the service resource. This parameter is required when the service resource is an ALB, NLB, or GWLB instance.	cn-hangzhou-j
ServiceId	string	Yes	The endpoint service to which you want to add a service resource.	epsrv-hp3vpx8yqxblby3i****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without adding 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. The ClientToken value can contain 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 obtain the 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

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	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	EndpointServiceOperationDenied	The specified operation of endpoint service is not allowed.	The specified operation of endpoint service is not allowed.
400	EndpointServiceResourceExist	The specified resource already exists.	The specified resource already exists.
400	LoadBalancerNotFound	The specified load balancer does not exist.	The specified Alb does not exist.
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.	The specified SLB does not support PrivateLink.
400	AlbNotFound	The specified Alb does not exist.	The specified Alb does not exist.
400	EndpointServiceResourceTypeNotSupport	The specified resource type is not supported.	The specified resource type is not supported.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	The resource you applied for has exceeded the quota.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	The specified endpoint service does not support the zone.
400	ServiceResourceNotSupportIpv6	The resource is not support ipv6.	The endpoint service does not support IPv6.
400	EndpointServiceResourceTypeNotEqual	the service resource type not equal request type.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.	The endpoint service and service resource AddressIpVersion do not match.