ListBackupPlans - AWS Backup

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

ListBackupPlans

返回经过身份验证的账户的所有有效备份计划的列表。该列表包含诸如 Amazon 资源名称 (ARN)、计划 ID、创建和删除日期、版本 ID、计划名称和创建者请求 ID 等信息。

请求语法

GET /backup/plans/?includeDeleted=IncludeDeleted&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

IncludeDeleted

默认值为的布尔值在设置FALSE为时返回已删除的备份计划TRUE

MaxResults

要返回的最大项目数量。

有效范围:最小值为 1。最大值为 1000。

NextToken

所返回项目的部分列表的后续下一个项目。例如,如果请求返回 MaxResults 数量的项目,则 NextToken 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

请求体

该请求没有请求体。

响应语法

HTTP/1.1 200 Content-type: application/json { "BackupPlansList": [ { "AdvancedBackupSettings": [ { "BackupOptions": { "string" : "string" }, "ResourceType": "string" } ], "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanName": "string", "CreationDate": number, "CreatorRequestId": "string", "DeletionDate": number, "LastExecutionDate": number, "VersionId": "string" } ], "NextToken": "string" }

响应元素

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

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

BackupPlansList

一系列备份计划列表项目,其中包含有关您已保存的备份计划的元数据。

类型:BackupPlansListMember 对象数组

NextToken

所返回项目的部分列表的后续下一个项目。例如,如果请求返回 MaxResults 数量的项目,则 NextToken 允许您从下一个令牌指向的位置开始返回列表中的更多项目。

类型:字符串

错误

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

InvalidParameterValueException

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

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

另请参阅

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