API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Privatelink/2020-04-15) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
PrivateLink
|
API |
Title |
Description |
| OpenPrivateLinkService | OpenPrivateLinkService | Activates PrivateLink. |
| CheckProductOpen | CheckProductOpen | Queries whether PrivateLink is activated. |
Regions and zones
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries the regions and zones where PrivateLink is available. |
| DescribeZones | Queries the zones in a specified region | Queries the zones in a specified region by calling the DescribeZones operation. |
Endpoint services
|
API |
Title |
Description |
| CreateVpcEndpointService | CreateVpcEndpointService | Creates an endpoint service. |
| UpdateVpcEndpointServiceAttribute | UpdateVpcEndpointServiceAttribute | The UpdateVpcEndpointServiceAttribute operation modifies the attributes of an endpoint service. |
| GetVpcEndpointServiceAttribute | GetVpcEndpointServiceAttribute | Call `GetVpcEndpointServiceAttribute` to retrieve the properties of an endpoint service in your account. |
| ListVpcEndpointServices | ListVpcEndpointServices | Call the ListVpcEndpointServices operation to query the endpoint services owned by your account. |
| ListVpcEndpointServicesByEndUser | ListVpcEndpointServicesByEndUser | Call the ListVpcEndpointServicesByEndUser operation to retrieve a list of endpoint services for which the current account is whitelisted. This list includes services that you can connect to by creating new endpoints, as well as services that are already connected to your existing ones. |
| DeleteVpcEndpointService | DeleteVpcEndpointService | Deletes an endpoint service. |
Service whitelists
|
API |
Title |
Description |
| AddUserToVpcEndpointService | AddUserToVpcEndpointService | Adds an account ID to the whitelist of an endpoint service. |
| ListVpcEndpointServiceUsers | ListVpcEndpointServiceUsers | Queries the whitelist of an endpoint service. |
| RemoveUserFromVpcEndpointService | RemoveUserFromVpcEndpointService | Removes an account ID from the whitelist of an endpoint service. |
Service resources
|
API |
Title |
Description |
| UpdateVpcEndpointServiceResourceAttribute | UpdateVpcEndpointServiceResourceAttribute | The UpdateVpcEndpointServiceResourceAttribute operation enables or disables automatic allocation for a service resource of an endpoint service. |
| AttachResourceToVpcEndpointService | AttachResourceToVpcEndpointService | Adds a service resource to an endpoint service. |
| ListVpcEndpointServiceResources | ListVpcEndpointServiceResources | Queries the service resources that are added to an endpoint service. |
| DetachResourceFromVpcEndpointService | DetachResourceFromVpcEndpointService | Removes a service resource from an endpoint service. |
Endpoints
|
API |
Title |
Description |
| DeleteVpcEndpoint | DeleteVpcEndpoint | Deletes an endpoint. |
| CreateVpcEndpoint | CreateVpcEndpoint | Creates an endpoint. |
| UpdateVpcEndpointAttribute | UpdateVpcEndpointAttribute | The `UpdateVpcEndpointAttribute` operation modifies the properties of an endpoint. |
| ListVpcEndpoints | ListVpcEndpoints | The `ListVpcEndpoints` operation lists endpoints. |
| GetVpcEndpointAttribute | GetVpcEndpointAttribute | Use `GetVpcEndpointAttribute` to query the attributes of a specified endpoint. |
Endpoint connections
|
API |
Title |
Description |
| EnableVpcEndpointConnection | EnableVpcEndpointConnection | Accepts an endpoint connection request. |
| UpdateVpcEndpointConnectionAttribute | UpdateVpcEndpointConnectionAttribute | Modifies the attributes of an endpoint connection. |
| ListVpcEndpointConnections | ListVpcEndpointConnections | To list endpoint connections, call the ListVpcEndpointConnections API. |
| DisableVpcEndpointConnection | DisableVpcEndpointConnection | Rejects a connection request from an endpoint. |
Endpoint zones
|
API |
Title |
Description |
| AddZoneToVpcEndpoint | AddZoneToVpcEndpoint | Adds a zone to an endpoint. |
| ListVpcEndpointZones | ListVpcEndpointZones | Call the ListVpcEndpointZones operation to query the zones of an endpoint. |
| RemoveZoneFromVpcEndpoint | RemoveZoneFromVpcEndpoint | Deletes a zone of an endpoint. |
Endpoint zone connections
|
API |
Title |
Description |
| DisableVpcEndpointZoneConnection | DisableVpcEndpointZoneConnection | Closes connections in an endpoint zone. |
| EnableVpcEndpointZoneConnection | EnableVpcEndpointZoneConnection | Allows connections to endpoint zones. |
| UpdateVpcEndpointZoneConnectionResourceAttribute | UpdateVpcEndpointZoneConnectionResourceAttribute | Modifies a service resource of a zone to which an endpoint connection belongs. |
Security groups
|
API |
Title |
Description |
| AttachSecurityGroupToVpcEndpoint | AttachSecurityGroupToVpcEndpoint | Associates an endpoint with a security group. |
| ListVpcEndpointSecurityGroups | ListVpcEndpointSecurityGroups | Queries the security group that is associated with an endpoint. |
| DetachSecurityGroupFromVpcEndpoint | DetachSecurityGroupFromVpcEndpoint | Disassociates an endpoint from a security group. |
Tags & Resource group
|
API |
Title |
Description |
| UntagResources | UntagResources | Removes tags from one or more endpoints or endpoint services at a time. |
| ListTagResources | ListTagResources | Queries the tags that are added to resources. |
| TagResources | TagResources | Adds tags to resources. You can call this API operation to add tags to one or more endpoints or endpoint services. |
| ChangeResourceGroup | ChangeResourceGroup | Modifies a resource group. |