Domain name for API request: tcaplusdb.tencentcloudapi.com.
This API is used to enable data subscription for tables or modify the feature's configurations.
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: SetTableDataFlow. |
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 | The ID of the cluster where the tables reside |
SelectedTables.N | Yes | Array of SelectedTableWithField | The list of tables for which data subscription will be enabled |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | The number of tables for which data subscription has been enabled |
TableResults | Array of TableResultNew | The result list of tables for which data subscription has been enabled |
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 enable data subscription for tables and modify the feature's configurations.
https://tcaplusdb.tencentcloudapi.com/?Action=SetTableDataFlow
&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
&SelectedTables.0.KafkaInfo.Address=string
&SelectedTables.0.KafkaInfo.IsVpc=0
&SelectedTables.0.KafkaInfo.Topic=string
&SelectedTables.0.KafkaInfo.User=string
&SelectedTables.0.KafkaInfo.Password=string
&SelectedTables.0.KafkaInfo.Instance=string
&<Common request parameters>
{
"Response": {
"RequestId": "122bb375-7464-4536-a3c5-8ddbdd6f4ce4",
"TableResults": [
{
"Error": null,
"TableGroupId": "101",
"TableIdlType": null,
"TableInstanceId": "tcaplus-1f224454",
"TableName": "tb_example",
"TableType": null,
"ApplicationId": "null",
"TaskId": "5674209986-1199",
"TaskIds": null
}
],
"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 |
---|---|
AuthFailure.UnauthorizedOperation | API operation authentication error. |
FailedOperation | Operation failed. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | Incorrect parameter value. |
LimitExceeded | The quota limit is exceeded. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?