本文介绍了边缘函数API的调用方式。

请求结构

服务地址

边缘函数服务地址为：https://veefedge.volcengineapi.com

通信协议

支持通过 HTTPS 方式进行请求通信。

请求方法

如接口无特殊说明，则默认支持以下 HTTP 请求方法：

• POST

请求参数

每个API请求都包含如下两类参数：

• 公共请求参数：每个API接口都需要使用的参数为公共请求参数。关于公共参数的更多详情，请参见公共参数。
• 接口请求参数：每个API接口特有的参数为接口请求。关于各个接口的请求参数，请参见API概览中各接口的详细描述。

字符编码

均使用UTF-8编码。

公共参数

公共参数是每个接口都需要使用的请求参数，开发者每次使用 OpenAPI 发送请求时都需要携带这些公共请求参数，否则会导致请求失败。公共请求参数首字母均为大写，以此区分接口请求参数。

Action&Version

签名参数

签名参数是请求必不可少的部分，可以放在Header或Query中：

• 签名函数在Header中的场景

Authorization内容如下：

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

Authorization中各字段含义如下：

• 签名函数在Query中的场景
  X-Date与Authorization的信息可以直接存在在Query当中。

签名机制

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

具体签名机制请参考签名方法文档。

返回结构

返回结果示例

• 请求调用成功返回结果（以CreateSparrow为例）

{
    "ResponseMetadata": {
        "RequestId": "2022011110011401022524308102B1****",
        "Action": "CreateSparrow",
        "Version": "2021-04-30",
        "Service": "veefedge",
        "Region": "cn-north-1"
    },
    "Result": { /* 具体业务的返回信息 */
        "domain": "test-sparrow.test.test"
    }
}

• 请求调用失败返回结果

{
    "ResponseMetadata": {
        "RequestId": "2022012515175801022524312505****",
        "Action": "CreateSparrow",
        "Version": "2021-04-30",
        "Service": "veefedge",
        "Region": "cn-north-1",
        "Error": {
            "Code": "SparrowDomainExisted",
            "Message": "Sparrow domain existed"
        }
    }
}