DescribeBackups - 获取备份详情 - 开源大数据平台E-MapReduce

获取备份详情

接口说明

该接口为异步接口，实例的重启不是立即完成的，成功调用后，实例会先进入重启中（restarting）状态，当返回的状态为运行中（running）时代表重启成功。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /webapi/backup/manage/describe HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所属地域 ID。	cn-hangzhou
InstanceId	string	否	实例 ID。	c-b25e21e24388****
BackupTaskId	string	否	备份任务 Id	bt-2389hsdui12m
Statuses	string	否	状态列表。	COMPLETED
TimePeriodStartTime	integer	否	备份任务查询开始时间	1747708000
TimePeriodEndTime	integer	否	备份任务查询结束时间	1747728000
PageNumber	integer	否	查询页码。	1
PageSize	integer	否	分页查询时每页的条目数。	10

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 请求状态码。	200
RequestId	string	请求 ID。	32A44F0D-BFF6-5664-999A-218BBDE7****
Success	boolean	请求是否成功。	false
ErrCode	string	错误码。	Success
ErrMessage	string	错误信息。	Invalid params: [instance not exists].
Data	array<object>	返回数据。
	array<object>	返回数据。
RegionId	string	地域 ID。	cn-hangzhou
InstanceId	string	实例 ID。	c-d4be777ff5e8cXXX
Size	integer	云盘大小，单位为 GiB。	100
Status	string	备份任务状态。	RUNNING
Description	string	任务描述。	任务描述
SubTasks	array<object>	备份子任务列表。
	object
StartTime	integer	任务开始日期。	1747708190
FinishedTime	integer	任务结束时间。	1747718190
SnapshotName	string	快照名称。	2025-02-10_backup
DataBase	string	数据库名称。	test1
Table	string	数据表名称。	cdc_ods_t2030_lcpf_api_topic_msg
Size	integer	数据大小。单位：GiB。	1
Status	string	备份任务状态。	success
Detail	string	快照 ID。	[]
BackupStartTime	integer	本次备份开始时间。	1742179018000
BackupFinishedTime	integer	本次备份结束时间。	1742179028000
ExpireTime	integer	备份数据过期时间。	1742189008000
BackupTaskId	string	备份任务 Id。	bt-12sui21312dd
BackupType	string	备份类型： 0：快速备份； 1：一致性备份。	FullBackup
InstanceSnapshot	object	备份实例信息。
InstanceName	string	实例名称。	c-37708ec80b5****
VpcId	string	VPC ID。	vpc-2ze0cez8106f2n85c2d7i
RunMode	string	集群的运行模式：存算一体（shared_nothing）。存算分离（shared_data）。	shared_data
SpecType	string	计算组规格类型。包括以下类型： standard，标准版。 localSSD ，本地 SSD。 bigData，大规格存储。 ramEnhanced，内存增强型。 networkEnhanced，网络增强型。	standard
ResourceGroupId	string	资源组 ID。	rg-aekzd7frphchx3a
Version	string	集群版本。	3.3
MinorVersion	string	小版本版本号。	3.3.13-1.0-1.7.2
NodeGroups	array<object>	计算组信息。
	object
ComponentType	string	计算组类型。包含以下取值： FE BE CN OBSERVER AGENT	FE
Cu	integer	CU 数量。CU (Compute Unit) 是服务的基本计量单元，1 CU=1 核 CPU+4GiB 内存，仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。	4
StorageSize	integer	存储大小。单位为 GiB。	200
StoragePerformanceLevel	string	云盘的性能级别。包含以下取值： pl0：单盘最高随机读写 IOPS 1 万。 pl1：单盘最高随机读写 IOPS 5 万。 pl2：单盘最高随机读写 IOPS 10 万。 pl3：单盘最高随机读写 IOPS 100 万。	pl1
DiskNumber	string	磁盘数量。	2
ResidentNodeNumber	string	节点数量。	3
SpecType	string	计算组规格类型。包括以下类型： standard，标准版。 localSSD ，本地 SSD。 bigData，大规格存储。 ramEnhanced，内存增强型。 networkEnhanced，网络增强型。	standard
LocalStorageInstanceType	string	节点组本地 SSD 实例规格, 仅在基于 Ecs 实例且 SpecType 为本地 SSD/大规格存储时该值才有意义。	null
RegionId	string	实例所属地域 ID。	cn-beijing
Tags	array<object>	标签信息。
	object	标签键。
Key	string	标签键。	bk-time
Value	string	标签值。	1747708000
Total	integer	查询结果总数。	1

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE7****",
  "Success": false,
  "ErrCode": "Success",
  "ErrMessage": "Invalid params: [instance not exists].\n",
  "Data": [
    {
      "RegionId": "cn-hangzhou",
      "InstanceId": "c-d4be777ff5e8cXXX",
      "Size": 100,
      "Status": "RUNNING",
      "Description": "任务描述",
      "SubTasks": [
        {
          "StartTime": 1747708190,
          "FinishedTime": 1747718190,
          "SnapshotName": "2025-02-10_backup",
          "DataBase": "test1",
          "Table": "cdc_ods_t2030_lcpf_api_topic_msg",
          "Size": 1,
          "Status": "success",
          "Detail": "[]"
        }
      ],
      "BackupStartTime": 1742179018000,
      "BackupFinishedTime": 1742179028000,
      "ExpireTime": 1742189008000,
      "BackupTaskId": "bt-12sui21312dd",
      "BackupType": "FullBackup",
      "InstanceSnapshot": {
        "InstanceName": "c-37708ec80b5****",
        "VpcId": "vpc-2ze0cez8106f2n85c2d7i",
        "RunMode": "shared_data",
        "SpecType": "standard",
        "ResourceGroupId": "rg-aekzd7frphchx3a",
        "Version": "3.3",
        "MinorVersion": "3.3.13-1.0-1.7.2",
        "NodeGroups": [
          {
            "ComponentType": "FE",
            "Cu": 4,
            "StorageSize": 200,
            "StoragePerformanceLevel": "pl1",
            "DiskNumber": "2",
            "ResidentNodeNumber": "3",
            "SpecType": "standard",
            "LocalStorageInstanceType": "null"
          }
        ],
        "RegionId": "cn-beijing",
        "Tags": [
          {
            "Key": "bk-time",
            "Value": "1747708000"
          }
        ]
      }
    }
  ],
  "Total": 1
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。