认证鉴权
调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。
- Token认证:通过Token认证通用请求。
- AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
Token认证
Token是服务端生成的一串字符串,作为客户端进行请求的一个令牌。第一次登录后,服务器生成一个Token并将此Token返回给客户端,以后客户端只需带上这个Token前来请求数据即可,无需再次带上用户名和密码。Token有效期是24小时,从客户端获取开始算起(24小时是相对时间),需要使用同一个Token鉴权时,建议缓存起来使用,避免频繁调用。在Token过期前,务必刷新Token或重新获取Token,否则Token过期后会在服务端鉴权失败。
如果您获取Token多次,以最新的为准,前面的Token会被覆盖并失效。
Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxxxxxx" } } } }
加粗的斜体字段需要根据实际值填写,其中username为IAM用户名,domainname为IAM用户所属账号名,********为IAM用户的登录密码,xxxxxxxxxxxxxxxxxx为IAM用户所属账号的项目名称,如“cn-north-1”,您可以参考我的凭证页面获取。
接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。
获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值为获取到的Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。
POST https://ocv2x-api.cn-north-4.myhuaweicloud.com/v1/{project_id}/traffic-events Content-Type: application/json X-Auth-Token: ABCDEFJ.... Instance-Id: xxxxxx
您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
AK/SK认证
AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。
AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。
- AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
- SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。
签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。