Skip to Content

get precheck task result - GetUDTSPrecheckTask

Overview

get precheck task result

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUDTSPrecheckTask.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in.No
TaskIdstringTask IDYes
TypestringTask TypeNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataCheckResultprecheck resultYes

Data Model

CheckResult

Field NameTypeDescription InformationRequired
Statestringprecheck task stateNo
PrecheckResultItemarray[CheckResultItem]precheck task itemNo

CheckResultItem

Field NameTypeDescription InformationRequired
StatestringStatusYes
TypestringCheck TypeYes
ErrMessagestringerror messageYes
InstructionstringInstructionYes
IsTargetbooleanis taeget check resultYes

Example

Request Example

https://api.surfercloud.com/?Action=GetUDTSPrecheckTask &ProjectId=QAYgheFF &TaskId=xNcUaeHI &Type=MdOHoRGC

Response Example

{ "Action": "GetUDTSPrecheckTaskResponse", "Data": {}, "Message": "UdAxekmr", "RetCode": 0 }