Domain name for API request: cls.intl.tencentcloudapi.com.
Create a CLS shipping 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: CreateCLSDeliverTask. |
| 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. |
| TaskName | Yes | String | Task name Parameter format: |
| SourceTopicConfig | Yes | SourceTopicConfig | Source topic information |
| TargetTopicConfig | Yes | TargetTopicConfig | Target topic information |
| DeliverRule | Yes | DeliverRule | Shipping Rule |
| Compliance | Yes | Integer | Compliance commitment. Enumeration values:
|
| HasServicesLog | No | Integer | Whether to enable delivery service log. Enumeration values:
Default value: 2 |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Task 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: CreateCLSDeliverTask
<Common request parameters>
{
"TaskName": "b*******_test_ap-tokyo_cross",
"SourceTopicConfig": {
"TopicFilterType": 1,
"LogsetId": "ca5938d1-e027-409c-a345-16ce7b5e8d98",
"Topics": [
{
"TopicId": "b*******-test-ok-1254077820"
}
]
},
"TargetTopicConfig": {
"AccountType": 1,
"Region": "ap-*****",
"LogsetId": "16bcb721-0101-4c6f-8c4c-aa0e290ab5da",
"TopicId": "32d29136-bdfc-4749-928b-a0b24d62a3b8"
},
"DeliverRule": {
"DataScope": 3
},
"Compliance": 1,
"HasServicesLog": 2
}{
"Response": {
"TaskId": "5c1f1002-ceb1-4b45-a2f9-bcfc1fbd23ed",
"RequestId": "2ade24da-8ed5-4680-bf2e-c2b9e1be01f8"
}
}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. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | Account arrears. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound.LogsetNotExist | The specified log set does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
文档反馈