DescribeFramework - Amazon Backup
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeFramework

返回指定 FrameworkName 的框架详细信息。

请求语法

GET /audit/frameworks/frameworkName HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

frameworkName

框架的唯一名称。

长度约束:最小长度为 1。最大长度为 256。

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

必需:是

请求体

该请求没有请求体。

响应语法

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "DeploymentStatus": "string", "FrameworkArn": "string", "FrameworkControls": [ { "ControlInputParameters": [ { "ParameterName": "string", "ParameterValue": "string" } ], "ControlName": "string", "ControlScope": { "ComplianceResourceIds": [ "string" ], "ComplianceResourceTypes": [ "string" ], "Tags": { "string" : "string" } } } ], "FrameworkDescription": "string", "FrameworkName": "string", "FrameworkStatus": "string", "IdempotencyToken": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

CreationTime

框架的创建日期和时间,以 ISO 8601 表示。CreationTime 的值精确到毫秒。例如,2020-07-10T15:00:00.000-08:00 表示 2020 年 7 月 10 日下午 3:00,比 UTC 晚 8 个小时。

类型:时间戳

DeploymentStatus

框架的部署状态。状态包括:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

类型:字符串

FrameworkArn

唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。

类型:字符串

FrameworkControls

构成框架的控件列表。列表中的每个控件都有名称、输入参数和范围。

类型:FrameworkControl 对象数组

FrameworkDescription

框架的可选描述。

类型:字符串

长度约束:最小长度为 0。最大长度为 1024。

模式:.*\S.*

FrameworkName

框架的唯一名称。

类型:字符串

长度约束:最小长度为 1。最大长度为 256。

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

FrameworkStatus

框架由一个或多个控件组成。每个控件都控制一种资源,例如备份计划、备份选择、备份保管库或恢复点。您也可以为每种资源开启或关闭 Amazon Config 记录。状态包括:

  • ACTIVE,当框架管理的所有资源都开启记录功能时。

  • PARTIALLY_ACTIVE,当至少一个受框架管理的资源关闭记录时。

  • INACTIVE,当框架管理的所有资源都关闭记录时。

  • UNAVAILABLE,当 Amazon Backup 此时无法验证记录状态时。

类型:字符串

IdempotencyToken

客户选择的字符串,可用于区分对 DescribeFrameworkOutput 的其他相同调用。使用相同的幂等性令牌重试成功的请求会生成一条成功消息,而不执行任何操作。

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

该操作所需的资源不存在。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: