全部产品
Search
文档中心

可观测监控 Prometheus 版:AddPrometheusIntegration - 增加Prometheus实例的集成中心Exporter实例

更新时间:Nov 05, 2024

增加Prometheus实例的集成中心Exporter实例(仅支持aliyun-cs、ecs两种类型的实例)。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ClusterIdstring

prometheus 实例 Id。仅支持 aliyun-cs、ecs 两种类型的实例。

cc7a37ee31aea4ed1a059eff8034b****
IntegrationTypestring

集成类型。

kafka、mysql、redis、snmp、emr、nubela、tidb等
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"}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

3703B98C-335E-5BA7-972E-F90E9E768A85
Dataobject

返回结构体。

InstanceIdlong

Prometheus 实例的集成 Exporter 实例 id。

2829
InstanceNamestring

prometheus 集成的 Exporter 实例名。

hw-cloud02
Codeinteger

接口状态或 pop 错误码。

200
Messagestring

返回结果的提示信息。

message

示例

正常返回示例

JSON格式

{
  "RequestId": "3703B98C-335E-5BA7-972E-F90E9E768A85",
  "Data": {
    "InstanceId": 2829,
    "InstanceName": "hw-cloud02"
  },
  "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-08-01OpenAPI 错误码发生变更查看变更详情