All Products
Search

This Product

    PrivateLink:AttachSecurityGroupToVpcEndpoint

    Document Center

    PrivateLink:AttachSecurityGroupToVpcEndpoint

    Last Updated:Feb 27, 2024

    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.

    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:AttachSecurityGroupToVpcEndpointWrite
    • VpcEndpoint
      acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}
    • SecurityGroup
      acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    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
    SecurityGroupIdstringYes

    The ID of the security group with which you want to associate the endpoint.

    		sg-hp3c8qj1tyct90ej****
    EndpointIdstringYes

    The ID of the endpoint with which you want to associate the security group.

    		ep-hp33b2e43fays7s8****
    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 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
    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.

    		8D778FF9-7640-4C13-BCD6-9265CA9A2F81

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400EndpointNotFoundThe specified Endpoint does not exist.The specified Endpoint does not exist.
    400EndpointOperationDeniedThe specified operation of endpoint is not allowed.The specified operation of endpoint is not allowed.
    400EndpointLockedThe specified Endpoint is locked.The specified Endpoint is locked.
    400EndpointConnectionOperationDeniedThe endpoint is being connected.The endpoint is being connected.
    400SecurityGroupExistThe specified security group already exists.The specified security group already exists.
    400EndpointServiceDeletedThe specified Service is already deleted.The specified Service is already deleted.
    400SecurityGroupNotFoundThe specified security group does not exist.The specified security group does not exist.
    400SecurityGroupTypeNotSupportThe specified security group type is not supported.-
    400SecurityGroupTypeOnlySingleTypeSupportededThe specified security group only support one type.-

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

    Change history

    Change timeSummary of changesOperation
    No change history