Querying Extension Indicator Configuration

Function

This API is used to query extension indicator configuration.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** 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 for . Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
[items]	No	Array of PluginPartQueryDTO objects	Definition: Query request body. Constraints: N/A

**Table 4** PluginPartQueryDTO
Parameter	Mandatory	Type	Description
plugin_name	Yes	String	Definition: Extension name. Constraints: N/A Value range: N/A Default value: N/A
display_name	Yes	String	Definition: Display name. Constraints: N/A Value range: N/A Default value: N/A
version	Yes	String	Definition: Version number. Constraints: N/A Value range: N/A Default value: N/A
plugin_attribution	Yes	String	Definition: Extension attribute. Constraints: N/A Value range: custom: custom extension. official: official extension. Default value: N/A
version_attribution	No	String	Definition: Version attribute. Constraints: N/A Value range: - draft: draft version. - formal: formal version. Default value: N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of PluginPartQueryVOListAgentPluginOutputVO objects	Parameter description: List of extension metric configurations. Constraints: N/A.

**Table 6** PluginPartQueryVOListAgentPluginOutputVO
Parameter	Type	Description
plugin_name	String	Definition: Extension name. Value range: N/A
display_name	String	Definition: Displayed extension name. Value range: N/A
data	Array of data objects	Definition: Extension output details. Value range: N/A

**Table 7** data
Parameter	Type	Description
unique_id	String	Definition: ID. Value range: N/A
plugin_name	String	Definition: Extension name. Value range: N/A
version	String	Definition: Extension version number. Value range: N/A
workspace_id	String	Definition: Tenant ID, that is, domain ID of a user. Range: N/A
output_key	String	Definition: Defined extension output name. Value range: N/A
output_value	String	Definition: Defined extension output content. Value range: N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

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

[ {
  "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 \"}]]"
  } ]
} ]