Queries the result of a precheck.

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 DescribePreCheckResult

The operation that you want to perform. Set the value to DescribePreCheckResult.

DrdsInstanceId String Yes drdshbga76p6****

The ID of the PolarDB-X 1.0 instance.

TaskId String Yes 4561

The ID of the precheck task.

RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
PreCheckResult Struct

Indicates the result of the precheck task.

PreCheckName String Does a unique key exist

Indicates the name of the precheck task.

State String FAIL

Indicates the state of the precheck task.

SubCheckItems Array of SubCheckItems

Indicates the details about the subtasks of the precheck task.

ErrorMsgCode String 1004

Indicates the error code that is returned by a subtask.

ErrorMsgParams List table1

Indicates an error message.

PreCheckItemName String Unique key

Indicates the name of the subtask.

State String Success

Indicates the state of the subtask.

RequestId String DescribePreCheckResult

Indicates the ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePreCheckResult
&DrdsInstanceId=drdshbga76p6****
&TaskId=4561
&<Common request parameters>

Sample success responses

XML format 

<PreCheckResult>
    <State>FAIL</State>
    <PreCheckName>Does a unique key exist</PreCheckName>
    <SubCheckItems>
        <PreCheckItemName>Unique key</PreCheckItemName>
        <State>Success</State>
        <ErrorMsgCode>1004</ErrorMsgCode>
        <ErrorMsgParams>table1</ErrorMsgParams>
    </SubCheckItems>
</PreCheckResult>
<RequestId>DescribePreCheckResult</RequestId>
<Success>true</Success>

JSON format 

{"PreCheckResult":{"State":"FAIL","PreCheckName":"Does a unique key exist","SubCheckItems":[{"PreCheckItemName":"Unique key","State":"Success","ErrorMsgCode":"1004","ErrorMsgParams":"table1"}]},"RequestId":"DescribePreCheckResult","Success":"true"}

Error codes

HttpCode Error code Error message Description
500 InternalError The request processing has failed due to some unknown error. The error message returned because an internal error has occurred.

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