产品概述
产品优势
应用场景
产品架构
地域介绍
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
This API is used to select a target table, upload and verify the table modification file, and return the result of whether the table structure is allowed to be modified.
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: CompareIdlFiles. |
| 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 to be modified resides |
| SelectedTables.N | Yes | Array of SelectedTableInfoNew | List of tables to be modified |
| ExistingIdlFiles.N | No | Array of IdlFileInfo | Selected list of uploaded IDL files. Either this parameter or NewIdlFiles must be selected |
| NewIdlFiles.N | No | Array of IdlFileInfo | List of IDL files to be uploaded. Either this parameter or ExistingIdlFiles must be selected |
| Parameter Name | Type | Description |
|---|---|---|
| IdlFiles | Array of IdlFileInfo | Information list of all IDL files uploaded and verified in this request |
| TotalCount | Integer | Number of tables verified to be valid in this request |
| TableInfos | Array of ParsedTableInfoNew | Verification result parsed from the selected table after the IDL description file is read |
| 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 upload and verify a table structure modification file.
POST / HTTP/1.1
Host: tcaplusdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CompareIdlFiles
<Common request parameters>
{
"ExistingIdlFiles": [
{
"FileExtType": "xx",
"FileType": "xx",
"FileName": "xx",
"FileSize": 0,
"FileContent": "xx",
"FileId": 0
}
],
"NewIdlFiles": [
{
"FileExtType": "proto",
"FileType": "PROTO",
"FileName": "tb_example_modify",
"FileSize": 0,
"FileContent": "syntax%3d%22proto2%22%3bpackage+myTcaplusTable%3bimport+%22tcaplusservice.optionv1.proto%22%3bmessage+tb_example%7boption(tcaplusservice.tcaplus_primary_key)%3d%22uin%2cname%22%3brequired+int64+uin+%3d+1%3brequired+string+name+%3d+2%3brequired+int32+gamesvrid+%3d+3%3boptional+string+logintime+%3d+4%3boptional+int32+add_v1+%3d+5%3b%7d",
"FileId": 0
}
],
"ClusterId": "5674209986",
"SelectedTables": [
{
"TableIdlType": "PROTO",
"TableGroupId": "101",
"FileExtType": "xx",
"TableInstanceId": "tcaplus-1f224454",
"Memo": "xx",
"TableName": "tb_example",
"ReservedReadQps": 0,
"ListElementNum": 0,
"ReservedVolume": 0,
"ReservedWriteQps": 0,
"FileSize": 0,
"FileContent": "xx",
"FileName": "xx",
"TableType": "xx"
}
]
}{
"Response": {
"IdlFiles": [
{
"FileContent": null,
"FileExtType": "proto",
"FileId": 600,
"FileName": "tb_example_modify",
"FileSize": 287,
"FileType": "PROTO"
}
],
"RequestId": "81274902-0df6-4574-a3b0-2ea229ef903f",
"TableInfos": [
{
"Error": null,
"IndexKeySet": null,
"KeyFields": "{\"KeyField\":[{\"Label\":\"required\",\"Name\":\"uin\",\"Type\":\"int64\"},{\"Crypto\":false,\"Label\":\"required\",\"Name\":\"name\",\"Type\":\"string\"}],\"Num\":2}",
"TableGroupId": "101",
"OldKeyFields": "{\"KeyField\":[{\"Label\":\"required\",\"Name\":\"uin\",\"Type\":\"int64\"},{\"Crypto\":false,\"Label\":\"required\",\"Name\":\"name\",\"Type\":\"string\"}],\"Num\":2}",
"OldValueFields": "{\"Num\":2,\"ValueField\":[{\"Label\":\"required\",\"Name\":\"gamesvrid\",\"Type\":\"int32\"},{\"Crypto\":false,\"Label\":\"optional\",\"Name\":\"logintime\",\"Type\":\"string\"}]}",
"ShardingKeySet": "",
"SumKeyFieldSize": 1022,
"SumValueFieldSize": 262144,
"TableIdlType": "PROTO",
"TableInstanceId": "tcaplus-1f224454",
"TableName": "tb_example",
"TableType": "GENERIC",
"TdrVersion": 1,
"ListElementNum": null,
"SortFieldNum": null,
"SortRule": null,
"ValueFields": "{\"Num\":3,\"ValueField\":[{\"Label\":\"required\",\"Name\":\"gamesvrid\",\"Type\":\"int32\"},{\"Crypto\":false,\"Label\":\"optional\",\"Name\":\"logintime\",\"Type\":\"string\"},{\"Label\":\"optional\",\"Name\":\"add_v1\",\"Type\":\"int32\"}]}"
}
],
"TotalCount": 1
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameterValue | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
文档反馈