本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
PutBackupVaultNotifications
开启有关备份保管库的通知,以了解指定主题和事件。
请求语法
PUT /backup-vaults/backupVaultName
/notification-configuration HTTP/1.1
Content-type: application/json
{
"BackupVaultEvents": [ "string
" ],
"SNSTopicArn": "string
"
}
URI请求参数
该请求使用以下URI参数。
- backupVaultName
-
用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。
模式:
^[a-zA-Z0-9\-\_]{2,50}$
必需:是
请求正文
该请求接受以下JSON格式的数据。
- BackupVaultEvents
-
一个事件数组,指示将资源备份到备份保管库的作业状态。
有关常见用例和代码示例,请参阅使用 Amazon SNS 跟踪 Amazon Backup 事件。
支持以下事件:
-
BACKUP_JOB_STARTED
|BACKUP_JOB_COMPLETED
-
COPY_JOB_STARTED
|COPY_JOB_SUCCESSFUL
|COPY_JOB_FAILED
-
RESTORE_JOB_STARTED
|RESTORE_JOB_COMPLETED
|RECOVERY_POINT_MODIFIED
-
S3_BACKUP_OBJECT_FAILED
|S3_RESTORE_OBJECT_FAILED
注意
以下列表包括支持的事件和不再使用的已弃用事件(供参考)。已弃用的事件不会返回状态或通知。有关支持的事件,请参阅上面的列表。
类型:字符串数组
有效值:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL | BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED | COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED | S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
必需:是
-
- SNSTopicArn
-
Amazon 资源名称 (ARN),它为备份库的事件指定主题;例如,
arn:aws:sns:us-west-2:111122223333:MyVaultTopic
。类型:字符串
必需:是
响应语法
HTTP/1.1 200
响应元素
如果操作成功,服务将发回 HTTP 200 响应,HTTP正文为空。
错误
有关所有操作返回的常见错误的信息,请参阅常见错误。
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出了范围。
HTTP状态码:400
- MissingParameterValueException
-
表示缺少必需的参数。
HTTP状态码:400
- ResourceNotFoundException
-
该操作所需的资源不存在。
HTTP状态码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP状态码:500
另请参阅
有关API在一种特定语言中使用此功能的更多信息 Amazon SDKs,请参阅以下内容: