Domain name for API request: cfs.intl.tencentcloudapi.com.
This API is used to query the list of snapshots of a file system.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeCfsSnapshots. |
| 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. |
| FileSystemId | No | String | File system ID, which can be obtained by querying the file system through the DescribeCfsFileSystems api. |
| SnapshotId | No | String | Snapshot ID. |
| Offset | No | Integer | Paging start position, defaults to 0. |
| Limit | No | Integer | Page length. default value 20. |
| Filters.N | No | Array of Filter | Filter criteria SnapshotId - Array of String - required: no - (filter condition) filter by snapshot ID. SnapshotName - Array of String - required: no - (filter condition) filter by snapshot name. FileSystemId - Array of String - required: no - (filter condition) filter by file system ID. FsName - Array of String - required: no - (filtering conditions) filters file system names. Status - Array of String - required: no - (filter criteria) filter by snapshot Status. Status classification: creating: under creation |
| OrderField | No | String | Sort by creation time to obtain value. |
| Order | No | String | Sorting order; ascending or descending order. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| Snapshots | Array of SnapshotInfo | Snapshot information description |
| TotalSize | Integer | Total size of snapshots |
| 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. |
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfsSnapshots
<Common request parameters>
{
"FileSystemId": "cfs-12345"
}
{
"Response": {
"RequestId": "dd01b47d-2b57-4721-a237-1bdf59eac8b4",
"Snapshots": [
{
"AliveDay": 0,
"AppId": 1300275735,
"CreationTime": "2024-09-27 16:03:06",
"DeleteTime": "0",
"FileSystemId": "cfs-12345",
"FsName": "aileen-api-charge",
"Percent": 0,
"RegionName": "ap-guangzhou",
"Size": 0,
"SnapshotId": "snapcfs-5v2hgj3p",
"SnapshotName": "heihei",
"SnapshotTime": "2024-09-27 16:03:06",
"SnapshotType": "Standard",
"Status": "creating",
"Tags": []
}
],
"TotalCount": 1,
"TotalSize": 0
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.InvalidFileSystemId | FileSystemId is invalid. |
| ResourceNotFound.SnapshotNotFound | The snapshot ID does not exist. |
| UnsupportedOperation.OutOfService | Your account is in arrears. Please top up and try again. |
| UnsupportedOperation.UnverifiedUser | Unverified user. |
피드백