创建主机指标采集配置

最近更新时间:2025-12-23 01:28:51

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

创建主机指标采集配置

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateHostMetricConfig。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TopicId String 指标日志主题id。
- 通过 获取日志主题列表 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
- 通过 创建日志主题 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题
示例值:715094e3-01b0-4aeb-91f5-ee9f46a4a13c
Name String 名称。

- 长度不超过 64字符。
示例值:template-1
MachineGroupIds.N Array of String 机器组id列表。最多支持100个机器组。
示例值:["81853bcf-67b4-4a4f-82c7-7882fd004613"]
Interval Integer 采集频率。单位:ms。 最小支持5000ms
示例值:5000
HostMetricItems.N Array of HostMetricItem 采集项。支持"cpu","mem","net","disk","system"。目前仅支持:所有采集项都需配置
- cpu:CPU
- mem:内存
- net:网络
- disk:磁盘
- system:系统

3. 输出参数

参数名称 类型 描述
ConfigId String 主机指标采集配置id
示例值:23986f8e-2cab-45e6-a5d3-b1d654681ce6
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建主机指标采集配置

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHostMetricConfig
<公共请求参数>

{
    "TopicId": "55fdd8a0-1a33-4ce3-8166-01f2361f0cdf",
    "Name": "host_metric_config_test",
    "MachineGroupIds": [
        "c8bdead9-0170-4d69-ab08-5caa607b76d0"
    ],
    "Interval": 50000,
    "HostMetricItems": [
        {
            "Type": "cpu"
        },
        {
            "Type": "mem"
        },
        {
            "Type": "net"
        },
        {
            "Type": "disk"
        },
        {
            "Type": "system"
        }
    ]
}

输出示例

{
    "Response": {
        "ConfigId": "e542d884-f08b-4be9-b700-2a99d9aa1545",
        "RequestId": "2a1f4deb-c47a-46d4-bb7a-565a17e6aa38"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未授权。
FailedOperation 操作失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InternalError.DbError DB错误。
InternalError.IllegalRole 角色非法。
InvalidParameter 参数错误。
InvalidParameter.DbDuplication 数据库唯一键冲突。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded.RecordOutOfLimit 记录超过限制
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。