1. 接口描述
接口请求域名: sts.tencentcloudapi.com 。
获取当前调用者的身份信息。
接口支持主账号,子账号长期密钥以及AssumeRole,GetFederationToken生成的临时访问凭证身份获取。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetCallerIdentity。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Arn | String | 当前调用者ARN。 示例值:qcs::sts:1000262:federated-user/1000261* |
AccountId | String | 当前调用者所属主账号Uin。 示例值:1000262*** |
UserId | String | 身份标识。 1. 调用者是云账号时,返回的是当前账号Uin 2. 调用者是角色时,返回的是roleId:roleSessionName 3. 调用者是联合身份时,返回的是uin:federatedUserName 示例值:1000261****:federatedUserName |
PrincipalId | String | 密钥所属账号Uin。 1. 调用者是云账号,返回的当前账号Uin 2, 调用者是角色,返回的申请角色密钥的账号Uin 示例值:1000261**** |
Type | String | 身份类型。 示例值:CAMUser |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用子账号长期密钥调用
使用子账号长期密钥调用
输入示例
https://sts.tencentcloudapi.com/?Action=GetCallerIdentity
&<公共请求参数>
输出示例
{
"Response": {
"Type": "CAMUser",
"AccountId": "1000262***",
"UserId": "1000261***",
"PrincipalId": "1000261****",
"Arn": "qcs::cam:1000262***:uin/1000261***",
"RequestId": "1c875b55-128b-4152-9e73-0984fd489ba2"
}
}
示例2 使用AssumeRole生成的临时凭证调用
使用AssumeRole生成的临时凭证调用
输入示例
https://sts.tencentcloudapi.com/?Action=GetCallerIdentity
&<公共请求参数>
输出示例
{
"Response": {
"Type": "CAMRole",
"AccountId": "1000262***",
"UserId": "461168601842741***:roleSessionName",
"PrincipalId": "1000261****",
"Arn": "qcs::sts:1000262***:assumed-role/461168601842741***",
"RequestId": "1c875b55-128b-4152-9e73-0984fd489ba2"
}
}
示例3 使用GetFederationToken生成的临时凭据调用
使用GetFederationToken生成的临时凭据调用
输入示例
https://sts.tencentcloudapi.com/?Action=GetCallerIdentity
&<公共请求参数>
输出示例
{
"Response": {
"Type": "CAMUser",
"AccountId": "1000262***",
"UserId": "1000261****:federatedUserName",
"PrincipalId": "1000261****",
"Arn": "qcs::sts:1000262***:federated-user/1000261****",
"RequestId": "1c875b55-128b-4152-9e73-0984fd489ba2"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.AccessKeyIllegal | 密钥不合法。 |
InternalError.GetSeedTokenError | 获取token失败。 |
InvalidParameter.AccessKeyNotSupport | 不支持该类型密钥。 |