监控对象列表

列出当前租户下被 monit-agent 路由投影所观测到的监控对象。支持 target_locator 前缀搜索与游标分页。用于为 /monit/tools/catalog 与 /monit/tools/invoke 选择 target_locator。

POST /monit/targets

监控对象列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/monit/targets?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keyword": "db-prod",
  "limit": 50
}
'

import requests

url = "https://api.flashcat.cloud/monit/targets?app_key="

payload = {
    "keyword": "db-prod",
    "limit": 50
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({keyword: 'db-prod', limit: 50})
};

fetch('https://api.flashcat.cloud/monit/targets?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/monit/targets?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'keyword' => 'db-prod',
    'limit' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/monit/targets?app_key="

	payload := strings.NewReader("{\n  \"keyword\": \"db-prod\",\n  \"limit\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/monit/targets?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"keyword\": \"db-prod\",\n  \"limit\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/monit/targets?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keyword\": \"db-prod\",\n  \"limit\": 50\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "target_kind": "host",
        "target_locator": "db-prod-01",
        "agent_version": "2.0.0",
        "cluster_name": "edge-a",
        "edge_ipport": "10.0.0.1:19090",
        "updated_at": 1710000000
      }
    ],
    "total": 120,
    "next_cursor": "eyJ0YXJnZXRfbG9jYXRvciI6ImRiLXByb2QtMDEiLCJpZCI6MTIzNDV9"
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

调用限制

项	值
速率限制	600 次/分钟;10 次/秒 每账户
权限	任意有效的 app_key(只读;不受特定权限分类约束)

​

使用说明

• 这是一个 UI 投影视图,不是 /monit/tools/invoke 所依赖的实时数据源。列表中存在不代表对应监控对象当前可被调用。
• keyword 是对 target_locator 的前缀匹配(仅 ASCII,不含空白,不含 |,最长 256 字节)。v1 不支持子串搜索。
• limit 默认 50,最大 200。分页基于游标:将上次响应中的 next_cursor 传入即可拉取下一页;next_cursor 为空或缺失表示已到末页。
• 重置 keyword、limit 或租户上下文时必须重置 cursor;切勿在不同筛选条件之间复用游标。
• total 是当前 (account_id, keyword) 组合下未受游标影响的匹配总数,跨页保持稳定。
• 字段中暴露 cluster_name / edge_ipport 供排障使用;updated_at 表示”最近一次被观测到”,而非实时在线指标。

授权

app_key · string · query · 必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

请求体

application/json

account_id · integer<int64>

可选的一致性校验。若提供,必须等于已认证账户。

keyword · string

对 target_locator 的前缀匹配。仅 ASCII,不含空白,不含 |,最长 256 字节。不支持子串搜索。

limit · integer · 默认值: 50

分页大小。默认 50,最大 200。

必填范围: x <= 200

cursor · string

来自上次响应的 next_cursor 的不透明游标。首页请省略或传空串。变更 keyword、limit 或租户时必须重置。

响应

200

application/json

成功

成功响应结构。2xx 响应中 request_id 标识本次调用（同时出现在 Flashcat-Request-Id 响应头中），data 为接口业务 payload。失败响应使用不同结构，参见 ErrorResponse。

request_id · string · 必填

本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。

Show child attributes