相关资料链接
获取Token 并检验Token的有效期
操作场景
Token的有效期为24小时,获取Token后建议及时保存,避免频繁调用。无论是否重新获取Token,在有效期内的Token始终有效。使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。
针对用户调用接口中常常出现的Token过期导致的调用失败问题,我们介绍了获取Token并检验Token有效期的方法。
若Token即将超期(无法满足一次完整的API调用或者完整的一套组合的调用)则需要重新获取Token,防止调用过程中Token超期,调用中断。或推荐您使用SDK,采用AK/SK方式认证鉴权。
获取Token
接口调用前需要认证鉴权,因此需要提前获取token信息。后续调用API的消息头中“X-Auth-Token”的值即为Token值。
本例以获取华东-上海二区域的Token为例:
请求URI:POST https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens
请求消息头:Content-Type=application/json
请求消息体:
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "请填写用户名",
"password": "用户登录密码",
"domain": {
"name": "用户所属的帐号名称"
}
}
}
},
"scope": {
"project": {
"name": "区 域名 称,本例为cn-east-2"
}
}
}
}
查看获取的Token:单击响应头,x-subject-token的取值即为获取的Token。请妥善保存Token信息,在后续的创建 云服务器 的请求头信息中需要使用Token认证。
General:
Request URL: https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens
Request Method: POST
Status Code: 201
Response Headers:
cache-control: no-cache, no-store, must-revalidate
connection: keep-alive
...
x-iam-trace-id: token_cn-east-2_null_9bbec3983f3c7a5c146e709251760467
x-request-id: d7796611318416bc8ffb2948a47fede8
x-subject-token: MIISMAYJKoZIhvcNAQ...7xMUw==
x-xss-protection: 1; mode=block;
查看Token过期时间:响应体中“expires_at”表示该Token过期时间。
{
"token": {
"expires_at": "2021-05-28T01:24:49.905000Z",
...
}
}
检验Token的有效期
调用API时判断Token有效期是否充足,若您的应用程序缓存了Token,建议每12小时刷新一次Token。以确保Token有足够长的有效期。
您还可以主动查询某个Token的过期时间。通过调用检验Token有效性的接口查看Token的有效时期。
本例以检验华东-上海二区域的Token为例:
请求URI:GET https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens
请求消息头:
Content-Type=application/json;charset=utf8
X-Auth-Token:管理员校验本帐号中 IAM 用户的token的有效性:拥有Security Administrator权限的token。
IAM用户校验自己token的有效性:该IAM用户的token(无需特殊权限)。
本例中使用的是IAM用户因此X-Auth-Token与待校验的Token相同。
X-Subject-Token:待校验的token。
查看Token过期时间:响应体中“expires_at”表示该Token过期时间。
若Token即将超期(无法满足一次完整的API调用或者完整的一套组合的调用)则需要重新获取Token,防止调用过程中Token超期,调用中断。
{
"token": {
"expires_at": "2021-05-28T01:24:49.905000Z",
...
}
}