All Products
Search
Document Center

File Storage NAS:DescribeZones

Last Updated:Nov 07, 2024

Queries all zones in a region and the file system types that are supported in each zone.

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:DescribeZonesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where you want to query zones.

You can call the DescribeRegions operation to query the latest region list.

cn-hangzhou
FileSystemTypestringNo

The type of the file system.

Valid values:

  • 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
RequestIdstring

The request ID.

A70BEE5D-76D3-49FB-B58F-1F398211****
Zonesarray<object>

The queried zones.

Zoneobject
Performancearray

This parameter is reserved. You can ignore this parameter.

Protocolstring

This parameter is reserved. You can ignore this parameter.

nfs
Capacityarray

This parameter is reserved. You can ignore this parameter.

Protocolstring

This parameter is reserved. You can ignore this parameter.

nfs
ZoneIdstring

The zone ID.

cn-hangzhou-b
InstanceTypesarray<object>

The details about file system types.

InstanceTypeobject
StorageTypestring

The storage type.

  • If the FileSystemType parameter is set to standard, the storage type is Performance or Capacity.
  • If the FileSystemType parameter is set to extreme, the storage type is standard or advance.
  • If the FileSystemType parameter is set to cpfs, the storage type is advance_100 (100 MB/s/TiB baseline) or advance_200 (200 MB/s/TiB baseline).
Note CPFS file systems are available only on the China site (aliyun.com).
Capacity
ProtocolTypestring

The protocol type.

  • If the FileSystemType parameter is set to standard, the protocol type is nfs or smb.
  • If the FileSystemType parameter is set to extreme, the protocol type is nfs.
  • If the FileSystemType parameter is set to cpfs, the protocol type is cpfs.
Note CPFS file systems are available only on the China site (aliyun.com).
nfs

Examples

Sample success responses

JSONformat

{
  "RequestId": "A70BEE5D-76D3-49FB-B58F-1F398211****",
  "Zones": {
    "Zone": [
      {
        "Performance": {
          "Protocol": [
            "nfs"
          ]
        },
        "Capacity": {
          "Protocol": [
            "nfs"
          ]
        },
        "ZoneId": "cn-hangzhou-b",
        "InstanceTypes": {
          "InstanceType": [
            {
              "StorageType": "Capacity",
              "ProtocolType": "nfs"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidRegionId.NotFoundThe specified Region is not found.The requested region does not exist or the service is not yet available.
500InternalErrorThe request processing has failed due to some unknown error.The request failed due to an unknown error. Please try again later.

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

Change history

Change timeSummary of changesOperation
2024-09-05API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details