企业搜索服务 KooSearch-认证鉴权:Token认证

时间:2023-11-01 16:16:26

Token认证

Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。

Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。

云服务存在两种部署方式:项目级服务和全局级服务。其中:

  • 项目级服务需要获取项目级别的Token,此时请求body中“auth.scope”的取值为“project”
  • 全局级服务需要获取全局级别的Token,此时请求body中“auth.scope”的取值为“domain”
调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
{     "auth": {         "identity": {             "methods": [                 "password"             ],             "password": {                 "user": {                     "name": "username",                     "password": "********",                     "domain": {                         "name": "domainname"                     }                 }             }         },         "scope": {             "project": {                    "name": "cn-north-4"             }         }    } }

获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。

POST https://koosearch.myhuaweicloud.com/v1/{project_id}/search/queryContent-Type: application/jsonApplication_ID:a0b1c2def3g456h7i899jkl876m54n21X-Auth-Token: ABCDEFJ....

您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333

support.huaweicloud.com/api-koosearch/koosearch_06_0010.html