文档中心

调用方法

最近更新时间：2022.09.23 19:21:38

首次发布时间：2021.10.21 21:32:31

请求结构

服务地址

接入地域	域名
华北	open.volcengineapi.com

通信协议

智能处理提供的所有接口均通过 HTTPS 进行通信，提供高安全性的通信通道。

请求方法

根据各个接口的具体需求，选择 GET 或 POST 方式发起请求。

方法	说明
GET（推荐）	请求服务器返回指定资源。使用 GET 方式，所有参数均放在 Query String 中的。使用 GET 方式，所有请求参数均需要做 URL 编码。
POST	请求服务器新增资源或执行特殊操作。使用 POST 方式，所有参数放在 Request Body 中。使用 POST 方式，POST 方式无需对参数编码。

方法

说明

GET（推荐）

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

使用 GET 方式，所有参数均放在 Query String 中的。
使用 GET 方式，所有请求参数均需要做 URL 编码。

POST

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

使用 POST 方式，所有参数放在 Request Body 中。
使用 POST 方式，POST 方式无需对参数编码。

注意

公共参数中的 Action 和 Version 必须放在 Query String 中。
一般情况下推荐使用 GET，当参数字符串过长时推荐使用 POST。

请求参数

每个请求都需要指定要执行的操作（Action 参数）。
每个请求需要包含的公共请求参数，以及指定操作特有的请求参数。

字符编码

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

公共参数

公共参数是用于标识账号和接口签名的参数，所有接口都相同。每次请求都需要携带这些参数才能正常发起请求。

在发起请求时，需要包含 2 类参数：公共请求参数和接口请求参数。

接口特有的请求参数，请参看具体 API 接口文档；
公共参数是所有 OpenAPI 请求必须包含的内容。

签名机制

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

响应结果

响应状态码

响应 HTTP 状态码成功请求的情况下均为 200，部分失败请求会返回 4xx 及 5xx 的错误码。

如何判定响应是否正常。

通过响应结果中的 ResponseMetadata 结构体是否存在 Error 字段来判断。
存在 Error 字段，则可判断响应失败。

返回结果

正常返回结果

{
    "ResponseMetadata": {
        "RequestId": "202008271***0650D0371A8",
        "Action": "SubmitJob",
        "Version": "2021-06-11",
        "Service": "imp",
        "Region": "cn-north-1"
    },
    "Result": {
       ...
    }
}

异常返回结果

{
    "ResponseMetadata": {
        "RequestId": "2018060411***0100232280022D30",
        "Action": "SubmitJob",
        "Version": "2020-08-03",
        "Service": "imp",
        "Region": "cn-north-1",
        "Error": {
            "Code": "ResourceNotFound",
            "Message": "resource is not found"
		}
	}
}