Domain name for API request: cls.tencentcloudapi.com.
This API is used to modify a CKafka 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: ModifyConsumer. |
Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
Region | No | String | Common Params. This parameter is not required for this API. |
TopicId | Yes | String | Log topic ID bound to the task |
Effective | No | Boolean | Whether the shipping task takes effect (default: no) |
NeedContent | No | Boolean | Whether to deliver log Metadata information; the default is true.When NeedContent is true: Content field is valid.When NeedContent is false: Content field is invalid. |
Content | No | ConsumerContent | Metadata to ship if NeedContent is true |
Ckafka | No | Ckafka | CKafka information |
Compression | No | Integer | Compression method during delivery. Valid values: 0, 2, and 3. [0: NONE; 2: SNAPPY; 3: LZ4] |
Parameter Name | Type | Description |
---|---|---|
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 modify a CKafka delivery task.
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyConsumer
<Common request parameters>
{
"TopicId": "xxx-xxx-xxx-xxx",
"Effective": true,
"Ckafka": {
"Vip": "10.123.123.123",
"Vport": "8888",
"InstanceId": "xxxxx",
"InstanceName": "myname",
"TopicId": "xxxxx",
"TopicName": "xxxxx"
},
"Content": {
"EnableTag": true,
"MetaFields": [
"__SOURCE__"
]
},
"NeedContent": true,
"Compression": 0
}
{
"Response": {
"RequestId": "6ef60xxx-0xxx-4xxx-bxxx-270359fb5xxx"
}
}
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.RecordNotExist | Record does not exist |
本页内容是否解决了您的问题?