获取企业直播 STS 签名--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取企业直播 STS 签名

最近更新时间：2024.10.31 18:00:36首次发布时间：2024.07.23 11:13:41

您可通过此接口获取指定账号在企业直播的 STS 签名。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetLoginLivesaasSts&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetLoginLivesaasSts`	接口名称。当前 API 的名称为 `GetLoginLivesaasSts`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
FollowerUserName	String	否	`+86188xxxxx1234`	子账号的账号。不填则表示主账号。
DurationSeconds	Long	否	`6000`	签名过期时间。取值范围为 [900,172800]，默认取值为 `7200`，单位为秒。

返回参数

参数	类型	示例值	描述
StsMsg	Object of StsMsg	`-`	STS 签名信息。
LoginLivesaasToken	String	`49e0***Y`	企业直播 Token。

StsMsg

参数	类型	示例值	描述
AccessKeyId	String	`AKTPODg0MzV****2ZDcxMDg`	临时凭证 AK。
SecretAccessKey	String	`TVRNNVlqRmxPR1****mRoTkdWbE1ESQ==`	临时凭证 SK。
SessionToken	String	`STSeyJBY2NvdW50SW****pYXNzdW1lIn0=`	使用临时凭证时需要传递的 Token。
ExpiredTime	String	`2024-07-16T16:14:30+08:00`	过期时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetLoginLivesaasSts&Version=2023-08-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetLoginLivesaasSts",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1705992306
    },
    "Result": {
        "StsMsg": {
            "AccessKeyId": "AKTPODg0MzV****2ZDcxMDg",
            "SecretAccessKey": "TVRNNVlqRmxPR1****mRoTkdWbE1ESQ==",
            "SessionToken": "STSeyJBY2NvdW50SW****pYXNzdW1lIn0=",
            "ExpiredTime": "2024-07-16T16:14:30+08:00"
        },
        "LoginLivesaasToken": "49e0***Y"
    }
}

错误码

访问公共错误码和错误码获取详细信息。