CreateIndex

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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	ES cluster ID
IndexType	Yes	String	Type of the index to create. `auto`: Automated; `normal`: General.
IndexName	Yes	String	Name of the index to create
IndexMetaJson	Yes	String	JSON-formatted index metadata to create, such as `mappings` and `settings`
Username	No	String	Username for cluster access
Password	No	String	Password for cluster access

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 automated index

Input Example

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

{
    "Username": "xx",
    "IndexName": "xx",
    "IndexType": "xx",
    "InstanceId": "xx",
    "IndexMetaJson": "xx",
    "Password": "xx"
}

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

Tencent Cloud CLI 3.0

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
AuthFailure	CAM signature/authentication error
AuthFailure.UnAuthorizedOperation	Unauthorized operation.
FailedOperation	Operation failed.
FailedOperation.ErrorClusterState	Incorrect cluster status
FailedOperation.ErrorClusterStateUnhealth	The cluster is unhealthy.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameter.InvalidAppId
InvalidParameter.InvalidEsVersion
InvalidParameter.InvalidIndexMetaJson
InvalidParameter.InvalidIndexName
InvalidParameter.InvalidIndexType
InvalidParameter.InvalidInstanceId
InvalidParameterValue	Incorrect parameter value.
MissingParameter	Missing parameter.
RequestLimitExceeded	The number of requests exceeds the frequency limit.
ResourceInUse	Resource is in use.
ResourceNotFound.ClusterInfoNotFound
ResourceNotFound.DBInfoNotFound
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	Unsupported operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Voice Technology

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description