您可使用 API 向 veImageX 的服务端地址发送请求,并按照接口文档在请求中加入相应请求参数。系统会根据请求的处理情况,返回处理结果。本章节为您介绍 veImageX API 的调用方法,包括但不限于请求结构、公共参数、签名机制和公共错误码。
如果想获得更加便捷的接入体验,推荐您使用服务端 SDK 来调用 API。
veImageX 在全球多个 Region 部署,请您参考下表来调用对应的 OpenAPI 域名。
Region | 英文缩写 | OpenAPI 域名 |
---|---|---|
中国 | cn-north-1 | https://imagex.volcengineapi.com |
新加坡 | ap-singapore-1 | https://imagex-ap-singapore-1.volcengineapi.com |
veImageX 支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。
请根据各接口的具体需求,选择 GET 或 POST 方式发起请求。
方法 | 说明 |
---|---|
GET | 请求服务器返回指定资源。支持将公共信息放置在 header 和 query string 中 |
POST | 请求服务器新增资源或执行特殊操作。仅支持将公共信息放置在 header 中 说明 使用 |
例如,查询服务开通状态的请求方法为 GET,则其中国区请求 URI 为:
https://imagex.volcengineapi.com/?Action=GetImageServiceSubscription&Version=2018-08-01
火山引擎的 OpenAPI 请求包含两类参数:公共请求参数和接口请求参数。
请求及返回结果使用 UTF-8
的字符集进行编码。
详细的签名机制和签名示例,请参见签名方法。
veImageX 的公共返回参数如下表所示。
参数 | 类型 | 描述 |
---|---|---|
RequestId | String | 请求 ID |
Action | String | 请求接口 |
Version | String | 版本 |
Service | String | 服务 |
Region | String | 区域 |
Error | ResponseError | 异常信息 |
参数 | 类型 | 描述 |
---|---|---|
code | String | 错误码 |
Message | String | 详细错误信息 |
当调用失败后,响应结果中的ResponseMetaData.Error
结构体会包含错误码和错误信息。关于错误码和含义请参见公共错误码和 veImageX 错误码。