获取Prometheus实例(仅支持aliyun-cs、ecs两种类型的实例)指定集成中心Exporter实例。
目前该API接口已标记为弃用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| ClusterId |
string |
是 |
Prometheus 实例 ID。仅支持 aliyun-cs 和 ecs 两种类型的实例。 |
cc7a37ee31aea4ed1a059eff8034b**** |
| IntegrationType |
string |
是 |
集成类型:kafka、mysql、redis、snmp、emr、nubela、tidb 等。 |
tidb |
| InstanceId |
integer |
是 |
Prometheus 实例集成中心 Exporter 实例 ID。 |
28** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
9BEF2832-9D95-5E3E-9B10-74887C****** |
| Data |
object |
返回结构体。 |
|
| ClusterId |
string |
Prometheus 实例 ID。 |
cc7a37ee31aea4ed1a059eff8034b**** |
| InstanceId |
integer |
Prometheus 实例的集成 Exporter 实例 ID。 |
28** |
| ShowDescribe |
boolean |
是否展示描述。 |
true |
| NeedUpgrade |
boolean |
是否需要升级。 |
True |
| InstanceName |
string |
Prometheus 集成的 Exporter 实例名。 |
lpd-skyeye |
| IntegrationType |
string |
集成类型:kafka、mysql、redis、snmp、emr、nubela、tidb 等。 |
tidb |
| ExporterType |
string |
集成 Exporter 类型。 |
tidb-exporter |
| Version |
string |
版本信息。 |
1.0.0 |
| Target |
string |
监控目标地址。 |
127.0.XX.XX:3422 |
| CanDelete |
boolean |
是否能删除。 |
true |
| CanEditor |
boolean |
是否可以编辑。 |
true |
| Status |
string |
Exporter 状态 |
installed |
| Describe |
string |
Exporter 描述。 |
"{}" |
| ShowLog |
string |
是否展示 Exporter 日志。 |
true |
| Namespace |
string |
命名空间。 |
arms-prom |
| ContainerName |
string |
容器名称。 |
kafka-exporter-1 |
| Param |
string |
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" } |
| Code |
integer |
状态码。200 为成功,其他状态码为异常。 |
200 |
| Message |
string |
返回信息。 |
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The 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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。