- Releases Notes and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practices
- API Documentation
- Troubleshooting
- FAQs
- CFS Service Level Agreement
- Contact Us
- Glossary
- Releases Notes and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practices
- API Documentation
- Troubleshooting
- FAQs
- CFS Service Level Agreement
- Contact Us
- Glossary
1. API Description
Domain name for API request: cfs.tencentcloudapi.com.
This API is used to query the availability of a region.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeAvailableZoneInfo. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | No | String | Common Params. This parameter is not required for this API. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RegionZones | Array of AvailableRegion | Information such as resource availability in each AZ and the supported storage classes and protocols |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying the region availability
Input Example
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAvailableZoneInfo
<Common request parameters>
{}
Output Example
{
"Response": {
"RegionZones": [
{
"Region": "ap-guangzhou",
"RegionName": "gz",
"RegionCnName": "Guangzhou",
"RegionStatus": "AVAILABLE",
"Zones": [
{
"Zone": "ap-guangzhou-2",
"ZoneId": 100002,
"ZoneName": "Guangzhou Zone 2",
"ZoneCnName": "Guangzhou Zone 2",
"Types": [
{
"Type": "SD",
"Prepayment": true,
"Protocols": [
{
"Protocol": "NFS",
"SaleStatus": "saling"
}
]
}
]
},
{
"Zone": "ap-guangzhou-3",
"ZoneId": 100003,
"ZoneName": "Guangzhou Zone 3",
"ZoneCnName": "Guangzhou Zone 3",
"Types": [
{
"Type": "SD",
"Prepayment": true,
"Protocols": [
{
"Protocol": "NFS",
"SaleStatus": "saling"
}
]
}
]
},
{
"Zone": "ap-guangzhou-4",
"ZoneId": 100004,
"ZoneName": "Guangzhou Zone 4",
"ZoneCnName": "Guangzhou Zone 4",
"Types": [
{
"Type": "SD",
"Prepayment": true,
"Protocols": [
{
"Protocol": "NFS",
"SaleStatus": "saling"
}
]
}
]
}
]
}
],
"RequestId": "a7493b9c-8650-409a-a950-8d4afa18b5ec"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.GetRoleFailed | Failed to get the CFS service role. |
| InternalError | Internal error. |
| InternalError.GetAccountStatusFailed | Failed to get the payment status of the user. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.OutOfService | Your account is in arrears. Please top up and try again. |
| UnsupportedOperation.UnverifiedUser | Unverified user. |
Yes
No
Was this page helpful?