调用CreateEnterpriseSnapshotPolicy创建企业级快照策略。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ebs:CreateEnterpriseSnapshotPolicy |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以调用 DescribeRegions 查询异步复制功能支持的地域信息。 | cn-hangzhou |
Name | string | 是 | 快照策略名称。 | xx |
TargetType | string | 是 | 类型。取值范围:
| DISK |
State | string | 否 | 状态。取值范围:
| ENABLED |
Desc | string | 否 | 描述信息。 | xxx |
Schedule | object | 是 | 调度规则。 | |
CronExpression | string | 是 | 策略执行的周期和时间。使用 cron 表达式。 例如:0 0 4 1/1 * ?表示从每月第一天上午 4 时开始,每天的上午 4 时执行快照操作。 | 0 0 */24 * * * |
RetainRule | object | 是 | 保留规则。 | |
Number | integer | 否 | 个数。取值范围 [1, 256]。 | 10 |
TimeInterval | integer | 否 | 保留时间值.取值范围大于 1。 | 14 |
TimeUnit | string | 否 | 保留时间单位。取值范围:
| DAYS |
StorageRule | object | 否 | 高级快照特性。 | |
EnableImmediateAccess | boolean | 否 | 是否启动快照极速可用。取值范围:
| false |
CrossRegionCopyInfo | object | 否 | 快照复制信息。 | |
Enabled | boolean | 否 | 是否启用跨地域复制。取值范围:
| false |
Regions | array<object> | 否 | 目的地域信息。 | |
Region | object | 否 | 复制目标地域信息,可选。 | |
RegionId | string | 否 | 快照复制目的地域 ID。您可以调用 DescribeDiskReplicaPairs 查询存量异步复制关系的地域信息。 | cn-hangzhou |
RetainDays | integer | 否 | 目的地快照保留天数。取值范围大于 1。 | 7 |
Tag | array<object> | 否 | 标签键值对。n 的取值范围为 [1, 20]。 | |
Tag | object | 否 | 标签。 | |
Key | string | 是 | 资源的标签键。 | tag-key |
Value | string | 是 | 资源的标签值。 | tag-value |
ResourceGroupId | string | 否 | 资源组 ID。 | xxx |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
SpecialRetainRules | object | 否 | 特殊保留规则。 | |
Enabled | boolean | 否 | 是否启用特殊保留。取值范围:
| true |
Rules | array<object> | 否 | 特殊保留规则列表。 | |
Rule | object | 否 | 特殊保留规则。 | |
SpecialPeriodUnit | string | 否 | 特殊保留的快照的周期单位,如果配置成 WEEKS,则为每周的第一个快照提供特殊保留,保留的时间由 TimeUnit,TimeInterval 决定。取值范围为:
| WEEKS |
TimeInterval | integer | 否 | 保留时间值。取值范围大于 1。 | 14 |
TimeUnit | string | 否 | 特殊快照的保留时间单位。取值范围:
| WEEKS |
返回参数
示例
正常返回示例
JSON
格式
{
"PolicyId": "esp-xxx",
"RequestId": "F13483A9-17E2-5085-9B2E-2155B0487FF7"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The parameter %s is invalid. | 参数错误 |
400 | InvalidParameter.Conflict | The specified parameter %s and %s are not blank at the same time. | 参数冲突 |
400 | InvalidParameter.Format | Specified parameter format is not valid. | 返回值格式不正确(Format 不支持)。返回格式支持 XML 与 JSON,默认为 XML。 |
400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | 参数缺失。 |
403 | Forbidden | User is not authorized to operate. | 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。 |
403 | Forbidden.Action | User is not authorized to operate this action. | 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。 |
403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | 您的账户余额不足。 |
403 | LastTokenProcessing | The last token request is processing. | 相同clientToken的请求正在执行,请稍后再重试。 |
403 | NoPermission.SLR | The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS. | 当前用户无权限创建SLR。 |
403 | OperationDenied | The operation is not allowed. | 当前操作不允许执行。 |
404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | 找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确,请注意确认大小写。 |
404 | NoSuchResource | The specified resource does not exist. | 指定的资源不存在。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误。 |
504 | RequestTimeout | The request is timeout, please try again later. | 该请求超时,请稍后再重试。 |
访问错误中心查看更多错误码。