# 生成场景截图列表 (/zh-CN/api-reference/api-ref/whiteboard/restful/screenshot-scene-list)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

对指定场景组下的所有场景进行截图。

- OpenAPI: /openapi/whiteboard/restful-wb.zh-CN.yaml
- Operation ID: post-v5-rooms-uuid-screenshot-list
- Method: POST
- Path: /v5/rooms/{uuid}/screenshot-list
- Endpoint: https://api.netless.link/v5/rooms/{uuid}/screenshot-list

## Servers

- https://api.netless.link

:::warning[注意]
后端截图相关 API 已废弃，请改用前端截图 API：[`screenshotToCanvasAsync`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/web/interfaces/displayer#screenshottocanvasasync)。
:::

## Parameters

- `region` (header, required, string) - 指定处理该请求的数据中心，取值如下：

- `cn-hz`：中国杭州，服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。

- `us-sv`：美国硅谷，服务区覆盖北美洲、南美洲。

- `sg`：新加坡，服务区覆盖新加坡、东亚、东南亚。

- `in-mum`：印度孟买，服务区覆盖印度。

- `eu`：欧洲（法兰克福），服务区覆盖欧洲。
  - Allowed: `cn-hz` | `us-sv` | `sg` | `in-mum` | `eu`
- `token` (header, required, string) - SDK Token，可以通过以下方式获取：

- 在声网控制台生成用于测试的 SDK Token，详见[获取互动白板项目的安全密钥](/zh-CN/realtime-media/whiteboard/fastboard-sdk/build/setup-and-access/enable-service#获取互动白板项目的安全密钥)。

- 调用服务端 RESTful API， 详见[生成 SDK Token](generate-sdk-token)。

- 在 App 服务端用代码生成，详见[在 App 服务端生成 Token](/zh-CN/realtime-media/whiteboard/fastboard-sdk/build/setup-and-access/generate-token#在-app-服务端生成-token)。
- `uuid` (path, required, string) - 房间的 UUID, 即房间的全局唯一标识符，可通过调用[创建房间 API](create-room) 或[获取房间信息 API](get-room) 获取。

## Request body

- `width` (number) - 截图的宽度，单位为像素。
- `height` (number) - 截图的高度，单位为像素。
- `path` (string) - 需要截图的场景路径，以 `/` 开头。如果不传，默认获取 `/init` 场景的截图。
  - Default: `/init`

## Responses

### 201

若返回的状态码为 `201` 则表示请求成功。响应 Body 中包含本次请求的结果。

若返回的状态码不为 `201` 则表示请求失败。你可以参考[响应状态码](/zh-CN/realtime-media/whiteboard/fastboard-sdk/reference/response-code)了解可能的原因。

- `url` (string) - 截图的 URL。
- `key` (string) - 截图在存储空间内的文件名。
- `bucket` (string) - 截图存放的存储空间名称。
- `region` (string) - 截图存放的存储空间所属地域。

## Response examples

### 201

```json
{
  "url": "https://white-cover.oss-cn-hangzhou.aliyuncs.com/room_cover/2811/a7exxxxca69undefined.png",
  "key": "room_cover/2811/a7exxxxxca69undefined.png",
  "bucket": "white-cover",
  "region": "oss-cn-hangzhou"
}
```