You need to enable JavaScript to run this app.
导航

请求结构

最近更新时间2023.07.03 16:32:38

首次发布时间2022.02.25 18:58:32

火山引擎边缘计算节点提供的 API 可以通过 GET 或 POST 方式调用。请求方法将在每个具体接口的文档中给出。

结构示例

以下内容以一条 GET 请求为例对请求结构进行说明。

GET https://veenedge.volcengineapi.com/?Action=GetCloudServer&Version=2021-04-30
&cloud_server_id=cloudserver-7wcqrqr425t****
&<其他公共参数>

以上示例中:

  • GET 指定了请求方法。
  • https 指定了请求通信协议。
  • veenedge.volcengineapi.com 指定了边缘计算节点的服务地址。
  • Action 是一个公共参数,指定了接口的名称。
  • Version 是一个公共参数,指定了接口的版本。
  • cloud_server_id 是接口特定的参数。
  • <其他公共参数>是指除了 Action 和 Version 以外的公共参数。每个请求中都必须包含公共参数

服务地址

边缘计算节点服务地址为:veenedge.volcengineapi.com

通信协议

支持通过 HTTPHTTPS 方式进行请求通信,推荐使用安全性更高的 HTTPS 方式发送请求。

请求方法

边缘计算节点 API 接口支持通过 POST 或 GET 方法调用。具体接口的请求方法,请参见相应文档中的说明。
注意事项

  • POST 请求支持的 Content-Type 为:application/json
  • 公共请求参数中,Action 和 Version 须放在 Query 中,签名参数可放在 Header 或 Query 中。GET 请求中的非公共请求参数放在 Query 中,POST 请求中的非公共请求参数放在 Body 中。

请求参数

边缘计算节点 API 请求包含两类参数:公共请求参数接口请求参数

  • 公共请求参数:每一个接口都需要包含的参数,详情请参见公共参数
  • 接口请求参数:各个接口特有的参数,请参见各个接口的文档。

字符编码

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