Amazon OpenSearch Service 的 API 参考 - Amazon Opensearch Service

Amazon OpenSearch Service 的 API 参考

重要

该参考已于 2022 年 9 月 13 日弃用。我们将不再继续更新或维护此参考。有关支持的 OpenSearch Service 操作和数据类型的最新文档,请参阅全面的 Amazon OpenSearch Service API 参考

本参考介绍了 Amazon OpenSearch Service 配置 API 中的操作、数据类型和错误。配置 API 是您可用于通过 HTTP 创建和配置 OpenSearch Service 域的 REST API。您还可以使用 AWS CLI 和控制台配置 OpenSearch Service 域。有关更多信息,请参阅创建和管理 Amazon OpenSearch Service 服务域

身份验证

所有配置服务请求必须经过签名。有关更多信息,请参阅本指南中的签署 Amazon OpenSearch Service 请求和《AWS 一般参考》中的签名版本 4 签名流程

新的 API 版本和弃用的操作

以下操作在 Amazon OpenSearch Service API 的 2021-01-01 版中被弃用,并替换为更简洁和与引擎无关的终端节点。但 AWS CLI 和配置 API 会继续接受。

已弃用的操作 Replacement
AcceptInboundCrossClusterSearchConnection AcceptInboundConnection
CreateElasticsearchDomain CreateDomain
CreateOutboundCrossClusterSearchConnection CreateOutboundConnection
CreateElasticsearchServiceRole 没有替换。您可以使用 IAM API 创建服务相关角色。
DeleteElasticsearchDomain DeleteDomain
DeleteElasticsearchServiceRole 没有替换。您可以使用 IAM API 删除服务相关角色。
DeleteInboundCrossClusterSearchConnection DeleteInboundConnection
DescribeElasticsearchDomain DescribeDomain
DescribeElasticsearchDomainConfig DescribeDomainConfig
DescribeElasticsearchInstanceTypeLimits DescribeInstanceTypeLimits
DescribeInboundCrossClusterSearchConnections DescribeInboundConnections
DescribeOutboundCrossClusterSearchConnections DescribeOutboundConnections
DescribeReservedElasticsearchInstanceOfferings DescribeReservedInstanceOfferings
DescribeReservedElasticsearchInstances DescribeReservedInstances
GetCompatibleElasticsearchVersions GetCompatibleVersions
ListElasticsearchInstanceTypeDetails ListInstanceTypeDetails
ListElasticsearchVersions ListVersions
PurchaseReservedElasticsearchInstanceOffering PurchaseReservedInstanceOffering
RejectInboundCrossClusterSearchConnection RejectInboundConnection
StartElasticsearchServiceSoftwareUpdate StartServiceSoftwareUpdate
StopElasticsearchServiceSoftwareUpdate StopServiceSoftwareUpdate
UpdateElasticsearchDomainConfig UpdateDomainConfig
UpgradeElasticsearchDomain UpgradeDomain

操作

下表针对 Amazon OpenSearch Service 配置 API 的 REST 接口,提供了每个操作所需的 HTTP 方法的快速参考。每个操作的描述还包括所需的 HTTP 方法。

AcceptInboundConnection

允许目标域所有者接受入站跨集群搜索连接请求。

语法

PUT https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id/accept

请求参数

此操作不使用 HTTP 请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
CrossClusterSearchConnection 对象 入站连接详细信息。

AddTags

将资源标签附加到 OpenSearch Service 域。有关更多信息,请参阅标记 Amazon OpenSearch Service 域

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/tags { "ARN": "domain-arn", "TagList": [{ "Key": "tag-key", "Value": "tag-value" }] }

请求参数

此操作不使用请求参数。

请求正文

参数 数据类型 必填? 描述
TagList TagList 资源标签列表。
ARN ARN 要附加资源标签的 OpenSearch Service 域的 Amazon Resource Name (ARN)。

响应元素

AddTags 操作不返回数据结构。

AssociatePackage

将程序包与 OpenSearch Service 域关联。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/associate/package-id/domain-name

请求参数

参数 数据类型 必填? 描述
PackageID 字符串 要与域关联的程序包的内部 ID。使用 DescribePackages 查找此值。
DomainName DomainName 要与程序包关联的域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型
DomainPackageDetails DomainPackageDetails

CreateDomain

创建 OpenSearch Service 域。有关更多信息,请参阅 创建 OpenSearch Service 域

注意

如果您尝试创建 OpenSearch Service 域,并且已存在具有相同名称的域,则 API 不会报告错误。相反,它会返回现有域的详细信息。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain { "ClusterConfig": { "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true|false, "InstanceCount": 3, "DedicatedMasterEnabled": true|false, "DedicatedMasterType": "c5.large.search", "DedicatedMasterCount": 3, "InstanceType": "r5.large.search", "WarmCount": 3, "WarmEnabled": true|false, "WarmType": "ultrawarm1.large.search", "ColdStorageOptions": { "Enabled": true|false }, "EBSOptions": { "EBSEnabled": true|false, "VolumeType": "gp3|gp2|io1|standard", "VolumeSize": 10, "Iops": 3000, "Throughput": 125 }, "EncryptionAtRestOptions": { "Enabled": true|false, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key" }, "VPCOptions": { "VPCId": "vpc-12345678", "SubnetIds": ["subnet-abcdefg1", "subnet-abcdefg2", "subnet-abcdefg3"], "SecurityGroupIds": ["sg-12345678"] }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true|false", "indices.fielddata.cache.size": "40", "indices.query.bool.max_clause_count": "1024", "override_main_response_version": "true|false" }, "CognitoOptions": { "Enabled": true|false, "UserPoolId": "us-east-1_121234567", "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012", "RoleArn": "arn:aws:iam::123456789012:role/service-role/CognitoAccessForAmazonOpenSearch" }, "NodeToNodeEncryptionOptions": { "Enabled": true|false }, "DomainEndpointOptions": { "EnforceHTTPS": true|false, "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07", "CustomEndpointEnabled": "true|false", "CustomEndpoint": "www.my-custom-endpoint.com", "CustomEndpointCertificateArn": "arn:aws:iam::123456789012:certificate/my-certificate" }, "LogPublishingOptions": { "SEARCH_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group1:sample-domain", "Enabled":true|false }, "INDEX_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group2:sample-domain", "Enabled":true|false }, "ES_APPLICATION_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group3:sample-domain", "Enabled":true|false } }, "AdvancedSecurityOptions": { "Enabled": true|false, "InternalUserDatabaseEnabled": true|false, "MasterUserOptions": { "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role" "MasterUserName": "my-master-username", "MasterUserPassword": "my-master-password" } }, "AutoTuneOptions": { "DesiredState": "ENABLED|DISABLED", "MaintenanceSchedules": [{ "StartAt": 1234567890, "Duration": { "Value": 2, "Unit": "HOURS" }, "CronExpressionForRecurrence": "cron(0 0 ? * 3 *)" }] }, "TagList": [ { "Key": "stack", "Value": "prod" } ], "EngineVersion": "OpenSearch_1.0", "DomainName": "my-domain", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012\"]},\"Action\":[\"esListDomainNames:ESHttp*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}" }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
DomainName DomainName 要创建的 OpenSearch Service 域的名称。
EngineVersion 字符串 打开搜索或弹性搜索的版本,格式为 Elasticsearch_X.Y 或 OpenSearch_x.y。默认为最新版本的 OpenSearch。有关所支持版本的完整列表,请参阅支持的 OpenSearch 和 Elasticsearch 版本
ClusterConfig ClusterConfig OpenSearch Service 域集群配置的容器。
EBSOptions EBSOptions 为 OpenSearch Service 域启用基于 EBS 存储所需的参数的容器。
VPCOptions VPCOptions 配置 VPC 访问域所需的值的容器。如果您不指定这些值,OpenSearch Service 将使用公有终端节点创建域。要了解更多信息,请参阅“在 VPC 中启动您的 Amazon OpenSearch Service 域”。
CognitoOptions CognitoOptions 键-值对,用来配置 OpenSearch Service 以将 Amazon Cognito 身份验证用于 OpenSearch 控制面板。
AccessPolicies 字符串 为新的 OpenSearch 域指定访问策略的 IAM policy 文档。有关更多信息,请参阅Amazon OpenSearch Service 中的 Identity and Access Management
SnapshotOptions SnapshotOptions

已弃用。配置域索引自动快照所需的参数的容器。

AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。有关更多信息,请参阅高级集群设置
LogPublishingOptions LogPublishingOptions 用于配置慢速日志发布的键值对。
EncryptionAtRestOptions EncryptionAtRestOptions 用于至少启用加密的键值对。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 启用节点到节点加密。
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
AdvancedSecurityOptions AdvancedSecurityOptions 用于精细访问控制的选项。
AutoTuneOptions AutoTuneOptions 自动调整选项。
TagList TagList 您希望在创建域时添加到域的标签列表。

响应元素

字段 数据类型
DomainStatus DomainStatus

CreateOutboundConnection

新建从源域到目标域的跨集群搜索连接。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection { "ConnectionAlias":"connection-name", "LocalDomainInfo":{ "AWSDomainInformation":{ "DomainName":"domain-name", "Region":"us-east-1" } }, "RemoteDomainInfo":{ "AWSDomainInformation":{ "OwnerId":"account-id", "DomainName":"domain-name", "Region":"us-east-1" } } }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
ConnectionAlias 字符串 连接的名称。
LocalDomainInfo 对象 源域的名称和区域。
RemoteDomainInfo 对象 目标域的名称和区域。

响应元素

字段 数据类型 描述
SourceDomainInfo 对象 源域的名称和区域。
DestinationDomainInfo 对象 目标域的名称和区域。
ConnectionAlias 字符串 连接的名称。
ConnectionStatus 字符串 连接的状态。
ConnectionId 字符串 出站连接的 ID。

CreatePackage

添加用于 OpenSearch Service 域的程序包。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages { "PackageName": "my-package-name", "PackageType": "TXT-DICTIONARY", "PackageDescription": "My synonym file.", "PackageSource": { "S3BucketName": "my-s3-bucket", "S3Key": "synonyms.txt" } }

请求参数

此操作不使用请求参数。

请求正文

参数 数据类型 必填? 描述
PackageName 字符串 为程序包键入名称。
PackageType 字符串 程序包的类型。目前仅支持 TXT-DICTIONARY
PackageDescription 字符串 程序包的描述。
PackageSource PackageSource 程序包的 S3 存储桶和密钥。

响应元素

字段 数据类型
PackageDetails PackageDetails

CreateElasticsearchServiceRole(已启用)

创建 OpenSearch Service 和 Amazon EC2 之间的服务相关角色。此操作已弃用。OpenSearch Service 会自动处理服务相关角色的创建和删除。

这种角色赋予 OpenSearch Service 权限来将 VPC 终端节点放入 VPC 中。必须存在服务相关角色才能在域中创建 VPC 终端节点或者域才能正常工作。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/role

请求参数

此操作不使用请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

CreateServiceRole 操作不返回数据结构。

DeleteDomain

删除 OpenSearch Service 域及其所有数据。您无法在删除阈后恢复。

语法

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name

请求参数

参数 数据类型 必填? 描述
DomainName DomainName 您要删除的 OpenSearch Service 域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型
DomainStatus DomainStatus

DeleteElasticsearchServiceRole(已弃用)

删除 OpenSearch Service 和 Amazon EC2 之间的服务相关角色。此操作已弃用。OpenSearch Service 会自动处理角色的创建和删除。

这种角色赋予 OpenSearch Service 权限来将 VPC 终端节点放入 VPC 中。必须存在服务相关角色才能在域中创建 VPC 终端节点或者域才能正常工作。

注意

仅当没有任何域在使用服务相关角色时,此操作才会成功。

语法

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/role

请求参数

此操作不使用请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

DeleteElasticsearchServiceRole 操作不返回数据结构。

DeleteInboundConnection

允许目标域所有者删除现有入站跨集群搜索连接。

语法

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id

请求参数

此操作不使用 HTTP 请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
CrossClusterSearchConnection 对象 入站连接详细信息。

DeleteOutboundConnection

允许源域所有者删除现有出站跨集群搜索连接。

语法

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection/connection-id

请求参数

此操作不使用 HTTP 请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
CrossClusterSearchConnection 对象 出站连接详细信息。

DeletePackage

从 OpenSearch Service 中删除程序包。该程序包不能与任何 OpenSearch Service 域关联。

语法

DELETE https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id

请求参数

参数 数据类型 必填? 描述
PackageID 字符串 要删除的程序包的内部 ID。使用 DescribePackages 查找此值。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型
PackageDetails PackageDetails

DescribeDomainAutoTunes

返回自动调整对域进行的优化列表。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/autoTunes

请求参数

参数 数据类型 必填? 描述
DomainName DomainName 您要自动优化详情的 OpenSearch Service 域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
AutoTunes List 优化列表。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

DescribeDomain

描述指定 OpenSearch Service 域的域配置,其中包括域 ID、域服务终端节点和域 ARN。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name

请求参数

参数 数据类型 必填? 描述
DomainName DomainName 您要说明的 OpenSearch Service 域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型
DomainStatus DomainStatus

DescribeDomainChangeProgress

显示域 configuration change(配置更改)的状态信息。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/progress

请求参数

参数 数据类型 必填? 描述
DomainName DomainName OpenSearch Service 域的名称。

请求正文

字段 数据类型 必填? 描述
ChangeId 字符串 配置更改的 ID。已通过 UpdateDomainConfig 请求检索。如果不包括在内,则 OpenSearch Service 将返回最近配置更改的详细信息。

响应元素

字段 数据类型
ChangeProgressStatus ChangeProgressStatus

DescribeDomainConfig

显示一个 OpenSearch Service 域的配置。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/config

请求参数

参数 数据类型 必填? 描述
DomainName DomainName 您要说明的 OpenSearch Service 域配置的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型
DomainConfig DomainConfig

DescribeDomains

描述最多五个指定 OpenSearch Service 域的域配置。其中包括域 ID、域服务终端节点和域 ARN 等信息。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain-info { "DomainNames": [ "domain-name1", "domain-name2", ] }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

字段 数据类型 必填? 描述
DomainNames DomainNameList OpenSearch Service 域名的数组。

响应元素

字段 数据类型
DomainStatusList DomainStatusList

DescribeInstanceTypeLimits

描述给定 OpenSearch 或 Elasticsearch 版本和实例类型的实例计数、存储和主节点限制。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/instanceTypeLimits/engine-version/instance-type?domainName=domain-name

请求参数

参数 数据类型 必填? 描述
EngineVersion 字符串 OpenSearch 或者 Elasticsearch 的版本,格式为 Elasticsearch_X.Y 或 OpenSearch_x.y。默认为最新版本的 OpenSearch。有关支持的版本的完整列表,请参阅 支持的 OpenSearch 和 Elasticsearch 版本 版本。
InstanceType 字符串 实例类型. 要按区域查看实例类型,请参阅 Amazon OpenSearch Service 定价
DomainName DomainName 现有域的名称。仅指定您是否需要针对现有域的限制。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
LimitsByRole 映射 包含所有适用的实例类型限制的映射。"data" 指数据节点。"master" 指专用主节点。

DescribeInboundConnections

列出目标域的所有入站跨集群搜索连接。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/search { "Filters": [ { "Name": filter-name (str), "Values" : [val1, val2, ..] (list of strings) }, .... "MaxResults": int (Optional, default value - 100), "NextToken": "next-token-string (optional)" ] }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
Filters 对象 可用于描述请求的筛选器名称和值的列表。支持以下字段:connection-idlocal-domain-info.domain-namelocal-domain-info.owner-idlocal-domain-info.regionremote-domain-info.domain-name
MaxResults 整数 限制结果数。默认值为 100。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

响应元素

字段 数据类型 描述
CrossClusterSearchConnections 对象 入站连接列表。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

DescribeOutboundConnections

列出源域的所有出站跨集群搜索连接。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/outboundConnection/search { "Filters": [ { "Name": filter-name (str), "Values" : [val1, val2, ..] (list of strings) }, .... "MaxResults": int (Optional, default value - 100), "NextToken": "next-token-string (optional)" ] }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
Filters 对象 可用于描述请求的筛选器名称和值的列表。支持以下字段:connection-idremote-domain-info.domain-nameremote-domain-info.owner-idremote-domain-info.regionlocal-domain-info.domain-name
MaxResults 整数 限制结果数。默认值为 100。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

响应元素

字段 数据类型 描述
CrossClusterSearchConnections 对象 出站连接列表。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

DescribePackages

描述所有可用于 OpenSearch Service 的程序包。包括用于筛选、限制结果数量和分页的选项。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/describe { "Filters": [{ "Name": "PackageStatus", "Value": [ "DELETING", "AVAILABLE" ] }], "MaxResults": 5, "NextToken": "next-token", }

请求参数

此操作不使用请求参数。

请求正文

参数 数据类型 必填? 描述
Filters Filters 仅返回与提供的值匹配的程序包。
MaxResults 整数 将结果限制为最大程序包数。
NextToken 字符串 用于分页。仅当之前的 API 调用包含非 Null NextToken 值时才需要。如果提供,则返回下一页的结果。

响应元素

字段 数据类型 描述
PackageDetailsList List PackageDetails 对象的列表。

DescribeReservedInstanceOfferings

描述给定区域的可用预留实例产品。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/reservedInstanceOfferings?offeringId=offering-id&maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
OfferingId 字符串 产品 ID。
MaxResults 整数 限制结果数。必须介于 30 和 100 之间。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
ReservedInstanceOfferings ReservedInstanceOfferings 有关预留实例产品的所有信息的容器。有关更多信息,请参阅购买预留实例 (AWS CLI)

DescribeReservedInstances

描述在给定区域中预留的实例。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/reservedInstances?reservationId=reservation-id&maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
ReservationId 字符串 购买预留后分配的预留 ID。
MaxResults 整数 限制结果数。必须介于 30 和 100 之间。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
ReservedInstances

ReservedInstance

有关您预留的实例的所有信息的容器。有关更多信息,请参阅购买预留实例 (AWS CLI)

DissociatePackage

从指定的 OpenSearch Service 域中移除程序包。该程序包不能与任何 OpenSearch 索引一起使用,才能成功取消关联。该软件包仍可在 OpenSearch Service 中使用,以便稍后进行关联。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/dissociate/package-id/domain-name

请求参数

参数 数据类型 必填? 描述
PackageID 字符串 要与域取消关联的程序包的内部 ID。使用 ListPackagesForDomain 查找此值。
DomainName DomainName 要与程序包取消关联的域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型
DomainPackageDetails DomainPackageDetails

GetCompatibleVersions

返回 OpenSearch 或者 Elasticsearch 版本和您可以将其升级到的版本的映射图:

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/compatibleVersions?domainName=domain-name

请求参数

参数 数据类型 必填? 描述
DomainName DomainName 现有域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
CompatibleVersions 映射 OpenSearch 或者 Elasticsearch 版本和您可以将其升级到的版本的映射图:
{ "CompatibleVersions": [{ "SourceVersion": "Elasticsearch_7.10", "TargetVersions": ["OpenSearch_1.0"] }] }

GetPackageVersionHistory

返回 OpenSearch 版本和您可以将其升级到的版本的映射图。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id/history?maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
PackageID 字符串 现有域的名称。
MaxResults 整数 限制结果数。必须介于 30 和 100 之间。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
PackageVersionHistoryList 映射 提交消息、更新 tmies 和给定软件包版本的列表:
"PackageVersionHistoryList": [ { CommitMessage": "Add new synonyms", "CreatedAt": 1.605225005466E9, "PackageVersion": "v4" } ]

GetUpgradeHistory

返回域的 10 个最近的升级操作的列表。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain/domain-name/history?maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
MaxResults 整数 限制结果数。必须介于 30 和 100 之间。
DomainName DomainName 现有域的名称。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
UpgradeHistoryList UpgradeHistoryList 过去的 10 个升级操作的结果日志的容器。

GetUpgradeStatus

返回域的 OpenSearch 或者 Elasticsearch 版本升级的最新状态。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain/domain-name/status

请求参数

参数 数据类型 必填? 描述
DomainName DomainName 现有域的名称。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
UpgradeStepItem UpgradeStepItem 域的版本升级的最新状态的容器。

ListDomainNames

显示当前用户在活动区域中拥有的所有 OpenSearch Service 域的名称。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/domain

请求参数

字段 数据类型 必填? 描述
EngineType 字符串 按域引擎类型筛选输出。可接受的值为 ElasticsearchOpenSearch

此操作不使用请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
DomainNameList DomainNameList 当前用户拥有的所有 OpenSearch Service 域的名称。

ListDomainsForPackage

列出与程序包关联的所有 OpenSearch Service 域。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/packages/package-id/domains?maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
PackageID 字符串 要列出其域的程序包。
MaxResults 整数 限制结果数。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
DomainPackageDetailsList List DomainPackageDetails 对象的列表。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

ListVersions

在 OpenSearch Service 上列出所有支持的 OpenSearch 和 Elasticsearch 版本。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/versions?maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
MaxResults 整数 限制结果数。必须介于 30 和 100 之间。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

ListInstanceTypeDetails

列出给定 OpenSearch 或 Elasticsearch 版本中的所有实例类型和可用功能。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/instanceTypeDetails/engine-version?domainName=domain-name?maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
EngineVersion 字符串 打开搜索或弹性搜索的版本,格式为 Elasticsearch_X.Y 或 OpenSearch_x.y。默认为最新版本的 OpenSearch。有关所支持版本的完整列表,请参阅支持的 OpenSearch 和 Elasticsearch 版本
DomainName DomainName 想要列出其实例类型详细信息的域的名称。

MaxResults

整数

限制结果数。必须介于 30 和 100 之间。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
InstanceTypeDetails List 列出给定 OpenSearch 或 Elasticsearch 版本中的所有受支持的实例类型和功能。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

ListPackagesForDomain

列出与 OpenSearch Service 域关联的所有程序包。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/domain/domain-name/packages?maxResults=max-results&nextToken=next-token

请求参数

参数 数据类型 必填? 描述
DomainName 字符串 要列出其关联程序包的域名。
MaxResults 整数 限制结果数。
NextToken 字符串 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
DomainPackageDetailsList List DomainPackageDetails 对象的列表。
NextToken String 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。接受用于为下一个页面返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

ListTags

显示一个 OpenSearch Service 域的所有资源标签。

语法

GET https://es.us-east-1.amazonaws.com/2021-01-01/tags?arn=domain-arn

请求参数

参数 数据类型 必填? 描述
ARN ARN OpenSearch Service 域的 Amazon Resource Name(ARN)。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
TagList TagList 资源标签列表。有关更多信息,请参阅标记 Amazon OpenSearch Service 域

PurchaseReservedInstanceOffering

购买预留实例。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/purchaseReservedInstanceOffering { "ReservationName" : "my-reservation", "ReservedInstanceOfferingId" : "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a", "InstanceCount" : 3 }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

名称 数据类型 必填? 描述
ReservationName 字符串 预留的描述性名称。长度必须介于 5-64 个字符之间
ReservedInstanceOfferingId 字符串 产品 ID。
InstanceCount 整数 要预留的实例的数量。

响应元素

字段 数据类型 描述
ReservationName 字符串 预留的名称。
ReservedInstanceId 字符串 预留 ID。

RejectInboundConnection

允许目标域所有者拒绝入站跨集群搜索连接请求。

语法

PUT https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/cc/inboundConnection/connection-id/reject

请求参数

此操作不使用 HTTP 请求参数。

请求正文

此操作不使用 HTTP 请求正文。

响应元素

字段 数据类型 描述
CrossClusterSearchConnection 对象 入站连接详细信息。

RemoveTags

从 OpenSearch Service 域中移除指定的资源标签。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/tags-removal { "ARN": "arn:aws:es:us-east-1:123456789012:domain/my-domain", "TagKeys": [ "tag-key1", "tag-key2" ] }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
ARN ARN OpenSearch Service 域的 Amazon Resource Name(ARN)。有关更多信息,请参阅 AWS Identity and Access Management 用户指南 中的 IAM 标识符
TagKeys TagKey 您想从 OpenSearch Service 域移除的资源标签的标签键列表。

响应元素

RemoveTags 操作不返回响应元素。

StartServiceSoftwareUpdate

为 OpenSearch Service 域计划服务软件更新。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/serviceSoftwareUpdate/start { "DomainName": "domain-name" }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
DomainName DomainName 要更新到最新服务软件的 OpenSearch Service 域的名称。

响应元素

字段 数据类型 描述
ServiceSoftwareOptions ServiceSoftwareOptions 与最新服务软件相关的域的状态容器。

CancelServiceSoftwareUpdate

为 OpenSearch Service 域停用计划的服务软件更新。仅在域的 UpdateStatusPENDING_UPDATE 时起作用。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/serviceSoftwareUpdate/stop { "DomainName": "domain-name" }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
DomainName DomainName 要更新到最新服务软件的 OpenSearch Service 域的名称。

响应元素

字段 数据类型 描述
ServiceSoftwareOptions ServiceSoftwareOptions 与最新服务软件相关的域的状态容器。

UpdateDomainConfig

修改 OpenSearch Service 域的配置,例如实例类型和实例数量。您只需指定要更新的值。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/domain/domain-name/config { "ClusterConfig": { "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true|false, "InstanceCount": 3, "DedicatedMasterEnabled": true|false, "DedicatedMasterType": "c5.large.search", "DedicatedMasterCount": 3, "InstanceType": "r5.large.search", "WarmCount": 6, "WarmType": "ultrawarm1.medium.search", "ColdStorageOptions": { "Enabled": true|false }, "EBSOptions": { "EBSEnabled": true|false, "VolumeType": "gp3|gp2|io1|standard", "VolumeSize": 35, "Iops": 3000, "Throughput": 125 }, "SnapshotOptions": { "AutomatedSnapshotStartHour": 3 }, "EncryptionAtRestOptions": { "Enabled": true|false, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key" }, "NodeToNodeEncryptionOptions": { "Enabled": true|false }, "VPCOptions": { "SubnetIds": ["subnet-abcdefg1", "subnet-abcdefg2", "subnet-abcdefg3"], "SecurityGroupIds": ["sg-12345678"] }, "AdvancedOptions": { "rest.action.multi.allow_explicit_index": "true|false", "indices.fielddata.cache.size": "40", "indices.query.bool.max_clause_count": "1024", "override_main_response_version": "true|false" }, "CognitoOptions": { "Enabled": true|false, "UserPoolId": "us-east-1_121234567", "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012", "RoleArn": "arn:aws:iam::123456789012:role/service-role/CognitoAccessForAmazonOpenSearch" }, "DomainEndpointOptions": { "EnforceHTTPS": true|false, "TLSSecurityPolicy": "Policy-Min-TLS-1-2-2019-07|Policy-Min-TLS-1-0-2019-07", "CustomEndpointEnabled": "true|false", "CustomEndpoint": "www.my-custom-endpoint.com", "CustomEndpointCertificateArn": "arn:aws:iam::123456789012:certificate/my-certificate" }, "LogPublishingOptions": { "SEARCH_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group1:sample-domain", "Enabled":true|false }, "INDEX_SLOW_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group2:sample-domain", "Enabled":true|false }, "ES_APPLICATION_LOGS": { "CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group3:sample-domain", "Enabled":true|false } }, "AdvancedSecurityOptions": { "Enabled": true|false, "InternalUserDatabaseEnabled": true|false, "AnonymousAuthEnabled": true|false, "AnonymousAuthDisableDate": 1234567890, "MasterUserOptions": { "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role" "MasterUserName": "my-master-username", "MasterUserPassword": "my-master-password" }, "SAMLOptions": { "Enabled": true, "Idp": { "EntityId": "entity-id", "MetadataContent": "metadata-content-with-quotes-escaped" }, "RolesKey": "optional-roles-key", "SessionTimeoutMinutes": 180, "SubjectKey": "optional-subject-key" } }, "AutoTuneOptions": { "DesiredState": "ENABLED|DISABLED", "MaintenanceSchedules": [{ "StartAt": 1234567890, "Duration": { "Value": 2, "Unit": "HOURS" }, "CronExpressionForRecurrence": "cron(0 0 ? * 3 *)" }], "RollbackOnDisable": "NO_ROLLBACK|DEFAULT_ROLLBACK" }, "DomainName": "my-domain", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"*\"]},\"Action\":[\"es:*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}", "DryRun": true|false }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
DomainName DomainName 您要更新配置的 OpenSearch Service 域的名称。
ClusterConfig ClusterConfig 您想要对集群配置进行的更改,例如实例类型和 EC2 实例计数。
EBSOptions EBSOptions 附加到数据节点的 EBS 卷的类型和大小。
VPCOptions VPCOptions 配置 OpenSearch Service 以便与 VPC 配合使用所需的值的容器。要了解更多信息,请参阅“在 VPC 中启动您的 Amazon OpenSearch Service 域”。
SnapshotOptions SnapshotOptions 已弃用。服务为 OpenSearch Service 域中的索引创建每日自动快照的时间。
AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。有关更多信息,请参阅高级集群设置
AccessPolicies 字符串 指定 OpenSearch Service 域的访问策略。有关更多信息,请参阅配置访问策略
LogPublishingOptions LogPublishingOptions 键/值字符串配对以配置慢速日志发布。
CognitoOptions CognitoOptions 键-值对,用来配置 OpenSearch Service 以将 Amazon Cognito 身份验证用于 OpenSearch 控制面板。
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
AdvancedSecurityOptions AdvancedSecurityOptions 用于精细访问控制的选项。
AutoTuneOptions AutoTuneOptions 自动调整选项。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 启用节点到节点加密。
EncryptionAtRestOptions EncryptionAtRestOptions 用于至少启用加密的键值对。
DryRun 布尔值 默认值为 false。如果为 true,则 OpenSearch Service 会检查配置更改是否会导致蓝/绿部署,但不会执行更新。

响应元素

字段 数据类型
DomainConfig DomainConfig
DryRunResults DryRunResults

UpdatePackage

更新用于 OpenSearch Service 域的程序包。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/packages/update { "PackageID": "F11111111", "PackageDescription": "My synonym file.", "CommitMessage": "Added some synonyms.", "PackageSource": { "S3BucketName": "my-s3-bucket", "S3Key": "synonyms.txt" } }

请求参数

此操作不使用请求参数。

请求正文

参数 数据类型 必填? 描述
PackageID 字符串 程序包的唯一 ID。
PackageDescription 字符串 程序包的描述。
CommitMessage 字符串 已更新文件的提交消息。
PackageSource PackageSource 程序包的 S3 存储桶和密钥。

响应元素

字段 数据类型
PackageDetails PackageDetails

UpgradeDomain

将 OpenSearch Service 域升级到新版本的 OpenSearch 或 Elasticsearch。或者,也可以检查升级资格。

语法

POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain { "DomainName": "domain-name", "TargetVersion": "OpenSearch_1.0", "PerformCheckOnly": true|false }

请求参数

此操作不使用 HTTP 请求参数。

请求正文

参数 数据类型 必填? 描述
DomainName 字符串 您要升级的 OpenSearch Service 域的名称。
TargetVersion 字符串 要升级到的 OpenSearch 或 Elasticsearch 版本,格式为 Opensearch_X.Y 或 Elasticsearch_X.Y.,请参阅 GetCompatibleVersions
PerformCheckOnly 布尔值 默认值为 false。如果为 true,OpenSearch Service 会检查域的资格,但不执行升级。

AdvancedOptions

AdvancedOptions 仅支持 override_main_response_version 参数而不是其他高级选项。只有在升级到 OpenSearch 版本时才能包含此选项。指定域是否将其版本报告为 7.10,以便它继续使用 Elasticsearch OSS 客户端和插件。

响应元素

字段 数据类型 描述
UpgradeDomainResponse 映射 确认操作详细信息的基本响应。

数据类型

本部分描述配置 API 使用的数据类型。

AdvancedOptions

用于指定高级 OpenSearch 配置选项的键值对。

字段 数据类型 描述
rest.action.multi.allow_explicit_index 键值对:

"rest.action.multi.allow_explicit_index":"true"

请注意使用字符串而不是布尔值。指定是否允许在 HTTP 请求正文中显式引用索引。如果您要为域子资源 (例如特定的索引和域 API) 配置访问策略,则必须禁用此属性。有关子资源访问策略的更多信息,请参阅 配置访问策略
indices.fielddata.cache.size 键值对:

"indices.fielddata.cache.size":"80"

请注意使用字符串而不是整数。指定分配到字段数据的 Java 堆空间的百分比。默认情况下,此设置是无界的。
indices.query.bool.max_clause_count 键值对:

"indices.query.bool.max_clause_count":"1024"

请注意使用字符串而不是整数。指定 Lucene 布尔查询中允许的子句的最大数量。1,024 为默认值。如果查询具有的子句数超过了允许的子句数,则会导致 TooManyClauses 错误。要了解更多信息,请参阅 Lucene 文档
override_main_response_version 键值对:

"override_main_response_version":"true"

请注意使用字符串而不是布尔值。指定域是否将其版本报告为 7.10,以允许 Elasticsearch OSS 客户端和插件继续使用它。仅当创建 OpenSearch 域或从 Elasticsearch OSS 版本升级到 OpenSearch 时才相关。当创建域时原定设置为 false,升级域时原定设置为 true

AdvancedSecurityOptions

字段 数据类型 描述
Enabled 布尔值 为 true,则启用精细访问控制
AnonymousAuthEnabled 布尔值 True 表示启用 30 天迁移期,管理员在此期间可以创建角色映射。只有在必要时才在现有域上启用精细访问控制
AnonymousAuthDisableDate 时间戳 禁用迁移期的日期和时间。
InternalUserDatabaseEnabled 布尔值 为 true,则启用内部用户数据库。
MasterUserOptions MasterUserOptions 有关主用户的信息的容器。
SAMLOptions SAMLOptions 有关 OpenSearch 仪表板的 SAML 配置信息的容器。

ARN

字段 数据类型 描述
ARN 字符串 OpenSearch Service 域的 Amazon Resource Name(ARN)。有关更多信息,请参阅 AWS Identity and Access Management 用户指南中的 IAM ARN

AutoTuneOptions

字段 数据类型 描述
DesiredState 字符串 ENABLEDDISABLED
MaintenanceSchedules List

自动调整可以部署更改的维护计划列表:

{ "StartAt": 1234567890, "Duration": { "Value": 2, "Unit": "HOURS" }, "CronExpressionForRecurrence": "cron(* * ? * * *)" }

维护计划将被覆盖,而不是追加。如果您的请求不包含任何计划,请求将删除所有现有计划。要保留现有计划,请调用 DescribeDomainConfig,然后使用 MaintenanceSchedules 部分的响应作为本节的基础。

StartAt 是纪元时间,Value 是一个长整数。

RollbackOnDisable 字符串 禁用“自动调整”时,请指定 NO_ROLLBACK 以保留所有先前的自动调整设置,或 DEFAULT_ROLLBACK 恢复为 OpenSearch Service 原定设置。

如果指定默认值返回,则必须将 MaintenanceSchedule 包含在请求中。否则,OpenSearch Service 将无法执行回滚。

ChangeProgressDetails

有关域上发生的配置更改的信息容器。

字段 数据类型 描述
ChangeId 字符串 配置更改的 ID。
Message 字符串 与配置更改的状态对应的消息。

ChangeProgressStatus

有关域上发生的配置更改阶段的信息容器。

字段 数据类型 描述
ChangeId 字符串 配置更改的 ID。
ChangeProgressStages 对象 更新过程的每个阶段的进度详细信息。每个阶段均包括 DescriptionLastUpdatedNameStatus 字段。
CompletedProperties StringList 已更新的域属性的列表。
PendingProperties StringList 仍需更新的域属性的列表。
StartTime 时间戳 开始配置更改的日期和时间。
Status 字符串 当前的配置更改状态。
TotalNumberOfStages 整数 要完成配置更改所需的阶段总数。

ClusterConfig

OpenSearch Service 域集群配置的容器。

字段 数据类型 描述
InstanceType 字符串 群集中的数据节点的实例类型。
InstanceCount 整数 群集中的实例数量。
DedicatedMasterEnabled 布尔值 指示是否已为集群启用专用主节点。如果集群将使用专用主节点,则为 True,否则为 False。有关更多信息,请参阅Amazon OpenSearch Service 中的专用主节点
DedicatedMasterType 字符串 集群中的专用主节点的 OpenSearch Service 实例类型。
DedicatedMasterCount 整数 群集中专用主节点的数量。此数字必须大于 1,否则您会收到验证例外。
ZoneAwarenessEnabled 布尔值 指示是否已启用多个可用区。有关更多信息,请参阅在 Amazon OpenSearch Service 中配置多 AZ 域
ZoneAwarenessConfig ZoneAwarenessConfig 区域感知配置选项的容器。仅当 ZoneAwarenessEnabledtrue 时必需。
WarmEnabled 布尔值 是否为集群启用温存储。
WarmCount 整数 集群中的温节点数。
WarmType 字符串 集群的温节点的实例类型。
WarmStorage 整数 预配置的温存储总量(以 GiB 为单位)。
ColdStorageOptions ColdStorageOptions 冷存配置选项的容器。

CognitoOptions

字段 数据类型 描述
Enabled 布尔值 为 OpenSearch 控制面板启用还是禁用 Amazon Cognito 身份验证。请参阅为 OpenSearch 控制面板配置 Amazon Cognito 认证
UserPoolId 字符串 您希望 OpenSearch Service 在进行 OpenSearch 控制面板身份验证时使用的 Amazon Cognito 用户池 ID。
IdentityPoolId 字符串 您希望 OpenSearch Service 用于 OpenSearch 控制面板身份验证的 Amazon Cognito 身份池 ID。
RoleArn 字符串 允许 OpenSearch Service 配置您的用户池和身份池的 AmazonOpenSearchServiceCognitoAccess 角色。

ColdStorageOptions

为 OpenSearch Service 域启用冷存储所需的参数的容器。

字段 数据类型 描述
Enabled 布尔值 是在域上启用还是禁用冷存储。请参阅用于 Amazon OpenSearch Service 的冷藏库

CreateDomainRequest

CreateDomain 服务操作所需的参数的容器。

字段 数据类型 描述
DomainName DomainName 要创建的 OpenSearch Service 域的名称。
ClusterConfig ClusterConfig OpenSearch Service 域集群配置的容器。
EBSOptions EBSOptions 为 OpenSearch Service 域启用基于 EBS 存储所需的参数的容器。
AccessPolicies 字符串 为新的 OpenSearch 域指定访问策略的 IAM policy 文档。有关更多信息,请参阅配置访问策略
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
SnapshotOptions SnapshotOptions 已弃用。配置域索引自动快照所需的参数的容器。
VPCOptions VPCOptions 配置 OpenSearch Service 以便与 VPC 配合使用所需的值的容器。
LogPublishingOptions LogPublishingOptions 键/值字符串配对以配置慢速日志发布。
AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。
CognitoOptions CognitoOptions 键-值对,用来配置 OpenSearch Service 以将 Amazon Cognito 身份验证用于 OpenSearch 控制面板。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 指定 true 以启用节点到节点加密。

DomainEndpointOptions

字段 数据类型 描述
EnforceHTTPS 布尔值 如果为 true,则要求域的所有流量都通过 HTTPS 到达。
TLSSecurityPolicy 字符串 域的流量所需的最低 TLS 版本。有效值为 TLS 1.0(默认值)或 1.2:
  • Policy-Min-TLS-1-0-2019-07

  • Policy-Min-TLS-1-2-2019-07

CustomEndpointEnabled 布尔值 是否为域启用自定义终端节点。
CustomEndpoint 字符串 自定义终端节点的完全限定 URL。
CustomEndpointCertificateArn 字符串 在 ACM 中管理的安全证书的 ARN。

DomainID

数据类型 描述
字符串 OpenSearch Service 域的唯一标识符。

DomainName

OpenSearch Service 域名。

数据类型 描述
字符串 OpenSearch Service 域名。域名在一个 AWS 区域 内相同账户拥有的所有域中是唯一的。域名必须以小写字母开头,且必须包含 3 到 28 个字符。有效的字符包括 a-z (仅小写字母)、0-9 和 – (连字符)。

DomainNameList

OpenSearch Service 域名的字符串。

数据类型 描述
字符串数组 OpenSearch Service 域的数组,采用以下格式:

["<Domain_Name>","<Domain_Name>"...]

DomainPackageDetails

与域关联的程序包相关的信息。

字段 数据类型 描述
DomainName 字符串 已关联程序包的域的名称。
DomainPackageStatus 字符串 关联的状态。值为 ASSOCIATINGASSOCIATION_FAILEDACTIVEDISSOCIATINGDISSOCIATION_FAILED
ErrorDetails 字符串 程序包处于错误状态时的其他信息。否则为 Null。
LastUpdated 时间戳 关联状态的最近更新的时间戳。
PackageID 字符串 程序包的内部 ID。
PackageName 字符串 用户指定的程序包名称。
PackageType 字符串 目前仅支持 TXT-DICTIONARY
ReferencePath 字符串 指示程序包在 OpenSearch Service 集群节点上的位置。这与字典文件的 synonym_path 相同。

DomainConfig

OpenSearch Service 域配置的容器。

字段 数据类型 描述
EngineVersion 字符串 OpenSearch 或 Elasticsearch 版本。
ClusterConfig ClusterConfig OpenSearch Service 域集群配置的容器。
EBSOptions EBSOptions 为 OpenSearch Service 域配置的 EBS 选项的容器。
AccessPolicies 字符串 指定 OpenSearch Service 域的访问策略。有关更多信息,请参阅配置访问策略
SnapshotOptions SnapshotOptions 已弃用。配置域索引自动快照所需的参数的容器。
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
VPCOptions VPCDerivedInfo 域的当前 VPCOptions 以及其配置的任何更新状态。
LogPublishingOptions LogPublishingOptions 用于配置慢速日志发布的键值对。
AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。
EncryptionAtRestOptions EncryptionAtRestOptions 用于至少启用加密的键值对。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 启用还是禁用节点到节点加密。
ChangeProgressDetails ChangeProgressDetails 有关配置更改进度的信息容器。

DomainStatus

DomainStatus 数据结构中的内容的容器。

字段 数据类型 描述
DomainID DomainID OpenSearch Service 域的唯一标识符。
DomainName DomainName OpenSearch Service 域名。域名在一个 AWS 区域 内相同账户拥有的所有域中是唯一的。域名必须以小写字母开头,且必须包含 3 到 28 个字符。有效的字符包括 a-z (仅小写字母)、0-9 和 – (连字符)。
ARN ARN OpenSearch Service 域的 Amazon Resource Name(ARN)。有关更多信息,请参阅 AWS Identity and Access Management 用户指南 中的 IAM 标识符
Created 布尔值 OpenSearch Service 域创建的状态。如果域创建已完成,则为 True。如果域创建仍在进行中,则为 False
Deleted 布尔值 OpenSearch Service 域删除的状态。如果域删除已完成,则为 True。如果域删除仍在进行中,则为 False
Endpoint ServiceUrl 用于向 OpenSearch Service 域提交索引、搜索和数据上传请求的特定于域的终端节点。
Endpoints EndpointsMap 当 OpenSearch Service 域使用 VPC 终端节点时存在的键值对。
Processing 布尔值 OpenSearch Service 域配置更改的状态。如果服务仍在处理配置更改,则为 True。如果配置更改处于活动状态,则为 False。您必须等待域达到活动状态才能提交索引、搜索和数据上传请求。
EngineVersion 字符串 OpenSearch 或 Elasticsearch 版本。
ClusterConfig ClusterConfig OpenSearch Service 域集群配置的容器。
EBSOptions EBSOptions 为 OpenSearch Service 域启用基于 EBS 存储所需的参数的容器。
AccessPolicies 字符串 为新的 OpenSearch 域指定访问策略的 IAM policy 文档。有关更多信息,请参阅配置访问策略
SnapshotOptions SnapshotOptions 已弃用。配置创建 OpenSearch Service 域索引的每日自动快照时间所需的参数的容器。
VPCOptions VPCDerivedInfo OpenSearch Service 基于域的 VPCOptions 派生的信息。
LogPublishingOptions LogPublishingOptions 用于配置慢速日志发布的键值对。
AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。
EncryptionAtRestOptions EncryptionAtRestOptions 用于至少启用加密的键值对。
CognitoOptions CognitoOptions 键-值对,用来配置 OpenSearch Service 以将 Amazon Cognito 身份验证用于 OpenSearch 控制面板。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 启用还是禁用节点到节点加密。
UpgradeProcessing 布尔值 如果正在升级到新的 OpenSearch 或者 Elasticsearch 版本,则为 true。
ServiceSoftwareOptions ServiceSoftwareOptions 域的服务软件的状态。

DomainStatusList

包含每个指定的 OpenSearch Service 域状态的列表。

字段 数据类型 描述
DomainStatusList DomainStatus 包含每个指定的 OpenSearch Service 域状态的列表。

DryRunResults

在更新域请求中执行的试运行的结果。

字段 数据类型 描述
DeploymentType 字符串 UpdateDomainConfig 操作中执行的试运行的结果。描述更新将会导发的部署类型。四个值之一:
  • 蓝/绿

  • DynamicUpdate

  • 未确定

  • None(无)

Message 字符串

与部署类型对应的消息。

EBSOptions

为 OpenSearch Service 域启用基于 EBS 存储所需的参数的容器。

字段 数据类型 描述
EBSEnabled 布尔值 指定 EBS 卷是否附加到 OpenSearch Service 域中的数据节点。
VolumeType 字符串 指定附加到数据节点的 EBS 卷的类型。选项包括 gp3gp2io1standard(磁介质)。
VolumeSize 字符串 指定附加到数据节点的 EBS 卷的大小(以 GiB 为单位)。
Iops 字符串 指定附加到数据节点的 EBS 卷的基准输入/输出 (I/O) 性能。仅适用于 gp3 和预调配 IOPS EBS 卷类型。
Throughput 字符串 指定挂载到数据节点的 EBS 卷的吞吐量(以 MiB/s 为单位)。仅适用于gp3 卷类型。

EncryptionAtRestOptions

指定域是否应加密静态数据,如果应加密,则使用 AWS Key Management Service (KMS) 密钥。只能用于创建新域,而不能用于更新现有域。要了解更多信息,请参阅“启用静态数据加密”。

字段 数据类型 描述
Enabled 布尔值 指定 true 以启用静态加密。
KmsKeyId 字符串 KMS 密钥 ID。采用形式 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a

EndpointsMap

包含 VPC 终端节点的键–值对。仅当 OpenSearch Service 域位于 VPC 中时才存在。

字段 数据类型 描述
Endpoints 键-值字符串对:"vpc": "<VPC_ENDPOINT>" 域的 VPC 终端节点。

Filters

筛选 DescribePackages响应中包含的程序包。

字段 数据类型 描述
Name 字符串 来自 PackageDetails的任何字段。
Value List 指定字段的值列表。

LogPublishingOptions

指定 OpenSearch Service 域是否将 OpenSearch 应用程序和慢速日志发布到 Amazon CloudWatch。您仍然必须使用 OpenSearch REST API 来启用慢速日志收集。要了解更多信息,请参阅“为慢速日志设置 OpenSearch 日志记录阈值”。

字段 数据类型 描述
INDEX_SLOW_LOGS 键/值

两个键-值对,用于定义 CloudWatch 日志组,以及 OpenSearch 索引慢速日志是否应该发布到该处:

"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
SEARCH_SLOW_LOGS 键/值

两个键-值对,用于定义 CloudWatch 日志组,以及 OpenSearch 搜索慢速日志是否应该发布到该处:

"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true
ES_APPLICATION_LOGS 键/值 两个键-值对,用于定义 CloudWatch 日志组,以及 OpenSearch 错误日志是否应该发布到该处:
"CloudWatchLogsLogGroupArn":"arn:aws:logs:us-east-1:264071961897:log-group:sample-domain", "Enabled":true

MasterUserOptions

字段 数据类型 描述
MasterUserARN 字符串 主用户的 ARN。仅指定 InternalUserDatabaseEnabledAdvancedSecurityOptions中是否为 false
MasterUserName 字符串 主用户的用户名。仅指定 InternalUserDatabaseEnabledAdvancedSecurityOptions中是否为 true
MasterUserPassword 字符串 主用户的密码。仅指定 InternalUserDatabaseEnabledAdvancedSecurityOptions中是否为 true

NodeToNodeEncryptionOptions

启用或禁用节点到节点加密。

字段 数据类型 描述
Enabled 布尔值 启用,结果为 true

OptionState

OpenSearch Service 域高级选项的更新状态。

字段 数据类型 描述
OptionStatus 字符串 三个有效值之一:
  • RequiresIndexDocuments

  • 处理

  • 处于活动状态

OptionStatus

OpenSearch Service 域的配置选项的更新状态。

字段 数据类型 描述
CreationDate 时间戳 创建 OpenSearch Service 域时的日期和时间。
UpdateDate 时间戳 更新 OpenSearch Service 域时的日期和时间。
UpdateVersion 整数 用于指定实体的最新版本的整数。
State OptionState OpenSearch Service 域的配置选项的更新状态。
PendingDeletion 布尔值 指示服务是否正在处理永久删除 OpenSearch Service 域及其所有资源的请求。

PackageDetails

有关程序包的基本信息。

字段 数据类型 描述
CreatedAt 时间戳 创建软件包的时间。
ErrorDetails 字符串 程序包处于错误状态时的其他信息。否则为 Null。
PackageDescription 字符串 用户指定的程序包描述。
PackageID 字符串 程序包的内部 ID。
PackageName 字符串 用户指定的程序包名称。
PackageStatus 字符串 值为 COPYINGCOPY_FAILEDAVAILABLEDELETINGDELETE_FAILED
PackageType 字符串 目前仅支持 TXT-DICTIONARY

PackageSource

要添加到 OpenSearch Service 的程序包的存储桶和密钥。

字段 数据类型 描述
S3BucketName 字符串 包含程序包的存储桶的名称。
S3Key 字符串 程序包的密钥(文件名)。

SAMLOptions

字段 数据类型 描述
Enabled 布尔值 是否启用面向控制面板的 SAML 身份验证。
MasterUserName 字符串 SAML IdP 中的此用户名将获得对群集的完全权限,等同于新建主用户
MasterBackendRole 字符串 SAML IdP 中的此后端角色将获得对群集的完全权限,等同于新建主用户
Idp 对象

您的身份提供商提供的信息的容器。包含两个元素:

"Idp": { "EntityId": "entity-id", "MetadataContent": "metadata-content-with-quotes-escaped" }
RolesKey 字符串 用于后端角色的 SAML 断言的元素。默认为 roles
SubjectKey 字符串 用于用户名的 SAML 断言的元素。默认为 NameID
SessionTimeoutMinutes 整数 用户登录后的会话持续时间(分钟)。默认值为 60。最长值为 1,440(24 小时)。

ServiceSoftwareOptions

与最新服务软件相关的域的状态容器。

字段 数据类型 描述
UpdateAvailable 布尔值 服务软件更新是否可用于您的域。
Cancellable 布尔值 如果您请求了域更新,您是否可以取消该更新。
AutomatedUpdateDate 时间戳 部署窗口进行所需更新而关闭的纪元时间。在此时间之后,OpenSearch Service 将自动计划软件升级。
UpdateStatus 字符串 更新的状态。值为 ELIGIBLEPENDING_UPDATEIN_PROGRESSCOMPLETEDNOT_ELIGIBLE
Description 字符串 状态的更详细描述。
CurrentVersion 字符串 您的当前服务软件版本。
NewVersion 字符串 最新服务软件版本。
OptionalDeployment 布尔值 服务软件更新是否为可选的。

ServiceURL

用于向 OpenSearch Service 域提交索引、搜索和数据上传请求的特定于域的终端节点。

字段 数据类型 描述
ServiceURL 字符串 用于向 OpenSearch Service 域提交索引、搜索和数据上传请求的特定于域的终端节点。

SnapshotOptions

已弃用。请参阅在 Amazon OpenSearch Service 中创建索引快照。配置创建 OpenSearch Service 域索引的每日自动快照时间所需的参数的容器。

字段 数据类型 描述
AutomatedSnapshotStartHour 整数 已弃用。服务为 OpenSearch Service 域中的索引创建每日自动快照的时间。

标签

字段 数据类型 描述
Key TagKey 标签的必填名称。标签键在其附加的 OpenSearch Service 域中必须是唯一的。有关更多信息,请参阅标记 Amazon OpenSearch Service 域
Value TagValue 标签的可选字符串值。标签值可为 null,且在标签集中不必具有唯一性。例如,在“项目/Trinity”和“成本 - 中心/Trinity”的一个标签集中,可以存在键值对。

TagKey

字段 数据类型 描述
Key 字符串 标签的名称。字符串最多可包含 128 个字符。

TagList

字段 数据类型 描述
Tag Tag 附加到 OpenSearch Service 域的资源标签。

TagValue

字段 数据类型 描述
Value 字符串 保存 TagKey 的值。字符串最多可包含 256 个字符。

VPCDerivedInfo

字段 数据类型 描述
VPCId 字符串 您的 VPC 的 ID。当您创建 VPC 时,Amazon VPC 生成此值。
SubnetIds StringList 与域的 VPC 终端节点关联的子网 ID 列表。有关更多信息,请参阅 Amazon VPC 用户指南中的 VPC 和子网
AvailabilityZones StringList 与 VPC 子网关联的可用区列表。有关更多信息,请参阅 Amazon VPC 用户指南 中的 VPC 和子网基础知识
SecurityGroupIds StringList 与域的 VPC 终端节点关联的安全组 ID 列表。有关更多信息,请参阅 Amazon VPC 用户指南中的您的 VPC 的安全组

VPCOptions

字段 数据类型 描述
SubnetIds StringList 与域的 VPC 终端节点关联的子网 ID 列表。如果您的域使用多个可用区,则您需要提供两个子网 ID,每个区域一个。否则,只需提供一个。要了解更多信息,请参阅 Amazon VPC 用户指南中的 VPC 和子网
SecurityGroupIds StringList 与域的 VPC 终端节点关联的安全组 ID 列表。如果不提供安全组 ID,OpenSearch Service 将使用 VPC 的默认安全组。要了解更多信息,请参阅 Amazon VPC 用户指南中的您的 VPC 的安全组
VPCId 字符串 VPC 的 ID。

ZoneAwarenessConfig

字段 数据类型 描述
AvailabilityZoneCount 整数 如果您启用了多个可用区,此字段是您希望域使用的可用区数量。有效值为 23

错误

OpenSearch Service 会引发以下错误:

例外 描述
BaseException 由所有服务错误引发。包含错误的 HTTP 状态代码。
ValidationException 在 HTTP 请求包含无效输入或缺少必需的输入时引发。返回 HTTP 状态代码 400。
DisabledOperationException 在客户端尝试执行不支持的操作时引发。返回 HTTP 状态代码 409。
InternalException 处理请求期间服务内部出现错误时引发。返回 HTTP 状态代码 500。
InvalidTypeException 尝试创建或访问无效或不支持的 OpenSearch Service 域子资源时引发。返回 HTTP 状态代码 409。
LimitExceededException 尝试创建的 OpenSearch Service 域资源和子资源超过允许的数量时引发。返回 HTTP 状态代码 409。
ResourceNotFoundException 访问或删除不存在的资源时引发。返回 HTTP 状态代码 400。
ResourceAlreadyExistsException 客户端尝试创建 OpenSearch Service 域中已存在的资源时引发。返回 HTTP 状态代码 400。