本文为您介绍在使用短剧智能翻译 API 时必须了解的一些信息。
接入地址 |
|---|
open.volcengineapi.com |
支持通过 HTTP 和 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。
根据各个接口的具体需求,选择 GET 或 POST 方式发起请求。
方法 | 说明 |
|---|---|
GET(推荐) | 请求服务器返回指定资源。
|
POST | 请求服务器新增资源或执行特殊操作。
|
注意
Action 和 Version 必须放在 Query String 中。在发起请求时,需要包含以下两类参数:
请求及返回结果都使用 UTF-8 字符集进行编码。
详细的签名机制和签名示例,请参见签名方法。
签名生成示例(签名生成逻辑复杂,建议直接使用示例中的签名示例)
响应 HTTP 状态码成功请求的情况下均为 200,部分失败请求会返回 4xx 及 5xx 的错误码。
公共返回参数如下表所示。
参数 | 类型 | 描述 |
|---|---|---|
RequestId | String | 请求 ID |
Action | String | 请求接口 |
Version | String | 版本 |
Service | String | 服务 |
Region | String | 区域 |
Error | 异常信息 |
参数 | 类型 | 描述 |
|---|---|---|
Code | String | 错误码 |
Message | String | 详细错误信息 |
说明
您可以通过返回结果中 ResponseMetadata 结构体是否存在 Error 字段来判断返回结果是否正常。存在 Error 字段则表示返回结果异常。
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "", "Version": "2021-05-21", "Service": "", "Region": "cn-north-1" }, "Result": { ...... } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "", "Version": "2021-05-21", "Service": "", "Region": "cn-north-1", "Error": { "Code": "ResourceNotFound", "Message": "resource is not found" } } }