获取参数 API
编辑获取参数 API编辑
根据提供的条件检索参数。
请求编辑
GET <kibana 主机>:<端口>/api/synthetics/params/{id?}
GET <kibana 主机>:<端口>/s/<空间 ID>/api/synthetics/params/{id?}
先决条件编辑
您必须对 可观察性 部分的 Synthetics 功能具有 read 权限 Kibana 功能权限.
查询参数编辑
-
id - (可选，字符串) 参数的唯一标识符。如果提供，此 API 将通过其 ID 检索特定参数。如果未提供，它将检索所有参数的列表。
响应示例编辑
API 响应包含参数作为 JSON 对象，其中每个参数对象具有以下属性
-
id(字符串): 参数的唯一标识符。 -
key(字符串): 参数的键。
如果用户对 Synthetics 应用程序具有只读权限，则将包含以下其他属性
-
description(字符串，可选): 参数的描述。 -
tags(字符串数组，可选): 与参数关联的标签数组。 -
namespaces(字符串数组): 与参数关联的命名空间。
如果用户具有写入权限，则将包含以下其他属性
-
value(字符串): 与参数关联的值。
以下是一个通过其 ID 检索单个参数的示例请求
GET /api/synthetics/params/unique-parameter-id
以下是一个通过其 ID 检索单个参数的示例响应
对于具有只读权限的用户
{
"id": "unique-parameter-id",
"key": "your-api-key",
"description": "Param to use in browser monitor",
"tags": ["authentication", "security"],
"namespaces": ["namespace1", "namespace2"]
}
对于具有写入权限的用户
{
"id": "unique-parameter-id",
"key": "your-param-key",
"description": "Param to use in browser monitor",
"tags": ["authentication", "security"],
"namespaces": ["namespace1", "namespace2"],
"value": "your-param-value"
}
以下是一个检索参数列表的示例响应
对于具有只读权限的用户
[
{
"id": "param1-id",
"key": "param1",
"description": "Description for param1",
"tags": ["tag1", "tag2"],
"namespaces": ["namespace1"]
},
{
"id": "param2-id",
"key": "param2",
"description": "Description for param2",
"tags": ["tag3"],
"namespaces": ["namespace2"]
}
]
对于具有写入权限的用户
[
{
"id": "param1-id",
"key": "param1",
"description": "Description for param1",
"tags": ["tag1", "tag2"],
"namespaces": ["namespace1"],
"value": "value1"
},
{
"id": "param2-id",
"key": "param2",
"description": "Description for param2",
"tags": ["tag3"],
"namespaces": ["namespace2"],
"value": "value2"
}
]