备份子组件 REST API

可使用此 REST API 来管理卷组的选择性备份。

通常，执行组件级别备份操作时，可选择一个或多个组件类型（例如，脚本包、附加组件和虚拟模式定义等），且备份操作会备份此组件类型的所有组件。

但是，卷组大小可能很大，并且您可能不希望备份此组件类型的所有卷组。可使用此 REST API 来有选择地仅指定需要备份的卷组，并将它们添加到备份配置概要文件，或者将它们从备份配置概要文件移除。

使用此 REST API 调用来执行下列任务，以管理卷组的备份：

获取有关所指定卷组的信息。
获取所指定备份概要文件和对象类型的卷组列表，前提是在备份概要文件中为备份启用了 volumegroup 对象类型。
将卷组添加到所指定的备份概要文件。
从所指定的备份概要文件移除现有卷组。

可使用可选参数来修改来自 REST API 调用的响应。有关更多信息，请参阅相关信息部分。

要使用此 REST API，必须具有以下所有角色和许可权：

具有“管理工作负载资源（完整许可权）”的工作负载资源管理
具有“管理云资源（完整许可权）”的云组管理
具有“管理硬件资源（完整许可权）”的硬件管理
具有“管理安全性（完整许可权）”许可权的安全性管理角色

获取有关所指定卷组的信息

URI	/admin/resources/backup_subcomponents/{id}
方法 (method)	GET
返回	200	已成功返回有关子组件的信息。
	400	未成功返回有关子组件的信息。
	500	Platform System Manager 在处理请求时遇到内部错误。

在 REST API 调用中，指定要检索的卷组数据的标识，与以下示例 URI 相似：

/admin/resources/backup_subcomponents/6eeda19c-2bd3-4a8b-80d7-1111687138f9

响应主体

此 REST API 调用在 JSON 响应主体中返回有关使用 {id} 指定的卷组的信息，与以下示例相似：

{
   "id": "/admin/resources/backup_subcomponents/6eeda19c-2bd3-4a8b-80d7-1111687138f9",
   "created_time_raw": 1394142686540,
   "updated_time_raw": 1394142686540,
   "backup_components": "/admin/resources/backup_components/26b7e0cd-7644-48ab-934f-0b93427c6f5c",
   "name": "svg1",
   "backup_profiles": "/admin/resources/backup_profiles/e858bafc-f1fe-40a4-91b9-00c5e393db58",
   "created_time": "Thu 06 Mar 2014 21:51:26.540 UTC",
   "updated_time": "Thu 06 Mar 2014 21:51:26.540 UTC",
   "version": "2.0.0.0"
}

获取所指定备份概要文件和对象类型的卷组列表

URI	/admin/resources/backup_subcomponents?objecttype={obj}&backup_profile={bprof}
方法 (method)	GET
返回	200	已成功返回指定对象类型和备份概要文件的子组件列表。
	400	找不到子组件。
	500	Platform System Manager 在处理请求时遇到内部错误。

此 REST API 调用指定特定对象类型（由 {obj} 标识）以及特定备份概要文件（由 {bprof} 标识），类似以下示例 URI：

/admin/resources/backup_subcomponents?objecttype=volumegroup
&backup_profile=e858bafc-f1fe-40a4-91b9-00c5e393db58

当前唯一支持的对象类型为 volumegroup。

响应主体

此 REST API 调用将返回有关 volumegroup 对象类型和备份概要文件的卷组的 JSON 详细信息列表，与以下示例相似。将按顺序显示每个卷组的输出，首先列出可用的卷组，然后列出正在使用的卷组的列表。

[
   {
      "updated_time": "Tue 04 Feb 2014 20:15:08.676 UTC",
      "backup_components": "/admin/resources/backup_components/fa05f04a-6656-4ddc-90fb-dea9bad64580",
      "created_time": "Tue 04 Feb 2014 20:15:08.676 UTC",
      "backup_profiles": "/admin/resources/backup_profiles/e858bafc-f1fe-40a4-91b9-00c5e393db58",
      "version": "1.2.0.0",
      "updated_time_raw": 1391544908676,
      "name": "svg1",
      "id": "/admin/resources/backup_subcomponents/dc1416af-1f5c-4e4e-85ad-a089da61922a",
      "created_time_raw": 1391544908676,
      "isas_rn": 1
   }
   { 
      "available": [
         {
            "target_state": "exporting",
            "created_time": "Thu 02 Jan 2014 21:27:08.844 UTC",
            "name": "svg1",
            "target_result": "done",
            "created_time_raw": 1388698028844,
            "state": "available",
            "updated_time": "Wed 22 Jan 2014 15:51:48.300 UTC",
            "volumes": [
               "/deployment/resources/volumes/0a16533e-0202-4fb4-9fc6-f36ac72064f6",
               "/deployment/resources/volumes/f49ee4f2-7b15-41cb-bd65-947a7ed78371"
            ],
            "updated_time_raw": 1390405908300,
            "dr_storage_last_state_change_time": null,
            "id": "/deployment/resources/volume_groups/ff01740f-93d6-483d-80fd-b3ed32ae95d3",
            "description": "test",
            "dr_storage_state": null,
            "isas_rn": 1
         }
       ]
   }
]

属性列表

backup_components

指定对象类型的备份组件标识，包括 URI，例如：

/admin/resources/backup_components/fa05f04a-6656-4ddc-90fb-dea9bad64580

backup_profiles

指定备份概要文件的标识，包括 URI，例如：

/admin/resources/backup_profiles/e858bafc-f1fe-40a4-91b9-00c5e393db58

created_time

指示创建备份组件或子组件的日期和时间的时间戳记。此值为以全球标准时间 (UTC) 格式表示的日期和时间（示例：

Fri 03
Jan 2014 15:59:20.613 UTC

）。

created_time_raw

指示创建备份组件或子组件时间的机器可读时间戳记。此值为长整形整数（示例：1388764760613）。

描述

卷组的文本描述。

id

在组件定义中，这是子组件的标识，包括 URI，例如：

/admin/resources/backup_subcomponents/dc1416af-1f5c-4e4e-85ad-a089da61922a

在卷定义中，这是卷组的标识，包括 URI，例如：

/deployment/resources/volume_groups/ff01740f-93d6-483d-80fd-b3ed32ae95d3

isas_rn

指示表中子组件的相对顺序的整数值（例如，列出的第 4 个子组件在此属性中具有值 4）。

名称

为卷组指定的唯一名称（示例：svg1）。

state

子组件的状态，指示子组件状态为可用还是正在使用。有效值如下所示：

可用: 子组件可用。
in use: 子组件正在使用中。

updated_time

指示上次更新备份组件或子组件的日期和时间的时间戳记。此值为以全球标准时间 (UTC) 格式表示的日期和时间（示例：

Mon 10
Feb 2014 22:03:19.633 UTC

）。

updated_time_raw

指示上次更新备份组件或子组件时间的机器可读时间戳记。此值为长整形整数（示例：1392069799633）。

版本

支持此备份组件的 IBM® Cloud Pak System 系统的版本 (示例: 2.0.0.0)

卷

与卷组相关联的卷的列表，例如：

[
  "/deployment/resources/volumes/0a16533e-0202-4fb4-9fc6-f36ac72064f6",
  "/deployment/resources/volumes/f49ee4f2-7b15-41cb-bd65-947a7ed78371"
],

将卷组添加到备份概要文件

URI	/admin/resources/backup_subcomponents
方法 (method)	POST
返回	200	子组件已成功添加到备份概要文件。
	400	子组件未成功添加到备份概要文件。
	500	Platform System Manager 在处理请求时遇到内部错误。

请求主体

此 REST API 调用需要 JSON 请求主体，此请求主体指定卷组的名称、volumegroup 对象类型以及备份概要文件，与以下示例相似：

{
  "objecttype":"volumegroup",
  "backup_profile":"e858bafc-f1fe-40a4-91b9-00c5e393db58",
  "name":"Aus 47"
}

如果满足以下需求，那么此示例会将名为

Aus
47

的新卷组添加到备份概要文件:

volumegroup 是有效组件。
volumegroup 支持子组件。
指定备份概要文件为有效概要文件。
子组件名称 Aus 47 未被使用。

响应主体

此 REST API 调用返回一个响应，此响应类似于指定子组件标识上 GET 操作的响应。

从备份概要文件中移除卷组

URI	/admin/resources/backup_subcomponents/{id}
方法 (method)	删除
返回	202	接受。
	400	未成功移除子组件。
	500	Platform System Manager 在处理请求时遇到内部错误。

此 REST API 调用将移除所指定的卷组。