查询跨区域备份实例列表

功能介绍

根据指定条件在备份目标区域查询跨区域备份实例列表。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  GET /v3/backups/offsite-backup-instance?offset={offset}&limit={limit}

• 参数说明

  表1 参数说明

  名称	参数类型	是否必选	说明
  offset	Integer	否	索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。
  limit	Integer	否	查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求消息

• 请求参数

  无。

• URI样例
  • 查询所有表

    GET https://{endpoint}/v3/backups/offsite-backup-instance

  • 根据指定条件查询实例列表

    GET https://{endpoint}/v3/backups/offsite-backup-instance?offset=0&limit=10

响应消息

• 正常响应要素说明

  表2 参数说明

  名称	参数类型	说明
  offsite_backup_instances	Array of objects	跨区域备份实例信息。 详情请参见表3。
  total_count	Integer	总记录数。

  表3 offsite_backup_instances字段数据结构说明

  名称	参数类型	说明
  id	String	实例ID。
  name	String	创建的实例名称。
  source_region	String	源区域。
  source_project_id	String	租户在源区域下的project ID。
  datastore	Object	数据库信息。 详情请参见表4。
  destination_region	String	跨区域备份所在区域。
  destination_project_id	String	租户在目标区域下的project ID。
  keep_days	Integer	跨区域备份保留天数。

  表4 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎。
  version	String	数据库版本。

• 正常响应样例

  根据指定条件查询实例列表：

  {
          "total_count": 1,
  	"offsite_backup_instances": [{
  		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
                  "name": "rds-instance-rep2",
                  "source_region": "aaa",
                  "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
                  "datastore": {
  			"type": "MySQL",
  			"version": "5.7"
  		},
  		"destination_region": "bbb",
  		"destination_project_id": "0503fd7f7580d3262fc5c001170fbab9",
  		"keep_days": 7
  		}
      	     ]
  }

• 查询所有实例列表：

  {
          "total_count": 1,
  	"offsite_backup_instances": [{
  		"id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01",
                  "name": "rds-instance-rep2",
                  "source_region": "aaa",
                  "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c",
                  "datastore": {
  			"type": "MySQL",
  			"version": "5.7"
  		},
  		"destination_region": "bbb",
  		"destination_project_id": "0503fd7f7580d3262fc5c001170fbab9",
  		"keep_days": 7
  		}
      	     ]
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。