You need to enable JavaScript to run this app.
导航
调用方法
最近更新时间:2024.02.19 15:03:24首次发布时间:2021.02.23 10:42:25

您可使用 API 向 veImageX 的服务端地址发送请求,并按照接口文档在请求中加入相应请求参数。系统会根据请求的处理情况,返回处理结果。本章节为您介绍 veImageX API 的调用方法,包括但不限于请求结构、公共参数、签名机制和公共错误码。

如果想获得更加便捷的接入体验,推荐您使用服务端 SDK 来调用 API。

请求结构

服务地址

veImageX 在全球多个 Region 部署,请您参考下表来调用对应的 OpenAPI 域名。

Region英文缩写OpenAPI 域名
中国cn-north-1https://imagex.volcengineapi.com
新加坡ap-singapore-1https://imagex-ap-singapore-1.volcengineapi.com

通信协议

veImageX 支持通过 HTTPHTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。

请求方法

请根据各接口的具体需求,选择 GETPOST 方式发起请求。

方法说明
GET请求服务器返回指定资源。支持将公共信息放置在 header 和 query string 中

POST

请求服务器新增资源或执行特殊操作。仅支持将公共信息放置在 header 中

说明

使用 POST 方法发送请求时,您必须在请求头中指定 Content-Type: application/json

例如,查询服务开通状态的请求方法为 GET,则其中国区请求 URI 为:

https://imagex.volcengineapi.com/?Action=GetImageServiceSubscription&Version=2018-08-01

请求参数

火山引擎的 OpenAPI 请求包含两类参数:公共请求参数和接口请求参数。

  • 公共请求参数:公共请求参数是用于标识账号和接口签名的参数,所有接口都相同。每次请求都需要携带这些参数才能正常发起请求。具体可参见公共参数
  • 接口请求参数:各个接口特有参数,详见各 API 接口文档

字符编码

请求及返回结果使用 UTF-8 的字符集进行编码。

签名机制

详细的签名机制和签名示例,请参见签名方法

返回结果

公共返回参数

veImageX 的公共返回参数如下表所示。

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息
ResponseError
参数类型描述
codeString错误码
MessageString详细错误信息

错误码

当调用失败后,响应结果中的ResponseMetaData.Error结构体会包含错误码和错误信息。关于错误码和含义请参见公共错误码veImageX 错误码