DescribeRegions API Overview for PrivateLink - PrivateLink - Alibaba Cloud - PrivateLink

Queries the regions that support 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
RegionId	string	No	The EPS resource type supported by PrivateLink. The available regions vary based on the EPS resource type. You can specify the EPS resource type when querying the regions where PrivateLink is available. Valid values: slb (default): the EPS resource type is Classic Load Balancer (CLB). alb: the EPS resource type is Application Load Balancer (ALB). nlb: the EPS resource type is Network Load Balancer (NLB). gwlb: the EPS resource type is Gateway Load Balancer (GWLB). ALL: all of the above.	slb
ServiceResourceType	string	No	The EPS resource type supported by PrivateLink. The available regions vary based on the service resource type. You can specify a service resource type when querying the regions where PrivateLink is available. Valid values: slb (default): the service resource type is Classic Load Balancer (CLB). alb: the service resource type is Application Load Balancer (ALB). nlb: the service resource type is Network Load Balancer (NLB). gwlb: the service resource type is Gateway Load Balancer (GWLB). ALL: all of the preceding types.	slb

Response elements

Element	Type	Description	Example
	object
Regions	object
Region	array<object>	The collection of available regions.
	array<object>	The collection of available regions.
LocalName	string	The region name.	华东1（杭州）
RegionEndpoint	string	The endpoint of the region.	privatelink.cn-hangzhou.aliyuncs.com
RegionId	string	The region ID.	cn-hangzhou
ServiceResourceTypes	object
ServiceResourceType	array	The list of resource types supported in the region. Note If ServiceResourceType is set to "ALL" in the request, all supported resource types are returned. If a specific resource type is specified, only the specified resource type is returned in the list.
	string	The supported resource type.	slb
RequestId	string	The request ID.	611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F

Examples

Success response

JSON format

{
  "Regions": {
    "Region": [
      {
        "LocalName": "华东1（杭州）",
        "RegionEndpoint": "privatelink.cn-hangzhou.aliyuncs.com",
        "RegionId": "cn-hangzhou",
        "ServiceResourceTypes": {
          "ServiceResourceType": [
            "slb"
          ]
        }
      }
    ]
  },
  "RequestId": "611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.