Product Overview
Benefits
Use Cases
Architecture
Regions
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
This API is used to upload and verify a table creation file and return the definition of tables that are verified to be valid.
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: VerifyIdlFiles. |
| 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 to create a table |
| TableGroupId | No | String | ID of the table group where to create a table |
| ExistingIdlFiles.N | No | Array of IdlFileInfo | List of information of uploaded IDL files. Either this parameter or NewIdlFiles must be present |
| NewIdlFiles.N | No | Array of IdlFileInfo | List of information of IDL files to be uploaded. Either this parameter or ExistingIdlFiles must be present |
| Parameter Name | Type | Description |
|---|---|---|
| IdlFiles | Array of IdlFileInfo | Information list of all IDL files uploaded and verified in this request |
| TotalCount | Integer | Number of valid tables parsed by reading IDL description file, excluding tables already created |
| TableInfos | Array of ParsedTableInfoNew | List of valid tables parsed by reading IDL description file, excluding tables already created |
| 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 select an uploaded table creation IDL file and verify it.
POST / HTTP/1.1
Host: tcaplusdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyIdlFiles
<Common request parameters>
{
"ExistingIdlFiles": [
{
"FileExtType": "proto",
"FileType": "PROTO",
"FileName": "tb_example",
"FileSize": 0,
"FileContent": "xx",
"FileId": 0
}
],
"TableGroupId": "101",
"NewIdlFiles": [
{
"FileExtType": "xx",
"FileType": "xx",
"FileName": "xx",
"FileSize": 0,
"FileContent": "xx",
"FileId": 0
}
],
"ClusterId": "5674209986"
}{
"Response": {
"IdlFiles": [
{
"FileContent": null,
"FileExtType": "proto",
"FileId": 564,
"FileName": "tb_example",
"FileSize": 261,
"FileType": "PROTO"
}
],
"RequestId": "70707604-2031-4c7e-a85f-a52daf354eb0",
"TableInfos": [
{
"Error": null,
"IndexKeySet": "{\"Num\":0}",
"KeyFields": "{\"KeyField\":[{\"Label\":\"required\",\"Name\":\"uin\",\"Type\":\"int64\"},{\"Crypto\":false,\"Label\":\"required\",\"Name\":\"name\",\"Type\":\"string\"}],\"Num\":2}",
"TableGroupId": null,
"OldKeyFields": null,
"OldValueFields": null,
"ShardingKeySet": "",
"SumKeyFieldSize": 1022,
"SumValueFieldSize": 262144,
"TableIdlType": "PROTO",
"TableInstanceId": null,
"TableName": "tb_example",
"TableType": "GENERIC",
"TdrVersion": 1,
"ListElementNum": null,
"SortFieldNum": null,
"SortRule": null,
"ValueFields": "{\"Num\":2,\"ValueField\":[{\"Label\":\"required\",\"Name\":\"gamesvrid\",\"Type\":\"int32\"},{\"Crypto\":false,\"Label\":\"optional\",\"Name\":\"logintime\",\"Type\":\"string\"}]}"
}
],
"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. |
피드백