› › ›

获取所有 Kibana 空间 API

编辑

获取所有 Kibana 空间 API编辑

[预览] 此功能处于技术预览阶段，可能会在未来版本中更改或删除。Elastic 将努力解决任何问题，但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。检索所有 Kibana 空间。

请求编辑

GET <kibana 主机>:<端口>/api/spaces/space

查询参数编辑

用途: （可选，字符串）有效选项包括 any、copySavedObjectsIntoSpace 和 shareSavedObjectsIntoSpace。这决定了对 API 调用应用哪些授权检查。如果未在 URL 中提供 purpose，则使用 any 用途。
include_authorized_purposes: （可选，布尔值）启用后，API 将返回用户有权访问的任何空间，并且每个空间都将包含用户被授权的目的。这对于确定用户可以读取但不能在其中执行特定操作的空间很有用。如果未启用安全插件，这将不起作用，因为不会进行授权检查。

此选项不能与 purpose 一起使用。

响应代码编辑

200: 表示调用成功。

示例编辑

默认选项编辑

检索所有空间，不指定任何选项

$ curl -X GET api/spaces/space

API 返回以下内容

[
  {
    "id": "default",
    "name": "Default",
    "description" : "This is the Default Space",
    "disabledFeatures": [],
    "imageUrl": "",
    "_reserved": true
  },
  {
    "id": "marketing",
    "name": "Marketing",
    "description" : "This is the Marketing Space",
    "color": "#aabbcc",
    "disabledFeatures": ["apm"],
    "initials": "MK",
    "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSU"
  },
  {
    "id": "sales",
    "name": "Sales",
    "initials": "MK",
    "disabledFeatures": ["discover"],
    "imageUrl": ""
  }
]

自定义选项编辑

用户对“销售”空间具有只读访问权限。检索所有空间并指定选项

$ curl -X GET api/spaces/space?purpose=shareSavedObjectsIntoSpace&include_authorized_purposes=true

API 返回以下内容

[
  {
    "id": "default",
    "name": "Default",
    "description" : "This is the Default Space",
    "disabledFeatures": [],
    "imageUrl": "",
    "_reserved": true,
    "authorizedPurposes": {
      "any": true,
      "copySavedObjectsIntoSpace": true,
      "findSavedObjects": true,
      "shareSavedObjectsIntoSpace": true,
    }
  },
  {
    "id": "marketing",
    "name": "Marketing",
    "description" : "This is the Marketing Space",
    "color": "#aabbcc",
    "disabledFeatures": ["apm"],
    "initials": "MK",
    "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSU",
    "authorizedPurposes": {
      "any": true,
      "copySavedObjectsIntoSpace": true,
      "findSavedObjects": true,
      "shareSavedObjectsIntoSpace": true,
    }
  },
  {
    "id": "sales",
    "name": "Sales",
    "initials": "MK",
    "disabledFeatures": ["discover"],
    "imageUrl": "",
    "authorizedPurposes": {
      "any": true,
      "copySavedObjectsIntoSpace": false,
      "findSavedObjects": true,
      "shareSavedObjectsIntoSpace": false,
    }
  }
]

« 获取空间 API 删除空间 API »