调用方法

请求结构

服务地址

通信协议

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

请求方法

请求方法详见各个接口具体的说明。

请求参数

火山引擎的OpenAPI请求包含两类参数：公共请求参数和接口请求参数。其中公共请求参数在每个请求中都必须包含。接口请求参数需参考具体的API接口文档。

字符编码

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

公共参数

所有接口请求中都必须携带公共参数，为了避免重复说明，后续文档中可能不再重复描述这部分参数，请您在请求API时携带这部分参数，否则请求将无法通过合法性验证。

• 接口特有的请求参数，请参看具体 API 接口文档；
• 公共参数请参见火山引擎OpenAPI公共参数。

签名机制

详细的签名方法和签名示例，请参见签名方法。

返回结构

以请求wap注册WapRegister接口为例，成功结果和失败结果示例如下：

成功结果

{
    "ResponseMetadata": {
        "RequestId": "20230228142604F6A6539251E53A778F77",
        "Action": "WapRegister",
        "Version": "2021-01-01",
        "Service": "content",
        "Region": "cn-north-1"
    },
    "Result": {
        "AccessToken": "xxx",
        "ExpiresIn": 5184000
    }
}

请求被正常处理后，返回中会包含ResponseMetadata和Result两部分，字段解释如下：

Result视请求的接口而定，不同的接口会有不同的Result返回。

失败结果

{
    "ResponseMetadata": {
        "RequestId": "20230228142937880718DB60D0CB102B54",
        "Action": "WapRegister",
        "Version": "2021-01-0",
        "Service": "content",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100008,
            "Code": "InvalidActionOrVersion",
            "Message": "Could not find operation WapRegister for version 2021-01-0"
        }
    }
}

相较于成功结果，错误结果将不再有Result部分，而ResponseMetadata中将额外出现Error字段，字段解释如下：

公共错误码

• 公共错误码请参见公共错误码
• 其他非公共错误码请参考具体的接口文档。