调用GetOfficePreviewURL获取文档预览URL_智能媒体管理(IMM)-阿里云帮助中心

获取文档预览的URL和AccessToken。

接口说明

此接口已不再维护，建议使用新版（2020-09-30 版本）接口 GenerateWebofficeToken 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
当前只有华东 1（杭州）、华东 2（上海）、华北 2（北京）、华南 1（深圳）、华北 3（张家口）和美国地域支持此功能。
此 API 不受单用户每秒调用次数不能超过十次的限制。
关于如何使用该预览地址和 AccessToken 实现文档预览，请参见快速入门。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
imm:GetOfficePreviewURL		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immdoctest
SrcUri	string	是	源数据的 OSS 地址。 OSS 地址规则为`oss://bucket/object`，其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称，object 为文件路径。	oss://test-bucket/mytest.doc
SrcType	string	否	源数据的后缀类型。默认根据 OSS 对象的后缀名确定源数据的类型。当 OSS 对象没有后缀名时，可以设置此参数。目前支持的文件类型有：表格文件：et、xls、xlt、xlsx、xlsm、xltx、xltm、csv 文字文件：doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf 演示文件：ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps PDF 格式文件：pdf	doc
WatermarkType	integer	否	水印类型。 0：无水印 1：文字水印	1
WatermarkValue	string	否	文字水印的文字。当 WatermarkType 设置为 1 时，才能设置此参数。	imm
WatermarkFillStyle	string	否	文字水印的透明度，默认值为 rgba(192, 192, 192, 0.6)。	rgba(192, 192, 192, 0.6)
WatermarkFont	string	否	文字水印的字体，默认值为 bold 20px Serif。	bold 20px Serif
WatermarkRotate	float	否	文字水印的旋转度，默认值为-0.7853982，单位为弧度。	-0.7853982
WatermarkHorizontal	integer	否	文字水印水平间距，默认值为 50，单位为 px。	50
WatermarkVertical	integer	否	文字水印垂直间距，默认值为 100，单位为 px。	100

返回参数

名称	类型	描述	示例值
	object
PreviewURL	string	文档预览地址。	https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1
RefreshToken	string	凭证过期时使用 RefeshToken 刷新凭证。	1eb6535cdf8a4732a7d7183891********
RequestId	string	当次请求的 Request ID。	14580EF3-442A-4AA2-959C-1464DC255EEB
AccessToken	string	访问文档预览服务器的凭证。	f3a3ad0ae32a4c6fb90ed00218********
RefreshTokenExpiredTime	string	刷新凭证的过期时间，有效时间为 1 天。	2020-11-20T06:16:19.069Z
AccessTokenExpiredTime	string	凭证的过期时间，有效时间为 30 分钟。	2020-11-19T06:46:19.069Z

示例

正常返回示例

JSON格式

{
  "PreviewURL": "https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1",
  "RefreshToken": "1eb6535cdf8a4732a7d7183891********",
  "RequestId": "14580EF3-442A-4AA2-959C-1464DC255EEB",
  "AccessToken": "f3a3ad0ae32a4c6fb90ed00218********",
  "RefreshTokenExpiredTime": "2020-11-20T06:16:19.069Z",
  "AccessTokenExpiredTime": "2020-11-19T06:46:19.069Z"
}

错误码

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