获取指定第三方插件列表 - ListDataTransmissionServiceThirdPlugins
功能介绍
根据配置模板ID查询任务下已配置的第三方插件，返回第三方插件的引擎名称、引擎执行命令和报告路径。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
codeartscheck:task:get | Read | task * | - | - | - |
- | codeartscheck:ProjectId |
URI
GET /v2/plugins
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
id | 是 | String | 参数解释： 配置模板ID，修改配置信息需要用到配置模板ID，每个代码检查任务及其下的分支任务都有相同的且唯一的配置模板ID。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过128。 默认取值： 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 长度为[1~100000]个字符。 默认取值： 不涉及。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
result | Array of ThirdPlugin objects | 参数解释： 第三方插件数组。 取值范围： 不涉及。 |
httpStatus | String | 参数解释： HTTP响应状态。 取值范围：
|
status | String | 参数解释： 接口响应状态。 取值范围：
|
参数 | 参数类型 | 描述 |
|---|---|---|
command | String | 参数解释： 执行的命令。 取值范围： 字符串长度不超过1024。 |
id | String | 参数解释： 配置模板ID，修改配置信息需要用到配置模板ID，每个代码检查任务及其下的分支任务都有相同的且唯一的配置模板ID。 取值范围： 字符串长度不少于1，不超过128。 |
pluginName | String | 参数解释： 第三方插件名称。 取值范围： 字符串长度不少于1，不超过128。 |
reportPath | String | 参数解释： 第三方插件指定的报告路径。 取值范围： 字符串长度不超过1024。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
查询配置模板ID为897acf5exxx48a5013cd的第三方插件列表。
GET https://{endpoint}/v2/plugins?id=897acf5exxx48a5013cd 响应示例
状态码：200
Request succeeded!
{
"httpStatus" : "OK",
"result" : [ {
"command" : "echo hello",
"id" : "72266**********919",
"pluginName" : "customTool",
"reportPath" : "dir/dir1"
} ],
"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 |
错误码
请参见错误码。
