1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
更新Serverless索引
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateServerlessInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-singapore, ap-tokyo, na-ashburn 。 |
| InstanceId | 是 | String | Serveless实例ID 示例值：index-abcdefgh |
| UpdateMetaJson | 否 | String | 更新的索引元数据JSON，如mappings、settings 示例值："{"mappings":{"properties":{}},"options":{"expire.max_age":"7d"},"settings":{}}" |
| Password | 否 | String | 实例访问密码 示例值：fwjaifAFJEIfj |
| KibanaPrivateAccess | 否 | String | 开启kibana内网访问，如OPEN、CLOSE 示例值：OPEN |
| KibanaPublicAccess | 否 | String | 开启kibana外网访问，如OPEN、CLOSE 示例值：OPEN |
| KibanaPublicAcl | 否 | KibanaPublicAcl | 访问控制列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新索引元数据
更新索引元数据---- 添加ResourceInUse.IsolatedStatus错误码
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateServerlessInstance
<公共请求参数>
{
"UpdateMetaJson": "{\"mappings\":{\"properties\":{}},\"options\":{\"expire.max_age\":\"7d\"},\"settings\":{}}",
"InstanceId": "index-asdasd"
}输出示例
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnAuthorizedOperation | 操作未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccessControlList | 更新ACL失败 |
| FailedOperation.ErrorClusterState | 集群状态错误。 |
| FailedOperation.ErrorClusterStateUnhealth | 集群状态不健康。 |
| FailedOperation.SpaceLanguage | 变更space的kibana语言信息失败 |
| FailedOperation.UnsupportedOpenLowFrequency | 不支持开启低频存储 |
| FailedOperation.UpdateVpc | 变更space的vpc信息失败 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidEsACL | EsAcl的取值和预期不符。 |
| InvalidParameter.InvalidIndexMetaJson | 创建的索引元数据JSON IndexMetaJson的取值和预期不符。 |
| InvalidParameter.InvalidOpType | 操作类型OpType的取值和预期不符。 |
| InvalidParameter.InvalidPrivateAccess | 内网访问PrivateAccess的取值和预期不符。 |
| InvalidParameter.InvalidPublicAccess | 外网访问PublicAccess的取值和预期不符。 |
| InvalidParameter.InvalidServerlessId | ES serverless的serverlessId未找到 |
| InvalidParameter.InvalidUpdateMetaJson | 更新的索引元数据json UpdateMetaJson的取值和预期不符。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInUse.IsolatedStatus | 索引状态处于隔离状态，不能进行其他操作。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UinNotInWhiteList | Uin不在白名单中。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
