访问监控数据--对象存储-火山引擎

文档中心

立即注册

导航

对象存储

访问监控数据

最近更新时间：2024.11.20 10:41:59首次发布时间：2024.11.20 10:41:59

本文介绍如何通过云监控提供的 API 或 SDK 获取 TOS 相关的监控数据。

访问方式

您可以通过云监控提供的 API 或 SDK 获取 TOS 相关的监控数据，详情请参见以下文档：

关键参数说明

参数	说明
StartTime	查询的时间选段的开始时间，秒级时间戳，例如1632904500。
EndTime	查询的时间选段的结束时间，秒级时间戳，例如1632904801。 EndTime > StartTime。 EndTime不能输入未来时间。 EndTime < 产品允许查询天数 + StartTime。
Instances	要查询的监控指标信息。存在多个instance时，instance和instance之间的逻辑关系是or。如果不传instance参数，会返回该地域下所有实例的监控数据。数据量较大可能会对业务产生影响，需谨慎操作。
MetricName	要查询的监控指标名称。详情请参见监控指标说明下的 MetricName。
Namespace	要查询的监控指标所属的产品空间，TOS 为 `VCM_TOS`。
SubNamespace	要查询的指标所属的维度。详情请参见监控指标说明下的 SubNamespace。
Period	查询数据的间隔粒度，支持秒（s）、分钟（m）、时（h）、天（d）和周（w）粒度。详细说明请参见 GetMetricData。

API 查询示例

以下请求用于查询 210015**** **** 存储桶的对象总数量，查询时间段为 (1648048800, 1648049400]，查询周期为 1h。

POST https://open.volcengineapi.com?Action=GetMetricData&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx

{
    "MetricName": "BucketObjectCount",
    "StartTime": 1648048800,
    "EndTime": 1648049400,
    "Period": "1h",
    "Namespace": "VCM_TOS",
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "ResourceID",
                    "Value": "210015****"
                }
            ]
        }
    ],
    "SubNamespace": "bucket_overview"
}

SDK 查询示例

以下请求用于查询 210015**** **** 存储桶的对象总数量，查询时间段为 (1648048800, 1648049400]，查询周期为 1h。

import com.volcengine.ApiClient;
import com.volcengine.ApiException;
import com.volcengine.sign.Credentials;
import com.volcengine.volcobserve.VolcObserveApi;
import com.volcengine.volcobserve.model.*;

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

public class GetMetricData {
    public static void main(String[] args)throws Exception {
        //设置您的ak
        String ak = "Your AK";
        //设置您的sk
        String sk = "Your SK";
        //设置您要访问的地域
        String region = "cn-beijing";
        //初始化apiclient
        ApiClient apiClient = new ApiClient()
                .setCredentials(Credentials.getCredentials(ak,sk))
                .setRegion(region);
        VolcObserveApi api = new VolcObserveApi(apiClient);
        //创建一个接口入参
        GetMetricDataRequest request = new GetMetricDataRequest();
        //设置接口入参
        request.setStartTime(1671783***);
        request.setEndTime(1671786***);
        request.setNamespace("VCM_TOS");
        request.setSubNamespace("bucket_overview");
        request.setMetricName("BucketObjectCount");
        request.setPeriod("1h");
        DimensionForGetMetricDataInput dimension = new DimensionForGetMetricDataInput();
        dimension.setName("ResourceID");
        dimension.setValue("210015****");
        InstanceForGetMetricDataInput instance = new InstanceForGetMetricDataInput();
        List<DimensionForGetMetricDataInput> dimensionList = new ArrayList<>();
        dimensionList.add(dimension);
        instance.setDimensions(dimensionList);
        List<InstanceForGetMetricDataInput> instanceList = new ArrayList<>();
        instanceList.add(instance);
        request.setInstances(instanceList);

        try {
            //调用接口
            GetMetricDataResponse response = api.getMetricData(request);
            System.out.println(response);
        } catch (ApiException e) {
            System.out.println(e.getResponseBody());
        }
    }
}