1. API Description
Domain name for API request: cfs.intl.tencentcloudapi.com.
This API is used to query file systems.
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: DescribeCfsFileSystems. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley. |
| FileSystemId | No | String | File system ID |
| VpcId | No | String | VPC ID |
| SubnetId | No | String | Subnet ID |
| Offset | No | Integer | |
| Limit | No | Integer | |
| CreationToken | No | String |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| FileSystems | Array of FileSystemInfo | File system information |
| TotalCount | Integer | Total number of file systems |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying file systems
Input Example
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfsFileSystems
<Common request parameters>
{
"FileSystemId": "cfs-12345"
}
Output Example
{
"Response": {
"RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
"TotalCount": 1,
"FileSystems": [
{
"Protocol": "NFS",
"Zone": "ap-guangzhou-3",
"CreationToken": "test_fs",
"StorageType": "SD",
"Encrypted": false,
"CreationTime": "2019-07-29 18:57:17",
"StorageResourcePkg": "",
"ZoneId": 100003,
"SizeByte": 0,
"FileSystemId": "cfs-12345",
"KmsKeyId": "",
"LifeCycleState": "mounting",
"Capacity": 1000,
"PGroup": {
"PGroupId": "pgroupbasic",
"Name": "Default permission group"
},
"SizeLimit": 0,
"BandwidthResourcePkg": "",
"FsName": "test_fs",
"AppId": 12700000,
"BandwidthLimit": 200,
"TieringDetail": {
"TieringSizeInBytes": 0
},
"TieringState": "xx",
"Tags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
]
}
]
}
}
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 Node.js
- 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.UnauthorizedOperation | Request unauthorized. |
| InternalError | Internal error. |
| InternalError.GetAccountStatusFailed | Failed to get the payment status of the user. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.InvalidFileSystemId | FileSystemId is invalid. |
| InvalidParameterValue.MissingFileSystemIdOrRegion | Either FileSystemId or Region must be selected. |
| InvalidParameterValue.MissingFsParameter | FileSystem is missing. |
| InvalidParameterValue.TagKeyFilterLimitExceeded | Invalid parameter value: the number of tag keys exceeds the upper limit (6). |
| InvalidParameterValue.TagKeyLimitExceeded | The length of the tag key exceeds the upper limit of 127 bytes. |
| InvalidParameterValue.UnavailableRegion | Services are unavailable in this AZ. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.OutOfService | Your account is in arrears. Please top up and try again. |
| UnsupportedOperation.UnverifiedUser | Unverified user. |
是
否
本页内容是否解决了您的问题？