Amazon Elasticsearch Service 配置 API 参考 - Amazon Elasticsearch Service
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

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

Amazon Elasticsearch Service 配置 API 参考

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

Actions

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

注意

所有配置服务请求必须经过签名。有关更多信息,请参阅本指南中的签署 Amazon Elasticsearch 服务请求http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html中的AWS General Reference签名版本 4 签名流程

AcceptInboundCrossClusterSearchConnection

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

Syntax

PUT https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept

请求参数

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

请求正文

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

响应元素

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

AddTags

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

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

参数 数据类型 必需? Description
TagList TagList 资源标签列表。
ARN ARN 要附加资源标签的 Amazon ES 域的 Amazon 资源名称 (ARN)。

响应元素

AddTags 操作不返回数据结构。

AssociatePackage

将程序包与 Amazon ES 域关联。

Syntax

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

请求参数

参数 数据类型 必需? Description
PackageID String 要与域关联的程序包的内部 ID。使用 DescribePackages 查找此值。
DomainName DomainName 要与程序包关联的域的名称。

请求正文

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

响应元素

字段 数据类型
DomainPackageDetails DomainPackageDetails

CreateElasticsearchDomain

创建 Amazon ES 域。有关更多信息,请参阅 创建 Amazon ES 域

注意

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

Syntax

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/domain { "ElasticsearchClusterConfig": { "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true|false, "InstanceCount": 3, "DedicatedMasterEnabled": true|false, "DedicatedMasterType": "c5.large.elasticsearch", "DedicatedMasterCount": 3, "InstanceType": "r5.large.elasticsearch", "WarmCount": 3, "WarmEnabled": true|false, "WarmType": "ultrawarm1.large.elasticsearch" }, "EBSOptions": { "EBSEnabled": true|false, "VolumeType": "io1|gp2|standard", "Iops": 1000, "VolumeSize": 35 }, "EncryptionAtRestOptions": { "Enabled": true|false, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:alias/my-key" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": 3 }, "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" }, "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/CognitoAccessForAmazonES" }, "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": { "InternalUserDatabaseEnabled": true|false, "MasterUserOptions": { "MasterUserARN": "arn:aws:iam::123456789012:role/my-master-user-role" "MasterUserName": "my-master-username", "MasterUserPassword": "my-master-password" } }, "ElasticsearchVersion": "7.1", "DomainName": "my-domain", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"123456789012\"]},\"Action\":[\"es:es:ESHttp*\"],\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}" }

请求参数

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

请求正文

参数 数据类型 必需? Description
DomainName DomainName 要创建的 Amazon ES 域的名称。
ElasticsearchVersion String Elasticsearch 的版本。如果未指定,则将 1.5 用作默认值。有关所支持版本的完整列表,请参阅支持的 Elasticsearch 版本
ElasticsearchClusterConfig ElasticsearchClusterConfig Amazon ES 域的群集配置的容器。
EBSOptions EBSOptions 为 Amazon ES 域启用基于 EBS 的存储所需的参数的容器。
VPCOptions VPCOptions 配置 VPC 访问域所需的值的容器。如果您不指定这些值,Amazon ES 将使用公有终端节点创建域。要了解更多信息,请参阅Amazon Elasticsearch Service 域的 VPC 支持
CognitoOptions CognitoOptions 键-值对,用来配置 Amazon ES 以使用用于 Kibana 的 Amazon Cognito 身份验证。
AccessPolicies String 为新的 Amazon ES 域指定访问策略的 IAM 策略文档。有关更多信息,请参阅 Amazon Elasticsearch Service 中的 Identity and Access Management
SnapshotOptions SnapshotOptions

已弃用。对于运行 Elasticsearch 5.3 及更高版本的域,Amazon ES 会每小时自动制作快照,因此该设置不相关。

对于运行较早版本的 Elasticsearch 的域,Amazon ES 会每日自动制作快照。此值充当您希望服务制作快照的一天中的小时的容器。

AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。有关更多信息,请参阅配置高级选项
LogPublishingOptions LogPublishingOptions 用于配置慢速日志发布的键值对。
EncryptionAtRestOptions EncryptionAtRestOptions 用于至少启用加密的键值对。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 启用节点到节点加密。
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
AdvancedSecurityOptions AdvancedSecurityOptions 用于精细访问控制的选项。

响应元素

字段 数据类型
DomainStatus ElasticsearchDomainStatus

CreateOutboundCrossClusterSearchConnection

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

Syntax

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/outboundConnection { "ConnectionAlias": "StringValue", "SourceDomainInfo": { "DomainName": "Domain-name", "Region": "us-east-1" }, "DestinationDomainInfo": { "OwnerId": "Account-id", "DomainName": "Domain-name", "Region": "us-east-1" } }

请求参数

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

请求正文

参数 数据类型 必需? Description
ConnectionAlias String 连接的名称。
SourceDomainInfo 对象 源域的名称和区域。
DestinationDomainInfo 对象 目标域的名称和区域。

响应元素

字段 数据类型 Description
SourceDomainInfo 对象 源域的名称和区域。
DestinationDomainInfo 对象 目标域的名称和区域。
ConnectionAlias String 连接的名称。
ConnectionStatus String 连接的状态。
CrossClusterSearchConnectionId String 出站连接的 ID。

CreatePackage

添加用于 Amazon ES 域的程序包。

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

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

响应元素

字段 数据类型
PackageDetails PackageDetails

DeleteElasticsearchDomain

删除 Amazon ES 域及其所有数据。域在删除后无法恢复。

Syntax

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

请求参数

参数 数据类型 必需? Description
DomainName DomainName 您要删除的 Amazon ES 域的名称。

请求正文

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

响应元素

字段 数据类型
DomainStatus ElasticsearchDomainStatus

DeleteElasticsearchServiceRole

删除 Amazon ES 和 Amazon EC2 之间的服务相关角色。这种角色赋予 Amazon ES 权限来将 VPC 终端节点放入 VPC 中。必须存在服务相关角色才能在域中创建 VPC 终端节点或者域才能正常工作。

注意

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

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

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

响应元素

DeleteElasticsearchServiceRole 操作不返回数据结构。

DeleteInboundCrossClusterSearchConnection

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

Syntax

DELETE https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/inboundConnection/{ConnectionId}

请求参数

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

请求正文

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

响应元素

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

DeleteOutboundCrossClusterSearchConnection

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

Syntax

DELETE https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/outboundConnection/{ConnectionId}

请求参数

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

请求正文

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

响应元素

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

DeletePackage

从 Amazon ES 中删除程序包。程序包不能与任何 Amazon ES 域关联。

Syntax

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

请求参数

参数 数据类型 必需? Description
PackageID String 要删除的程序包的内部 ID。使用 DescribePackages 查找此值。

请求正文

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

响应元素

字段 数据类型
PackageDetails PackageDetails

DescribeElasticsearchDomain

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

Syntax

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

请求参数

参数 数据类型 必需? Description
DomainName DomainName 您要描述的 Amazon ES 域的名称。

请求正文

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

响应元素

字段 数据类型
DomainStatus ElasticsearchDomainStatus

DescribeElasticsearchDomainConfig

显示一个 Amazon ES 域的配置。

Syntax

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

请求参数

参数 数据类型 必需? Description
DomainName DomainName 要描述的 Amazon ES 域配置的名称。

请求正文

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

响应元素

字段 数据类型
DomainConfig ElasticsearchDomainConfig

DescribeElasticsearchDomains

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

Syntax

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

请求参数

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

请求正文

字段 数据类型 必需? Description
DomainNames DomainNameList Amazon ES 域名的数组。

响应元素

字段 数据类型
DomainStatusList ElasticsearchDomainStatusList

DescribeElasticsearchInstanceTypeLimits

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

Syntax

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

请求参数

参数 数据类型 必需? Description
ElasticsearchVersion String Elasticsearch 版本。有关受支持的版本的列表,请参阅支持的 Elasticsearch 版本
InstanceType String 实例类型。要按区域查看实例类型,请参阅 Amazon Elasticsearch Service 定价
DomainName DomainName 现有域的名称。仅指定您是否需要针对现有域的限制。

请求正文

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

响应元素

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

DescribeInboundCrossClusterSearchConnections

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

Syntax

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/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 请求参数。

请求正文

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

响应元素

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

DescribeOutboundCrossClusterSearchConnections

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

Syntax

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/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 请求参数。

请求正文

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

响应元素

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

DescribePackages

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

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

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

响应元素

字段 数据类型 Description
PackageDetailsList 列表 PackageDetails 对象的列表。

DescribeReservedElasticsearchInstanceOfferings

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

Syntax

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

请求参数

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

请求正文

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

响应元素

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

DescribeReservedElasticsearchInstances

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

Syntax

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

请求参数

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

请求正文

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

响应元素

字段 数据类型 Description
ReservedElasticsearchInstances

ReservedElasticsearchInstances

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

DissociatePackage

从指定的 Amazon ES 域中删除程序包。该程序包不得与任何 ES 索引一起使用,才能成功取消关联。该程序包仍可在 Amazon ES 服务中使用,以便以后进行关联。

Syntax

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

请求参数

参数 数据类型 必需? Description
PackageID String 要与域取消关联的程序包的内部 ID。使用 ListPackagesForDomain 查找此值。
DomainName DomainName 要与程序包取消关联的域的名称。

请求正文

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

响应元素

字段 数据类型
DomainPackageDetails DomainPackageDetails

GetCompatibleElasticsearchVersions

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

Syntax

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

请求参数

参数 数据类型 必需? Description
DomainName DomainName 现有域的名称。

请求正文

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

响应元素

字段 数据类型 Description
CompatibleElasticsearchVersions 映射 Elasticsearch 版本和您可以将其升级到的版本的映射:
{ "CompatibleElasticsearchVersions": [{ "SourceVersion": "6.7", "TargetVersions": ["6.8"] }] }

GetUpgradeHistory

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

Syntax

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

请求参数

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

请求正文

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

响应元素

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

GetUpgradeStatus

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

Syntax

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

请求参数

参数 数据类型 必需? Description
DomainName DomainName 现有域的名称。

请求正文

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

响应元素

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

ListDomainNames

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

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

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

响应元素

字段 数据类型 Description
DomainNameList DomainNameList 当前用户拥有的所有 Amazon ES 域的名称。

ListDomainsForPackage

列出与程序包关联的所有 Amazon ES 域。

Syntax

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

请求参数

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

请求正文

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

响应元素

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

ListElasticsearchInstanceTypeDetails

列出给定 Elasticsearch 版本支持的所有 Elasticsearch 实例类型以及这些实例类型支持的功能。

Syntax

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

请求参数

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

请求正文

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

响应元素

字段 数据类型 Description
ElasticsearchInstanceTypes 列表 列出给定 Elasticsearch 版本的受支持实例类型和这些实例类型支持的功能。
NextToken String

用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。 接受用于为下一页返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

ListElasticsearchInstanceTypes(已弃用)

列出给定 Elasticsearch 版本支持的所有 Elasticsearch 实例类型。此操作已弃用。请改用 ListElasticsearchInstanceTypeDetails

Syntax

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

请求参数

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

请求正文

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

响应元素

字段 数据类型 Description
ElasticsearchInstanceTypes 列表 给定 Elasticsearch 版本支持的实例类型的列表。
NextToken String 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。 接受用于为下一页返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

ListElasticsearchVersions

列出 Amazon ES 上所有受支持的 Elasticsearch 版本。

Syntax

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

请求参数

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

请求正文

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

响应元素

字段 数据类型 Description
ElasticsearchVersions 列表 列出所有受支持的 Elasticsearch 版本。
NextToken String 用于分页。仅当之前的 API 调用生成了包含 NextToken 的结果时才需要。 接受用于为下一页返回结果的 next-token 输入,并在响应中提供 next-token 输出,供客户端用于检索更多结果。

ListPackagesForDomain

列出与 Amazon ES 域关联的所有程序包。

Syntax

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

请求参数

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

请求正文

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

响应元素

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

ListTags

显示一个 Amazon ES 域的所有资源标签。

Syntax

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

请求参数

参数 数据类型 必需? Description
ARN ARN Amazon ES 域的 Amazon 资源名称 (ARN)。

请求正文

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

响应元素

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

PurchaseReservedElasticsearchInstanceOffering

购买预留实例。

Syntax

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

请求参数

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

请求正文

名称 数据类型 必需? Description
ReservationName String 预留的描述性名称。
ReservedElasticsearchInstanceOfferingId String 产品 ID。
InstanceCount 整数 要预留的实例的数量。

响应元素

字段 数据类型 Description
ReservationName String 预留的名称。
ReservedElasticsearchInstanceId String 预留 ID。

RejectInboundCrossClusterSearchConnection

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

Syntax

PUT https://es.us-east-1.amazonaws.com/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject

请求参数

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

请求正文

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

响应元素

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

RemoveTags

从 Amazon ES 域中移除指定的资源标签。

Syntax

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

请求参数

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

请求正文

参数 数据类型 必需? Description
ARN ARN Amazon ES 域的 Amazon 资源名称 (ARN)。有关更多信息,请参阅使用 AWS Identity and Access Management 中的 IAM 实体的标识符
TagKeys TagKey 您想从 Amazon ES 域移除的资源标签的标签键列表。

响应元素

RemoveTags 操作不返回响应元素。

StartElasticsearchServiceSoftwareUpdate

为 Amazon ES 域计划服务软件更新。

Syntax

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

请求参数

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

请求正文

参数 数据类型 必需? Description
DomainName DomainName 要更新到最新服务软件的 Amazon ES 域的名称。

响应元素

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

StopElasticsearchServiceSoftwareUpdate

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

Syntax

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

请求参数

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

请求正文

参数 数据类型 必需? Description
DomainName DomainName 要更新到最新服务软件的 Amazon ES 域的名称。

响应元素

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

UpdateElasticsearchDomainConfig

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

Syntax

POST https://es.us-east-1.amazonaws.com/2015-01-01/es/domain/<DOMAIN_NAME>/config { "ElasticsearchClusterConfig": { "ZoneAwarenessConfig": { "AvailabilityZoneCount": 3 }, "ZoneAwarenessEnabled": true|false, "InstanceCount": 3, "DedicatedMasterEnabled": true|false, "DedicatedMasterType": "c5.large.elasticsearch", "DedicatedMasterCount": 3, "InstanceType": "r5.large.elasticsearch", "WarmCount": 6, "WarmType": "ultrawarm1.medium.elasticsearch" }, "EBSOptions": { "EBSEnabled": true|false, "VolumeType": "io1|gp2|standard", "Iops": 1000, "VolumeSize": 35 }, "SnapshotOptions": { "AutomatedSnapshotStartHour": 3 }, "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" }, "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/CognitoAccessForAmazonES" }, "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": { "InternalUserDatabaseEnabled": true|false, "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" } }, "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/*\"}]}" }

请求参数

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

请求正文

参数 数据类型 必需? Description
DomainName DomainName 您要更新配置的 Amazon ES 域的名称。
ElasticsearchClusterConfig ElasticsearchClusterConfig 您想要对集群配置进行的更改,例如实例类型和 EC2 实例计数。
EBSOptions EBSOptions 附加到数据节点的 EBS 卷的类型和大小。
VPCOptions VPCOptions 配置 Amazon ES 以便与 VPC 配合使用所需的值的容器。要了解更多信息,请参阅Amazon Elasticsearch Service 域的 VPC 支持
SnapshotOptions SnapshotOptions 已弃用。服务为 Amazon ES 域中的索引创建每日自动快照的时间。
AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。有关更多信息,请参阅配置高级选项
AccessPolicies String 指定 Amazon ES 域的访问策略。有关更多信息,请参阅配置访问策略
LogPublishingOptions LogPublishingOptions 键/值字符串配对以配置慢速日志发布。
CognitoOptions CognitoOptions 键-值对,用来配置 Amazon ES 以使用用于 Kibana 的 Amazon Cognito 身份验证。
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
AdvancedSecurityOptions AdvancedSecurityOptions 用于精细访问控制的选项。

响应元素

字段 数据类型
DomainConfig ElasticsearchDomainConfig

UpgradeElasticsearchDomain

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

Syntax

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

请求参数

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

请求正文

参数 数据类型 必需? Description
DomainName String 您要升级的 Amazon ES 域的名称。
TargetVersion String 要升级到的 Elasticsearch 版本。请参阅GetCompatibleElasticsearchVersions
PerformCheckOnly 布尔型 默认值为 false。 如果为 true,Amazon ES 会检查域的资格,但不执行升级。

响应元素

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

数据类型

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

AdvancedOptions

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

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

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

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

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

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

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

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

ARN

字段 数据类型 Description
ARN String Amazon ES 域的 Amazon 资源名称 (ARN)。有关更多信息,请参阅 AWS Identity and Access Management 文档中的 IAM ARNs

AdvancedSecurityOptions

字段 数据类型 Description
Enabled 布尔型 为 true,则启用精细访问控制
InternalUserDatabaseEnabled 布尔型 为 true,则启用内部用户数据库。
MasterUserOptions MasterUserOptions 有关主用户的信息的容器。
SAMLOptions SAMLOptions 有关 Kibana 的 SAML 配置的信息的容器。

CognitoOptions

字段 数据类型 Description
Enabled 布尔型 对 Kibana 启用还是禁用 Amazon Cognito 身份验证。请参阅用于 Kibana 的 Amazon Cognito 身份验证
UserPoolId String 您希望 Amazon ES 用于 Kibana 身份验证的 Amazon Cognito 用户池 ID。
IdentityPoolId String 您希望 Amazon ES 用于 Kibana 身份验证的 Amazon Cognito 身份池 ID。
RoleArn String 允许 Amazon ES 配置您的用户池和身份池的 AmazonESCognitoAccess 角色。

CreateElasticsearchDomainRequest

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

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

DomainEndpointOptions

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

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

CustomEndpointEnabled 布尔型 是否为域启用自定义终端节点。
CustomEndpoint String 自定义终端节点的完全限定 URL。
CustomEndpointCertificateArn String 安全证书的 ARN,在 ACM 中托管。

DomainID

数据类型 Description
String Amazon ES 域的唯一标识符。

DomainName

Amazon ES 域的名称。

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

DomainNameList

Amazon ES 域名的字符串。

数据类型 Description
字符串数组 Amazon ES 域的数组,采用以下格式:

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

DomainPackageDetails

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

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

EBSOptions

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

字段 数据类型 Description
EBSEnabled 布尔型 指定 EBS 卷是否附加到 Amazon ES 域中的数据节点。
VolumeType String 指定附加到数据节点的 EBS 卷的类型。
VolumeSize String 指定附加到数据节点的 EBS 卷的大小(在 GiB 中)。
Iops String 指定附加到数据节点的 EBS 卷的基准输入/输出 (I/O) 性能。仅适用于预配置 IOPS EBS 卷类型。

ElasticsearchClusterConfig

Amazon ES 域的群集配置的容器。

字段 数据类型 Description
InstanceType String 群集中的数据节点的实例类型。
InstanceCount 整数 群集中的实例数量。
DedicatedMasterEnabled 布尔型 指示是否为集群启用专用主节点。True 如果集群将使用专用主节点。False 如果集群没有。有关更多信息,请参阅关于专用主节点
DedicatedMasterType String 群集中的专用主节点的 Amazon ES 实例类型。
DedicatedMasterCount 整数 群集中专用主节点的数量。
ZoneAwarenessEnabled 布尔型 指示是否已启用多个可用区。有关更多信息,请参阅 配置多 AZ 域
ZoneAwarenessConfig ZoneAwarenessConfig 区域感知配置选项的容器。仅当 ZoneAwarenessEnabledtrue 时必需。
WarmEnabled 布尔型 是否为集群启用温存储。
WarmCount 整数 集群中的温节点数。
WarmType String 集群的温节点的实例类型。
WarmStorage 整数 在 GiB 中预置的温存储总量。

ElasticsearchDomainConfig

Amazon ES 域配置的容器。

字段 数据类型 Description
ElasticsearchVersion String Elasticsearch 版本。
ElasticsearchClusterConfig ElasticsearchClusterConfig Amazon ES 域的群集配置的容器。
EBSOptions EBSOptions 为 Amazon ES 域配置的 EBS 选项的容器。
AccessPolicies String 指定 Amazon ES 域的访问策略。有关更多信息,请参阅配置访问策略
SnapshotOptions SnapshotOptions 已弃用。服务为 Amazon ES 域中的索引创建每日自动快照的时间。
DomainEndpointOptions DomainEndpointOptions 域终端节点的其他选项,例如是否要求所有流量都使用 HTTPS。
VPCOptions VPCDerivedInfo 域的当前 VPCOptions 以及其配置的任何更新状态。
LogPublishingOptions LogPublishingOptions 用于配置慢速日志发布的键值对。
AdvancedOptions AdvancedOptions 用于指定高级配置选项的键值对。
EncryptionAtRestOptions EncryptionAtRestOptions 用于至少启用加密的键值对。
NodeToNodeEncryptionOptions NodeToNodeEncryptionOptions 启用还是禁用节点到节点加密。

ElasticsearchDomainStatus

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

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

ElasticsearchDomainStatusList

包含每个指定的 Amazon ES 域状态的列表。

字段 数据类型 Description
DomainStatusList ElasticsearchDomainStatus 包含每个指定的 Amazon ES 域状态的列表。

EncryptionAtRestOptions

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

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

EndpointsMap

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

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

Filters

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

字段 数据类型 Description
Name String 来自 PackageDetails的任何字段。
Value 列表 指定字段的值列表。

LogPublishingOptions

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

字段 数据类型 Description
INDEX_SLOW_LOGS 键/值

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

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

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

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

MasterUserOptions

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

NodeToNodeEncryptionOptions

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

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

OptionState

Amazon ES 域高级选项的更新状态。

字段 数据类型 Description
OptionStatus String 三个有效值之一:
  • RequiresIndexDocuments

  • 处理

  • Active (处于活动状态)

OptionStatus

Amazon ES 域配置选项的更新状态。

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

PackageDetails

有关程序包的基本信息。

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

PackageSource

要添加到 Amazon ES 的程序包的存储桶和密钥。

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

SAMLOptions

字段 数据类型 Description
Enabled 布尔型 是否为 Kibana 启用 SAML 身份验证。
MasterUserName String 来自 SAML IdP 的此用户名接收集群的完整权限,等同于新主用户
MasterBackendRole String SAML IdP 中的此后端角色接收集群的完整权限,相当于新主用户
Idp 对象

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

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

ServiceSoftwareOptions

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

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

ServiceURL

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

字段 数据类型 Description
ServiceURL String 用于向 Amazon ES 域提交索引、搜索和数据上传请求的特定于域的终端节点。

SnapshotOptions

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

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

Tag

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

TagKey

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

TagList

字段 数据类型 Description
Tag Tag 附加到 Amazon ES 域的资源标签。

TagValue

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

VPCDerivedInfo

字段 数据类型 Description
VPCId String 您的 VPC 的 ID。当您创建 VPC 时,Amazon VPC 将生成此值。
SubnetIds StringList 与域的 VPC 终端节点关联的子网 IDs 的列表。有关更多信息,请参阅 VPCs 中的 和子网Amazon VPC 用户指南。
AvailabilityZones StringList 与 VPC 子网关联的可用区列表。有关更多信息,请参阅 https://docs.amazonaws.cn/AmazonVPC/latest/UserGuide/VPC_Subnets.html#vpc-subnet-basics 中的 VPC 和子网基础知识Amazon VPC 用户指南。
SecurityGroupIds StringList 与域的 VPC 终端节点关联的安全组 IDs 的列表。有关更多信息,请参阅 https://docs.amazonaws.cn/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html 中的 VPC 的安全组Amazon VPC 用户指南。

VPCOptions

字段 数据类型 Description
SubnetIds StringList 与域的 VPC 终端节点关联的子网 IDs 的列表。如果您的域使用多个可用区,则您需要提供两个子网 IDs,每个可用区一个子网。否则,只需提供一个。要了解更多信息,请参阅 VPCs 中的 和子网Amazon VPC 用户指南。
SecurityGroupIds StringList 与域的 VPC 终端节点关联的安全组 IDs 的列表。如果不提供安全组 ID, Amazon ES 将使用 VPC 的默认安全组。有关更多信息,请参阅 https://docs.amazonaws.cn/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html 中的Amazon VPC 用户指南您的 VPC 的安全组
VPCId String VPC 的 ID。

ZoneAwarenessConfig

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

Errors

Amazon ES 会引发以下错误:

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