最近更新时间:2023.05.11 16:26:01
首次发布时间:2023.05.11 16:17:40
本文档介绍批式计算 Spark 版 OpenAPI 请求的基本结构。
OpenAPI 请求主要由三部分构成:
Content-Type
和请求鉴权信息等公共参数。您可以通过发送请求来调用批式计算 Spark 版的 API。
发起 API 请求的 URL 有固定的请求结构,请根据业务需求填写正确的接口名称和版本号。请求及返回结果均使用 UTF-8 的字符集进行编码。
HTTPS 请求 URL 的格式如下:
https://open.volcengineapi.com?Action=xxx&Version=2021-06-01
HTTPS 请求的请求头(Header)中需要指定 Content-Type
和请求鉴权信息等公共参数,用于标识用户和接口签名。若非必要,每个单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
其中,Content-type 指定了请求消息体的结构化格式,批式计算 Spark 版的 Content-Type 固定为application/json
。详细的参数列表及说明请参见公共参数。
请求 Body,即请求消息体,主要传递业务相关的请求参数。若请求消息体中参数支持中文,则中文字符必须为 UTF-8 编码。
每个接口的请求消息体内容不同,也并非每个接口都需要有请求消息体(即消息体为空),调用接口时,请参考具体 API 接口文档构建请求消息体。
批式计算 Spark 版支持 HTTP 和 HTTPS 网络请求协议,支持 POST 请求方法。
推荐使用安全性更高的 HTTPS 方式发送请求。
您可以使用 curl、Postman 或直接编写代码等方式发送请求调用 API。
例如 DescribeProject 接口的请求示例如下:
POST https://open.volcengineapi.com?Action=DescribeProject&Version=2021-06-01 Content-Type: application/json Region: cn-beijing ServiceName: spark { "ProjectId": "qh8i***e0xt" }