View a markdown version of this page

Amazon OpenSearch Serverless 中支持的操作和插件 - 亚马逊 OpenSearch 服务
支持 OpenSearch 的 API 操作和权限支持的 OpenSearch 插件

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Amazon OpenSearch Serverless 中支持的操作和插件

Amazon OpenSearch Serverless 支持各种 OpenSearch 插件以及中 OpenSearch提供的索引、搜索和元数据 API 操作的子集。您可以将权限包括在数据访问策略中表的左列，以限制对某些操作的访问权限。

支持 OpenSearch 的 API 操作和权限

下表列出了 OpenSearch Serverless 支持的 API 操作及其相应的数据访问策略权限：

数据访问策略权限 OpenSearch API 操作 描述和注意事项

aoss:CreateIndex

 PUT <index>

创建索引。有关更多信息，请参阅 Create index（创建索引）。

注意

此权限也适用于使用 OpenSearch 仪表板上的示例数据创建索引。

aoss:DescribeIndex

  • GET <index>

  • GET <index>/_mapping

  • GET <index>/_mappings

  • GET <index>/_setting

  • GET <index>/_setting/<setting>

  • GET <index>/_settings

  • GET <index>/_settings/<setting>

  • GET _cat/indices

  • GET _mapping

  • GET _mappings

  • 获取 _resolve/index/<index>

  • HEAD <index>

描述索引。有关更多信息，请参阅以下资源：

aoss:WriteDocument

  • DELETE <index>/_doc/<id>

  • POST <index>/_bulk

  • POST <index>/_create/<id>（仅适用于搜索集合类型）

  • POST <index>/_doc

  • POST <index>/_update/<id>（仅适用于搜索集合类型）

  • POST _bulk

  • PUT <index>/_create/<id>（仅适用于搜索集合类型）

  • PUT <index>/_doc/<id>（仅适用于搜索集合类型）

编写和更新文档。有关更多信息，请参阅以下资源：

注意

有些操作仅允许针对 SEARCH 类型的集合执行。有关更多信息，请参阅 选择集合类型。

aoss:ReadDocument

  • GET <index>/_analyz

  • GET <index>/_doc/<id>

  • GET <index>/_explain/<id>

  • GET <index>/_mget

  • GET <index>/_source/<id>

  • GET <index>/_count

  • GET <index>/_field_caps

  • GET <index>/_msearch

  • GET <index>/_rank_eval

  • GET <index>/_search

  • GET <index>/_validate/<query>

  • GET _analyze

  • GET _field_caps

  • GET _mget

  • GET _search

  • GET/_search/point_in_time/_all

  • HEAD <index>/_doc/<id>

  • HEAD <index>/_source/<id>

  • 帖子/_plugins/_sql

  • 帖子/_plugins/_ppl

  • 帖子/ _plugins/_sql /_解释

  • 帖子/ _plugins/_ppl /_解释

  • POST/ _plugins/_ppl /_close

  • POST <index>/_analyze

  • 帖子/_search/point_in_time

  • POST <index>/_explain/<id>

  • POST <index>/_count

  • POST <index>/_field_caps

  • POST <index>/_rank_eval

  • POST <index>/_search

  • POST _analyze

  • POST _field_caps

  • POST _search

  • 删除/_search/point_in_time/_all

  • 删除/_search/point_in_time

 阅读文档。有关更多信息，请参阅以下资源：

aoss:DeleteIndex

 DELETE <target> 删除索引。有关更多信息，请参阅 Delete index（删除索引）。

aoss:UpdateIndex

  • POST _mapping

  • POST <index>/_mapping/

  • POST <index>/_mappings/

  • POST <index>/_setting

  • POST <index>/_settings

  • POST _setting

  • POST _settings

  • PUT _mapping

  • PUT <index>/_mapping

  • PUT <index>/_mappings/

  • PUT <index>/_setting

  • PUT <index>/_settings

  • PUT _setting

  • PUT _settings

更新索引设置。有关更多信息，请参阅以下资源：

aoss:CreateCollectionItems

  • POST _aliases

  • 帖子/ _plugins/_flow_framework /工作流程

  • <workflow_id>* POST// _plugins/_flow_framework workflow/ /_provision

  • 看跌期 _ingest/pipeline权/<pipeline-id>

  • 看跌期 _search/pipeline权/<pipeline-id>

  • 创建索引别名、管道以及模板。有关更多信息，请参阅创建别名。

  • * 预置或重新预置模板。ML Commons 客户端和 OpenSearch 无服务器服务管理依赖策略。

aoss:DescribeCollectionItems

  • GET <index>/_alias/<alias>

  • GET _alias

  • GET _alias/<alias>

  • GET _cat/aliases

  • GET _cat/templates

  • 获取 _cat/templates/<template_name>

  • GET _component_template

  • GET _component_template/<component-template>

  • GET _index_template

  • GET _index_template/<index-template>

  • 获取 _ingest/pipeline/<pipeline-id>

  • 获取 _ingest/pipeline /_simulate

  • GET//workf _plugins/_flow_framework low/ <workflow-id>

  • 获取/_plugins/_flow_framework/workflow/_search

  • <workflow-id>GET//_plugins/_flow_frameworkworkflow/ /_status

  • GET/_plugins/_flow_framework/workflow/state/_search

  • 获取/_plugins/_flow_framework/workflow/_steps

  • GET_plugins/_flow_framework//workflow/_step？ workflow_step= <step_name>

  • 获取 _search/pipeline/<pipeline-id>

  • HEAD _alias/<alias>

  • HEAD _component_template/<component-template>

  • HEAD _index_template/<name>

  • HEAD <index>/_alias/<alias>

  • 帖子 _ingest/pipeline /_simulate

  • 帖子/_plugins/_flow_framework/workflow/_search

  • 帖子/_plugins/_flow_framework/workflow/state/_search

介绍如何使用别名、索引和框架模板以及管道。有关更多信息，请参阅以下资源：

aoss:UpdateCollectionItems

  • POST <index>/_alias/<alias>

  • POST <index>/_aliases/<alias>

  • POST _component_template/<component-template>

  • POST _index_template/<index-template>

  • <workflow_id>* POST// _plugins/_flow_framework workflow/ /_deprovision

  • PUT <index>/_alias/<alias>

  • PUT <index>/_aliases/<alias>

  • PUT _component_template/<component-template>

  • PUT _index_template/<index-template>

  • PUT/ /workf _plugins/_flow_framework low/ <workflow_id>

 更新别名、索引模板及框架模板。有关更多信息，请参阅以下资源：

* 用于取消预置模板的 API。ML Commons 客户端和 OpenSearch 无服务器服务管理依赖策略。

aoss:DeleteCollectionItems

  • DELETE <index>/_alias/<alias>

  • DELETE _component_template/<component-template>

  • DELETE _index_template/<index-template>

  • DELETE <index>/_aliases/<alias>

  • 删除 _search/pipeline/<pipeline-id>

  • 删除 _ingest/pipeline/<pipeline-id>

  • 删除/ /workfl _plugins/_flow_framework ow/ <workflow_id>

删除别名、索引和框架模板以及管道。有关更多信息，请参阅以下资源：

aoss:DescribeMLResource

  • GET//models_plugins/_ml/<model_id>

  • GET/_plugins_ml/models/_search

  • GET//model_grou _plugins/_ml ps/ <model_group_id>

  • 获取/_plugins/_ml/model_groups/_search

  • GET//connectors_plugins/_ml/<connector_id>

  • 获取/_plugins/_ml/connectors/_search

  • 获取/_plugins/_ml/profile/tasks/<task_id>

  • 帖子/_plugins/_ml/models/_search

  • 帖子/_plugins/_ml/model_groups/_search

  • 帖子/_plugins/_ml/connectors/_search

介绍用于检索模型和连接器相关信息的 GET 及搜索 API。

aoss:CreateMLResource

  • 帖子/_plugins/_ml/models/_register

  • 帖子/_plugins/_ml/model_groups/_register

  • 帖子/_plugins/_ml/connectors/_create

提供创建机器学习资源的权限。

aoss:UpdateMLResource

  • PUT//models_plugins/_ml/<model_id>

  • <model_id>POST//_plugins/_mlmodels/ /_deploy

  • <model_id>POST// _plugins/_ml models/ /_undeploy

  • PUT/ /model_groups_plugins/_ml/<model_group_id>

  • PUT//connectors_plugins/_ml/<connector_id>

提供更新现有机器学习资源的权限。

aoss:DeleteMLResource

  • 删除//models_plugins/_ml/<model_id>

  • 删除 _plugins/_ml /model_groups/ <model_group_id>

  • 删除//connectors_plugins/_ml/<connector_id>

  • 删除/ /tasks_plugins/_ml/<task_id>

提供删除机器学习资源的权限。

aoss:ExecuteMLResource

  • <model_id>POST// _plugins/_ml models/ /_predict

提供运行模型的权限。

支持的 OpenSearch 插件

OpenSearch 无服务器集合预先打包了来自社区的以下插件。 OpenSearch无服务器可为您自动部署和管理插件。

分析插件

映射器插件

脚本插件

  • P@@ ainles s（仅限搜索查询和聚合中的内联脚本；Serverless 不支持存储的脚本和/_scripts端点） OpenSearch

  • 表达式

  • Mustache

此外， OpenSearch Serverless 还包括所有作为模块发布的插件。