调用CreateSnapshot为数据库文件系统创建快照-数据库文件存储-阿里云-数据库文件存储（文档停止维护）(DBFS)-阿里云帮助中心

接口说明

以下场景中，您无法为指定的数据库文件系统创建快照：

上一份快照还未完成创建。
数据库文件系统实例未处于已挂载（Attached）或者待挂载（Unattached）状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbfs:CreateSnapshot

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	DBFS 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
FsId	string	是	数据库文件系统 ID。	d-bp131n0q38u3a4zi*****
SnapshotName	string	否	快照的显示名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头，不能以`http://`和`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者连字符（-）。为防止和自动快照的名称冲突，不能以 auto 开头和 dbfs-auto 开头。	testSnapshotName
Description	string	否	快照的描述。长度为 2~256 个英文或中文字符，不能以`http://`和`https://`开头。默认值：空。	testDescription
RetentionDays	integer	否	设置快照的保留时间，单位为天。保留时间到期后快照会被自动释放，取值范围：1~65536 默认值：空，表示快照不会被自动释放。	30
ClientToken	string	否	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多详情，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-426655440000

返回参数

名称	类型	描述	示例值
	object
SnapshotId	string	快照 ID。	s-Q2greuDZTvWeS8bfKZ****
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AccessDeniedDetail	object
PolicyType	string	PolicyType
AuthPrincipalOwnerId	string	AuthPrincipalOwnerId
EncodedDiagnosticMessage	string	EncodedDiagnosticMessage
AuthPrincipalType	string	AuthPrincipalType
AuthPrincipalDisplayName	string	AuthPrincipalDisplayName
NoPermissionType	string	NoPermissionType
AuthAction	string	AuthAction

示例

正常返回示例

JSON格式

{
  "SnapshotId": "s-Q2greuDZTvWeS8bfKZ****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AccessDeniedDetail": {
    "PolicyType": "",
    "AuthPrincipalOwnerId": "",
    "EncodedDiagnosticMessage": "",
    "AuthPrincipalType": "",
    "AuthPrincipalDisplayName": "",
    "NoPermissionType": "",
    "AuthAction": ""
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidRegion.DBFS	The region is not supported.	不支持的区域。
400	InvalidStatus.DBFS	The current state of the DBFS instance does not support this operation.
404	EntityNotExist.DBFS	The DBFS instance does not exist.

访问错误中心错误中心查看更多错误码。

变更历史

更多信息，参考变更详情变更详情。