# 批量查询指标结果 - BatchSearchMetricHits #### 功能介绍 批量查询指标结果 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | timespan | 否 | String | **参数解释:** 查询指标的时间范围，ISO8601格式，例如：2007-03-01T13:00:00Z/2008-05-11T15:30:00Z或2007-03-01T13:00:00Z/P1Y2M10DT2H30M或P1Y2M10DT2H30M/2008-05-11T15:30:00Z **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | | cache | 否 | Boolean | **参数解释:** 是否启用缓存，默认true，禁用缓存 false **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: true | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释:** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**: 不涉及 **取值范围**: 不涉及 **默认取值**: 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | metric_ids | 是 | Array of strings | **参数解释：** 待查询的指标Id列表，可参照附录中指标信息说明获取已有指标信息。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_ids | 否 | Array of strings | **参数解释：** 工作空间列表，当指标支持获取多工作空间数据时填写。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | params | 否 | Array of Map\ objects | **参数解释：** 待查询指标的参数列表，列表内每个元素为\的K-V形式 **约束限制：** 元素数量必须与metric_ids列表相同，具体填写方式请参照附录 **取值范围：** 不涉及 **默认取值：** 不涉及 | | interactive_params | 否 | Array of Map\ objects | **参数解释：** 交互式参数查询，当指标支持交互式参数时，填写\的K-V形式的参数列表，具体填写方式请参照附录。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | field_ids | 否 | Array of strings | **参数解释：** 指标卡片ID列表 **约束限制：** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [ShowMetricResultResponseBody] objects | 批量查询指标结果 | 表6ShowMetricResultResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric_id | String | 指标ID | | result | [result] object | **参数解释：** 指标查询结果内容 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | metric_format | Array of [MetricFormat] objects | **参数解释：** 指标显示格式，根据不同指标固定返回。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | log_msg | String | **参数解释：** 结果日志信息 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | status | String | **参数解释：** 查询结果状态，SUCCESS：查询成功，FAILED：查询失败，FALLBACK：使用默认值 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表7result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | labels | Array of strings | **参数解释：** 指标查询结果表格标题 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | datarows | Array\\> | **参数解释：** 指标查询结果内容表格 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | effective_column | String | **参数解释：** 生效的列，当有该参数时，使用指定列作为指标数据结果 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表8MetricFormat | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | String | **参数解释：** 数据格式 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | display | String | **参数解释：** 显示格式 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | display_param | Map\ | **参数解释：** 显示参数 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | data_param | Map\ | **参数解释：** 数据参数 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求示例 通过指标接口查询从6月25日至当前的告警等级分布 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits { "metric_ids" : [ "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c" ], "params" : [ { "start_date" : "2024-06-25T00:00:00.000+08:00" } ] } ``` #### 响应示例 **状态码：200** 请求成功 ``` [ { "metric_id" : "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c", "result" : { "labels" : [ "label1" ], "datarows" : [ [ { } ] ], "effective_column" : "0:1" }, "status" : "SUCCESS" } ] ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 通过指标接口查询从6月25日至当前的告警等级分布 ``` 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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.util.HashMap; public class BatchSearchMetricHitsSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("")) .build(); BatchSearchMetricHitsRequest request = new BatchSearchMetricHitsRequest(); request.withWorkspaceId("{workspace_id}"); BatchSearchMetricHitsRequestBody body = new BatchSearchMetricHitsRequestBody(); Map listParamsParams = new HashMap<>(); listParamsParams.put("start_date", "2024-06-25T00:00:00.000+08:00"); List> listbodyParams = new ArrayList<>(); listbodyParams.add(listParamsParams); List listbodyMetricIds = new ArrayList<>(); listbodyMetricIds.add("1f0f5e29-5a92-17a5-2c16-5f37c6dc109c"); body.withParams(listbodyParams); body.withMetricIds(listbodyMetricIds); request.withBody(body); try { BatchSearchMetricHitsResponse response = client.batchSearchMetricHits(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()); } } } ``` - [Python] 通过指标接口查询从6月25日至当前的告警等级分布 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("")) \ .build() try: request = BatchSearchMetricHitsRequest() request.workspace_id = "{workspace_id}" listParamsParams = { "start_date": "2024-06-25T00:00:00.000+08:00" } listParamsbody = [ listParamsParams ] listMetricIdsbody = [ "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c" ] request.body = BatchSearchMetricHitsRequestBody( params=listParamsbody, metric_ids=listMetricIdsbody ) response = client.batch_search_metric_hits(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 通过指标接口查询从6月25日至当前的告警等级分布 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.BatchSearchMetricHitsRequest{} request.WorkspaceId = "{workspace_id}" var listParamsParams = map[string]string{ "start_date": "2024-06-25T00:00:00.000+08:00", } var listParamsbody = []map[string]string{ listParamsParams, } var listMetricIdsbody = []string{ "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c", } request.Body = &model.BatchSearchMetricHitsRequestBody{ Params: &listParamsbody, MetricIds: listMetricIdsbody, } response, err := client.BatchSearchMetricHits(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=BatchSearchMetricHits&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。