调用方式--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

调用方式

最近更新时间：2024.06.28 16:41:10首次发布时间：2023.08.24 19:59:29

请求结构

服务地址

边缘托管的服务地址为：https://veecp.volcengineapi.com

通信协议

边缘托管支持通过 HTTP 或 HTTPS 两种方式进行请求通信。推荐使用安全性更高的 HTTPS 方式发送请求。

请求方法

边缘托管 API 仅支持使用 POST 请求方法。使用 POST 方式时，公共参数中的Action和Version必须放在Query String当中。
POST 请求支持的 Content-Type 类型为：application/json

请求参数

边缘托管 API 请求包含两类参数：公共参数和接口请求参数。

公共请求参数：每一个接口都需要包含的请求参数。详细信息，请参见公共参数。
接口请求参数：各个接口特有的请求参数。详细信息，请参见各个接口描述。

字符编码

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

公共参数

公共参数是每个接口都需要使用的请求参数，开发者每次使用 OpenAPI 发送请求时都需要携带这些公共请求参数，否则会导致请求失败。

Action & Version

名称	类型	是否必填	描述	示例
Action	string	是	接口名称，格式为 `[a-zA-Z]+`。	CreateCloudServer
Version	string	是	接口版本信息，以具体接口说明为准，格式为 `YYYY-MM-DD`。	2022-05-12

签名参数

说明

签名参数是请求必不可少的部分，既可以在 Query 当中，也可以在 Header 当中。

签名参数放置在请求 Header

名称	类型	是否必填	描述	示例
X-Date	string	是	使用 UTC 时间，精确到秒。	20201103T104027Z
Authorization	string	是	签名值。	见下文说明

Authorization 内容如下：

HMAC-SHA256 Credential = {AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

{} 内的各字段对应信息如下：

名称	类型	描述	示例
AccessKey	string	火山引擎账号 AccessKey ID。请前往秘钥管理获取。
ShortDate	string	请求的短时间，精确到日。格式为 YYYYMMDD。	20210430
Region	string	请求的地域。对于边缘托管产品，可填写默认值`cn-north-1`。更多 Region 信息，请参见地域和可用区列表。	cn-north-1
Service	string	请求的服务。对于边缘托管产品，需填写`veecp_openapi`。	veecp_openapi
SignedHeaders	string	参与签名的 Header，用分号分隔。	详情参考签名方法
Signature	string	计算完毕的签名。	详情参考签名方法

签名参数放置在请求 Query

名称	类型	是否必填	描述	示例
X-Date	string	是	使用 UTC 时间，精确到秒。	20201103T104027Z
X-Algorithm	string	是	固定值：HMAC-SHA256。	HMAC-SHA256
X-Credential	string	是	{AccessKey}/{ShortDate}/{Region}/{Service}/request	详情参考签名方法
X-SignedHeaders	string	是	参与签名的 Header，用分号分隔。	详情参考签名方法
X-Signature	string	是	计算完毕的签名。	详情参考签名方法

签名机制

为了保证请求者身份的合法性以及请求在传输过程中不被恶意篡改，火山引擎签名机制要求请求者对请求参数进行哈希值计算，经过加密后同 API 请求一起发送到服务器中，服务器将以同样的机制对收到的请求进行签名计算，并以此与请求者传来的签名进行比对，若签名未通过验证，请求将被拒绝。
计算签名的方法，请参见签名方法。

返回结果

调用火山引擎 OpenAPI 后，所有返回结果都会带上 RequestId、Action、Version、Service、Region 等字段。

正常返回示例

接口调用成功后，会返回请求 ID 和接口返回参数。HTTP 状态码为 2xx。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****", 
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}" 
    },
    "Result":"..."
}

异常返回示例

接口调用出错后，会返回请求 ID 和错误信息。HTTP 状态码为 4xx 或者 5xx。
您可以根据接口错误代码 Code 和错误信息 Message，参考错误码排查错误。
如果返回结果中存在 Error 字段，则表示调用 API 接口失败。例如：

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
        "Error": {
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation GetUserById for version 2022-05-12"
        }
    }
}