Help Center/CodeArts Pipeline/API Reference/API/Extension Plug-in Management/Querying All Plug-in Version Information
Updated on 2023-12-08 GMT+08:00
View PDF

Querying All Plug-in Version Information

Function

Querying All Plug-in Version Information

URI

GET /v1/{domain_id}/agent-plugin/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

plugin_name

No

String

Plug-in

offset

No

String

Offset

limit

No

String

Size

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

offset

Integer

Offset

limit

Integer

Size

total

Integer

Total number.

data

Array of PluginBasicVO objects

Viewing execution results

Table 5 PluginBasicVO

Parameter

Type

Description

plugin_name

String

Plug-in

display_name

String

Display Name

version

String

Version

version_description

String

Change History

description

String

Description

version_attribution

String

Version Attribute

unique_id

String

Unique ID

op_user

String

Operator

op_time

String

Operated

plugin_composition_type

String

Combination Type

plugin_attribution

String

Attribute

workspace_id

String

Indicates the tenant ID.

business_type

String

Service Type

business_type_display_name

String

Display Name of Service Type

maintainers

String

Maintainer

icon_url

String

Icon URL

refer_count

Integer

Reference Times

usage_count

Integer

Usage Times

runtime_attribution

String

Operating attributes

active

Integer

Whether to activate a job

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error Message

error_code

String

Error code.

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/query?plugin_name=fff&offset=0&limit=1

Example Responses

Status code: 200

OK

{
  "offset" : 0,
  "limit" : 1,
  "total" : 1,
  "data" : [ {
    "plugin_name" : "fff",
    "display_name" : "hhjk",
    "version" : "0.0.1",
    "version_description" : "",
    "description" : "",
    "version_attribution" : "formal",
    "unique_id" : "d4d18039ac4248b68d38aca463a0c35a",
    "op_user" : "devcloud_devcloud_h00485561_01",
    "op_time" : "1699931374000",
    "plugin_composition_type" : "multi",
    "plugin_attribution" : "custom",
    "workspace_id" : "ce8df55870164338a72d7e828a966a2a",
    "business_type" : "Normal",
    "business_type_display_name" : "General",
    "maintainers" : "[\"847a5317086c41798469d0868535943a\"]",
    "icon_url" : "",
    "refer_count" : null,
    "usage_count" : null,
    "runtime_attribution" : "agent",
    "active" : 1
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.