创建私有位置 API
编辑创建私有位置 API
编辑使用以下模式创建一个私有位置。
请求
编辑POST <kibana 主机>:<端口>/api/synthetics/private_locations
POST <kibana 主机>:<端口>/s/<空间 ID>/api/synthetics/private_locations
先决条件
编辑您必须在 Observability 部分的 Synthetics 和 Uptime 功能中拥有 all
权限,详见Kibana 功能权限。
请求体
编辑请求体应包含以下属性
-
label
- (必需,字符串)私有位置的标签。
-
agentPolicyId
- (必需,字符串)与私有位置关联的代理策略的 ID。
-
tags
- (可选,字符串数组)用于对私有位置进行分类的标签数组。
-
geo
-
(可选,对象)位置的地理坐标 (WGS84)。它应包含以下属性
-
lat
(必需,数字):位置的纬度。 -
lon
(必需,数字):位置的经度。
-
示例
编辑以下是创建私有位置的 POST 请求的示例
POST /api/private_locations { "label": "Private Location 1", "agentPolicyId": "abcd1234", "tags": ["private", "testing"], "geo": { "lat": 40.7128, "lon": -74.0060 } }
API 返回创建的私有位置如下所示
{ "id": "abcd1234", "label": "Private Location 1", "agentPolicyId": "abcd1234", "tags": ["private", "testing"], "geo": { "lat": 40.7128, "lon": -74.0060 } }
如果 agentPolicyId
已被现有私有位置使用,或者如果 label
已存在,API 将返回 400 Bad Request
响应以及相应的错误消息。