本文介绍调用 Mobile Use Agent OpenAPI 的方法。对于具体的调用说明和参数说明，请查阅各 OpenAPI 文档。 ## 前提条件 1. 完成[账号注册](https://www.volcengine.com/docs/6261/64925)和[实名认证](https://www.volcengine.com/docs/6261/64935)。 2. 获取账号的 Access Key ID 和 Secret Access Key （AK/SK），用于 API 请求鉴权。详细步骤，参考 [API 访问密钥使用指南](https://www.volcengine.com/docs/6291/65568)。 3. 调用 Mobile Use Agent OpenAPI 前，必须先访问[跨服务访问请求](https://console.volcengine.com/iam/service/attach_role/?ServiceName=ipaas)为您的账号授权。 ## 请求结构调用 Mobile Use Agent OpenAPI 是通过向指定服务地址发送请求，并需满足签名信息和具体接口的业务信息来完成的。OpenAPI 的请求需要包含服务地址、请求方式、请求参数等信息。接口调用成功后，对返回结果进行解析。 ### 服务地址 `open.volcengineapi.com` ### 通信协议 Mobile Use Agent OpenAPI 通信均采用 HTTPS 协议，确保数据传输的安全性和完整性，为您提供一个安全可靠的通信环境。 ### 字符编码请求及返回结果使用 UTF\-8 的字符集进行编码。 ### 请求方式根据各个接口的具体需求，选择 GET 或 POST 方式发起请求。 ### 请求参数在发起请求时，请包含以下两类参数： * 公共请求参数：所有接口调用时必须包含的参数。公共请求参数首字母均为大写，以此区分接口特有的请求参数。有关火山引擎 OpenAPI 公共参数的详细说明，请参考[公共参数](https://www.volcengine.com/docs/6369/67268)。 * 接口特定参数：各接口特有的业务参数。详情查阅各接口参数描述。 ### 示例以**查询代理运行配置列表**接口为例，一条未编码的 URL 请求示例如下： ```HTTP https://open.volcengineapi.com?Action=ListAgentRunConfig &Version=2023-08-01 &<通过header传入的公共请求参数> &<请求体> ``` 说明如下： |**参数/结构** |**说明** | |---|---| |https://open.volcengineapi.com |请求的通信协议和服务接入地址。 | |Action |指定要调用的接口名称。例如，**查询代理运行配置列表**接口名称为 `ListAgentRunConfig`。 | |Version |接口的版本号。Mobile Use Agent OpenAPI 版本号统一为 `2023-08-01`。 | |通过header传入的公共请求参数 |系统规定的公共参数，主要包括以下参数：

* AccessKey：用于 API 请求鉴权的密钥。参考 [API 访问密钥使用指南](https://www.volcengine.com/docs/6291/65568) 获取。

* SecretKey：用于 API 请求鉴权的密钥。参考 [API 访问密钥使用指南](https://www.volcengine.com/docs/6291/65568) 获取。

* ServiceName：OpenAPI 服务名称。Mobile Use Agent OpenAPI 的服务名称固定为 **ipaas**。

* Region：OpenAPI 服务所在区域。Mobile Use Agent OpenAPI 的服务区域固定为 **cn\-north\-1**。 | |请求体 |调用 OpenAPI 需要的业务参数。 | ## 签名机制对于每一次 HTTPS 协议请求，会根据访问中的签名信息验证访问请求者的身份。具体由用户的火山引擎账号对应的 Access Key ID 和 Secret Access Key（AK/SK）对称加密验证实现。具体的签名机制和方法，参考火山引擎 OpenAPI [签名方法](https://www.volcengine.com/docs/6369/67269)。 ## 返回结果 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 的错误码，参看[错误码](https://www.volcengine.com/docs/6394/1134303) | |Code |String |是 |状态消息 | |Message |String |是 |具体的错误描述信息 |

云手机