文档

CreateSnapshot - 创建快照

更新时间:

调用CreateSnapshot给一个数据库文件系统创建快照。

接口说明

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

  • 上一份快照还未完成创建。

  • 数据库文件系统实例未处于已挂载(Attached)或者待挂载(Unattached)状态。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbfs:CreateSnapshotWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

DBFS 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
FsIdstring

数据库文件系统 ID。

d-bp131n0q38u3a4zi*****
SnapshotNamestring

快照的显示名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

为防止和自动快照的名称冲突,不能以 auto 开头和 dbfs-auto 开头。

testSnapshotName
Descriptionstring

快照的描述。长度为 2~256 个英文或中文字符,不能以http://https://开头。

默认值:空。

testDescription
RetentionDaysinteger

设置快照的保留时间,单位为天。保留时间到期后快照会被自动释放,取值范围:1~65536

默认值:空,表示快照不会被自动释放。

30
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000

返回参数

名称类型描述示例值
object
SnapshotIdstring

快照 ID。

s-Q2greuDZTvWeS8bfKZ****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "SnapshotId": "s-Q2greuDZTvWeS8bfKZ****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史