1. 接口描述
接口请求域名: sts.tencentcloudapi.com 。
获取MFA临时证书
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetSessionToken。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SerialNumber | 是 | String | MFA序列号,与进行调用的CAM用户关联的MFA设备的标识号。格式qcs::cam:uin/${ownerUin}::mfa/${mfaType}。mfaType支持softToken(软token) 示例值:qcs::cam:uin/10001::mfa/softToken |
TokenCode | 是 | String | mfa身份验证码。 示例值:482724 |
DurationSeconds | 否 | Integer | 指定临时证书的有效期,单位:秒,默认1800秒,主账号最长可设定有效期为7200秒,子账号最长可设定有效期为129600秒。 示例值:1800 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Credentials | Credentials | 临时访问凭证 示例值:{"Token":"da1e*","TmpSecretId":"AKID*","TmpSecretKey":"q95K***"} |
ExpiredTime | Integer | 证书无效的时间,返回 Unix 时间戳,精确到秒 示例值:1686664553 |
Expiration | String | 临时访问凭证的过期时间,以 iso8601 格式的 UTC 时间表示 示例值:2018-12-04T09:06:16Z |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取MFA临时证书
输入示例
POST / HTTP/1.1
Host: sts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSessionToken
<公共请求参数>
{
"SerialNumber": "qcs::cam:uin/10001::mfa/softToken",
"TokenCode": "102342"
}
输出示例
{
"Response": {
"Credentials": {
"Token": "da1e***",
"TmpSecretId": "AKID***",
"TmpSecretKey": "q95K***"
},
"ExpiredTime": 1744271441,
"Expiration": "2025-04-10T07:50:41Z",
"RequestId": "4rkgc443-9cd2-4f09-9e7a-7d4c43b2a74c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CheckMFAError | 校验MFA失败 |
FailedOperation.MFATypeNotSupported | MFA类型不支持 |
FailedOperation.TempKeyNotAllowed | 该接口不支持临时密钥调用 |
InternalError.DbError | DB错误。 |
InternalError.EncryptError | 加密失败。 |
InternalError.GetSeedTokenError | 获取token失败。 |
InternalError.PbSerializeError | pb打包失败。 |
InternalError.SystemError | 系统内部错误,如网络错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter.AccountNotAvaliable | 账号不存在或不可用。 |
InvalidParameter.OverTimeError | 过期时间超过阈值。 |
InvalidParameter.ParamError | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |