All Products
Search
Document Center

Database Backup:DescribePreCheckProgressList

Last Updated:Nov 09, 2022

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

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribePreCheckProgressListRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringNo

The ID of the backup schedule.

dbstooi01XXXX
RestoreTaskIdstringNo

The ID of the restore task.

dbasdsaXXXX
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The precheck status. Valid values:

  • running: The precheck is in progress.
  • failed: The precheck failed.
  • finish: The precheck is complete.
failed
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

C4A45FE1-A903-470D-B113-F12A4DF942AB
Progressinteger

The precheck progress. Valid values: 0 to 100.

100
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
Itemsarray

The details of the progress.

object
FinishTimelong

The time when the check for the item ends. Example: 1554560477000.

1583734969000
Statestring

The progress of the check item. Valid values:

  • init: The check item is initialized.
  • warning: An alert is reported.
  • catched: An exception occurs.
  • running: The check item is being checked.
  • failed: The check item failed.
  • finish: The check item is complete.
warning
BootTimelong

The time when the check for the item starts. Example: 1554560477000.

1583734969000
JobIdstring

The ID of the job for the check item.

uvk8f6fxnq5s
Itemstring

The code of the check item.

CHECK_OTHER
ErrMsgstring

The error message.

java.lang.RuntimeException: Could not find any schema ......
OrderNumstring

The sequence number of the check item.

10
Namesstring

The name of the group to which the check item belongs.

CHECK_OTHER

Example

Normal return example

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": [
    {
      "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

For a list of error codes, visit the API error center.