SetTableIndex

Last updated: 2021-01-07 20:02:28

1. API Description

Domain name for API request: tcaplusdb.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.

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 parameter. The value used for this API: SetTableIndex.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. 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

3. Output Parameters

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a global index for a table

This example shows you how to create a global index for a table.

Input Example

https://tcaplus.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>

Output Example

{
  "Response": {
    "RequestId": "122bb375-7464-4536-a3c5-8ddbdd6f4ce4",
    "TableResults": [
      {
        "Error": null,
        "TableGroupId": "101",
        "TableIdlType": null,
        "TableInstanceId": "tcaplus-1f224454",
        "TableName": "tb_example",
        "TableType": null,
        "TaskId": "5674209986-1199",
        "TaskIds": null
      }
    ],
    "TotalCount": 1
  }
}

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
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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help