Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to query a 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: DescribeConsumer. |
| 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 bound to the delivery task. -Obtain the log topic Id through Get Log Topic List. -Obtain the log topic Id through Create Log Topic. |
| Parameter Name | Type | Description |
|---|---|---|
| Effective | Boolean | Whether the shipping task is effective |
| NeedContent | Boolean | Whether log metadata is shipped |
| Content | ConsumerContent | Metadata shipped if NeedContent is trueNote: This field may return null, indicating that no valid value was found. |
| Ckafka | Ckafka | CKafka information |
| Compression | Integer | Compression mode [0:NONE；2:SNAPPY；3:LZ4] |
| 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. |
Obtaining the Shipping Configurations
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsumer
<Common request parameters>
{
"TopicId": "871710c5-35cd-4d1e-8e79-2fa92c35d612"
}
{
"Response": {
"RequestId": "ef9e67c9-8437-477a-8629-06555a3afbbc",
"Effective": true,
"Ckafka": {
"Vip": "127.0.0.1",
"Vport": "9092",
"InstanceId": "ckafka-8b4az591",
"InstanceName": "kafka protocol consumption monitoring"
"TopicId": "topic-jmpmwejg",
"TopicName": "businesstest000"
},
"Content": {
"EnableTag": true,
"MetaFields": [
"__SOURCE__"
],
"TagJsonNotTiled": true,
"TimestampAccuracy": 0,
"JsonType": 0
},
"NeedContent": true,
"Compression": 0
}
}
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. |
| InvalidParameter | Incorrect parameter. |
| 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. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan