文档首页/ 云搜索服务 CSS/ API参考/ 如何调用API/ 构造请求
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

构造请求

本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户接口说明如何调用API。

您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987 。

请求URI

请求URI由如下部分组成。

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

表1 请求URL

参数

说明

URI-scheme

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

Endpoint

承载REST服务端点的服务器域名或IP，不同服务在不同区域的Endpoint不同，可以参考终端节点获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。

resource-path

资源路径，即API访问路径。从具体API的URI模块获取，例如“管理员创建IAM用户”接口的resource-path为“/v3.0/OS-USER/users”。

query-string

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

例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint（比如“华北-北京四”区域的Endpoint：“iam.cn-north-4.myhuaweicloud.com”），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。

https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users
图1 URI示意图

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

请求方法

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

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

在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 

  

  

   
请求消息头

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

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

   

    
    

     
      表2 公共请求消息头
     
     
      

       
        
参数

       
        
是否必选

       
        
描述

      

     
     
      

       
        
Content-Type

       
        
是

       
        
消息体的类型（格式）。推荐用户使用默认值“application/json”。

      

      

       
        
X-Auth-Token

       
        
使用Token认证时必选

       
        
用户Token。是调用“获取用户Token”接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头（Header）中包含的“X-Subject-Token”的值即为Token值。

      

      

       
        
X-Project-Id

       
        
否

       
        
子项目ID，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。

      

      

       
        
X-Sdk-Date

       
        
使用AK/SK认证时必选

       
        
请求的发生时间，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。

        
AK/SK认证的详细说明请参见认证鉴权。

        
格式为(YYYYMMDD'T'HHMMSS'Z')，取值为当前系统的GMT时间。

      

      

       
        
Authorization

       
        
使用AK/SK认证时必选

       
        
签名认证信息。当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。

        
AK/SK认证的详细说明请参见认证鉴权。

      

      

       
        
X-Language

       
        
否

       
        
请求语言。

      

     
    

   

   
对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。

   
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 
Content-Type: application/json 
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

  

  

   
请求消息体

   
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码，并在Content-type中声明字符编码方式，例如：Content-Type: application/json; charset=utf-8。

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

   
对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。

   
    
    
  • accountid为IAM用户所属的账号ID。
    • 
    
  • username为要创建的IAM用户名。
    • 
    
  • **********为IAM用户的登录密码。
    • 
   

   
POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users（中国站） 
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3.0/OS-USER/users（国际站） 
Content-Type: application/json 
X-Sdk-Date: 20240416T095341Z 
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** 
 
{ 
     "user": { 
         "domain_id": "accountid", 
         "name": "username", 
         "password": "**********", 
         "description": "IAM User Description" 
     } 
 }

   
到此为止，一个API请求所需要的内容已经准备完成，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

  

 





 

  父主题： 如何调用API 
 



    
  


  

  
  
  

    
    

      
相关文档