Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Tenant or Project Gate Configuration
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Tenant or Project Gate Configuration

Function

This API is used to query the code check gate configuration of a tenant or project based on the tenant ID or project ID. The gate thresholds of the number of critical issues, major issues, minor issues, and suggestions, and the gate switch status 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::getProjectConfig

Read

-

codeartscheck:ProjectId

-

-

URI

GET /v2/transmission/review-data

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Definition :

32-character project UUID. Obtain it by calling the API used to query the project list.

Constraints:

N/A

Value range:

32 characters.

Default value:

N/A

domain_id

No

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

32 characters.

Default value:

N/A

is_check_project

Yes

Integer

Definition:

Whether to query the project configuration. 1: yes; 0: no.

Constraints:

0 or 1

Value range:

  • 0: Query the tenant configuration.

  • 1: Query the project configuration.

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

Value range:

1–100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Range:

N/A

httpStatus

Integer

Definition:

Response status code.

Range:

N/A

result

ReviewData object

Definition:

Tenant or project gate configurations.

Range:

N/A
Table 4 ReviewData

Parameter

Type

Description

review_info

Array of ReviewDataInfo objects

Definition:

Tenant or project gate configuration list.

Range:

N/A
Table 5 ReviewDataInfo

Parameter

Type

Description

compareType

String

Definition:

Calculation logic.

Range:

The value is ≤.

isCheck

Integer

Definition:

Gate switch.

Value range:

  • 0: disabled.

  • 1: enabled.

name

String

Definition:

Gate item.

Range:

Number of critical issues.

Member of major issues.

Number of minor issues.

Number of suggestions.

value

Integer

Definition:

Gate threshold.

Value range:

≥0

Status code: 400

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

Status code: 401

Table 7 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 query the tenant or project gate configuration.

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

Example Responses

Status code: 200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : {
    "review_info" : [ {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "Number of critical issues.",
      "value" : 0
    }, {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "Member of major issues.",
      "value" : 3
    }, {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "Number of minor issues.",
      "value" : 3
    }, {
      "compareType" : "≤",
      "isCheck" : 0,
      "name" : "Number of suggestions.",
      "value" : 4
    } ]
  },
  "status" : "success"
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management