签发临时 Token--云游戏-火山引擎

文档中心

立即注册

导航

签发临时 Token

最近更新时间：2025.01.20 15:42:49首次发布时间：2024.03.26 13:15:56

签发临时 Token，用于对接入云游戏服务的用户进行鉴权（通过客户端 SDK 启动游戏时需要传入相关鉴权参数）。使用方法如下：

通过 expire 参数设置 Token 的过期时间，在 Token 过期前，重新调用接口刷新 Token（旧的 Token 在过期之前，仍可继续使用）。
根据业务需要，设置合理和安全的 Token 过期时间。
调用云游戏服务端 OpenAPI 接口的 Java 示例，可参考 Demo Project on GitHub。示例代码中封装了调用云游戏服务端 OpenAPI 接口的鉴权和签名步骤，开发者可参考示例代码调用云游戏服务的其它 OpenAPI 接口。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`STSToken`	接口名称。当前 API 的名称为 `STSToken`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。
Ak	String	是	`AKLTOWFkNGViMWEyZDFlNDQzNWI1MzQ5OTVkMjUxxxxxxxx`	用户访问火山引擎 OpenAPI 的密钥（Access Key ID），主账户可通过火山引擎控制台右上角『个人 > API访问密钥』页面获取。
Sk	String	是	`WmpjeU9XVTRNbVZtTlRKaE5ETTNZemhtTlRJek9XUmpOak5sTm1Wxxxxxxxx`	用户访问火山引擎 OpenAPI 的密钥（Secret Access Key），主账户可通过火山引擎控制台右上角『个人 > API访问密钥』页面获取。
Expire	Integer	否	`600`	Token 过期时间，单位为 s。默认值为 300，最大取值为 604800（7 天）。

返回参数

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

参数	类型	示例值	描述
Ak	String	`AKTPYzZhMmY5ZDU1NzllNGNmYmJlMGI0Njk0Nzcxxxxxxxxflight`	临时 Token 的 Access Key，用户客户端 SDK 接入云游戏服务时对用户进行鉴权。
Sk	String	`D0Ejw+9o+0DYCzurOBd/3UkeFS/8vH0z2Ck4F0g0UgEbt1HASPJLTetnxxxxxxxx`	临时 Token 的 Secret Key，用户客户端 SDK 接入云游戏服务时对用户进行鉴权。
Token	String	`xxxxxxxxVEFjY2Vzc0tleUlEIjoiQUtMVE9XRmtOR1ZpTVdFeVpERmxORFF6TldJMU16UTVPVFZrTWpVeVlUUXdObV`	签发的临时 Token 字符串，用户客户端 SDK 接入云游戏服务时对用户进行鉴权。
ExpireAt	String	`2021-08-26T15:57:23+08:00`	Token 过期时间，秒级时间戳，例如：2021-08-26T15:57:23+08:00
CreateAt	String	`2021-08-26T15:47:23+08:00`	Token 创建时间，秒级时间戳，例如：2021-08-26T15:47:23+08:00

请求示例

GET https://open.volcengineapi.com?Action=STSToken&Version=2023-03-18&Ak=AKLTOWFkNGViMWEyZDFlNDQzNWI1MzQ5OTVkMjUxxxxxxxx&Sk=WmpjeU9XVTRNbVZtTlRKaE5ETTNZemhtTlRJek9XUmpOak5sTm1Wxxxxxxxx&Expire=600

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "STSToken",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Ak": "AKTPYzZhMmY5ZDU1NzllNGNmYmJlMGI0Njk0Nzcxxxxxxxxflight",
        "Sk": "D0Ejw+9o+0DYCzurOBd/3UkeFS/8vH0z2Ck4F0g0UgEbt1HASPJLTetnxxxxxxxx",
        "Token": "xxxxxxxxVEFjY2Vzc0tleUlEIjoiQUtMVE9XRmtOR1ZpTVdFeVpERmxORFF6TldJMU16UTVPVFZrTWpVeVlUUXdObV",
        "ExpireAt": "2021-08-26T15:57:23+08:00",
        "CreateAt": "2021-08-26T15:47:23+08:00"
    }
}

错误码

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