产品概述
产品优势
应用场景
产品架构
地域介绍
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
This API is used to create a global index for a table.
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: SetTableIndex. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-23. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ClusterId | Yes | String | ID of the cluster where the table resides |
| SelectedTables.N | Yes | Array of SelectedTableWithField | The list of tables that need to create global indexes |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The number of tables whose global indexes are created |
| TableResults | Array of TableResultNew | The list of global index creation results |
| 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. |
This example shows you how to create a distributed index for a table.
https://tcaplusdb.intl.tencentcloudapi.com/?Action=SetTableIndex
&ClusterId=5674209986
&SelectedTables.0.TableInstanceId=tcaplus-1f224454
&SelectedTables.0.TableGroupId=101
&SelectedTables.0.TableName=tb_example
&SelectedTables.0.TableIdlType=PROTO
&SelectedTables.0.TableType=GENERIC
&SelectedTables.0.ShardNum=3
&SelectedTables.0.SelectedFields.0.FieldName=name
&SelectedTables.0.SelectedFields.0.IsPrimaryKey=Yes
&SelectedTables.0.SelectedFields.0.FieldType=string
&SelectedTables.0.SelectedFields.0.FieldSize=64
&SelectedTables.0.SelectedFields.1.FieldName=id
&SelectedTables.0.SelectedFields.1.IsPrimaryKey=No
&SelectedTables.0.SelectedFields.1.FieldType=int32
&SelectedTables.0.SelectedFields.1.FieldSize=4
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"TableResults": [
{
"TableInstanceId": "abc",
"TaskId": "abc",
"TableName": "abc",
"TableType": "abc",
"TableIdlType": "abc",
"TableGroupId": "abc",
"Error": {
"Code": "abc",
"Message": "abc"
},
"TaskIds": [
"abc"
],
"ApplicationId": "abc"
}
],
"RequestId": "abc"
}
}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.UnauthorizedOperation | API operation authentication error. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
文档反馈