ApplyAutoSnapshotPolicy - 设置自动快照策略

为一个或多个数据库文件系统设置自动快照策略。

接口说明

  • 一个文件系统只能设置一条自动快照策略。若需要更换策略,请先取消原自动快照策略。
  • 一条自动快照策略支持应用到多个文件系统。

数据库文件系统快照基于云盘快照,由云盘进行快照扣费。请确保在使用该接口前,已充分了解云盘快照的收费方式和价格

调试

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

授权信息

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

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

请求参数

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

自动快照策略 ID。

sp-z5siir3iq3m**********
DbfsIdsarray

传入的需要设置该自动快照策略的数据库文件系统 ID 列表,传入的参数需要保持 JSON 数组格式,ID 之间用半角逗号(,)隔开。例如:["dbfs-1luaxt4vs1iusrd*******", "dbfs-cxbyu98fspcbvm******“]。

string

需要设置该自动快照策略的数据库文件系统。

"dbfs-1luaxt4vs1iusrd*******"
RegionIdstring

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

cn-hangzhou

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AccessDeniedDetailobject
PolicyTypestring

PolicyType

AuthPrincipalOwnerIdstring

AuthPrincipalOwnerId

EncodedDiagnosticMessagestring

EncodedDiagnosticMessage

AuthPrincipalTypestring

AuthPrincipalType

AuthPrincipalDisplayNamestring

AuthPrincipalDisplayName

NoPermissionTypestring

NoPermissionType

AuthActionstring

AuthAction

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400ParameterInvalid.DbfsIdsThe DbfsIds parameter is invalid.文件系统列表格式不规范。
400ParameterEmpty.PolicyIdThe value of policyId is empty.策略ID值未填写。
400DbfsAlreadyAppliedAutoSnapshotPolicyAn automatic snapshot policy has been applied on the specified dbfs.单个文件系统只支持设置一个自动快照策略。
400InvalidRegion.DBFSThe region is not supported.不支持的区域。
401PermissionDeny.PolicyThe account has no permission on this policy.该账户没有操作该策略的权限。
401PermissionDeny.DBFSThe account has no permission on this DBFS.-
404EntityNotExist.DBFSThe DBFS instance does not exist.-
404AutoSnapshotPolicyNotFoundThe automatic snapshot policy does not exist.该自动快照策略不存在。
409OperationConflictToo many requests on automatic snapshot policy, please try again later.自动快照策略操作冲突,请稍后再试。
503AutoShapshotBusyThe server is busy now, please try again later.服务器繁忙,请稍后再试。

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

变更历史

变更时间变更内容概要操作
2024-12-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情