tencent cloud

Elasticsearch Service

CreateIndex

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-13 13:26:51

1. API Description

Domain name for API request: es.intl.tencentcloudapi.com.

Create an index

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateIndex.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String ES cluster ID
IndexType Yes String Index type of the created index. auto: autonomous index; normal: general index
IndexName Yes String Index name of the created index
IndexMetaJson Yes String [Required] JSON-formatted index metadata created, such as mappings and settings
Username No String Cluster access username.
Password No String Cluster access password

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Creating an Autonomous Index

Create an autonomous index

Input Example

POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIndex
<Common request parameters>

{
    "Username": "elastic",
    "IndexName": "index_name",
    "IndexType": "normal",
    "InstanceId": "es-abcdefgh",
    "IndexMetaJson": "",
    "Password": "G7j#kL9p$2w"
}

Output Example

{
    "Response": {
        "RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter.InvalidAppId The APPID value does not match the expectation.
InvalidParameter.InvalidEsVersion The instance version EsVersion does not match the expectation.
InvalidParameter.InvalidIndexMetaJson The value of the created JSON-formatted index metadata IndexMetaJson does not match expectations.
InvalidParameter.InvalidIndexName The value of IndexName does not match the expected value.
InvalidParameter.InvalidIndexType The value of IndexType does not match the expected value.
InvalidParameter.InvalidInstanceId Invalid InstanceId. No corresponding resources were found.
ResourceNotFound.ClusterInfoNotFound Failed to obtain the cluster resource.
ResourceNotFound.DBInfoNotFound Failed to obtain the database resource.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック