Release Notes
Product Announcements
Security Announcement
Domain name for API request: es.intl.tencentcloudapi.com.
This API is used to create indices.
A maximum of 20 requests can be initiated per second for this API.
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 |
| 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. |
POST / HTTP/1.1
Host: es.intl.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"
}{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | AppId value does not match the expected value. |
| InvalidParameter.InvalidEsVersion | The instance version EsVersion value does not match the expected value. |
| InvalidParameter.InvalidIndexMetaJson | The value of the created index metadata JSON field IndexMetaJson does not match the expected value. |
| InvalidParameter.InvalidIndexName | The IndexName value does not match the expected value. |
| InvalidParameter.InvalidIndexType | The IndexType value does not match the expected value. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId, no corresponding resource found. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceInUse | Resource is in use. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain cluster resources. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain database resources. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
피드백