Help Center/ CodeArts Pipeline/ API Reference/ API/ Extension Management/ Querying Extension Indicator Configuration
Updated on 2025-09-08 GMT+08:00

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.

Constraints:

N/A

Value 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 forobtaining a user token.

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: None.

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.

Value 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

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

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion;
import com.huaweicloud.sdk.codeartspipeline.v2.*;
import com.huaweicloud.sdk.codeartspipeline.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class ShowPluginMetricsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowPluginMetricsRequest request = new ShowPluginMetricsRequest();
        request.withDomainId("{domain_id}");
        List<PluginPartQueryDTO> listbodyBody = new ArrayList<>();
        listbodyBody.add(
            new PluginPartQueryDTO()
                .withPluginName("test_multi_language")
                .withVersion("0.0.11")
                .withPluginAttribution("official")
        );
        request.withBody(listbodyBody);
        try {
            ShowPluginMetricsResponse response = client.showPluginMetrics(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartspipeline.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsPipelineClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowPluginMetricsRequest()
        request.domain_id = "{domain_id}"
        listBodybody = [
            PluginPartQueryDTO(
                plugin_name="test_multi_language",
                version="0.0.11",
                plugin_attribution="official"
            )
        ]
        request.body = listBodybody
        response = client.show_plugin_metrics(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowPluginMetricsRequest{}
	request.DomainId = "{domain_id}"
	var listBodybody = []model.PluginPartQueryDto{
        {
            PluginName: "test_multi_language",
            Version: "0.0.11",
            PluginAttribution: "official",
        },
    }
	request.Body = &listBodybody
	response, err := client.ShowPluginMetrics(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.