本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
PutBackupVaultNotifications
開啟指定主題與事件的備份保存庫通知。
請求語法
PUT /backup-vaults/backupVaultName
/notification-configuration HTTP/1.1
Content-type: application/json
{
"BackupVaultEvents": [ "string
" ],
"SNSTopicArn": "string
"
}
URI 請求參數
請求使用以下URI參數。
- backupVaultName
-
存放備份的邏輯容器的名稱。備份文件庫依名稱識別,這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。
模式:
^[a-zA-Z0-9\-\_]{2,50}$
必要:是
請求主體
請求接受下列JSON格式的資料。
- BackupVaultEvents
-
事件陣列,指示將資源備份到備份文件庫的任務狀態。
如需常見使用案例和程式碼範例,請參閱使用 Amazon SNS追蹤 AWS 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 Resource Name (ARN);例如
arn:aws:sns:us-west-2:111122223333:MyVaultTopic
。類型:字串
必要:是
回應語法
HTTP/1.1 200
回應元素
如果動作成功,服務會傳回 200 HTTP 回應,其中內HTTP文為空白。
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如,值超出範圍。
HTTP 狀態碼:400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼:400
- ResourceNotFoundException
-
動作所需的資源不存在。
HTTP 狀態碼:400
- ServiceUnavailableException
-
由於伺服器發生臨時故障,請求失敗。
HTTP 狀態碼:500
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: