Query available regions by calling DescribeRegions - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries the available Alibaba Cloud regions.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeRegions

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of regions returned per page in a paging query. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
FileSystemType	string	No	The file system type. Valid values: all: all types standard: General-purpose NAS (default) extreme: Extreme NAS cpfs: CPFS Valid values: standard : General-purpose NAS. all : All types. cpfs : CPFS file system. extreme : Extreme NAS.	standard

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The current page number.	1
PageSize	integer	The number of regions returned per page.	10
Regions	object
Region	array<object>	The region information.
	object
LocalName	string	The region name.	East China 1
RegionEndpoint	string	The endpoint of the region.	nas.cn-hangzhou.aliyuncs.com
RegionId	string	The region ID.	cn-hangzhou
RequestId	string	The request ID.	A70BEE5D-76D3-49FB-B58F-1F398211****
TotalCount	integer	The total number of regions returned.	1

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "Regions": {
    "Region": [
      {
        "LocalName": "East China 1",
        "RegionEndpoint": "nas.cn-hangzhou.aliyuncs.com",
        "RegionId": "cn-hangzhou"
      }
    ]
  },
  "RequestId": "A70BEE5D-76D3-49FB-B58F-1F398211****",
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.