Help Center/ CodeArts Pipeline/ API Reference/ API/ Extension Plug-in Management/ Query Plug-in Indicator Configuration
Updated on 2023-11-28 GMT+08:00
View PDF

Query Plug-in Indicator Configuration

Function

Query Plug-in Indicator Configuration

URI

POST /v1/{domain_id}/agent-plugin/plugin-metrics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Indicates the tenant ID.

Request Parameters

Table 2 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).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

No

Array of PluginPartQueryDTO objects

Query Request Body
Table 4 PluginPartQueryDTO

Parameter

Mandatory

Type

Description

plugin_name

No

String

Plug-in name

display_name

No

String

Display Name

version

No

String

Version

plugin_attribution

No

String

Plug-in Attribute

version_attribution

No

String

Version Attribute

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of PluginPartQueryVOListAgentPluginOutputVO objects

OK
Table 6 PluginPartQueryVOListAgentPluginOutputVO

Parameter

Type

Description

plugin_name

String

Plug-in

display_name

String

Display Name

data

Array of data objects

Viewing execution results
Table 7 data

Parameter

Type

Description

unique_id

String

Unique ID

plugin_name

String

Plug-in name

version

String

Version

workspace_id

String

Indicates the tenant ID.

output_key

String

Name

output_value

String

Value

Status code: 400

Table 8 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/plugin-metrics

[ {
  "plugin_name" : "test_multi_language",
  "version" : "0.0.11",
  "plugin_attribution" : "official"
} ]

Example Responses

Status code: 200

OK

[ {
  "plugin_name" : "test_multi_language",
  "display_name" : "",
  "data" : [ {
    "unique_id" : "2df0e830196247f8a10cd598b045fa8a",
    "plugin_name" : "test_multi_language",
    "version" : "0.0.11",
    "workspace_id" : "*",
    "output_key" : "SYSTEM_METRICS_UNIQUE_KEY",
    "output_value" : "[{\"group_name\":\"Chinese \",\"properties\":[{\"key\":\"test\",\"value\":\"111\",\"desc\": \"Chinese \"}]]"
  } ]
} ]

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.