Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to get the configuration of the task shipped to COS.
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: DescribeShippers. |
| 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. |
| Filters.N | No | Array of Filter | -shipperName: Filter by [delivery rule name]. Type: String. Required: No -shipperId: Filter by [Delivery Rule ID]. Type: String. Required: No -topicId: Filter by [log topic]. Type: String. Required: No -taskStatus: Filter by [task running status]. Supported values: 0: stop, 1: running, 2: exception.Type: String Required: No Each request can have up to 10 Filters. The upper limit of Filter.Values is 10. |
| Offset | No | Integer | Page offset. Default value: 0 |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100 |
| PreciseSearch | No | Integer | Control whether the relevant fields in Filters use exact matching. 0: Default value, fuzzy matching for shipperName. 1: Exact match for shipperName. |
| Parameter Name | Type | Description |
|---|---|---|
| Shippers | Array of ShipperInfo | Shipping rule list |
| TotalCount | Integer | Total number of results obtained in this query |
| 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. |
Retrieve task configuration information shipped to COS
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeShippers
<Common request parameters>
{
"Filters": [
{
"Key": "shipperId",
"Values": [
"0c2486ee-xxxx-xxxx-a10c-15f01573d928"
]
}
],
"Offset": 0,
"Limit": 10
}
{
"Response": {
"RequestId": "e34e49f3-xxxx-xxxx-8ec4-441419573405",
"Shippers": [
{
"Bucket": "good-123456780",
"Compress": {
"Format": "gzip"
},
"Content": {
"Csv": null,
"Format": "json",
"Json": {
"EnableTag": false,
"JsonType": 0,
"MetaFields": null
},
"Parquet": null
},
"CreateTime": "2020-10-28 22:04:41",
"EndTime": 0,
"FilenameMode": 0,
"FilterRules": [],
"HistoryStatus": 0,
"Interval": 300,
"MaxSize": 256,
"Partition": "%Y/%m/%d",
"Prefix": "logproxy",
"Progress": 0,
"RemainTime": 0,
"ShipperId": "0c2486ee-xxxx-xxxx-a10c-15f01573d928",
"ShipperName": "shipper_task",
"StartTime": 0,
"Status": true,
"TaskStatus": 1,
"TopicId": "313f58b2-xxxx-xxxx-b9b8-08fa4b0bd260"
}
],
"TotalCount": 15
}
}
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 | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit has been reached. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback