Elasticsearch Service 创建Serverless索引-Serverless实例相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： es.tencentcloudapi.com 。

创建Serverless索引

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateServerlessInstance。
Version	是	String	公共参数，本接口取值：2018-04-16。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-singapore, ap-tokyo, na-ashburn 。
IndexName	是	String	索引名，需以-AppId结尾示例值：test-12345678
Zone	否	String	可用区示例值：ap-guangzhou-3
VpcId	否	String	私有网络ID 示例值：vpc-xxxxxx
SubnetId	否	String	子网ID 示例值：subnet-xxxxxx
IndexMetaJson	否	String	创建的索引元数据JSON，如mappings、settings 示例值：{}
SpaceId	否	String	创建索引的空间ID 示例值：space-xxxxxxxx
Username	否	String	创建索引的用户名示例值：test
Password	否	String	创建索引的密码示例值：test
ServerlessDi	否	ServerlessDi	创建数据接入
AutoGetIp	否	Integer	是否自行添加白名单ip 示例值：0
TagList.N	否	Array of TagInfo	标签信息
KibanaWhiteIpList.N	否	Array of String	kibana公网白名单

3. 输出参数

参数名称	类型	描述
InstanceId	String	实例ID 示例值：index-xxxxxxxx
DealName	String	订单号注意：此字段可能返回 null，表示取不到有效值。示例值：123
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建serverless实例

创建serverless实例

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateServerlessInstance
<公共请求参数>

{
    "Zone": "abc",
    "VpcId": "abc",
    "SubnetId": "abc",
    "IndexName": "abc",
    "IndexMetaJson": "{}",
    "SpaceId": "abc",
    "Username": "abc",
    "Password": "abc"
}

输出示例

{
    "Response": {
        "InstanceId": "abc",
        "DealName": "abc",
        "RequestId": "abc"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnAuthorizedOperation	操作未授权。
FailedOperation.ClusterResourceLimitError	集群资源配额限制错误。
FailedOperation.DiskCountParamError	节点磁盘块数参数检查失败。
FailedOperation.NoPayment	账户未绑定信用卡或paypal，无法支付。
FailedOperation.NotAuthenticated	用户未实名认证。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.IndexNameExist	索引名已存在。
InvalidParameter.IndexNameInvalid	索引名不合法。
InvalidParameter.UsernameExist	用户名已存在。
LimitExceeded	超过配额限制。
LimitExceeded.IndexCount	空间索引数超过配额。
LimitExceeded.IndexCreate	空间索引每日创建数超过配额。
LimitExceeded.SpaceCount	空间数超过配额。
LimitExceeded.SpaceCreate	空间每日创建数超过配额。
ResourceInUse	资源被占用。
ResourceInsufficient	资源不足。
ResourceInsufficient.Balance	账户余额不足。
ResourceInsufficient.HiddenZone	隐藏可用区专用主节点资源不足。
ResourceInsufficient.Subnet	子网剩余ip数量不足。