CreateReportPlan - AWS Backup

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

CreateReportPlan

建立報告計畫。報告計畫是包含報告內容以及 AWS Backup 報告交付地點相關資訊的文件。

如果呼叫 CreateReportPlan 已經存在的計畫,您會收到 AlreadyExistsException 例外。

請求語法

POST /audit/report-plans HTTP/1.1 Content-type: application/json { "IdempotencyToken": "string", "ReportDeliveryChannel": { "Formats": [ "string" ], "S3BucketName": "string", "S3KeyPrefix": "string" }, "ReportPlanDescription": "string", "ReportPlanName": "string", "ReportPlanTags": { "string" : "string" }, "ReportSetting": { "Accounts": [ "string" ], "FrameworkArns": [ "string" ], "NumberOfFrameworks": number, "OrganizationUnits": [ "string" ], "Regions": [ "string" ], "ReportTemplate": "string" } }

URI 請求參數

請求不會使用任何URI參數。

請求主體

請求接受下列JSON格式的資料。

IdempotencyToken

客戶所選擇的字串,可用來區分在其他方面相同的 CreateReportPlanInput 呼叫。重試具有相同等冪性字符的成功請求會導致出現成功消息,但未執行任何動作。

類型:字串

必要:否

ReportDeliveryChannel

包含有關在何處和如何交付報告的架構,特別是 Amazon S3 儲存貯體名稱、S3 金鑰字首以及報告格式。

類型:ReportDeliveryChannel 物件

必要:是

ReportPlanDescription

報告計畫的選用描述,最多可包含 1,024 個字元。

類型:字串

長度限制:長度下限為 0。長度上限為 1024。

模式:.*\S.*

必要:否

ReportPlanName

報告計畫的唯一名稱。此名稱的長度必須介於 1 到 256 個字元,以英文字母開頭,由英文字母 (a-z、A-Z)、數字 (0-9) 和底線 (_) 組成。

類型:字串

長度限制:長度下限為 1。長度上限為 256。

模式:[a-zA-Z][_a-zA-Z0-9]*

必要:是

ReportPlanTags

要指派給報告計畫的標籤。

類型:字串到字串映射

必要:否

ReportSetting

識別報告的報告範本。使用報告範本建立的報告。報告範本包括:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

如果報告範本為 RESOURCE_COMPLIANCE_REPORTCONTROL_COMPLIANCE_REPORT,此API資源也會說明 AWS 區域 和 架構的報告涵蓋範圍。

類型:ReportSetting 物件

必要:是

回應語法

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "ReportPlanArn": "string", "ReportPlanName": "string" }

回應元素

如果動作成功,服務會傳回 HTTP 200 個回應。

服務會以 JSON 格式傳回下列資料。

CreationTime

建立備份保存庫的日期和時間,採用 Unix 格式和國際標準時間 (UTC)。CreationTime 的值精確到毫秒。例如,值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。

類型:Timestamp

ReportPlanArn

唯一識別資源的 Amazon Resource Name (ARN)。的格式ARN取決於資源類型。

類型:字串

ReportPlanName

報告計畫的唯一名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 256。

模式:[a-zA-Z][_a-zA-Z0-9]*

錯誤

如需所有動作常見的錯誤資訊,請參閱《常見錯誤》。

AlreadyExistsException

所需資源已存在。

HTTP 狀態碼:400

InvalidParameterValueException

表示參數的值出現問題。例如,值超出範圍。

HTTP 狀態碼:400

LimitExceededException

請求已超過限制;例如,請求中允許的最大項目數量。

HTTP 狀態碼:400

MissingParameterValueException

表示缺少必要的參數。

HTTP 狀態碼:400

ServiceUnavailableException

由於伺服器發生臨時故障,請求失敗。

HTTP 狀態碼:500

另請參閱

如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: