Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Obtaining the List of Specified Third-Party Plug-ins
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the List of Specified Third-Party Plug-ins

Function

Query the third-party plug-ins configured for a task by the configuration template ID. The engine name, engine execution command, and report path of the third-party plug-ins 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:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v2/plugins

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition:

Configuration template ID. The configuration template ID is required for modifying the configuration information. Each CodeArts Check task and its branch tasks have the same unique configuration template ID.

Constraints:

N/A

Value range:

1 to 128 characters.

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

result

Array of ThirdPlugin objects

Definition:

Array of third-party plug-ins.

Range:

N/A

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.
Table 4 ThirdPlugin

Parameter

Type

Description

command

String

Definition:

Command to be executed.

Range:

Max. 1,024 characters.

id

String

Definition:

Configuration template ID. The configuration template ID is required for modifying the configuration information. Each CodeArts Check task and its branch tasks have the same unique configuration template ID.

Value range:

1 to 128 characters.

pluginName

String

Definition:

Third-party plug-in name.

Range:

1 to 128 characters.

reportPath

String

Definition:

Report path specified by the third-party plug-in.

Range:

Max. 1,024 characters.

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 the third-party plug-in list with the configuration template ID 897acf5exxx48a5013cd.

GET https://{endpoint}/v2/plugins?id=897acf5exxx48a5013cd

Example Responses

Status code: 200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : [ {
    "command" : "echo hello",
    "id" : "72266**********919",
    "pluginName" : "customTool",
    "reportPath" : "dir/dir1"
  } ],
  "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