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 方法。

AcceptInboundCrossClusterSearchConnection

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

Syntax

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

请求参数

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

请求正文

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

响应元素

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"
  }]
}

请求参数

此操作不使用请求参数。

请求正文

响应元素

AddTags 操作不返回数据结构。

AssociatePackage

将程序包与 Amazon ES 域关联。

Syntax

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

请求参数

请求正文

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

响应元素

CreateElasticsearchDomain

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

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"
    }
  },
  "AutoTuneOptions": {
    "DesiredState": "ENABLED|DISABLED",
    "MaintenanceSchedules": [{
      "StartAt": 1234567890,
      "Duration": {
        "Value": 2,
        "Unit": "HOURS"
      },
      "CronExpressionForRecurrence": "0 0 ? * 3 *"
    }]
  },
  "ElasticsearchVersion": "7.9",
  "TagList": [
    {
      "Key": "stack",
      "Value": "prod"
    }
  ],
  "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 请求参数。

请求正文

响应元素

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 请求参数。

请求正文

响应元素

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"
  }
}

请求参数

此操作不使用请求参数。

请求正文

响应元素

DeleteElasticsearchDomain

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

Syntax

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

请求参数

请求正文

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

响应元素

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 请求正文。

响应元素

DeleteOutboundCrossClusterSearchConnection

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

Syntax

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

请求参数

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

请求正文

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

响应元素

DeletePackage

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

Syntax

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

请求参数

请求正文

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

响应元素

DescribeDomainAutoTunes

返回 Auto-Tune 对域进行的优化的列表。

Syntax

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

请求参数

请求正文

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

响应元素

DescribeElasticsearchDomain

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

Syntax

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

请求参数

请求正文

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

响应元素

DescribeElasticsearchDomainConfig

显示一个 Amazon ES 域的配置。

Syntax

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

请求参数

请求正文

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

响应元素

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 请求参数。

请求正文

响应元素

DescribeElasticsearchInstanceTypeLimits

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

Syntax

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

请求参数

请求正文

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

响应元素

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 请求参数。

请求正文

响应元素

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 请求参数。

请求正文

响应元素

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",
}

请求参数

此操作不使用请求参数。

请求正文

响应元素

DescribeReservedElasticsearchInstanceOfferings

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

Syntax

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

请求参数

请求正文

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

响应元素

DescribeReservedElasticsearchInstances

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

Syntax

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

请求参数

请求正文

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

响应元素

DissociatePackage

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

Syntax

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

请求参数

请求正文

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

响应元素

GetCompatibleElasticsearchVersions

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

Syntax

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

请求参数

请求正文

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

响应元素

GetPackageVersionHistory

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

Syntax

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

请求参数

请求正文

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

响应元素

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

请求参数

请求正文

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

响应元素

GetUpgradeStatus

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

Syntax

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

请求参数

请求正文

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

响应元素

ListDomainNames

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

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

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

响应元素

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

请求参数

请求正文

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

响应元素

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

请求参数

请求正文

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

响应元素

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

请求参数

请求正文

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

响应元素

ListElasticsearchVersions

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

Syntax

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

请求参数

请求正文

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

响应元素

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

请求参数

请求正文

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

响应元素

ListTags

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

Syntax

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

请求参数

请求正文

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

响应元素

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 请求参数。

请求正文

响应元素

RejectInboundCrossClusterSearchConnection

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

Syntax

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

请求参数

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

请求正文

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

响应元素

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 请求参数。

请求正文

响应元素

RemoveTags 操作不返回响应元素。

StartElasticsearchServiceSoftwareUpdate

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

Syntax

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

请求参数

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

请求正文

响应元素

StopElasticsearchServiceSoftwareUpdate

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

Syntax

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

请求参数

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

请求正文

响应元素

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
  },
  "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"
  },
  "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"
    }
  },
  "AutoTuneOptions": {
    "DesiredState": "ENABLED|DISABLED",
    "MaintenanceSchedules": [{
      "StartAt": 4104152288000,
      "Duration": {
        "Value": 2,
        "Unit": "HOURS"
      },
      "CronExpressionForRecurrence": "30 11 ? * 3,6 *"
    }]
  },
  "AutoTuneOptions": {
    "DesiredState": "ENABLED|DISABLED",
    "MaintenanceSchedules": [{
      "StartAt": 1234567890,
      "Duration": {
        "Value": 2,
        "Unit": "HOURS"
      },
      "CronExpressionForRecurrence": "* * * * *"
    }],
    "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/*\"}]}"
}

请求参数

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

请求正文

响应元素

UpdatePackage

更新用于 Amazon ES 域的程序包。

Syntax

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

请求参数

此操作不使用请求参数。

请求正文

响应元素

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 请求参数。

请求正文

响应元素

数据类型

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

AdvancedOptions

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

AdvancedSecurityOptions

ARN

AutoTuneOptions

CognitoOptions

CreateElasticsearchDomainRequest

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

DomainEndpointOptions

DomainID

DomainName

Amazon ES 域的名称。

DomainNameList

Amazon ES 域名的字符串。

DomainPackageDetails

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

EBSOptions

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

ElasticsearchClusterConfig

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

ElasticsearchDomainConfig

Amazon ES 域配置的容器。

ElasticsearchDomainStatus

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

ElasticsearchDomainStatusList

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

EncryptionAtRestOptions

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

EndpointsMap

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

Filters

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

LogPublishingOptions

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

MasterUserOptions

NodeToNodeEncryptionOptions

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

OptionState

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

OptionStatus

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

PackageDetails

有关程序包的基本信息。

PackageSource

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

SAMLOptions

ServiceSoftwareOptions

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

ServiceURL

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

SnapshotOptions

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

Tag

TagKey

TagList

TagValue

VPCDerivedInfo

VPCOptions

ZoneAwarenessConfig

Errors

Amazon ES 会引发以下错误：