All Products
Search
Document Center

Database Backup:DescribeJobErrorCode

Last Updated:Nov 09, 2022

Queries the standard error information of a Database Backup (DBS) 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:DescribeJobErrorCodeRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringYes

The ID of the full backup or restore task.

dbstooi0XXXX
LanguagestringNo

The language of the error message. Valid values: en and cn. Default value: en.

en
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5
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.
Itemobject

The error information.

JobStatestring

The status of the task.

init
ErrorMessagestring

The standard error message.

Describe preCheck progress failed.
ErrorCodestring

The error code.

failed
JobIdstring

The ID of the full backup or restore task.

tooi0XXXX
JobTypestring

The internal ID of the DBS task type.

testId
Languagestring

The language of the error message.

en

Example

Normal return example

JSONFormat

{
  "HttpStatusCode": 200,
  "RequestId": "1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Item": {
    "JobState": "init",
    "ErrorMessage": "Describe preCheck progress failed.",
    "ErrorCode": "failed",
    "JobId": "tooi0XXXX",
    "JobType": "testId",
    "Language": "en"
  }
}

Error codes

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