日志服务获取集群指标基础监控采集配置

1. 接口描述

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

获取指标订阅配置

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterBaseMetricConfigs。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
GroupId	是	String	机器组id 示例值：5871c48d-219b-4274-829b-5aa7fb24229b
Filters.N	否	Array of Filter	topicId按照【指标主题id】进行过滤。类型：String 必选：否每次请求的Filters的上限为10，所有Filter.Values总和上限为100。
Offset	否	Integer	分页的偏移量，默认值为0。示例值：0
Limit	否	Integer	分页单页限制数目，默认值为20，最大值100。示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总数目示例值：0
Datas	Array of BaseMetricCollectConfig	指标采集配置列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取集群下的指标基础监控信息

输入示例

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

{
    "GroupId": "886bf7a8-7340-4314-8d64-b360da0ffd78",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Datas": [
            {
                "Configs": [
                    {
                        "ConfigId": "6886a667-77eb-4363-ad5a-906d1481fe04",
                        "CreateTime": 1724244707,
                        "Flag": 1,
                        "GroupIds": [
                            "43948ea4-f286-4636-adfd-92aa0fc8344e"
                        ],
                        "HonorLabels": false,
                        "Name": "node-exporter",
                        "Operate": 0,
                        "Scheme": "",
                        "ScrapeInterval": "",
                        "ScrapeTimeout": "",
                        "Source": 0,
                        "TopicIds": [
                            "d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"
                        ],
                        "Type": 0,
                        "UpdateTime": 1724244707,
                        "YamlSpec": {
                            "Spec": "job_name: node-exporter\nhonor_timestamps: true\ntrack_timestamps_staleness: false\nmetrics_path: /metrics\nscheme: http\nenable_compression: true\nauthorization:\n  type: Bearer\n  credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token\ntls_config:\n  insecure_skip_verify: true\nfollow_redirects: true\nenable_http2: true\nhttp_headers: null\nrelabel_configs:\n- source_labels: [__meta_kubernetes_pod_node_name]\n  separator: ;\n  regex: (.*)\n  target_label: instance\n  replacement: $1\n  action: replace\n",
                            "Type": "ScrapeConfig-prometheus"
                        }
                    },
                    {
                        "ConfigId": "853fd8d1-77ec-4815-8696-5e2e029fba21",
                        "CreateTime": 1724244707,
                        "Flag": 1,
                        "GroupIds": [
                            "43948ea4-f286-4636-adfd-92aa0fc8344e"
                        ],
                        "HonorLabels": false,
                        "Name": "kube-state-metric",
                        "Operate": 0,
                        "Scheme": "",
                        "ScrapeInterval": "",
                        "ScrapeTimeout": "",
                        "Source": 0,
                        "TopicIds": [
                            "d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"
                        ],
                        "Type": 0,
                        "UpdateTime": 1724244707,
                        "YamlSpec": {
                            "Spec": "job_name: kube-state-metric\nhonor_timestamps: true\ntrack_timestamps_staleness: false\nmetrics_path: /metrics\nscheme: http\nenable_compression: true\nauthorization:\n  type: Bearer\n  credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token\ntls_config:\n  insecure_skip_verify: true\nfollow_redirects: true\nenable_http2: true\nhttp_headers: null\nmetric_relabel_configs:\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_pod_container_resource_requests;cpu;core\n  target_label: __name__\n  replacement: kube_pod_container_resource_requests_cpu_cores\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_pod_container_resource_limits;cpu;core\n  target_label: __name__\n  replacement: kube_pod_container_resource_limits_cpu_cores\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_pod_container_resource_requests;memory;byte\n  target_label: __name__\n  replacement: kube_pod_container_resource_requests_memory_bytes\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_pod_container_resource_limits;memory;byte\n  target_label: __name__\n  replacement: kube_pod_container_resource_limits_memory_bytes\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_node_status_capacity;cpu;core\n  target_label: __name__\n  replacement: kube_node_status_capacity_cpu_cores\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_node_status_capacity;memory;byte\n  target_label: __name__\n  replacement: kube_node_status_capacity_memory_bytes\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_node_status_allocatable;cpu;core\n  target_label: __name__\n  replacement: kube_node_status_allocatable_cpu_cores\n  action: replace\n- source_labels: [__name__, resource, unit]\n  separator: ;\n  regex: kube_node_status_allocatable;memory;byte\n  target_label: __name__\n  replacement: kube_node_status_allocatable_memory_bytes\n  action: replace\n",
                            "Type": "ScrapeConfig-prometheus"
                        }
                    },
                    {
                        "ConfigId": "1bac0b5b-7bbe-4612-8831-5d445da9553d",
                        "CreateTime": 1724244707,
                        "Flag": 1,
                        "GroupIds": [
                            "43948ea4-f286-4636-adfd-92aa0fc8344e"
                        ],
                        "HonorLabels": false,
                        "Name": "cadvisor",
                        "Operate": 0,
                        "Scheme": "",
                        "ScrapeInterval": "",
                        "ScrapeTimeout": "",
                        "Source": 0,
                        "TopicIds": [
                            "d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"
                        ],
                        "Type": 0,
                        "UpdateTime": 1724244707,
                        "YamlSpec": {
                            "Spec": "job_name: cadvisor\nhonor_timestamps: false\ntrack_timestamps_staleness: false\nmetrics_path: /metrics\nscheme: https\nenable_compression: true\nauthorization:\n  type: Bearer\n  credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token\ntls_config:\n  ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt\n  insecure_skip_verify: false\nfollow_redirects: true\nenable_http2: true\nhttp_headers: null\nrelabel_configs:\n- source_labels: [__meta_kubernetes_node_name]\n  separator: ;\n  regex: (.*)\n  target_label: __address__\n  replacement: kubernetes.default.svc:443\n  action: replace\n- source_labels: [__meta_kubernetes_node_name]\n  separator: ;\n  regex: (.+)\n  target_label: __metrics_path__\n  replacement: /api/v1/nodes/${1}/proxy/metrics/cadvisor\n  action: replace\n- separator: ;\n  regex: __meta_kubernetes_node_label_(.+)\n  replacement: $1\n  action: labelmap\n- separator: ;\n  regex: eks_tke_cloud_tencent_com_(.+)\n  replacement: $1\n  action: labeldrop\nmetric_relabel_configs:\n- source_labels: [container_name]\n  separator: ;\n  regex: (.+)\n  target_label: container\n  replacement: $1\n  action: replace\n- source_labels: [pod_name]\n  separator: ;\n  regex: (.+)\n  target_label: pod\n  replacement: $1\n  action: replace\n- source_labels: [container]\n  separator: ;\n  regex: (.*)\n  replacement: $1\n  action: keep\n",
                            "Type": "ScrapeConfig-prometheus"
                        }
                    }
                ],
                "GroupId": "43948ea4-f286-4636-adfd-92aa0fc8344e"
            }
        ],
        "RequestId": "c8db920f-a681-44a6-a22b-c8d5d40a09fe",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	请求未授权。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.DbError	DB错误。
InternalError.IllegalRole	角色非法。
InvalidParameter	参数错误。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded.RecordOutOfLimit	记录超过限制
MissingParameter	缺少参数错误。
OperationDenied.AccountNotExists	账户不存在。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

获取集群指标基础监控采集配置

本页目录：