DescribeRegions - PrivateLink - Alibaba Cloud Documentation Center

Queries the regions and zones where PrivateLink is available.

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 region ID.	cn-hangzhou
ServiceResourceType	string	No	The regions where PrivateLink is available vary based on the service resource type. When you query the regions where PrivateLink is available, specify a service resource type. 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). ALL: all of the preceding resource types.	slb

Response parameters

Parameter	Type	Description	Example
	object
Regions	object
Region	array<object>	The collection of available regions.
	object	The collection of available regions.
LocalName	string	The name of the region.	华东1（杭州）
RegionEndpoint	string	The endpoint of the service in the region.	privatelink.cn-hangzhou.aliyuncs.com
RegionId	string	The region ID.	cn-hangzhou
ServiceResourceTypes	object
ServiceResourceType	array	The list of resource types that are supported in the region. Note If you set the ServiceResourceType request parameter to ALL, all supported resource types are returned. If you set the parameter to a specific resource type, 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.