# Alibaba Cloud PrivateLink API

> Alibaba Cloud PrivateLink API on Apizie: 40 endpoints (Adds a user account to the service whitelist of an endpoint service, Adds a zone to an endpoint, Adds a service resource to an endpoint service by calling the AttachResourceToVpcEndpointService operation, Calls the AttachSecurityGroupToVpcEndpoint operation to add an endpoint to a security group, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-privatelink`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/privatelink
- Page: https://zieapi.vercel.app/api/cloud/aliyun-privatelink
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-privatelink/openapi.json

Alibaba Cloud OpenAPI for PrivateLink (privatelink, version 2020-04-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a user account to the service whitelist of an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/add-user-to-vpc-endpoint-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service for which you want to add a service whitelist entry. You can call the… |
| UserId | integer | no | The ID of the user account to add to the service whitelist |
| ServiceId | string | yes | The ID of the endpoint service |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without adding the service whitelist entry. The system… |
| ClientToken | string | no | 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… |
| UserARN | string | no | The whitelist entry in ARN format. The format is acs:ram:: : |

### Adds a zone to an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/add-zone-to-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint to which you want to add a zone. You can call https://help.aliyun.com/document_detail/120468.html to query… |
| ZoneId | string | yes | The ID of the zone to add |
| VSwitchId | string | yes | The vSwitch in the zone to add. The system automatically creates an endpoint elastic network interface (ENI) in this vSwitch |
| ip | string | no | The IP address of the endpoint elastic network interface (ENI) in the zone to add. You can specify an active IP address in the vSwitch of… |
| EndpointId | string | yes | The ID of the endpoint to which you want to add a zone |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without adding the zone. The system checks required… |
| ClientToken | string | no | 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… |
| Ipv6Address | string | no | The IPv6 address of the endpoint elastic network interface (ENI) in the zone to add. You can specify an active IPv6 address in the vSwitch… |

### Adds a service resource to an endpoint service by calling the AttachResourceToVpcEndpointService operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/attach-resource-to-vpc-endpoint-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service to which you want to add a service resource. You can call the… |
| ResourceType | string | yes | The EPS resource type. Valid values: slb: The service resource type is Classic Load Balancer (CLB). alb: The service resource type is… |
| ResourceId | string | yes | The service resource ID |
| ZoneId | string | no | The zone of the service resource. This parameter is required when the service resource is an ALB, NLB, or GWLB instance |
| ServiceId | string | yes | The endpoint service to which you want to add a service resource |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without adding the service resource. The system checks the… |
| ClientToken | string | no | 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… |

### Calls the AttachSecurityGroupToVpcEndpoint operation to add an endpoint to a security group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/attach-security-group-to-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint that you want to add to the security group. You can call https://help.aliyun.com/document_detail/120468.html… |
| SecurityGroupId | string | yes | The ID of the security group to which you want to add the endpoint |
| EndpointId | string | yes | The ID of the endpoint that you want to add to the security group |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ClientToken | string | no | 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… |

### Changes the resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| ResourceType | string | no | The resource type. Valid values: VpcEndpoint (default): endpoint. VpcEndpointService: endpoint service |
| ResourceId | string | yes | The ID of the PrivateLink resource for which you want to change the resource group |
| ResourceGroupId | string | yes | The ID of the target resource group |

### Calls the CheckProductOpen operation to query whether PrivateLink is activated
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/check-product-open` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |

### create an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/create-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint. You can call the https://help.aliyun.com/document_detail/120468.html operation to query region IDs |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the parameter value on your client to ensure that… |
| DryRun | string | no | Specifies whether to only perform a dry run for this request. Valid values: true: The system performs a dry run and does not create an… |
| EndpointName | string | no | The name of the endpoint. The name must be 2 to 128 characters in length, and must start with a letter or a Chinese character. It can… |
| EndpointType | string | no | The endpoint type. Valid values: Interface: interface endpoint. You can add EPS resource types such as Application Load Balancer (ALB),… |
| ZonePrivateIpAddressCount | integer | no | The number of private IP addresses for the endpoint elastic network interface (ENI) in each zone. Set the value to 1 |
| EndpointDescription | string | no | The description of the endpoint. The description must be 2 to 256 characters in length, and cannot start with `http://` or `https://` |
| VpcId | string | yes | The virtual private cloud (VPC) to which the endpoint belongs |
| ServiceId | string | no | The endpoint service that is associated with the endpoint |
| ServiceName | string | no | The name of the endpoint service that is associated with the endpoint |
| Zone | string | no | The list of endpoint zones. The specified zones must be supported by the endpoint service. Otherwise, the EndpointServiceNotSupportedZone… |
| SecurityGroupId | string | no | The list of endpoint security groups associated with the endpoint ENI (JSON-encoded) |
| ProtectedEnabled | string | no | Specifies whether to enable managed protection. This parameter takes effect only for Security Token Service (STS) calls. Valid values:… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| PolicyDocument | string | no | The Resource Access Management (RAM) access policy. For more information about access policy definitions, see… |
| AddressIpVersion | string | no | The IP version. Valid values: IPv4: IPv4 (default). DualStack: dual-stack. To use dual-stack for the endpoint, both the associated… |
| ZoneAffinityEnabled | string | no | Specifies whether to support nearest access resolution for the endpoint domain name of the connected service. Valid values: true: yes.… |
| ServiceRegionId | string | no | The region ID of the endpoint service. The default value is the current region, which is the region where you create an endpoint |
| CrossRegionBandwidth | integer | no | The cross-region bandwidth. This parameter is required only when the endpoint and the endpoint service are in different regions. Unit:… |

### Calls the CreateVpcEndpointService operation to create an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/create-vpc-endpoint-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service. You can call https://help.aliyun.com/document_detail/469325.html to query the most recent region list |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceDescription | string | no | The description of the endpoint service |
| AutoAcceptEnabled | string | no | Specifies whether to automatically accept endpoint connections. Valid values: true: automatically accept endpoint connections. false… |
| Payer | string | no | The payer. Valid values: Endpoint: service consumer. EndpointService: service provider |
| ZoneAffinityEnabled | string | no | Specifies whether to support zone affinity for the endpoint domain name of the endpoint service. Valid values: true: supported. false… |
| ServiceResourceType | string | no | The EPS resource type. Valid values: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer… |
| Resource | string | no | The service resources of the endpoint service. You can add up to 10 resources during creation. After creation, you can add more resources… |
| ServiceSupportIPv6 | string | no | Specifies whether the endpoint service supports IPv6. Valid values: true: supported. false (default): not supported |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The list of tags (JSON-encoded) |
| AddressIpVersion | string | no | The protocol version. Valid values: IPv4: IPv4 (default). DualStack: dual-stack. Only endpoint services whose backend resource type is nlb… |
| SupportedRegionList | string | no | The list of regions supported by the endpoint service. Service consumers can create endpoint connections from the regions in this list… |

### Deletes an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/delete-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint that you want to delete. You can call https://help.aliyun.com/document_detail/120468.html to query the most… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: sends a check request. The… |
| EndpointId | string | yes | The ID of the endpoint that you want to delete |

### Deletes an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/delete-vpc-endpoint-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service. You can call https://help.aliyun.com/document_detail/120468.html to query the most recent region list |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The ID of the endpoint service that you want to delete |

### Queries the regions that support PrivateLink
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| ServiceResourceType | string | no | The EPS resource type supported by PrivateLink. The available regions vary based on the EPS resource type. You can specify the EPS… |

### Queries the list of zones supported by PrivateLink in a specified region. In cross-region scenarios, the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/describe-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the zones. You can call the https://help.aliyun.com/document_detail/120468.html operation to query region IDs |
| ServiceResourceType | string | no | The zone active status of PrivateLink in a region depends on the EPS resource type. You can specify the EPS resource type when querying… |
| CrossRegion | string | no | Specifies whether this is a cross-region scenario. Default value: false. Set CrossRegion to true and use it together with CrossRegionSide… |
| CrossRegionSide | string | no | Specifies whether to query the zone active status for the initiator side or the service side in a cross-region connection. Valid values:… |

### Calls the DetachResourceFromVpcEndpointService operation to remove a service resource from an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/detach-resource-from-vpc-endpoint-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service from which you want to remove a service resource. You can call the… |
| ResourceType | string | no | The type of the service resource. Valid values: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load… |
| ResourceId | string | yes | The service resource ID |
| ZoneId | string | no | The zone of the endpoint service from which you want to remove a service resource. You can call the… |
| ServiceId | string | yes | The ID of the endpoint service from which you want to remove a service resource |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without removing the service resource. The system checks… |
| ClientToken | string | no | 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… |

### Removes an endpoint from a security group by calling the DetachSecurityGroupFromVpcEndpoint operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/detach-security-group-from-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint that you want to remove from the security group. You can call… |
| SecurityGroupId | string | yes | The ID of the security group from which you want to remove the endpoint |
| EndpointId | string | yes | The ID of the endpoint that you want to remove from the security group |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without actually removing the endpoint from the security… |
| ClientToken | string | no | 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… |

### Rejects a connection request from an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/disable-vpc-endpoint-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the connection request from the endpoint is rejected. You can call the… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The endpoint service ID |
| EndpointId | string | yes | The endpoint ID |

### Calls the DisableVpcEndpointZoneConnection operation to disconnect an endpoint zone connection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/disable-vpc-endpoint-zone-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint connection that you want to reject endpoint connection. You can invoke the… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The endpoint service ID |
| EndpointId | string | yes | The endpoint ID |
| ZoneId | string | yes | The zone ID of the endpoint connection |
| ReplacedResource | string | no | Specifies whether to disconnect the legacy connection after smooth migration of EPS resource. Valid values: true: disconnects the legacy… |

### Accepts an endpoint connection request for an endpoint service by calling the EnableVpcEndpointConnection…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/enable-vpc-endpoint-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint connection to accept. You can call the https://help.aliyun.com/document_detail/120468.html operation to… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The endpoint service ID |
| EndpointId | string | yes | The endpoint ID |
| Bandwidth | integer | no | The bandwidth of the endpoint connection. Unit: Mbit/s. The valid values vary based on the service resource type: NLB: 100 to 50000. ALB:… |
| TrafficControlMode | string | no | Scalability: automatic scaling. In this pattern, the bandwidth settings for the endpoint connection do not take effect. BandwidthLimit:… |

### Allows connections to endpoint zones
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/enable-vpc-endpoint-zone-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the endpoint connection request is accepted. You can call the… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The endpoint service ID |
| EndpointId | string | yes | The endpoint ID |
| ZoneId | string | yes | The ID of the zone that is associated with the endpoint |

### Retrieves the attributes of an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/get-vpc-endpoint-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint whose attributes you want to retrieve. You can call the https://help.aliyun.com/document_detail/448570.html… |
| EndpointId | string | yes | The ID of the endpoint whose attributes you want to retrieve |

### Queries the attributes of an endpoint service that belongs to the current account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/get-vpc-endpoint-service-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service. You can call https://help.aliyun.com/document_detail/120468.html to query the most recent region list |
| ServiceId | string | yes | The ID of the endpoint service |

### Queries the tags that are bound to resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| ResourceId | string | no | The list of resource IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: vpcendpoint: endpoint. vpcendpointservice: endpoint service |
| Tag | string | no | The list of tags (JSON-encoded) |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure that the… |
| RegionId | string | yes | The region ID of the resource. You can call the https://help.aliyun.com/document_detail/120468.html operation to query the region ID |
| NextToken | string | no | Specifies whether a next query token is available. Valid values: If this is the first query or no next query is available, you do not need… |

### Queries endpoint connections by calling the ListVpcEndpointConnections operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint connections to query. You can call the https://help.aliyun.com/document_detail/120468.html operation to… |
| NextToken | string | no | Specifies whether to include a token for the next query. Valid values: Leave this parameter empty for the first query or if no next query… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 1000. Default value: 50 |
| ServiceId | string | no | The endpoint service ID |
| EniId | string | no | The endpoint elastic network interface (ENI) ID |
| EndpointId | string | no | The endpoint ID |
| ConnectionStatus | string | no | The endpoint connection status. Valid values: Pending: Being modified. Connecting: Connecting. Connected: Connected. Disconnecting:… |
| EndpointOwnerId | integer | no | The ID of the account to which the endpoint belongs |
| ResourceId | string | no | The service resource ID |
| ReplacedResourceId | string | no | The ID of the service resource that is replaced in a smooth migration of EPS resource scenario |
| ResourceGroupId | string | no | The resource group ID of the endpoint to query |

### Calls the ListVpcEndpointSecurityGroups operation to query the security groups that are associated with an…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-security-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint to query. You can call the https://help.aliyun.com/document_detail/120468.html operation to obtain the… |
| 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.… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 50. Default value: 50 |
| EndpointId | string | yes | The ID of the endpoint to query |

### Queries the service resources that are added to an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-service-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the service resource. You can call the https://help.aliyun.com/document_detail/120468.html operation to query the most… |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is your first request and… |
| MaxResults | integer | no | The number of entries to return on each page. Valid values: 1 to 50. Default value: 50 |
| ServiceId | string | yes | The endpoint service ID |

### Queries the whitelist of an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-service-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service that you want to query. You can call the https://help.aliyun.com/document_detail/120468.html… |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is your first request and… |
| MaxResults | integer | no | The number of entries to return on each page. Valid values: 1 to 50. Default value: 50 |
| ServiceId | string | yes | The endpoint service ID |
| UserId | integer | no | The ID of the Alibaba Cloud account in the whitelist of the endpoint service |
| UserListType | string | no | The type of the user list in the whitelist of the endpoint service |

### Queries the list of endpoint services that belong to the current account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service. You can call the https://help.aliyun.com/document_detail/120468.html operation to query the most… |
| NextToken | string | no | Specifies whether to have a token for the next query. Valid values: Leave this parameter empty for the first query or if no next query… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 1000. Default value: 50 |
| ServiceId | string | no | The ID of the endpoint service |
| ServiceName | string | no | The name of the endpoint service |
| ResourceId | string | no | The service resource ID |
| ServiceResourceType | string | no | The EPS resource type. Valid values: slb: Classic Load Balancer (CLB). alb: Application Load Balancer (ALB). nlb: Network Load Balancer… |
| AutoAcceptEnabled | string | no | Specifies whether to automatically accept endpoint connections. Valid values: true: Endpoint connections are automatically accepted.… |
| ServiceStatus | string | no | The endpoint service status. Valid values: Creating: being created. Pending: being modified. Active: active. Deleting: being deleted |
| ServiceBusinessStatus | string | no | The business status of the endpoint service. Valid values: Normal: normal. FinancialLocked: locked due to overdue payment |
| ZoneAffinityEnabled | string | no | Specifies whether zone affinity is enabled for the endpoint that connects to the endpoint service. Valid values: true: Zone affinity is… |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| AddressIpVersion | string | no | The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack |

### Invokes the ListVpcEndpointServicesByEndUser operation to query the endpoint services for which the current…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-services-by-end-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint services to query. You can call https://help.aliyun.com/document_detail/120468.html to obtain the region ID |
| NextToken | string | no | Specifies whether to include a token for the next query. Valid values: Leave this parameter empty for the first query or if no more… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 1000. Default value: 50 |
| ServiceId | string | no | The ID of the endpoint service to query |
| ServiceName | string | no | The name of the endpoint service to query |
| ServiceType | string | no | The endpoint service type. Set the value to Interface, which indicates an interface endpoint. You can add Application Load Balancer (ALB),… |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| ServiceRegionId | string | no | The region ID of the endpoint service |

### Call the ListVpcEndpointZones operation to query the zones of an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoint-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region. Call the https://help.aliyun.com/document_detail/120468.html operation to obtain the region ID |
| NextToken | string | no | The token that is used to retrieve the next page of results. Valid values: If this is your first query, you do not need to specify this… |
| MaxResults | integer | no | The number of entries to return on each page. Valid values: 1 to 1000. Default value: 50 |
| EndpointId | string | yes | The ID of the endpoint. After you specify the endpoint ID, the system queries the zones of the endpoint |

### Queries endpoints
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/list-vpc-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoints to query. You can call the https://help.aliyun.com/document_detail/120468.html operation to obtain the… |
| NextToken | string | no | The pagination token for the next query. Valid values: If this is the first query or no next query is required, leave this parameter… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 1000. Default value: 50 |
| EndpointId | string | no | The ID of the endpoint to query |
| ServiceName | string | no | The service name of the endpoint service associated with the endpoint to query |
| VpcId | string | no | The VPC to which the endpoint belongs |
| EndpointName | string | no | The name of the endpoint |
| EndpointType | string | no | The endpoint type. Valid values: Interface: interface endpoint. Reverse: reverse endpoint. GatewayLoadBalancer: Gateway Load Balancer… |
| EndpointStatus | string | no | The status of the endpoint. Valid values: Creating: The endpoint is being created. Active: The endpoint is available. Pending: The… |
| ConnectionStatus | string | no | The endpoint connection status. Valid values: Pending: The endpoint is being modified. Connecting: The endpoint is being connected.… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |
| AddressIpVersion | string | no | The IP version. Valid values: IPv4: IPv4. DualStack: dual-stack |
| ServiceRegionId | string | no | The region ID of the endpoint service |

### Enables the PrivateLink service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/open-private-link-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |

### Calls the RemoveUserFromVpcEndpointService operation to remove a user account from the service whitelist of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/remove-user-from-vpc-endpoint-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service from which you want to remove the service whitelist. You can call the… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax,… |
| UserId | integer | no | The ID of the account to remove from the service whitelist |
| ServiceId | string | yes | The ID of the endpoint service |
| UserARN | string | no | The user whitelist in ARN format |

### Deletes a zone of an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/remove-zone-from-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint for which you want to delete the zone. You can call the https://help.aliyun.com/document_detail/120468.html… |
| ZoneId | string | yes | The ID of the zone that you want to delete |
| EndpointId | string | yes | The ID of the endpoint for which you want to delete the zone |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ClientToken | string | no | 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… |

### Adds tags to resources. You can call this API operation to add tags to one or more endpoints or endpoint…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The resource IDs. Up to 50 resource IDs are supported (JSON-encoded) |
| Tag | string | yes | The tags to add to the resources (JSON-encoded) |
| ResourceType | string | yes | The type of resource. Valid values: vpcendpoint: endpoint vpcendpointservice: endpoint service |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ClientToken | string | no | 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… |
| RegionId | string | yes | The region ID of the PrivateLink instance. You can call the https://help.aliyun.com/document_detail/120468.html operation to query the… |

### Removes tags from one or more endpoints or endpoint services at a time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The resource IDs. You can specify up to 50 resource IDs (JSON-encoded) |
| TagKey | string | no | The keys of the tags that you want to remove from the resources. You can specify up to 20 tag keys (JSON-encoded) |
| ResourceType | string | yes | The resource type. Valid values: vpcendpoint: endpoint vpcendpointservice: endpoint service |
| All | string | no | Specifies whether to remove all tags from the resource. Valid values: true false If you specify both the All and TagKey.N parameters, the… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ClientToken | string | no | 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… |
| RegionId | string | yes | The region ID of the PrivateLink instance. You can call the https://help.aliyun.com/document_detail/120468.html operation to query the… |

### Modifies the attributes of an endpoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/update-vpc-endpoint-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint that you want to modify. You can call the https://help.aliyun.com/document_detail/120468.html operation to… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: sends a check request without… |
| EndpointId | string | yes | The ID of the endpoint that you want to modify |
| EndpointName | string | no | The name of the endpoint. The name must be 2 to 128 characters in length, and can contain letters, digits, hyphens (-), and underscores… |
| EndpointDescription | string | no | The description of the endpoint. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://` |
| PolicyDocument | string | no | The RAM access policy. For more information about the policy definition, see https://help.aliyun.com/document_detail/93738.html |
| AddressIpVersion | string | no | The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack. To enable dual-stack for the endpoint, the endpoint service… |
| ZoneAffinityEnabled | string | no | Specifies whether to enable nearest access for the endpoint domain name of the connected service. Valid values: true: enabled. false:… |
| ResetPolicy | string | no | Resets the policy to the default policy |
| CrossRegionBandwidth | integer | no | The cross-region bandwidth. This parameter is required only when the endpoint and the endpoint service are in different regions. Unit:… |

### Calls the UpdateVpcEndpointConnectionAttribute operation to modify the attributes of an endpoint connection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/update-vpc-endpoint-connection-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint connection bandwidth that you want to modify. You can call the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The endpoint service ID |
| EndpointId | string | yes | The endpoint ID |
| Bandwidth | integer | no | The bandwidth of the endpoint connection. Unit: Mbit/s. The valid values vary based on the type of service resource: NLB: 100 to 50000.… |
| TrafficControlMode | string | no | Scalability: auto scaling. In this mode, the bandwidth configured for the endpoint connection does not take effect. BandwidthLimit:… |

### Calls the UpdateVpcEndpointServiceAttribute operation to modify the attributes of an endpoint service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/update-vpc-endpoint-service-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint service. You can call the https://help.aliyun.com/document_detail/120468.html operation to query the most… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The ID of the endpoint service |
| ServiceDescription | string | no | The description of the endpoint service |
| AutoAcceptEnabled | string | no | Specifies whether to automatically accept endpoint connections. Valid values: true: automatically accepts endpoint connections. false:… |
| ConnectBandwidth | integer | no | The default bandwidth limit. Default value: 3072. Unit: Mbit/s. Valid values: 100 to 10240. Settings for the default bandwidth limit are… |
| ZoneAffinityEnabled | string | no | Specifies whether to resolve the domain name of the endpoint that is connected to the endpoint service to the nearest access point. Valid… |
| ServiceSupportIPv6 | string | no | Specifies whether the endpoint service supports IPv6. Valid values: true: yes. false (default): no |
| AddressIpVersion | string | no | The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack. Currently, only endpoint services whose backend resource type is… |
| AddSupportedRegionSet | string | no | The list of remote regions to add for the endpoint service (JSON-encoded) |
| DeleteSupportedRegionSet | string | no | The list of remote regions to remove from the endpoint service (JSON-encoded) |

### The UpdateVpcEndpointServiceResourceAttribute operation enables or disables automatic allocation for a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/update-vpc-endpoint-service-resource-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where you want to modify the service resource. Call the https://help.aliyun.com/document_detail/120468.html operation… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure that the… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: sends a check request without modifying the properties of the service… |
| ServiceId | string | yes | The ID of the endpoint service |
| ResourceId | string | yes | The ID of the service resource |
| ZoneId | string | no | The zone where the service resource is located. This parameter is required if the service resource is an Application Load Balancer (ALB),… |
| AutoAllocatedEnabled | string | yes | Specifies whether to enable automatic resource allocation. Valid values: true: Enables automatic resource allocation. false: Disables… |

### Modifies a service resource of a zone to which an endpoint connection belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/update-vpc-endpoint-zone-connection-resource-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the endpoint connection whose bandwidth you want to modify. You can call the… |
| ClientToken | string | no | 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… |
| DryRun | string | no | Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The… |
| ServiceId | string | yes | The endpoint service ID |
| EndpointId | string | yes | The endpoint ID |
| ZoneId | string | yes | The zone ID |
| ResourceAllocateMode | string | no | The resource allocation mode. You can change the resource allocation mode only if the endpoint connection is in the Disconnected state.… |
| ResourceReplaceMode | string | no | The migration mode of the service resource. Valid values: Graceful: smooth migration. Service resources in the zone are smoothly migrated.… |
| ResourceType | string | no | The type of the service resource. Valid values: slb: a CLB instance that supports PrivateLink. In addition, the CLB instance is deployed… |
| ResourceId | string | no | The ID of the service resource that you want to manually allocate or migrate in the zone where the endpoint connection is deployed. If… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://privatelink.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/add-user-to-vpc-endpoint-service" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud PrivateLink API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-privatelink/add-user-to-vpc-endpoint-service with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud PrivateLink API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud PrivateLink itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud PrivateLink API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-privatelink.

### What is the status of the Alibaba Cloud PrivateLink API?
Needs your own provider key (bring your own key)