# 发送消息 - SendMessage #### 功能介绍 发送消息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hrm/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hrm/api-grant-policy.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v2/{engine}/{project_id}/instances/{instance_id}/messages 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine | 是 | String | **参数解释**： 消息引擎类型。 **约束限制**： 不涉及。 **取值范围**： - rocketmq：RocketMQ消息引擎。 - reliability：RocketMQ消息引擎别称。 **默认取值**： 不涉及。 | | project_id | 是 | String | **参数解释**： 项目ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hrm/hrm-api-0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。获取方法如下：调用"查询所有实例列表"接口，从响应体中获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | topic | 是 | String | **参数解释**： 主题名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | body | 是 | String | **参数解释**： 消息内容。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | property_list | 否 | Array of [SendMessagePropertiesReqEntity] objects | **参数解释**： 特性列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值** 不涉及。 | 表3SendMessagePropertiesReqEntity | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 特性名称。 **约束限制**： 不涉及。 **取值范围**： - KEYS：消息标识，是用来标识单条消息的唯一特征的字符串，通常关联业务主键。 - TAGS：标签，是用来对同一主题（Topic）下的消息进行细分归类的标识。 **默认取值** 不涉及。 | | value | 否 | String | **参数解释**： 特性值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | topic | String | **参数解释**： 主题名称。 **取值范围**： 不涉及。 | | body | String | **参数解释**： 消息内容。 **取值范围**： 不涉及。 | | property_list | Array of [SendMessagePropertiesRespEntity] objects | **参数解释**： 特性列表。 | | msg_id | String | **参数解释**： 消息ID。 **取值范围**： 不涉及。 | | queue_id | Number | **参数解释**： 队列ID。 **取值范围**： 不涉及。 | | queue_offset | Number | **参数解释**： 队列offset。 **取值范围**： 不涉及。 | | broker_name | String | **参数解释**： Broker名称。 **取值范围**： 不涉及。 | 表5SendMessagePropertiesRespEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 特性名称。 **取值范围**： - KEYS：消息标识，是用来标识单条消息的唯一特征的字符串，通常关联业务主键。 - TAGS：标签，是用来对同一主题（Topic）下的消息进行细分归类的标识。 - UNIQ_KEY：RocketMQ内置的全局唯一标识。 | | value | String | **参数解释**： 特性值。 **取值范围**： 不涉及。 | #### 请求示例 发送消息。 ``` POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages { "topic" : "aaaaaaaaaaaa", "body" : "test", "property_list" : [ ] } ``` #### 响应示例 **状态码：200** 发送消息成功。 ``` { "topic" : "aaaaaaaaaaaa", "body" : "test", "property_list" : [ { "name" : "UNIQ_KEY", "value" : "644F0069A35A0FC5A0FC5AB7244F4573A03FA" } ], "msg_id" : "644F0E2A315323EAB33D8F4733110009", "queue_id" : 0, "queue_offset" : 0, "broker_name" : "broker-0" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 发送消息。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; import java.util.List; import java.util.ArrayList; public class SendMessageSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("")) .build(); SendMessageRequest request = new SendMessageRequest(); request.withEngine("{engine}"); request.withInstanceId("{instance_id}"); SendMessageReq body = new SendMessageReq(); body.withBody("test"); body.withTopic("aaaaaaaaaaaa"); request.withBody(body); try { SendMessageResponse response = client.sendMessage(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 发送消息。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("")) \ .build() try: request = SendMessageRequest() request.engine = "{engine}" request.instance_id = "{instance_id}" request.body = SendMessageReq( body="test", topic="aaaaaaaaaaaa" ) response = client.send_message(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 发送消息。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := rocketmq.NewRocketMQClient(hcClient) request := &model.SendMessageRequest{} request.Engine = "{engine}" request.InstanceId = "{instance_id}" request.Body = &model.SendMessageReq{ Body: "test", Topic: "aaaaaaaaaaaa", } response, err := client.SendMessage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RocketMQ/sdk?api=SendMessage)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 发送消息成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hrm/ErrorCode.html)。