DescribeBackups - E-MapReduce - Alibaba Cloud Documentation Center

Obtain backup details

Operation description

This is an asynchronous interface. Instance restarts are not immediate. After a successful call, the instance first enters the restarting state. The instance is successfully restarted when its status returns to running.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance.	cn-hangzhou
InstanceId	string	No	The instance ID.	c-b25e21e24388****
BackupTaskId	string	No	The backup task ID.	bt-2389hsdui12m
Statuses	string	No	The list of statuses.	COMPLETED
TimePeriodStartTime	integer	No	The start time for querying backup jobs.	1747708000
TimePeriodEndTime	integer	No	The end time for querying backup jobs.	1747728000
PageNumber	integer	No	The query page number.	1
PageSize	integer	No	The number of entries per page for paged query.	10

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP request status code.	200
RequestId	string	The request ID.	32A44F0D-BFF6-5664-999A-218BBDE7****
Success	boolean	Indicates whether the request was successful.	false
ErrCode	string	The error code.	Success
ErrMessage	string	The error message.	Invalid params: [instance not exists].
Data	array<object>	The returned data.
	array<object>	The returned data.
RegionId	string	The region ID.	cn-hangzhou
InstanceId	string	The instance ID.	c-d4be777ff5e8cXXX
Size	integer	The cloud disk size in GiB.	100
Status	string	The backup job status.	RUNNING
Description	string	The task description.	Task description
SubTasks	array<object>	The list of backup subtasks.
	object
StartTime	integer	The task start date.	1747708190
FinishedTime	integer	The task end time.	1747718190
SnapshotName	string	The snapshot name.	2025-02-10_backup
DataBase	string	The database name.	test1
Table	string	The data table name.	cdc_ods_t2030_lcpf_api_topic_msg
Size	integer	The data size in GiB.	1
Status	string	The backup job status.	success
Detail	string	The snapshot ID.	[]
BackupStartTime	integer	The start time of this backup.	1742179018000
BackupFinishedTime	integer	The end time of this backup.	1742179028000
ExpireTime	integer	The expiration time of the backup data.	1742189008000
BackupTaskId	string	The backup task ID.	bt-12sui21312dd
BackupType	string	The backup type: 0: Fast backup. 1: Consistent backup.	FullBackup
InstanceSnapshot	object	The backup instance information.
InstanceName	string	The instance name.	c-37708ec80b5****
VpcId	string	The VPC ID.	vpc-2ze0cez8106f2n85c2d7i
RunMode	string	The cluster's running mode: Shared-nothing. Shared-data.	shared_data
SpecType	string	The compute group specification type. Includes the following types: standard: Standard Edition. localSSD: Local SSD. bigData: Large-capacity storage. ramEnhanced: Memory-enhanced instance family. networkEnhanced: Network-enhanced.	standard
ResourceGroupId	string	The resource group ID.	rg-aekzd7frphchx3a
Version	string	The cluster version.	3.3
MinorVersion	string	The minor version number.	3.3.13-1.0-1.7.2
NodeGroups	array<object>	The compute group information.
	object
ComponentType	string	The compute group type. Includes the following values: FE BE CN OBSERVER AGENT	FE
Cu	integer	The number of CUs. A CU (Compute Unit) is the basic unit of measurement for the service. 1 CU equals 1 CPU core + 4 GiB memory. If SpecType is memory-enhanced instance family, 1 CU equals 1 CPU core + 8 GiB memory.	4
StorageSize	integer	The storage size in GiB.	200
StoragePerformanceLevel	string	The performance level (PL) of the cloud disk. Includes the following values: pl0: Maximum random read/write IOPS of 10,000 per disk. pl1: Maximum random read/write IOPS of 50,000 per disk. pl2: Maximum random read/write IOPS of 100,000 per disk. pl3: Maximum random read/write IOPS of 1,000,000 per disk.	pl1
DiskNumber	string	The number of disks.	2
ResidentNodeNumber	string	The number of nodes.	3
SpecType	string	The compute group specification type. Includes the following types: standard: Standard Edition. localSSD: Local SSD. bigData: Large-capacity storage. ramEnhanced: Memory-enhanced instance family. networkEnhanced: Network-enhanced.	standard
LocalStorageInstanceType	string	The node group's local SSD instance type. This value is only meaningful for ECS instances where SpecType is local SSD or large-capacity storage.	null
RegionId	string	The region ID of the instance.	cn-beijing
Tags	array<object>	The tag information.
	object	The tag key.
Key	string	The tag key.	bk-time
Value	string	The tag value.	1747708000
Total	integer	The total number of query results.	1

Examples

Success response

JSON format

{
  "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": "Task 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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.