Updated on 2026-08-10 GMT+08:00

Obtaining the Check Tool Version

Function

This API is used to query the check tool version of a tenant based on the tenant ID. The tool version, small tool version, and version status of the tenant are returned.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartscheck::getConfig	Read	-	-	-	-

URI

GET /v2/{domain_id}/checkers-version

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, which can be obtained from the basic account information on the console. Constraints: N/A. Value range: 1 to 32 characters. Default value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range The length is the value of [1-100000]. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition: Response status. Range: success: successful. failed: failed.
httpStatus	String	Definition: HTTP response status. Value range: OK: The request has been successfully processed, and the server returns the requested resource or operation result. ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations). INTERNAL_SERVER_ERROR: internal API exception. BAD_REQUEST: abnormal parameter verification.
result	CheckersVersionResult object	Definition: Result of querying the version of the tenant check tool. Range: N/A

**Table 4** CheckersVersionResult
Parameter	Type	Description
status	String	Definition: Version status. Range: new: new version. old: old version.
toolVersion	String	Definition: Tool version. Range: N/A
minorToolVersion	String	Definition: Minor version. Range: N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

This API is used to obtain the check tool version.

GET https://{endpoint}/v2/fxxxx7ba3ae14a87a32b151bcbe20801/checkers-version

Example Responses

Status code: 200

Request succeeded.

{
  "httpStatus" : "OK",
  "status" : "success",
  "result" : {
    "status" : "new",
    "toolVersion" : "202506",
    "minorToolVersion" : "001"
  }
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
200	Request succeeded.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management