Call the DescribeJobErrorCode API to view the error codes returned by DBS tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeJobErrorCode

The operation that you want to perform. Valid values: DescribeJobErrorCode

TaskId String Yes dbstooi0XXXX

The ID of the full backup or restoration job.

Language String No en

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

RegionId String No cn-hangzhou

The region ID of the instance. Call DescribeRegions to view the regions supported by DBS.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

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

Response parameters

Parameter Type Example Description
ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

Item Struct

The error code information.

ErrorCode String failed

The error code.

ErrorMessage String Describe preCheck progress failed.

Standardized error information.

JobId String tooi0XXXX

The ID of the full backup or restoration job.

JobState String init

The status of the task.

JobType String testId

The id of the DBS internal task type.

Language String en

The error message language.

RequestId String 1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5

Request ID.

Success Boolean true

Indicates whether the request succeeded.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeJobErrorCode
&TaskId=dbstooi0XXXX
&<Common request parameters>

Sample success responses

XML format

<DescribeJobErrorCodeReponse>
  <Item>
        <Language>en</Language>
        <JobId>tooi0XXXX</JobId>
  </Item>
  <RequestId>1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <Success>true</Success>
</DescribeJobErrorCodeReponse>

JSON format

{
    "Item": {
        "Language": "en",
        "JobId": "tooi0XXXX"
    },
    "RequestId": "1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5",
    "HttpStatusCode": 200,
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.