AttachResourceToVpcEndpointService - PrivateLink - Alibaba Cloud Documentation Center

Adds a service resource to an endpoint service.

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 status of the endpoint service.
You cannot repeatedly call the AttachResourceToVpcEndpointService operation to add a service resource to an endpoint service 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:AttachResourceToVpcEndpointService	Write	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	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint service to which you want to add the service resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The type of the service resource. Valid values: slb: a Classic Load Balancer (CLB) instance alb: an Application Load Balancer (ALB) instance nlb: a Network Load Balancer (NLB) instance	slb
ResourceId	string	Yes	The service resource ID.	lb-hp32z1wp5peaoox2q****
ZoneId	string	No	The zone ID of the service resource.	cn-hangzhou-j
ServiceId	string	Yes	The ID of the endpoint service to which you want to add the service resource.	epsrv-hp3vpx8yqxblby3i****
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 code 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

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	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.	The vSwitch is not found.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.	-
400	Mismatch.ResourceType	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.	-

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

Change history

Change time

Summary of changes

Operation

2023-08-23

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400