文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 获取租户检查工具版本 - ShowDataTransmissionServiceUserCheckersVersion
更新时间:2025-12-30 GMT+08:00
分享

获取租户检查工具版本 - ShowDataTransmissionServiceUserCheckersVersion

功能介绍

根据租户ID查询租户的检查工具版本,返回租户的工具版本、小工具版本和版本状态。

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

GET /v2/{domain_id}/checkers-version

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释:

租户ID,通过进入Console页面查看账号的基本信息获取。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过32。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

长度为[1~100000]个字符。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

响应状态。

取值范围:

success:成功

failed:失败

httpStatus

Integer

参数解释:

响应状态码。

取值范围:

ok:成功

failed:失败

result

CheckersVersionResult object

参数解释:

查询租户检查工具版本的结果。

取值范围:

不涉及。

表4 CheckersVersionResult

参数

参数类型

描述

status

String

参数解释:

版本状态。

取值范围:

new: 新版本。old: 旧版本。

toolVersion

String

参数解释:

工具版本。

取值范围:

不涉及。

minorToolVersion

String

参数解释:

小工具版本。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

获取租户检查工具版本。

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

响应示例

状态码:200

Request succeeded!

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

状态码:400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档