All Products
Search
Document Center

Apsara File Storage NAS:DescribeZones

Last Updated:Mar 14, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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****
Zonesobject []

The queried zones.

Performancearray

This parameter is reserved. You can ignore this parameter.

string

This parameter is reserved. You can ignore this parameter.

nfs
Capacityarray

This parameter is reserved. You can ignore this parameter.

string

This parameter is reserved. You can ignore this parameter.

nfs
ZoneIdstring

The zone ID.

cn-hangzhou-b
InstanceTypesobject []

The details about file system types.

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.