CreateStreamSnapshot - 触发按需截图

对指定流,按需创建新的截图。

接口说明

说明 需要预先在绑定的截图模板中启用按需截图功能。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vs:CreateStreamSnapshotcreate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Idstring

流 ID。

323*****997-cn-qingdao
Locationstring

截图方式。取值范围:

  • center(云端截图)(默认)
  • device(设备截图)
device

返回参数

名称类型描述示例值
object
OssObjectstring

截图文件的 Object。

photos/live/340200*****100049/ondemand-1639126601767.jpg
RequestIdstring

请求 ID。

BEA5625F-8FCF-48F4-851B-CA63946DA664
Widthlong

图片宽度。

1280
Heightlong

图片高度。

720
Urlstring

截图文件的 URL。

http://examplebucket.oss-*****.aliyuncs.com/photos/live/340200*****100049/ondemand-1639126601767.jpg
Timestamplong

截图时间戳。

1639126601767
OssBucketstring

截图文件的 Bucket。

examplebucket
Formatstring

图片格式。

jpg
OssEndpointstring

截图文件的 OSS Endpoint。

oss-cn-qingdao.aliyuncs.com
Idstring

流 ID。

323*****997-cn-qingdao

示例

正常返回示例

JSON格式

{
  "OssObject": "photos/live/340200*****100049/ondemand-1639126601767.jpg",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Width": 1280,
  "Height": 720,
  "Url": "http://examplebucket.oss-*****.aliyuncs.com/photos/live/340200*****100049/ondemand-1639126601767.jpg",
  "Timestamp": 1639126601767,
  "OssBucket": "examplebucket",
  "Format": "jpg",
  "OssEndpoint": "oss-cn-qingdao.aliyuncs.com",
  "Id": "323*****997-cn-qingdao"
}

错误码

访问错误中心查看更多错误码。