All Products
Search
Document Center

File Storage NAS:DescribeRegions

Last Updated:Nov 11, 2024

Queries the regions in which File Storage NAS is available.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
nas:DescribeRegionsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

10
PageNumberintegerNo

The page number.

Pages start from page 1. Default value: 1.

1
FileSystemTypestringNo

The type of the file system.

Valid values:

  • all: all types of file systems
  • standard (default): General-purpose NAS file system
  • extreme: Extreme NAS file system
  • cpfs: Cloud Parallel File Storage (CPFS) file system
Note CPFS file systems are available only on the China site (aliyun.com).
standard

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

1
RequestIdstring

The request ID.

A70BEE5D-76D3-49FB-B58F-1F398211****
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
Regionsarray<object>

The queried regions.

Regionobject
LocalNamestring

The region name.

East China 1
RegionEndpointstring

The endpoint for the region.

nas.cn-hangzhou.aliyuncs.com
RegionIdstring

The region ID.

cn-hangzhou

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history