更新时间:2024-03-20 GMT+08:00

构造请求

本节介绍REST API请求的组成,以调用查询所属组织信息接口说明如何调用API,该API查询账号所属组织的信息。此操作可以由组织中的任何账号调用。

请求URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

表1 请求URL

参数

说明

URI-scheme

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

Endpoint

承载REST服务端点的服务器域名或IP,不同服务在不同区域,Endpoint不同,可以从地区和终端节点处获取。例如Organizations服务的Endpoint为organizations.myhuaweicloud.com。

resource-path

资源路径,即API访问路径。从具体API的URI模块获取,例如查询所属组织信息API的resource-path为“/v1/organizations”

query-string

查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。

例如您需要查询所属组织信息,则需使用Organizations的Endpoint(organizations.myhuaweicloud.com),并在查询所属组织信息的URI部分找到resource-path(/v1/organizations),拼接起来如下所示。

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

请求方法

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

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

查询所属组织信息的URI部分,您可以看到其请求方法为“GET”,则其请求为:

GET  https://organizations.myhuaweicloud.com/v1/organizations

请求消息头

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

如下公共消息头需要添加到请求中。

  • Content-Type:消息体的类型(格式),必选,默认取值为“application/json”
  • Authorization:请求消息中可带的签名信息,必选,AK/SK认证的详细说明请参见:AK/SK认证
  • X-Sdk-Date:请求发送的时间,必选,例如:20221107T020014Z。
  • Host:表明主机地址,必选,如organizations.myhuaweicloud.com。

    API支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见:AK/SK认证

对于查询所属组织信息接口,请求如下所示。

GET https://organizations.myhuaweicloud.com/v1/organizations
content-type: application/json
X-Sdk-Date: 20230330T021902Z 
host: organizations.myhuaweicloud.com
Authorization: SDK-HMAC-SHA256 Access=xxxxxxxxxxxxxxxxxxx, SignedHeaders=content-type;host;x-sdk-date, Signature=xxxxxxxxxxxxxxxxxxxx

请求消息体(可选)

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

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

发起请求

您可以使用curlPostman或直接编写代码等方式发送请求调用API。