You need to enable JavaScript to run this app.
导航
公共描述和固定参数
最近更新时间:2024.06.21 12:46:12首次发布时间:2024.06.21 12:46:12

以下接口均按火山引擎标准API方式访问:

公共描述

请求方法

  • 接口通过 POST 方法请求

请求格式

  • 域名

https://open.volcengineapi.com

  • Query公共参数
字段类型是否必填描述
Actionstring接口名
Versionstring2022-11-08
  • 下文请求参数通过 body 传参,需指定公共参数,Request Header:

Content-Type: application/json
ServiceName: vlog
Region:cn-north-1
以及火山签名参数,生成方法可参考各语言的SDK

响应格式

  • 下文响应参数,Content-Type:application/json。

  • 正常返回:包含 ResponseMetadata 及 Result 两部分,对于无出参的接口,不返回 Result 结构。

{
    "ResponseMetadata": {
        "RequestId": "2022021**********209131054BC103", //header中的X-Top-Request-Id参数
        "Action": "{Action}",//query中的Action参数
        "Version": "{Version}",//query中的Version参数
        "Service": "{Service}",//header中的X-Top-Service参数
        "Region": "{Region}" //header中的X-Top-Region参数
    },
    "Result":{"..."}
}
  • 错误返回:包含 ResponseMetadata,错误信息包含在 Error 字段
{
    "ResponseMetadata": {
        "RequestId": "2022021**********209131054BC103",
        "Action": "{Action}",
        "Version": "{Version}",
        "Service": "{Service}",
        "Region": "{Region}",
       "Error": {
            "Code": "{ErrorCode}",
            "Message": "{ErrorMessage}"
        }
    }
}

固定参数

ScenicSpotId 景区ID。请联系客服申请。