DescribePreCheckProgressList - Database Backup - Alibaba Cloud Documentation Center

Queries the precheck progress of a backup schedule or a restore task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:DescribePreCheckProgressList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	No	The backup schedule ID. Note You must specify one of BackupPlanId and RestoreTaskId.	dbstooi01XXXX
RestoreTaskId	string	No	The restoration task ID.	dbasdsaXXXX
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Status	string	The status of the precheck. Valid values: running: The precheck is in progress. failed: The precheck failed. finish: The precheck is complete.	failed
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	C4A45FE1-A903-470D-B113-F12A4DF942AB
Progress	integer	The precheck progress. Valid values: 0 to 100.	100
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Items	array<object>	The details of check items.
PreCheckProgressDetail	object
FinishTime	long	The time when the check for the item was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1583734969000
State	string	The state of the check for the item. Valid values: init: The check for the item is being initialized. warning: A warning is reported. catched: An exception occurs. running: The check for the item is in progress. failed: The check for the item fails. finish: The check for the item is completed.	warning
BootTime	long	The time when the check for the item started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1583734969000
JobId	string	The ID of the job for the check item.	uvk8f6fxnq5s
Item	string	The name of the check item.	CHECK_OTHER
ErrMsg	string	The error message.	java.lang.RuntimeException: Could not find any schema ......
OrderNum	string	The sequence number of the check item.	10
Names	string	The name of the group to which the check item belongs.	CHECK_OTHER

Examples

Sample success responses

JSONformat

{
  "Status": "failed",
  "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": 1583734969000,
        "State": "warning",
        "BootTime": 1583734969000,
        "JobId": "uvk8f6fxnq5s",
        "Item": "CHECK_OTHER",
        "ErrMsg": "java.lang.RuntimeException: Could not find any schema ......",
        "OrderNum": "10",
        "Names": "CHECK_OTHER"
      }
    ]
  }
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history