截图 CaptureScreen--云游戏-火山引擎

文档中心

立即注册

导航

截图 CaptureScreen

最近更新时间：2025.01.20 15:42:49首次发布时间：2024.04.19 13:53:04

对当前云端游戏画面发起截图请求（异步任务）。截图请求结果通过回调返回，参考游戏截图结果回调。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CaptureScreen&Version=2023-03-18

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CaptureScreen`	接口名称。当前 API 的名称为 `CaptureScreen`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。

Body

参数	类型	是否必选	示例值	描述
ReservedId	String	是	`7083793914380xxxxxx`	资源预锁定 ID，通过调用 PreAllocateResource 接口获取，或通过客户端 SDK `start()` 接口成功回调。
TaskId	String	是	`task01`	用户自定义截图任务 ID，用于区分截图顺序。注意不支持 /、<、>、?、*、= 符号。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
Result	String	`success`	接口调用成功，返回 `success`。仅表示接口调用成功，截图结果通过回调返回，参考游戏截图结果回调。

请求示例

POST https://open.volcengineapi.com?Action=CaptureScreen&Version=2023-03-18
{
    "ReservedId": "7083793914380xxxxxx",
    "TaskId": "task01"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CaptureScreen",
        "Version": "2023-03-18",
        "Service": "vegame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Result": "success"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。