tencent cloud

文档反馈

SendMessage

最后更新时间:2023-07-05 15:57:48

1. API Description

Domain name for API request: ckafka.tencentcloudapi.com.

This API is used to send messages through the HTTP access layer.

A maximum of 5000 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: SendMessage.
Version Yes String Common Params. The value used for this API: 2019-08-19.
Region No String Common Params. This parameter is not required for this API.
DataHubId Yes String Datahub access ID.
Message.N Yes Array of BatchContent Content of the message that has been sent. Up to 500 messages can be sent in a single request.

3. Output Parameters

Parameter Name Type Description
MessageId Array of String Message ID list.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sending messages through the HTTP access layer in DataHub

This example shows you how to send messages through the HTTP access layer in DataHub.

Input Example

POST / HTTP/1.1Host: ckafka.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: SendMessage<Common request parameters>{    "DataHubId": "datahub-meuh9nhn",    "Message": [        {            "Key": "",            "Body": "vvvvsdgsgshhh"        },        {            "Key": "",            "Body": "vvvhhhhhhvsdgsgshhh"        }    ]}

Output Example

{
    "Response": {
        "RequestId": "20e995ed-75b9-43bb-84c0-35676567e1a8",
        "MessageId": [
            "646174616875622d6d657568396e686e3a6465736372696265436c6f75644170693a343a3236313838",
            "875622d6d657568396e686e3a6465736372696265436c6f75644170693a343a3236323337"
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 Invalid parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InstanceNotExist The instance does not exist.
OperationDenied Operation denied.
OperationDenied.ResourceTaskPaused Task paused.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceNotFound The resource does not exist.
ResourceUnavailable.KafkaStorageError Disk resources are unavailable on the broker.