Docs

Big Data File Storage

General interfaces

DescribeZones - Query availability zones

Call the DescribeZones API to query Availability Zone information.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Below are the request parameters specific to this API and some common parameters. For more information, see Common parameters.

Query

Action string required Example value: DescribeZones

The action to perform. Value: DescribeZones.

Version string required Example value: 2024-08-01

API version. Value: 2024-08-01.

WithSemiManaged boolean Optional Example value: false

Whether to return semi-managed clusters

Body

RegionId string required Example value: cn-beijing

Region ID.

Response parameters

Below are the response parameters specific to this API. For more information, see Response structure.

Zones object[] Example value: See response example for details

Availability Zone list.

FileSystemModes object[] Example value: See response example for details

File system mode information.

CachePlans object[] Example value: See response example for details

Cache specification information.

CachePlan string Example value: SaaS_T2

Cache specification details:

SaaS_Disabled: Cache acceleration disabled

SaaS_T2: Performance type 1

SaaS_T4: Performance type 2

SemiManaged: Semi-managed type

CachePlanCN string Example value: Performance type 1

Cache specification (Chinese).

LegacyCachePlanCN string Example value: Performance type 1

Legacy cache specification (Chinese).

LegacyCachePlan string Example value: T2

Legacy cache specification.

Status string Example value: OnSale

Sale status. Value description as follows:

OnSale: On sale.

SoldOut: Sold out.

FileSystemMode string Example value: ACC

File system mode. Value description as follows:

HDFS: File storage scenario

ACC: Data lake scenario

FileSystemModeCN string Example value: Data lake scenario

File system mode (Chinese).

LegacyFsMode string Example value: ACC_MODE

Legacy file system mode.

LegacyFsModeCN string Example value: Data lake scenario

Legacy file system mode (Chinese).

ZoneId string Example value: cn-beijing-a

Availability Zone ID.

ZoneName string Example value: North China 2 (Beijing) - Availability Zone A

Availability Zone name.

Request example

POST /?Action=DescribeZones&Version=2024-08-01 HTTP/1.1​
Host: open.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241208T141446Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241208/cn-beijing/cfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "RegionId": "cn-beijing"​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "20241208221459233084219068C012C2",​
    "Action": "DescribeZones",​
    "Version": "2024-08-01",​
    "Service": "cfs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Zones": [​
      {​
        "ZoneId": "cn-beijing-a",​
        "ZoneName": "China 2（Beijing）-availability zone A",​
        "FileSystemModes": [​
          {​
            "FileSystemMode": "HDFS",​
            "FileSystemModeCN": "File storage scenario",​
            "LegacyFsMode": "HDFS_MODE",​
            "LegacyFsModeCN": "File storage scenario",​
            "CachePlans": [​
              {​
                "CachePlan": "Saas_Disabled",​
                "CachePlanCN": "Disabled",​
                "LegacyCachePlan": "DISABLED",​
                "LegacyCachePlanCN": "Disabled",​
                "Status": "OnSale"​
              },​
              {​
                "CachePlan": "Saas_T2",​
                "CachePlanCN": "Performance Type 1",​
                "LegacyCachePlan": "T2",​
                "LegacyCachePlanCN": "Performance Type 1",​
                "Status": "OnSale"​
              },​
              {​
                "CachePlan": "Saas_T4",​
                "CachePlanCN": "Performance Type 2",​
                "LegacyCachePlan": "T4",​
                "LegacyCachePlanCN": "Performance Type 2",​
                "Status": "SoldOut"​
              }​
            ]​
          }​
        ]​
      }​
    ]​
  }​
}​

Error codes

The following table lists the error codes related to this API and its business logic. For common error codes, see the Common error codes documentation.

Status code	Error codes	Error message	Note
400	InvalidParameter	The specified parameter %s is not valid.	Invalid parameter value.
400	InvalidRequest	Invalid request in request body: %s.	Invalid request body.
400	MissingParameter	The required parameter %s is not supplied.	Missing parameter.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	Internal error.

Last updated: 2026.02.02 11:27:57