操作指南

API 文档

云产品监控指标

更新服务发现

最近更新时间:2022-06-14 06:14:37

我的收藏

1. 接口描述

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

在腾讯云容器服务下更新 Prometheus 服务发现。

注意:前提条件,已经通过 Prometheus 控制台集成了对应的腾讯云容器服务,具体请参考 Agent 安装

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpdateServiceDiscovery。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley, sa-saopaulo
InstanceId String Prometheus 实例 ID
KubeClusterId String
  • 类型是 TKE,为对应的腾讯云容器服务集群 ID
  • KubeType Integer 用户 Kubernetes 集群类型:
  • 1 = 容器服务集群(TKE)
  • Type Integer 服务发现类型,取值如下:
  • 1 = ServiceMonitor
  • 2 = PodMonitor
  • 3 = JobMonitor
  • Yaml String 服务发现配置信息

    3. 输出参数

    参数名称 类型 描述
    ServiceDiscovery ServiceDiscoveryItem 更新成功之后,返回对应服务发现的信息
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 更新服务发现

    输入示例

    https://monitor.tencentcloudapi.com/?Action=UpdateServiceDiscovery
    &InstanceId=prom-sdfk2342a
    &KubeClusterId=cls-pwerf3k3
    &KubeType=1
    &Type=1
    &Yaml=yaml
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "ServiceDiscovery": {
          "Kind": "ServiceMonitor",
          "Name": "name",
          "Namespace": "namespace",
          "Selector": "{\"matchLabels\":{\"k8sapp\":\"mysql-exporter\"}}",
          "Yaml": "apiVersion: monitoring.coreos.com...",
          "NamespaceSelector": "{\"matchNames\":[\"demo-ns\"]}",
          "Endpoints": "[{\"port\":\"tcp-port\",\"path\":\"/metrics\",\"interval\":\"30s\",\"bearerTokenSecret\":{\"key\":\"\"}}]"
        },
        "RequestId": "nrtlca1qmunlpf51noe13qp5vyvg7mq5"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.AccessSTSFail 访问STS失败。
    FailedOperation.AccessTKEFail 访问用户TKE集群失败。
    FailedOperation.AgentVersionNotSupported Agent版本不支持该操作,请升级Agent。
    FailedOperation.BadYamlFormat Yaml 格式不正确。
    FailedOperation.TKEEndpointStatusError TKE的endpoint不可访问。
    FailedOperation.TKEResourceConflict 更新TKE资源时出现冲突。
    InvalidParameter 参数错误。
    ResourceNotFound 资源不存在。
    目录