UpdateSnapshot - 更新快照--文件存储 NAS-火山引擎

文档中心

立即注册

导航

UpdateSnapshot - 更新快照

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

调用 UpdateSnapshot 接口修改快照属性。

调试

API Explorer

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

去调试

请求参数

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

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

返回参数

无。

请求示例

POST /?Action=UpdateSnapshot&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
{
  "SnapshotId" : "snap-1a1b8ef4****",
  "SnapshotName" : "testmodify"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022111611084401017424912606EA3174",
        "Action": "UpdateSnapshot",
        "Version": "2022-01-01",
        "Service": "FileNAS",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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

状态码	错误码	错误信息	说明
400	MissingParameter.SnapshotName	The required parameter SnapshotName is not supplied.	参数 SnapshotName 不能为空。
400	InvalidParameter.Description	The specified parameter Description is invalid.	指定的描述信息不合法。
400	InvalidParameter.SnapshotName	The specified parameter SnapshotName is invalid.	快照名称不合法。
403	OperationDenied.PermissionGroupDefault	The specified PermissionGroup is default configuration and operation is not allowed.	默认权限组不允许操作。
500	InternalError	An internal error has occurred.	内部错误。