更新时间:2024-06-28 GMT+08:00

添加监控数据

功能介绍

该接口用于向服务端添加一条或多条监控数据。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/ams/report/metricdata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的projectid,一般为32位字符串。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token。

Content-Type

String

指定类型为application/json。

枚举值:

  • application/json

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of MetricDataItem objects

指标参数信息。

表4 MetricDataItem

参数

是否必选

参数类型

描述

collect_time

Long

数据收集时间支持过去1天和未来半小时范围内的数据上报。数据收集时间需要满足:

当前UTC时间减去collect_time小于等于24小时或者collect_time减去当前UTC时间小于等于30分钟。

若数据上报时间早于当天8点,则指标监控页面只显示当天8点后的数据。取值范围: UNIX时间戳,单位毫秒。

metric

MetricItemInfo object

指标详细信息。

values

Array of ValueData objects

指标数据的值。

表5 MetricItemInfo

参数

是否必选

参数类型

描述

dimensions

Array of Dimension2 objects

指标维度列表。维度最多允许50个,单个维度为json对象,结构说明如下 dimension.name:长度最短为1,最大为32。 dimension.value:长度最短为1,最大为64。

namespace

String

指标命名空间。namespace中不允许存在":"符号,取值范围格式为service.item;service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,总长度最短为3,最大为32,service不能为“PAAS”。

最小长度:3

最大长度:32

表6 Dimension2

参数

是否必选

参数类型

描述

name

String

维度名称。

最小长度:1

最大长度:32

value

String

维度取值。

最小长度:1

最大长度:64

表7 ValueData

参数

是否必选

参数类型

描述

metric_name

String

指标名称。长度1~255。

type

String

数据的类型。取值范围只能是"int"或"float"。

枚举值:

  • int

  • float

unit

String

数据的单位。长度不超过32个字符。

value

Double

指标数据的值。取值范围有效的数值类型。

最小值:0

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

errorCode

String

响应码。

errorMessage

String

响应信息描述。

请求示例

向服务端添加一条指标名称为“cpu_util”且维度名称为“instance_id”的监控数据(下述例子中,"collect_time"应填写为最新的时间戳)。

https://{Endpoint}/v1/{project_id}/ams/report/metricdata

[ {
  "metric" : {
    "namespace" : "NOPAAS.ESC",
    "dimensions" : [ {
      "name" : "instance_id",
      "value" : "instance-101"
    } ]
  },
  "values" : [ {
    "unit" : "percent",
    "metric_name" : "cpu_util",
    "type" : "int",
    "value" : 35
  } ],
  "collect_time" : 1467787152000
} ]

响应示例

状态码: 200

OK 请求响应成功。

{
  "errorCode" : "SVCSTG_AMS_2000000",
  "errorMessage" : "success"
}

SDK代码示例

SDK代码示例如下。

向服务端添加一条指标名称为“cpu_util”且维度名称为“instance_id”的监控数据(下述例子中,"collect_time"应填写为最新的时间戳)。

 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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.aom.v2.region.AomRegion;
import com.huaweicloud.sdk.aom.v2.*;
import com.huaweicloud.sdk.aom.v2.model.*;

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

public class AddMetricDataSolution {

    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);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        AddMetricDataRequest request = new AddMetricDataRequest();
        List<ValueData> listBodyValues = new ArrayList<>();
        listBodyValues.add(
            new ValueData()
                .withMetricName("cpu_util")
                .withType(ValueData.TypeEnum.fromValue("int"))
                .withUnit("percent")
                .withValue((double)35)
        );
        List<Dimension2> listMetricDimensions = new ArrayList<>();
        listMetricDimensions.add(
            new Dimension2()
                .withName("instance_id")
                .withValue("instance-101")
        );
        MetricItemInfo metricBody = new MetricItemInfo();
        metricBody.withDimensions(listMetricDimensions)
            .withNamespace("NOPAAS.ESC");
        List<MetricDataItem> listbodyBody = new ArrayList<>();
        listbodyBody.add(
            new MetricDataItem()
                .withCollectTime(1467787152000L)
                .withMetric(metricBody)
                .withValues(listBodyValues)
        );
        request.withBody(listbodyBody);
        try {
            AddMetricDataResponse response = client.addMetricData(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());
        }
    }
}

向服务端添加一条指标名称为“cpu_util”且维度名称为“instance_id”的监控数据(下述例子中,"collect_time"应填写为最新的时间戳)。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v2.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.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 = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AddMetricDataRequest()
        listValuesBody = [
            ValueData(
                metric_name="cpu_util",
                type="int",
                unit="percent",
                value=35
            )
        ]
        listDimensionsMetric = [
            Dimension2(
                name="instance_id",
                value="instance-101"
            )
        ]
        metricBody = MetricItemInfo(
            dimensions=listDimensionsMetric,
            namespace="NOPAAS.ESC"
        )
        listBodybody = [
            MetricDataItem(
                collect_time=1467787152000,
                metric=metricBody,
                values=listValuesBody
            )
        ]
        request.body = listBodybody
        response = client.add_metric_data(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

向服务端添加一条指标名称为“cpu_util”且维度名称为“instance_id”的监控数据(下述例子中,"collect_time"应填写为最新的时间戳)。

 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
57
58
59
60
61
62
63
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/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 := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AddMetricDataRequest{}
	typeValues:= model.GetValueDataTypeEnum().INT
	unitValues:= "percent"
	var listValuesBody = []model.ValueData{
        {
            MetricName: "cpu_util",
            Type: &typeValues,
            Unit: &unitValues,
            Value: float64(35),
        },
    }
	var listDimensionsMetric = []model.Dimension2{
        {
            Name: "instance_id",
            Value: "instance-101",
        },
    }
	metricBody := &model.MetricItemInfo{
		Dimensions: listDimensionsMetric,
		Namespace: "NOPAAS.ESC",
	}
	var listBodybody = []model.MetricDataItem{
        {
            CollectTime: int64(1467787152000),
            Metric: metricBody,
            Values: listValuesBody,
        },
    }
	request.Body = &listBodybody
	response, err := client.AddMetricData(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求,不要重试该请求。

401

Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

503

ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。

错误码

请参见错误码