添加参数 API
编辑添加参数 API编辑
将一个或多个参数添加到 Synthetics 应用程序。
请求编辑
POST <kibana 主机>:<端口>/api/synthetics/params
POST <kibana 主机>:<端口>/s/<空间 ID>/api/synthetics/params
先决条件编辑
您必须对 Kibana 功能权限 中的 可观察性 部分中的 Synthetics 功能拥有 all 权限。
请求正文编辑
请求正文可以包含单个参数对象或参数对象的数组。参数对象模式包括以下属性
-
key - (必填，字符串) 参数的键。
-
value - (必填，字符串) 与参数关联的值。
-
description - (可选，字符串) 参数的描述。
-
tags - (可选，字符串数组) 用于对参数进行分类的标签数组。
-
share_across_spaces - (可选，布尔值) 是否应在空间之间共享参数。
添加单个参数时，提供单个对象。添加多个参数时，提供参数对象的数组。
示例编辑
以下是添加参数的 POST 请求示例，可以是单个参数，也可以是参数数组
添加单个参数
POST /api/synthetics/params
{
"key": "your-key-name",
"value": "your-parameter-value",
"description": "Param to use in browser monitor",
"tags": ["authentication", "security"],
"share_across_spaces": true
}
添加多个参数
POST /api/synthetics/params
[
{
"key": "param1",
"value": "value1"
},
{
"key": "param2",
"value": "value2"
}
]
API 根据请求返回响应。如果您添加了单个参数，它将返回单个参数对象。如果您添加了多个参数，它将返回参数对象的数组。
响应示例编辑
API 响应包含创建的参数作为 JSON 对象，其中每个参数对象都具有以下属性
-
id(字符串): 参数的唯一标识符。 -
key(字符串): 参数的键。 -
value(字符串): 与参数关联的值。 -
description(字符串，可选): 参数的描述。 -
tags(字符串数组，可选): 与参数关联的标签数组。 -
share_across_spaces(布尔值，可选): 指示参数是否在空间之间共享。
以下是一个添加单个参数的响应示例
{
"id": "unique-parameter-id",
"key": "your-key-name",
"value": "your-param-value",
"description": "Param to use in browser monitor",
"tags": ["authentication", "security"],
"share_across_spaces": true
}
以下是一个添加多个参数的响应示例
[
{
"id": "param1-id",
"key": "param1",
"value": "value1"
},
{
"id": "param2-id",
"key": "param2",
"value": "value2"
}
]