› › ›

获取私有位置 API

编辑

获取私有位置 API编辑

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

请求编辑

GET <kibana 主机>:<端口>/api/synthetics/private_locations

GET <kibana 主机>:<端口>/s/<空间 ID>/api/synthetics/private_locations

先决条件编辑

您必须对 Synthetics 和正常运行时间 功能具有 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 正常运行时间 API »