CreateSnapshot - 创建快照--文件存储 NAS-火山引擎

文档中心

立即注册

导航

CreateSnapshot - 创建快照

最近更新时间：2025.05.16 14:12:24首次发布时间：2023.07.10 11:11:52

调用 CreateSnapshot 接口创建文件系统快照。

注意事项

仅 NAS 极速型支持创建快照。
当前快照处于公测状态，暂不收费，免费期间，一个 NAS 极速型文件系统最多可以创建 128 个手动快照。
创建快照需要一定时间，且会有分钟级的数据不可写入时间，建议您选择业务低峰期操作，在创建期间，您可以挂载文件系统，但不能删除或扩容文件系统。
单个文件系统不能同时创建两个快照。
同一账号不能同时对多个文件系统创建快照。
手动快照创建后会永久保留，无法自动删除。如果您需要删除快照，具体步骤，请参见 DeleteSnapshot。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateSnapshot	要执行的操作，取值：CreateSnapshot。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
FileSystemId	String	是	enas-cn01961fc437****	需要创建快照的文件系统 ID。
SnapshotName	String	是	testcreate	快照名称。命名规范如下：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1～128 个字符内。不能以 auto 开头。
Description	String	否	test	快照描述信息，长度为 0～120 个字符。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
SnapshotId	String	snap-472a716f****	生成的快照 ID。

请求示例

POST /?Action=CreateSnapshot&Version=2022-01-01 HTTP/1.1
Host: filenas.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/filenas/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z
{
    "FileSystemId": "enas-cn01961fc437****",
    "SnapshotName": "testcreate"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022111611351701022514515209540961",
        "Action": "CreateSnapshot",
        "Version": "2022-01-01",
        "Service": "FileNAS",
        "Region": "cn-beijing"
    },
    "Result": {
        "SnapshotId": "snap-472a716f****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.FileSystemId	The required parameter FileSystemId is not supplied.	文件系统 ID 不能为空。
400	MissingParameter.SnapshotName	The required parameter SnapshotName is not supplied.	参数 SnapshotName 不能为空。
400	InvalidParameter.SnapshotName	The specified parameter SnapshotName is invalid.	参数 SnapshotName 不合法。
400	InvalidParameter.Description	The specified parameter Description is invalid.	指定的描述信息不合法。
400	LimitExceeded.SnapshotNumber	The specified number of Snapshot of the specified FileSystem exceeds the limit.	指定文件系统的快照个数已经达到上限。
400	AlreadyExist.SnapshotName	The specified Snapshot is already exist.	指定名称的快照已存在。
403	OperationDenied.SnapshotCreating	The specified FileSystem is creating snapshot.	文件系统正在创建快照。
423	OperationDenied.FileSystemBusy	The specified FileSystem is busy.	文件系统繁忙。
500	InternalError	An internal error has occurred.	内部错误。