All Products
Search
Document Center

PrivateLink:List of operations by function

Last Updated:Dec 19, 2024
This product(Privatelink/2020-04-15) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

PrivateLink

APITitleDescription
OpenPrivateLinkServiceOpenPrivateLinkServiceActivates PrivateLink.
CheckProductOpenCheckProductOpenQueries whether PrivateLink is activated.

Regions and zones

APITitleDescription
DescribeRegionsDescribeRegionsQueries regions and zones that support PrivateLink.
DescribeZonesDescribeZonesQueries a list of zones in a specified region.

Endpoint services

APITitleDescription
CreateVpcEndpointServiceCreateVpcEndpointServiceCreates an endpoint service.
UpdateVpcEndpointServiceAttributeUpdateVpcEndpointServiceAttributeModifies the attributes of an endpoint service.
GetVpcEndpointServiceAttributeGetVpcEndpointServiceAttributeQueries the attributes of an endpoint service.
ListVpcEndpointServicesListVpcEndpointServicesQueries a list of endpoint services.
DeleteVpcEndpointServiceDeleteVpcEndpointServiceDeletes an endpoint service.

Service whitelists

APITitleDescription
AddUserToVpcEndpointServiceAddUserToVpcEndpointServiceAdds an account ID to the whitelist of an endpoint service.
ListVpcEndpointServiceUsersListVpcEndpointServiceUsersQueries the whitelist of an endpoint service.
RemoveUserFromVpcEndpointServiceRemoveUserFromVpcEndpointServiceRemoves an account ID from the whitelist of an endpoint service.

Service resources

APITitleDescription
UpdateVpcEndpointServiceResourceAttributeUpdateVpcEndpointServiceResourceAttributeModifies the attributes of a service resource that is added to an endpoint service.
AttachResourceToVpcEndpointServiceAttachResourceToVpcEndpointServiceAdds a service resource to an endpoint service.
ListVpcEndpointServiceResourcesListVpcEndpointServiceResourcesQueries the service resources that are added to an endpoint service.
DetachResourceFromVpcEndpointServiceDetachResourceFromVpcEndpointServiceRemoves a service resource from an endpoint service.

Endpoints

APITitleDescription
DeleteVpcEndpointDeleteVpcEndpointDeletes an endpoint.
CreateVpcEndpointCreateVpcEndpointCreates an endpoint.
UpdateVpcEndpointAttributeUpdateVpcEndpointAttributeModifies the attributes of an endpoint.
ListVpcEndpointsListVpcEndpointsQueries a list of endpoints.
GetVpcEndpointAttributeGetVpcEndpointAttributeQueries the attributes of an endpoint.
ListVpcEndpointServicesByEndUserListVpcEndpointServicesByEndUserQueries a list of endpoint services that can be associated with the endpoint created within the current account.

Endpoint connections

APITitleDescription
EnableVpcEndpointConnectionEnableVpcEndpointConnectionAccepts connection requests from an endpoint.
UpdateVpcEndpointConnectionAttributeUpdateVpcEndpointConnectionAttributeModifies the attributes of an endpoint connection.
ListVpcEndpointConnectionsListVpcEndpointConnectionsQueries endpoint connections.
DisableVpcEndpointConnectionDisableVpcEndpointConnectionRejects a connection request from an endpoint.

Endpoint zones

APITitleDescription
AddZoneToVpcEndpointAddZoneToVpcEndpointAdds a zone to an endpoint.
ListVpcEndpointZonesListVpcEndpointZonesQueries the zones of an endpoint.
RemoveZoneFromVpcEndpointRemoveZoneFromVpcEndpointDeletes a zone of an endpoint.

Endpoint zone connections

APITitleDescription
DisableVpcEndpointZoneConnectionDisableVpcEndpointZoneConnectionCloses connections in an endpoint zone.
EnableVpcEndpointZoneConnectionEnableVpcEndpointZoneConnectionAllows connections to endpoint zones.
UpdateVpcEndpointZoneConnectionResourceAttributeUpdateVpcEndpointZoneConnectionResourceAttributeModifies the service resources of an endpoint connection in a zone.

Security groups

APITitleDescription
AttachSecurityGroupToVpcEndpointAttachSecurityGroupToVpcEndpointAdds an endpoint to a security group.
ListVpcEndpointSecurityGroupsListVpcEndpointSecurityGroupsQueries the security groups that are associated with an endpoint.
DetachSecurityGroupFromVpcEndpointDetachSecurityGroupFromVpcEndpointRemoves an endpoint from a security group.

Tags & Resource group

APITitleDescription
UntagResourcesUntagResourcesRemoves tags from one or more endpoints or endpoint services at a time.
ListTagResourcesListTagResourcesQueries the tags that are added to resources.
TagResourcesTagResourcesAdds tags to resources. You can call this API operation to add tags to one or more endpoints or endpoint services.
ChangeResourceGroupChangeResourceGroupModifies a resource group.