« 删除私有位置 API Uptime API »
Elastic 文档 ›Kibana 指南 [8.17] ›REST API ›Synthetics API

获取私有位置 API

编辑

获取私有位置 API

编辑

检索私有位置列表或按 ID 检索单个私有位置。

请求

编辑

GET <kibana host>:<port>/api/synthetics/private_locations

GET <kibana host>:<port>/s/<space_id>/api/synthetics/private_locations

先决条件

编辑

您必须在 可观测性 部分的 Synthetics 和 Uptime 功能中拥有 read 权限，请参阅 Kibana 功能权限。

列表响应示例

编辑

当访问列表端点时，API 返回一个私有位置的 JSON 数组，每个私有位置具有以下属性：

  • label (字符串)：私有位置的标签。
  • id (字符串)：私有位置的唯一标识符。
  • agentPolicyId (字符串)：与私有位置关联的代理策略的 ID。
  • isInvalid (布尔值)：指示该位置是否无效。如果为 true，则该位置无效，这意味着与该位置关联的代理策略已被删除。
  • geo (对象)：该位置的地理坐标，包括 lat 和 lon。
  • namespace (字符串)：该位置的命名空间，与与该位置关联的代理策略的命名空间相同。

这是一个列表响应示例

[
    {
        "label": "Test private location",
        "id": "fleet-server-policy",
        "agentPolicyId": "fleet-server-policy",
        "isInvalid": false,
        "geo": {
            "lat": 0,
            "lon": 0
        },
        "namespace": "default"
    },
    {
        "label": "Test private location 2",
        "id": "691225b0-6ced-11ee-8f5a-376306ee85ae",
        "agentPolicyId": "691225b0-6ced-11ee-8f5a-376306ee85ae",
        "isInvalid": false,
        "geo": {
            "lat": 0,
            "lon": 0
        },
        "namespace": "test"
    }
]

按 ID/标签获取的响应示例

编辑

当访问具有特定 id 的端点时，API 返回单个私有位置的 JSON 对象，其属性与列表响应中的属性相同。

这是一个按 ID 获取单个位置的请求示例

GET api/synthetics/private_locations/<location_id>

或按标签获取

GET api/synthetics/private_locations/<Location label>

这是一个响应对象示例

{
    "label": "Test private location",
    "id": "test-private-location-id",
    "agentPolicyId": "test-private-location-id",
    "isServiceManaged": false,
    "isInvalid": false,
    "geo": {
        "lat": 0,
        "lon": 0
    },
    "namespace": "default"
}
« 删除私有位置 API Uptime API »