List VPC Endpoint Security Groups using ListVpcEndpointSecurityGroups - PrivateLink - Alibaba Cloud - PrivateLink

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

get

*VpcEndpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint to query. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
NextToken	string	No	Specifies whether there is a next query token. Valid values: Leave this parameter empty for the first query or when no next query exists. If a next query exists, set this parameter to the NextToken value returned by the previous API call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 50.	50
EndpointId	string	Yes	The ID of the endpoint to query.	ep-hp33b2e43fays7s8****
RegionId	string	Yes	The region ID of the endpoint that you want to query. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote

Response elements

Element	Type	Description	Example
	object
SecurityGroups	array<object>	The security group information.
	object	The security group information.
SecurityGroupId	string	The ID of the security group associated with the endpoint.	sg-hp33bw6ynvm2yb0e****
SecurityGroupStatus	string	The association status of the security group. Valid values: Attaching: being associated. Attached: associated. Detaching: being disassociated.	Attached
NextToken	string	Indicates whether there is a next query token. Valid values: If NextToken is empty, no next query exists. If NextToken is returned, the value indicates the token for the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResults	integer	The number of entries per page.	50
TotalCount	integer	The total number of entries returned.	12

Examples

Success response

JSON format

{
  "SecurityGroups": [
    {
      "SecurityGroupId": "sg-hp33bw6ynvm2yb0e****",
      "SecurityGroupStatus": "Attached"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "TotalCount": 12
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.