文档首页/代码检查 CodeArts Check/API参考/API/任务管理/查询租户或项目门禁配置 - ShowDataTransmissionServiceReviewData
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询租户或项目门禁配置 - ShowDataTransmissionServiceReviewData

功能介绍

根据租户ID或项目ID查询租户或项目下的代码检查门禁配置，返回致命问题数、严重问题数、一般问题数和提示问题数的门禁阈值以及门禁开关的状态。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck::getProjectConfig

Read

-

codeartscheck:ProjectId

-

-

URI

GET /v2/transmission/review-data

表1 Query参数

参数

是否必选

参数类型

描述

project_id

否

String

参数解释：

项目的32位UUID，项目唯一标识，通过查询项目列表接口获取。

约束条件：

不涉及。

取值范围：

字符串长度32。

默认取值：

不涉及。

domain_id

否

String

参数解释：

租户ID。

约束限制：

不涉及。

取值范围：

字符串长度32。

默认取值：

不涉及。

is_check_project

是

Integer

参数解释：

是否查询项目的配置，1是，0否。

约束限制：

0或1。

取值范围：

  • 0：查询租户的配置

  • 1：查询项目的配置

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

不涉及。

httpStatus

Integer

参数解释：

响应状态码。

取值范围：

不涉及。

result

ReviewData object

参数解释：

租户或项目门禁配置。

取值范围：

不涉及。

表4 ReviewData

参数

参数类型

描述

review_info

Array of ReviewDataInfo objects

参数解释：

租户或项目门禁配置列表。

取值范围：

不涉及。

表5 ReviewDataInfo

参数

参数类型

描述

compareType

String

参数解释：

运算逻辑。

取值范围：

取值为"≤"。

isCheck

Integer

参数解释：

门禁开关。

取值范围：

  • 0：关闭门禁。

  • 1：打开门禁。

name

String

参数解释：

门禁项。

取值范围：

致命问题数

严重问题数

一般问题数

提示问题数

value

Integer

参数解释：

门禁阈值。

取值范围：

≥0

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

查询租户或项目门禁配置。

GET https://{endpoint}/v2/transmission/review-data?is_check_project=0&project_id=&domain_id=389efb76b1354e4482eabeedxxxxxxxx&

响应示例

状态码：200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : {
    "review_info" : [ {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "致命问题数",
      "value" : 0
    }, {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "严重问题数",
      "value" : 3
    }, {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "一般问题数",
      "value" : 3
    }, {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "提示问题数",
      "value" : 4
    } ]
  },
  "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

错误码

请参见错误码。

父主题： 任务管理

相关文档