New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 添加参数 API 按 ID 编辑参数 API »
Elastic 文档 ›Kibana 指南 [8.17] ›REST API ›Synthetics API

获取参数 API

编辑

获取参数 API

编辑

根据提供的标准检索参数。

请求

编辑

GET <kibana host>:<port>/api/synthetics/params/{id?}

GET <kibana host>:<port>/s/<space_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"
  }
]
« 添加参数 API 按 ID 编辑参数 API »

On this page

Was this helpful?
Feedback