全部产品
Search

搜索本产品

    应用实时监控服务ARMS：GetPrometheusIntegration - 获取Prometheus实例指定集成中心Exporter实例

    文档中心

    应用实时监控服务ARMS：GetPrometheusIntegration - 获取Prometheus实例指定集成中心Exporter实例

    更新时间：Nov 05, 2024

    获取Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）指定集成中心Exporter实例。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    arms:GetPrometheusIntegrationnone
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    地域 ID。

    		cn-hangzhou
    ClusterIdstring是

    Prometheus 实例 ID。仅支持 aliyun-cs 和 ecs 两种类型的实例。

    		cc7a37ee31aea4ed1a059eff8034b****
    IntegrationTypestring是

    集成类型：kafka、mysql、redis、snmp、emr、nubela、tidb 等。

    		tidb
    InstanceIdlong是

    Prometheus 实例集成中心 Exporter 实例 ID。

    		28**

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    Id of the request

    		9BEF2832-9D95-5E3E-9B10-74887C******
    Dataobject

    返回结构体。

    ClusterIdstring

    Prometheus 实例 ID。

    		cc7a37ee31aea4ed1a059eff8034b****
    InstanceIdlong

    Prometheus 实例的集成 Exporter 实例 ID。

    		28**
    ShowDescribeboolean

    是否展示描述。

    		true
    NeedUpgradeboolean

    是否需要升级。

    		True
    InstanceNamestring

    Prometheus 集成的 Exporter 实例名。

    		lpd-skyeye
    IntegrationTypestring

    集成类型：kafka、mysql、redis、snmp、emr、nubela、tidb 等。

    		tidb
    ExporterTypestring

    集成 Exporter 类型。

    		tidb-exporter
    Versionstring

    版本信息。

    		1.0.0
    Targetstring

    监控目标地址。

    		127.0.XX.XX:3422
    CanDeleteboolean

    是否能删除。

    		true
    CanEditorboolean

    是否可以编辑。

    		true
    Statusstring

    Exporter 状态

    		installed
    Describestring

    Exporter 描述。

    		"{}"
    ShowLogstring

    是否展示 Exporter 日志。

    		true
    Namespacestring

    命名空间。

    		arms-prom
    ContainerNamestring

    容器名称。

    		kafka-exporter-1
    Paramstring

    Exporter 配置参数 JSON 串。

    		{ "port": "5554", "name": "kafka-test12", "kafka_instance": "kafka-test", "__label_value": "kafka-test", "scrape_interval": 33, "metrics_path": "/metrics", "__label_key": "kafka-test" }
    Codeinteger

    状态码。200 为成功，其他状态码为异常。

    		200
    Messagestring

    返回信息。

    		message

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "9BEF2832-9D95-5E3E-9B10-74887C******",
  "Data": {
    "ClusterId": "cc7a37ee31aea4ed1a059eff8034b****",
    "InstanceId": 0,
    "ShowDescribe": true,
    "NeedUpgrade": true,
    "InstanceName": "lpd-skyeye",
    "IntegrationType": "tidb",
    "ExporterType": "tidb-exporter",
    "Version": "1.0.0",
    "Target": "127.0.XX.XX:3422",
    "CanDelete": true,
    "CanEditor": true,
    "Status": "installed",
    "Describe": "\"{}\"",
    "ShowLog": "true",
    "Namespace": "arms-prom",
    "ContainerName": "kafka-exporter-1",
    "Param": "{\n      \"port\": \"5554\",\n      \"name\": \"kafka-test12\",\n      \"kafka_instance\": \"kafka-test\",\n      \"__label_value\": \"kafka-test\",\n      \"scrape_interval\": 33,\n      \"metrics_path\": \"/metrics\",\n      \"__label_key\": \"kafka-test\"\n}"
  },
  "Code": 200,
  "Message": "message"
}

    错误码

    HTTP status code错误码错误信息
    400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-04-10OpenAPI 错误码发生变更查看变更详情
    2023-03-23OpenAPI 错误码发生变更查看变更详情