All Products
Search
Document Center

PrivateLink:AttachResourceToVpcEndpointService

Last Updated:Sep 26, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
privatelink:AttachResourceToVpcEndpointServiceupdate
  • 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

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
ResourceTypestringYes

The type of the service resource. Valid values:

  • slb: Classic Load Balancer (CLB) instance
  • alb: Application Load Balancer (ALB) instance
  • nlb: Network Load Balancer (NLB) instance
Note You cannot access TCP/SSL listeners configured for NLB instances.
slb
ResourceIdstringYes

The service resource ID.

lb-hp32z1wp5peaoox2q****
ZoneIdstringNo

The zone ID of the service resource.

cn-hangzhou-j
ServiceIdstringYes

The ID of the endpoint service to which you want to add the service resource.

epsrv-hp3vpx8yqxblby3i****
DryRunbooleanNo

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
ClientTokenstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.
400EndpointServiceOperationDeniedThe specified operation of endpoint service is not allowed.The specified operation of endpoint service is not allowed.
400EndpointServiceResourceExistThe specified resource already exists.The specified resource already exists.
400LoadBalancerNotFoundThe specified load balancer does not exist.The specified Alb does not exist.
400LoadBalancerNotSupportPrivateLinkThe specified SLB does not support PrivateLink.The specified SLB does not support PrivateLink.
400AlbNotFoundThe specified Alb does not exist.The specified Alb does not exist.
400EndpointServiceResourceTypeNotSupportThe specified resource type is not supported.The specified resource type is not supported.
400QuotaMisMatchedThe resource you applied for has exceeded the quota.The resource you applied for has exceeded the quota.
400VSwitchNotFoundThe specified VSwitch does not exist.The vSwitch is not found.
400ResourceNotFound.NatGatewayThe specified resource %s is not found.-
400Mismatch.ResourceTypeThe %s is mismatched for %s and %s.-
400EndpointServiceNotSupportedZoneThe specified endpoint service does not support the zone.The specified endpoint service does not support the zone.
400ServiceResourceNotSupportIpv6The resource is not support ipv6.The endpoint service does not support IPv6.
400EndpointServiceResourceTypeNotEqualthe service resource type not equal request type.-
400OperationDenied.ServiceResourceIpVersionMismatchThe endpoint service and service resource AddressIpVersion do not match.The endpoint service and service resource AddressIpVersion do not match.

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

Change history

Change timeSummary of changesOperation
2024-09-18The Error code has changedView Change Details
2023-08-23The Error code has changedView Change Details