更新时间:2025-09-10 gmt 08:00

构造请求-j9九游会登录

本节介绍rest api请求的组成,以调用获取用户token接口说明如何调用api,该api获取用户的token,token是用户的访问令牌,承载身份与权限信息,token可以用于调用其他api时鉴权。

您还可以通过这个视频教程了解如何构造请求调用api: 。

请求uri

请求uri由如下部分组成。

{uri-scheme}://{endpoint}/{resource-path}

表1 请求url

参数

说明

uri-scheme

传输请求的协议,当前所有api均采用https协议。

endpoint

承载rest服务端点的服务器域名或ip,不同服务在不同区域,endpoint不同,可以参考终端节点获取。例如iam服务在“西南-贵阳一”区域的endpoint为“iam.cn-southwest-2.myhuaweicloud.com”

resource-path

资源路径,即api访问路径。从具体api的uri模块获取,例如“获取用户token”api的resource-path为“/v3/auth/tokens”

例如您需要获取“西南-贵阳一”区域的token,则需使用“西南-贵阳一”区域的endpoint(iam.cn-southwest-2.myhuaweicloud.com),并在获取用户token的uri部分找到resource-path(v3/auth/tokens),拼接起来如下所示。

https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens
图1 uri示意图

为查看方便,每个具体api的uri,只给出resource-path部分,并将请求方法写在一起。这是因为uri-scheme都是https,而endpoint在同一个区域也相同,所以简洁起见将这两部分省略。

请求方法

http请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。

  • get:请求服务器返回指定资源。
  • put:请求服务器更新指定资源。
  • post:请求服务器新增资源或执行特殊操作。
  • delete:请求服务器删除指定资源,如删除对象等。
  • head:请求服务器资源头部。
  • patch:请求服务器更新资源的部分内容。当资源不存在的时候,patch可能会去创建一个新的资源。

在获取用户token的uri部分,您可以看到其请求方法为“post”,则其请求为:

post https://iam.cn-southwest-2.myxxxcloud.com/v3/auth/tokens

请求消息头

附加请求头字段,如指定的uri和http方法所要求的字段。例如定义消息体类型的请求头“content-type”,请求鉴权信息等。

详细的公共请求消息头字段请参见表 公共请求消息头

表2 公共请求消息头

参数

是否必选

描述

content-type

消息体的类型(格式)。推荐用户使用默认值application/json。

x-auth-token

否(使用token认证时必选)

用户token。

调用“获取用户token”接口的响应值,该接口是唯一不需要认证的接口。请求响应成功后在响应消息头(header)中包含的“x-subject-token”的值即为token值。

对于“获取用户token”接口,由于不需要认证,所以只添加“content-type”即可,添加消息头后的请求如下所示。

post https://iam.xxx.myhuaweicloud.com/v3/auth/tokens
content-type: application/json

请求消息体

请求消息体通常以结构化格式发出,与请求消息头中content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为utf-8编码。

每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(即消息体为空),get、delete操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。

对于“获取用户token”接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,********为用户的登录密码,domainname为用户所属的账号名称,如果是账号本身获取token,usernamedomainname填为一致,xxxxxxxxxxxxxxxxxx为project的id。

scope参数定义了token的作用范围,表示获取的token仅能访问指定project下的资源,scope参数的详细说明请参见:获取用户token

post https://iam.cn-southwest-2.myxxloud.com/v3/auth/tokens
{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",    //用户名
                    "password": "********",    //登录密码
                    "domain": {
                        "name": "domainname "    //用户所属的账号名称
                    }
                }
            }
        },
        "scope": {
            "project": {
                "id": "xxxxxxxxxxxxxxxxxx"    //项目id
            }
        }
    }
}

到这里为止这个请求需要的内容就具备齐全了,您可以使用、或直接编写代码等方式发送请求调用api。对于“获取用户token”接口,返回的响应消息头中“x-subject-token”就是需要获取的用户token。有了token之后,您就可以使用token认证调用其他api。

相关文档

网站地图