All Products
Search
Document Center

Database Backup:DescribePreCheckProgressList

Last Updated:Mar 03, 2024

Indicates whether the request is successful.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dbs:DescribePreCheckProgressListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringNo

The backup schedule ID.

Note You must set one of BackupPlanId or RestoreTaskId.
dbstooi01XXXX
RestoreTaskIdstringNo

The restoration task ID.

dbasdsaXXXX
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Statusstring

The status of the precheck. Valid values:

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

The ID of the backup schedule.

200
RequestIdstring

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

C4A45FE1-A903-470D-B113-F12A4DF942AB
Progressinteger

The precheck progress. Valid values: 0 to 100.

100
ErrCodestring

The sequence number of the check item.

Param.NotFound
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrMessagestring

The error code.

The specified parameter %s value is not valid.
Itemsobject []

The details of check items.

FinishTimelong

The time when the check for the item was complete.

1583734969000
Statestring

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 runnning.
  • failed: The check for the item fails.
  • finish: The check for the item is completed
warning
BootTimelong

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

1583734969000
JobIdstring

The ID of the job for the check item.

uvk8f6fxnq5s
Itemstring

The name 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

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 codeError codeError message
403Request.ForbiddenHave no Permissions

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

Change history

Change timeSummary of changesOperation
No change history