API standards and multilingual preset SDKs
The OpenAPI of this product (Privatelink/2020-04-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
PrivateLink
|
API |
Title |
Description |
| OpenPrivateLinkService | OpenPrivateLinkService | Activates PrivateLink. |
| CheckProductOpen | CheckProductOpen | Queries whether PrivateLink is activated. |
Regions and zones
|
API |
Title |
Description |
| DescribeRegions | Query regions supported by privateLink | Queries the regions that support PrivateLink. |
| DescribeZones | Query zones supported by privateLink | Queries the list of zones supported by PrivateLink in a specified region. In cross-region scenarios, the zones supported on the endpoint side and the endpoint service side are independent of each other. This operation allows you to query the supported zones for the endpoint side and the endpoint service side separately. |
Endpoint services
|
API |
Title |
Description |
| CreateVpcEndpointService | Create an endpoint service | Calls the CreateVpcEndpointService operation to create an endpoint service. |
| UpdateVpcEndpointServiceAttribute | Modify the attributes of an endpoint service | Calls the UpdateVpcEndpointServiceAttribute operation to modify 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 | Create an endpoint | Creates an endpoint. |
| UpdateVpcEndpointAttribute | Modify endpoint attributes | Modifies the attributes 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 | Accept an endpoint connection request | Calls the EnableVpcEndpointConnection operation, and the endpoint service accepts the connection request from the endpoint. |
| UpdateVpcEndpointConnectionAttribute | Modify the attributes of an endpoint connection | Calls the UpdateVpcEndpointConnectionAttribute operation to modify the attributes of an endpoint connection. |
| ListVpcEndpointConnections | Query endpoint connections | Queries endpoint connections by calling the ListVpcEndpointConnections operation. |
| 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 groups
|
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. |