文档首页/代码检查 CodeArts Check/API参考/API/规则管理/查询第三方引擎 - ShowThirdTools
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询第三方引擎 - ShowThirdTools

功能介绍

该接口用于查询第三方引擎。用户可以导入第三方引擎的规则，该接口响应信息为用户租户下已导入的第三方引擎列表。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck::getRule

Read

-

-

-

-

URI

GET /v2/excute/all-thirdtools

表1 Query参数

参数

是否必选

参数类型

描述

rule_type

是

Integer

参数解释：

规则类型。

约束限制：

不涉及。

取值范围：

  • 0：自定义规则。

  • 1：系统内置规则。

  • 3：用户导入的第三方规则。

默认取值：

不涉及。

language

否

String

参数解释：

规则语言。

约束限制：

不涉及。

取值范围：

编程语言名称。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

  • OK：请求已成功处理，服务器返回了请求的资源或操作结果。

  • ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。

  • INTERNAL_SERVER_ERROR：接口内部异常。

  • BAD_REQUEST：参数校验异常。

result

Array of strings

参数解释：

引擎工具列表。

取值范围：

不涉及。

status

String

参数解释：

接口响应状态。

取值范围：

  • success：接口响应成功。

  • error：接口响应失败。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v2/excute/all-thirdtools?rule_type=3

响应示例

状态码：200

Request Succeeded!

{
  "httpStatus" : "OK",
  "result" : [ "checker01", "checker01" ],
  "status" : "success"
}

状态码：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

错误码

请参见错误码。

父主题： 规则管理

相关文档