分布式消息服务-RocketMQ

构造请求

2024-07-02 02:42:31

请求的URI

请求URI由如下部分组成:{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

参数

描述

是否必选

URI-scheme

用于传输请求的协议,当前所有API均采用HTTPS协议。

Endpoint

当前资源池或者通用的域名

resource-path

资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1”。

query-string

 

查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?userID=1”,表示查询用户ID为1的数据。

请求方法

方法

说明

GET

请求服务器返回指定资源。

PUT

请求服务器更新指定资源。

POST

请求服务器新增资源或执行特殊操作。

DELETE

请求服务器删除指定资源,如删除对象等。

HEAD

请求服务器资源头部。

PATCH

请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。

请求消息头

附加请求头字段,主要是用于鉴权的公共字段。

参数

值(说明)

Content-Type

application/json

ctyun-eop-request-id

用户请求id,通过uuid生成,形如33dfa732-b27b-464f-b15a-21ed6845afd5

Eop-Authorization

由天翼云官网accessKey和securityKey经签名后生成,签名逻辑详见后续说明

Eop-Date

请求时间,形如yyyyMMdd'T'HHmmss'Z',例如20211109T104641Z

请求代码示例

Bash

Curl https://{Endpoint}/接口地址

 -H "Content-Type:application/json;charset=UTF-8" -H "eop-authorization:xxxxxxxxxxxxxxxxxx" -H "Eop-date:20211014T163109Z" -H "ctyun-eop-request-id:e5d0d445-29a5-4bfc-a4e8-a5b70f889cc3"

请求消息体

请求消息体可选,格式统一为JSON,具体内容参见各个API接口说明。


6t2mfiInyGzv