【旧版】签发临时Token STSToken--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】签发临时Token STSToken

最近更新时间：2024.06.17 19:36:15首次发布时间：2021.10.18 18:26:50

注意

该接口已废弃，请参考签发临时密钥（STS）获取临时 Token。

签发临时 STS Token，用于对接入云手机服务的用户进行鉴权。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	STSToken
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
ak	Query	string	是	用户访问火山引擎 API 的密钥（AccessKey ID）	主账户可通过火山引擎「控制台 > 页面右上角用户信息 > API访问密钥」获取
sk	Query	string	是	用户访问火山引擎 API 的密钥（AccessKey Secret）	主账户可通过火山引擎「控制台 > 页面右上角用户信息 > API访问密钥」获取
expire	Query	Int64	否	Token 过期时间，单位 s，默认 300s	例：600

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
create_at	String	Token 创建时间，秒级时间戳，例如：2021-08-26T15:47:23+08:00
expire_at	String	Token 过期时间，秒级时间戳，例如：2021-08-26T15:57:23+08:00
token	String	签发的临时 Token 字符串，用户客户端 SDK 接入云手机服务时对用户进行鉴权
ak	String	临时 Token 的 Access Key，用户客户端 SDK 接入云手机服务时对用户进行鉴权
sk	String	临时 Token 的 Secret Key，用户客户端 SDK 接入云手机服务时对用户进行鉴权

示例

请求示例

GET https://open.volcengineapi.com?Action=STSToken
&Version=2022-08-01
&ak=AKLTOWFkNGViMWEyZDFlNDQzNWI1MzQ5OTVkMxxxxxxxxxx
&sk=WmpjeU9XVTRNbVZtTlRKaE5ETTNZemhtTlRJek9XUmpOak5sTmxxxxxxxxxx
&expire=120
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "STSToken",
        "Region": "cn-north-1",
        "RequestId": "202311301539127976C4E03C379983377E",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "ak": "AKTPMDFkYTcwYzBiZTEyNGE3MWI5ZmZjNWQ0Mxxxxxxxxxx",
        "sk": "JEGORyXppGLMh2II/+vZXXPXfcnY6InUHWX2xHna9CEzv8F0ey0jVRxxxxxxxxxx",
        "create_at": "2023-11-30T15:39:12+08:00",
        "expire_at": "2023-11-30T15:41:12+08:00",
        "token": "STS2XXXXXXXXXXzkifQ=="
    }
}

错误码

错误码	说明	操作建议
16000002	STS鉴权错误	参考接口文档，检查生成的鉴权token是否有效或过期，如有问题，可联系火山引擎云手机技术支持