DescribePreCheckProgressList - Data Management - Alibaba Cloud Documentation Center

This operation queries the precheck progress for a backup plan or a restore job.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribePreCheckProgressList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The ID of the backup plan. Note Specify either BackupPlanId or RestoreTaskId.	dbsr1l3ro21****
RestoreTaskId	string	No	The ID of the restore job.	dbasdsa****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCziJZNwH****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Status	string	The precheck status. Valid values: running: The precheck is in progress. failed: The precheck failed. finish: The precheck is complete.	finish
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	C4A45FE1-A903-470D-B113-F12A4DF942AB
Progress	integer	The precheck progress. The value ranges from 0 to 100.	100
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Items	object
PreCheckProgressDetail	array<object>	A list of progress details.
	object	The response parameters.
FinishTime	integer	The time when the task was complete. This value is a UNIX timestamp.	1704351396000
State	string	The progress status. Valid values: init: The task is being initialized. warning: A warning is reported for the task. catched: The task is abnormal. running: The task is in progress. failed: The task failed. finish: The task is complete.	warning
BootTime	integer	The time when the task started. This value is a UNIX timestamp.	1704351395000
JobId	string	The progress ID.	qxwmxh2b****
Item	string	The code for the precheck item.	CHECK_BINLOG_ON
ErrMsg	string	The error message.	java.lang.RuntimeException: Could not find any schema ......
OrderNum	string	The sequence number.	30
Names	string	The group to which the precheck item belongs.	CHECK_BINLOG_ON_DETAIL

Examples

Success response

JSON format

{
  "Status": "finish",
  "HttpStatusCode": 200,
  "RequestId": "C4A45FE1-A903-470D-B113-F12A4DF942AB",
  "Progress": 100,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Items": {
    "PreCheckProgressDetail": [
      {
        "FinishTime": 1704351396000,
        "State": "warning",
        "BootTime": 1704351395000,
        "JobId": "qxwmxh2b****",
        "Item": "CHECK_BINLOG_ON",
        "ErrMsg": "java.lang.RuntimeException: Could not find any schema ......",
        "OrderNum": "30",
        "Names": "CHECK_BINLOG_ON_DETAIL"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.