文档

RefreshWebofficeToken - 刷新Weboffice凭证

更新时间:

刷新Weboffice访问凭证。Weboffice访问凭证有效期是30分钟,过期会失效,无法继续访问Weboffice。如果要继续访问Weboffice,可以使用这个接口刷新Weboffice访问凭证,即获取一个新的凭证,新的凭证过期时间也是30分钟。

接口说明

请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格

  • 计费详情可以参考 WebOffie 计费说明
  • 访问凭证过期时间为 30 分钟,需在访问凭证过期之前打开预览,过期后将无法预览。
  • 刷新凭证过期时间为 1 天,需在刷新凭证过期之前调用刷新接口,过期后该凭证将会失效。
  • 返回的过期时间为 UTC 时间,和北京时间有 8 小时的时差。
说明 访问凭证是用来进行实际预览会话访问的,刷新凭证是用来减少用户刷新凭证的参数设置,可以使用刷新凭证直接获取之前配置的新凭证。

调试

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

授权信息

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

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

请求参数

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

项目名称,获取方式请参见创建项目

test-project
AccessTokenstring

Weboffice 访问凭证。通过 GenerateWebofficeToken 接口或者 RefreshWebofficeToken 接口获取。

99d1b8b478b641c1b3372f5bd6********
RefreshTokenstring

Weboffice 刷新凭证。通过 GenerateWebofficeToken 接口或者 RefreshWebofficeToken 接口获取。

a730ae0d7c6a487d87c661d199********
CredentialConfigCredentialConfig

如无特殊需求,请保持留空即可。

链式授权配置,非必填。更多信息,请参见使用链式授权访问其他实体资源

返回参数

名称类型描述示例值
object

Weboffice 访问凭证

RequestIdstring

请求 ID。

501339F9-4B70-0CE2-AB8C-866C********
RefreshTokenstring

Weboffice 刷新凭证。

72a52ab3702a4123ab5594671a********
AccessTokenstring

Weboffice 访问凭证。

4996466c690a4902846ce00f96********
RefreshTokenExpiredTimestring

刷新凭证的过期时间。过期时间 1 天。

2021-09-01T12:37:28.950065359Z
AccessTokenExpiredTimestring

访问凭证的过期时间。过期时间 30 分钟。

2021-08-31T13:07:28.950065359Z

示例

正常返回示例

JSON格式

{
  "RequestId": "501339F9-4B70-0CE2-AB8C-866C********",
  "RefreshToken": "72a52ab3702a4123ab5594671a********",
  "AccessToken": "4996466c690a4902846ce00f96********",
  "RefreshTokenExpiredTime": "2021-09-01T12:37:28.950065359Z",
  "AccessTokenExpiredTime": "2021-08-31T13:07:28.950065359Z"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-04-19OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更查看变更详情
2023-08-30OpenAPI 错误码发生变更查看变更详情