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

报告计划的可选描述,最多 1024 个字符。

类型:字符串

长度约束:最小长度为 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。

类型:时间戳

ReportPlanArn

唯一标识资源的 Amazon 资源名称 (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,请参阅以下内容: