本文档介绍云原生消息引擎 OpenAPI 请求的基本结构。
云原生消息引擎 OpenAPI 请求主要由三部分构成：

• 请求 URL：指向具体的业务请求。
• 请求 Header：指定 Content-Type 和请求鉴权信息等公共参数。
• 请求 Body：API 对应的若干请求参数。若接口没有请求参数，则无需传递 Body。

请求 URL

您可以通过发送 HTTPS 请求来调用云原生消息引擎的 API。
发起 API 请求的 URL 由不同参数拼凑而成，有固定的请求结构。URL 中包含公共参数、签名和接口参数。请求及返回结果均使用 UTF-8 的字符集进行编码。

HTTPS 请求 URL 的格式如下：

https://open.volcengineapi.com/?Action=xxx&{parameters}

其中：

• Action：表示要执行的操作，即要调用的 API 接口。
• parameters：表示 API 接口在 URL 中的请求参数。查询类 API 接口需要在请求 URL 中传递业务参数，例如 Describe* 等 API；其他 API 接口直接在 Body 中传递业务参数。

以查看项目详情（DescribeProject）为例，未编码的 HTTPS 请求 URL 如下。

GET https://open.volcengineapi.com?Action=DescribeTopic&Version=2023-06-01&TopicId=f129bb8ddb5e**09a9133a9ce5

请求 Header

HTTPS 请求的请求头（Header）中需要指定 Content-Type 和请求鉴权信息等公共参数，用于标识用户和接口签名。若非必要，每个单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。
其中，Content-type 指定了请求消息体的结构化格式，云原生消息引擎的 Content-Type 固定为application/json。详细的参数列表及说明请参见公共参数。

请求 Body

请求 Body，即请求消息体，主要传递业务相关的请求参数。若请求消息体中参数支持中文，则中文字符必须为 UTF-8 编码。
每个接口的请求消息体内容不同，也并非每个接口都需要有请求消息体（即消息体为空），调用接口时，请参考具体 API 接口文档构建请求消息体。

请求方法

云原生消息引擎支持 HTTP 和 HTTPS 网络请求协议，支持 GET 和 POST 请求方法。
推荐使用安全性更高的 HTTPS 方式发送请求。

发起请求

您可以使用 curl、Postman 或直接编写代码等方式发送请求调用 API。
例如 CreateTopic 接口的请求示例如下：

POST https://open.volcengineapi.com?Action=CreateTopic&Version=2023-06-01
Content-Type: application/json
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/bmq/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***
{
    "InstanceId": "o-00o0**8bg3",
    "Topic": "doc-topic-1",
    "Description": "文档测试 Topic！",
    "Partitions": 12,
    "Replicas": 3,
    "Retention": 72
}