OpenAPI 调用说明--云手机-火山引擎

文档中心

导航

OpenAPI 调用说明

最近更新时间：2024.08.01 19:40:59首次发布时间：2021.10.18 18:26:50

本文介绍了调用云手机服务端 OpenAPI 的方法，对于具体 OpenAPI 的调用方法，请参考具体的接口说明文档。

前提条件

通过火山引擎云手机控制台注册帐号，获取账号的 Access Key ID 和 Secret Access Key （AK/SK），用于 API 请求鉴权。详细步骤，参考 API 访问密钥使用指南。
开通云手机服务，并确保使用的账号具有对应资源的访问权限。

调用云手机服务端 OpenAPI 接口时，是通过向指定服务地址发送请求，并需满足签名信息和具体接口的业务信息来完成的。OpenAPI 的请求需要包含服务地址、请求方式、请求参数等信息。接口调用成功后，对返回结果进行解析。

open.volcengineapi.com

云手机的所有接口通信均采用 HTTPS 协议，确保数据传输的安全性和完整性，为您提供一个安全可靠的通信环境。

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

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

在发起请求时，请包含以下两类参数：

公共请求参数：所有接口调用时必须包含的参数。公共请求参数首字母均为大写，以此区分接口特有的请求参数。有关火山引擎 OpenAPI 公共参数的详细说明，请参考公共参数。
接口特定参数：各接口特有的业务参数。详情参看各接口参数描述。

以获取实例列表信息接口为例，一条未编码的 URL 请求示例如下：

https://open.volcengineapi.com?Action=ListPod
&Version=2023-10-30
&<通过header传入的公共请求参数>
&<请求体>

说明如下：

参数/结构	说明
https://open.volcengineapi.com	请求的通信协议和服务接入地址。
Action	指定要调用的 API 接口（示例中的 `ListPod` 为查询实例列表接口）。
Version	接口的版本号，当前为 2023-10-30。
通过header传入的公共请求参数	系统规定的公共参数，主要包括以下参数： AccessKey：用于 API 请求鉴权的密钥。参考 API 访问密钥使用指南获取。 SecretKey：用于 API 请求鉴权的密钥。参考 API 访问密钥使用指南获取。 ServiceName：OpenAPI 服务名称。云手机 OpenAPI 的服务名称固定为 ACEP。 Region：OpenAPI 服务所在区域。云手机 OpenAPI 的服务区域固定为 cn-north-1。
请求体	调用 OpenAPI 接口需要的业务参数

对于每一次 HTTPS 协议请求，会根据访问中的签名信息验证访问请求者的身份。具体由用户的火山引擎账号对应的 Access Key ID 和 Secret Access Key（AK/SK）对称加密验证实现。具体的签名机制和方法，参考火山引擎 OpenAPI 签名方法。

OpenAPI 请求可返回以下结果：

字段	类型	是否一定返回	说明
ResponseMetadata	Object	是	响应元数据；需通过解析该结构体，判断响应结果，参考以下 ResponseMetadata 结构体说明
Result	Any	否	响应数据；调用成功时返回

ResponseMetadata 结构体说明

字段	类型	是否一定返回	说明
RequestId	String	是	请求 ID
Action	String	是	OpenAPI 接口名称
Version	String	是	OpenAPI 接口版本
Service	String	是	OpenAPI 服务名称
Region	String	是	服务所在地域信息
Error	Object	否	错误信息；调用失败时返回，参考以下 Error 结构体说明

Error 结构体说明

字段	类型	是否一定返回	说明
CodeN	Int64	是	API 的错误码，参看错误码
Code	String	是	状态消息
Message	String	是	具体的错误描述信息