Obtaining System Parameters

Function

This API is used to obtain the global default system parameters.

Calling Method

For details, see Calling APIs.

URI

GET /v3/system/configs

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A.

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
[items]	Array of QuerySystemConfig objects	Definition System parameter list.

**Table 3** QuerySystemConfig
Parameter	Type	Description
name	String	Definition System parameter name. Range N/A
type	String	Definition System parameter type. Range text: Text type.
description	String	Definition System parameter description. Range N/A
pipeline_source	String	Definition Source information transferred by the pipeline. Range Artifact: The source is CodeArts Artifact.
pipeline_source_type	String	Definition Artifact repository type of the pipeline source. Range generic: Release repository. docker: Docker repository.
static_status	Boolean	Definition Whether the system parameter is static. Range false: Parameters cannot be changed during deployment. true: Parameters can be changed during deployment and reported to the pipeline.

Example Requests

Obtain the global default system parameters.

https://{endpoint}/v3/system/configs

Example Responses

Status code: 200

OK indicates that the system parameters are queried.

[ {
  "name" : "CODEARTS_ARTIFACT_FILE",
  "type" : "text",
  "description" : "First-level directory in CodeArts Artifact as the deployment source.",
  "pipeline_source" : "Artifact",
  "pipeline_source_type" : "generic",
  "static_status" : false
} ]