接口请求域名: es.intl.tencentcloudapi.com 。
更新索引
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpdateIndex。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | ES集群ID |
| IndexType | 是 | String | 更新的索引类型。auto:自治索引;normal:普通索引 |
| IndexName | 是 | String | 更新的索引名 |
| UpdateMetaJson | 否 | String | 更新的索引元数据JSON,如mappings、settings |
| Username | 否 | String | 集群访问用户名 |
| Password | 否 | String | 集群访问密码 |
| RolloverBackingIndex | 否 | Boolean | 是否滚动后备索引 |
| MountIndex | 否 | Boolean | 是否为取回完全卸载索引 |
| IndexUuid | 否 | String | 索引Uuid |
| BackingIndexName | 否 | String | 后备索引名 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateIndex
<公共请求参数>
{
"InstanceId": "es-h3pzdpd6",
"IndexName": "asd",
"IndexType": "normal",
"UpdateMetaJson": "{\"mappings\":{\"properties\":{\"aa\":{\"analyzer\":\"standard\",\"index\":true,\"type\":\"text\"}}},\"settings\":{}}"
}
{
"Response": {
"RequestId": "6cf36e17-abdf-4a75-a95a-78a0e59fc959"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidIndexMetaJson | 创建的索引元数据JSON IndexMetaJson的取值和预期不符。 |
| InvalidParameter.InvalidIndexType | 索引类型IndexType的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId,没有找到对应资源。 |
| InvalidParameter.InvalidUpdateMetaJson | 更新的索引元数据json UpdateMetaJson的取值和预期不符。 |
| LimitExceeded.UpdateItemLimit | 更新参数值过多,超过限制。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
文档反馈