AttachSecurityGroupToVpcEndpoint - PrivateLink - Alibaba Cloud Documentation Center

Associates an endpoint with a security group.

Operation description

AttachSecurityGroupToVpcEndpoint 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 ListVpcEndpoints operation to query the state of the endpoint.
- If the endpoint is in the Pending state, the endpoint is being associated with the security group.
- If the endpoint is in the Active state, the endpoint is associated with the security group.
You cannot repeatedly call the AttachSecurityGroupToVpcEndpoint operation to associate an endpoint with a security group within a specified period of time.

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

update

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint with which you want to associate with the security group. You can call the DescribeRegions operation to query the most recent region list.	eu-west-1
SecurityGroupId	string	Yes	The ID of the security group with which you want to associate the endpoint.	sg-hp3c8qj1tyct90ej****
EndpointId	string	Yes	The ID of the endpoint with which you want to associate the security group.	ep-hp33b2e43fays7s8****
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
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
RegionId	string	Yes	The region ID of the endpoint with which you want to associate with the security group. You can call the DescribeRegions operation to query the most recent region list.	eu-west-1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8D778FF9-7640-4C13-BCD6-9265CA9A2F81

Examples

Success response

JSON format

{
  "RequestId": "8D778FF9-7640-4C13-BCD6-9265CA9A2F81"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.
400	EndpointOperationDenied	The specified operation of endpoint is not allowed.	The specified operation of endpoint is not allowed.
400	EndpointLocked	The specified Endpoint is locked.	The specified Endpoint is locked.
400	EndpointConnectionOperationDenied	The endpoint is being connected.	The endpoint is being connected.
400	SecurityGroupExist	The specified security group already exists.	The specified security group already exists.
400	EndpointServiceDeleted	The specified Service is already deleted.	The specified Service is already deleted.
400	SecurityGroupNotFound	The specified security group does not exist.	The specified security group does not exist.
400	SecurityGroupTypeNotSupport	The specified security group type is not supported.
400	SecurityGroupTypeOnlySingleTypeSupporteded	The specified security group only support one type.
400	GatewayLoadBalancerNotSupportSecurityGroup	The gateway load balancer not support security group.	The gateway load balancer type does not support setting a security group.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.