Domain name for API request: cls.intl.tencentcloudapi.com.
Create a DLC delivery task
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: CreateDlcDeliver. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| TopicId | Yes | String | Log topic id.
|
| Name | Yes | String | Name: Length not exceeding 64 characters, starts with a letter, accepts 0-9, a-z, A-Z, _, -, Chinese character. |
| DeliverType | Yes | Integer | Delivery Type. 0: Batch delivery, 1: Real-time delivery |
| StartTime | Yes | Integer | Start time of the delivery time range |
| DlcInfo | Yes | DlcInfo | dlc configuration message |
| MaxSize | No | Integer | Delivery file size in MB. Required when DeliverType=0. Range: 5<= MaxSize <= 256. |
| Interval | No | Integer | Delivery interval in seconds. Required when DeliverType=0. Valid range: 300 <= Interval <= 900. |
| EndTime | No | Integer | End time of the delivery time range. If empty, it means unlimited time. When EndTime is not empty, it must be greater than StartTime. |
| HasServicesLog | No | Integer | Whether to enable delivery service log. Valid values: 1: disable; 2: enable. Enabled by default. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Configuration id |
| 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. |
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDlcDeliver
<Common request parameters>
{
"TopicId": "03334fb8-4d74-4dde-ada6-da4c0d0b2ff8",
"Name": "add_dlc_deliver_test1",
"DeliverType": 0,
"StartTime": 1741005340,
"DlcInfo": {
"TableInfo": {
"DataDirectory": "test_table",
"DatabaseName": "test_schema",
"TableName": "test_db"
},
"FieldInfos": [
{
"ClsField": "cls_test_field1",
"DlcField": "dlc_test_field1",
"DlcFieldType": "string",
"Disable": true
}
],
"PartitionInfos": [
{
"ClsField": "cls_test_field2",
"DlcField": "dlc_test_field2",
"DlcFieldType": "int"
}
],
"PartitionExtra": {
"TimeFormat": "/%Y/%m/%d/%H",
"TimeZone": "UTC+08:00"
}
},
"MaxSize": 5,
"Interval": 300,
"EndTime": 1741006340,
"HasServicesLog": 2
}
{
"Response": {
"TaskId": "ba05f9aa-432f-4ccc-9120-b60d1f3a0c20",
"RequestId": "d2ceec4a-1f59-4508-ae4c-e256c30dea1f"
}
}
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 | CAM signature/authentication error. |
| AuthFailure.UnauthorizedOperation | Request unauthorized. |
| FailedOperation | Operation failed. |
| FailedOperation.Timeout | Operation timed out |
| InternalError | Internal error. |
| InternalError.DbError | DB Error. |
| InternalError.IllegalRole | Illegal role. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.DbDuplication | The unique key of database conflicts. |
| InvalidParameter.ParamError | Parameter error. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded.RecordOutOfLimit | Record exceeds limit |
| MissingParameter | Missing parameter. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
피드백