Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying System Configuration
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying System Configuration

Function

This API is used to query system configuration.

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::getConfig

Read

-

-

-

-

URI

GET /v2/system-configs

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

search

No

String

Definition:

Keyword search (prefix matching)

Constraints:

N/A

Value range:

N/A

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

Range

The length is the value of [1-100000].

Default Value

N/A

Content-Type

Yes

String

Definition

Encoding format.

Constraints

N/A

Range

N/A

Default Value

application/json: The return value is in JSON format for any input value.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

Array of SystemConfigItem objects

Definition

System configuration list.

total

Integer

Definition

Number of system configurations.

Range

N/A
Table 4 SystemConfigItem

Parameter

Type

Description

id

String

Definition

System configuration ID. Each system configuration has a unique ID.

Range

N/A

key

String

Definition

Key of the system configuration.

Range

N/A

value

String

Definition

Value of the system configuration.

Range

N/A

description

String

Definition

Description of the system configuration.

Range

N/A

create_time

String

Definition

Creation time of the system configuration.

Range

N/A

creator

String

Definition

Creator of the system configuration.

Range

N/A

last_reviser

String

Definition

Last modifier of the system configuration.

Range

N/A

domain_id

String

Definition:

Tenant ID, which is the same as the IAM tenant ID.

Value range:

32-character UUID.

has_default_config

Boolean

Definition

Whether the default configuration exists.

Range

N/A

last_update_time

String

Definition

Last modification time of the system configuration.

Range

N/A

Status code: 400

Table 5 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 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

Example Requests

Query system configuration details of error code CC.10010263.500.

GET https://{endpoint}/v2/system-configs?search=errorCode_CC.10010263.500

Example Responses

Status code: 200

System configuration obtained.

{
  "data" : [ {
    "id" : "ce73d793f81511ef8c02fa163eed4919",
    "key" : "errorCode_CC.00030009.400",
    "value" : "codeartscheck_02_0157",
    "description" : "CC.00030009.400, rule set information not found.",
    "create_time" : "2025-03-03 17:18:37.0",
    "creator" : "SYSTEM",
    "last_reviser" : "SYSTEM",
    "domain_id" : null,
    "has_default_config" : null,
    "last_update_time" : "2025-03-03 17:18:37.0"
  } ],
  "total" : 1
}

Status code: 400

A request error occurred.

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

Status code: 401

The permission is insufficient.

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

Status Codes

Status Code

Description

200

System configuration obtained.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management