文档首页/ 自然语言处理 NLP/ 常见问题/ 如何通过API Explorer获取用户Token
更新时间：2024-04-24 GMT+08:00
查看PDF
分享

如何通过API Explorer获取用户Token

API Explorer是华为云为开发者提供的一站式API解决方案的统一平台，集成华为云服务开放API，支持全量快速检索、可视化调试、帮助文档，帮助开发者快速查找、学习API和定位修复错误。

Token是用户的访问令牌，承载了用户的身份、权限等信息，用户调用API接口时，需要使用Token进行鉴权。

本章节指导用户如何通过API Explorer获取用户Token。更多参数说明请参见获取IAM用户Token。

  • Token的有效期

    Token的有效期为24小时。建议进行缓存，避免频繁调用。使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。

    重新获取Token，不影响已有Token有效性。如果在Token有效期内进行如下操作，当前Token将立即失效：

    • 删除/停用IAM用户。
    • 修改IAM用户密码、访问密钥。
    • IAM用户权限发生变化（如账号欠费无法访问云服务、申请公测通过、IAM用户权限被修改等）。
  • 非华为云账号获取Token
    • 如果您的华为云账号已升级为华为账号，将不支持获取账号Token，建议您为自己创建一个IAM用户，授予该用户必要的权限，获取IAM用户Token。
    • 如果您是第三方系统用户，直接使用联邦认证的用户名和密码获取Token，系统会提示密码错误。请先在华为云的登录页面，通过“忘记密码”功能，设置华为云账号密码。

前提条件

已注册并登录华为云账号。

操作步骤

  1. 进入API Explorer平台获取IAM用户Token接口。
  2. 选择Region，编辑获取用户Token接口的请求参数，进行具体的API调用。

    • Region

      在Region下拉列表选取您需要访问的区域。

    • Params

      nocatalog为非必填，如果设置该参数，返回的响应体中将不显示catalog信息。任何非空字符串都将解释为true，并使该字段生效。

    • Body

      通过切换输入方式可以选择表单填写或文本输入请求体。

      • 表单填写：通过表单填写完成请求体，无需了解JSON语法，参考示例填写参数值。

      • 文本输入：通过文本输入完成请求体，可以直接在编辑框内编写JSON格式的请求体。 
        {
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "domain": {
                        "name": "IAM用户所属账号名"
                    },
                    "name": "IAM用户名",
                    "password": "IAM用户的登录密码"
                }
            }
        },
        "scope": {
            "domain": {
                "name": "IAM用户所属账号名"
            }
        }
    }
}
        • 参数说明请参见：请求参数。
        • 如果是第三方系统用户，没有在本系统设置登录密码，可以通过系统登录页面的找回密码功能设置登录密码，并在password中输入新设置的密码。

  3. 单击调试，发送API请求。
  4. 在返回的响应体中查看获取的用户Token，用户调用IAM其他API接口时，可以使用该Token进行鉴权。

    • Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。
    • 如果返回错误码，例如401，表示认证失败，请确认Request Body中请求参数填写正确后重新发送请求。

相关文档