构造请求
本节介绍RESTful API请求的组成,以调用创建客户的接口说明如何调用API,该API用于创建伙伴的子客户。
请求URI
请求URI由如下部分组成:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以我们在此单独拿出来强调。
| 
        参数  | 
      
        描述  | 
     
|---|---|
| 
        URI-scheme  | 
      
        表示用于传输请求的协议,当前所有API均采用HTTPS协议。  | 
     
| 
        Endpoint  | 
      
        指定承载REST服务端点的服务器域名或IP。 合作伙伴运营能力API的Endpoint为“bss.myhuaweicloud.com”。 
         说明: 
         
  | 
     
| 
        resource-path  | 
      
        资源路径,也即API访问路径。从具体API的URI模块获取,例如“创建客户”API的resource-path为“/v2/partners/sub-customers”。  | 
     
| 
        query-string  | 
      
        查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。  | 
     
例如您需要获取创建客户的请求URI,则需找到创建客户的resource-path(/v2/partners/sub-customers),拼接起来如下所示。
https://bss.myhuaweicloud.com/v2/partners/sub-customers

 
   为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
| 
         方法  | 
       
         说明  | 
      
|---|---|
| 
         GET  | 
       
         请求服务器返回指定资源。  | 
      
| 
         PUT  | 
       
         请求服务器更新指定资源。  | 
      
| 
         POST  | 
       
         请求服务器新增资源或执行特殊操作。  | 
      
| 
         DELETE  | 
       
         请求服务器删除指定资源,如删除对象等。  | 
      
| 
         HEAD  | 
       
         请求服务器资源头部。  | 
      
| 
         PATCH  | 
       
         请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。  | 
      
在创建客户的URI部分,您可以看到其请求方法为“POST”,则其请求URI为:
        1
         | 
       
        POST https://bss.myhuaweicloud.com/v2/partners/sub-customers  | 
      
请求消息头
| 
         名称  | 
       
         描述  | 
       
         是否必选  | 
       
         示例  | 
      
|---|---|---|---|
| 
         Host  | 
       
         请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。  | 
       
         否 使用AK/SK认证时该字段必选。  | 
       
         bss.myhuaweicloud.com or bss.myhuaweicloud.com:443  | 
      
| 
         Content-Type  | 
       
         发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。  | 
       
         是  | 
       
         application/json  | 
      
| 
         Content-Length  | 
       
         请求body长度,单位为Byte。  | 
       
         否  | 
       
         3495  | 
      
| 
         X-Auth-Token  | 
       
         用户Token。 获取Token,请参考Token认证。  | 
       
         否 使用Token认证时该字段必选。  | 
       
         注:以下仅为Token示例片段MIIPAgYJKoZIhvcNAQcCoIIO8zCCDu8CAQExDTALBglghkgBZQMEAgEwgg1QBgkqhkiG9w0BBwGggg1BBIINPXsidG9rZ  | 
      
 
    API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。
AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。
对于创建客户接口,添加消息头后的请求如下所示。
POST https://bss.myhuaweicloud.com/v2/partners/sub-customers Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
请求消息体(可选)
该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于创建客户接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,请求参数的取值需要根据实际情况填写。
        1 2 3 4 5 6 7 8 9 10 11 12 13 14 15  | 
       
        POST https://bss.myhuaweicloud.com/v2/partners/sub-customers HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "domain_name": "test", "mobile_phone": "189xxxxxxxx", "verification_code": "253xxx", "xaccount_id": "35reyxxxx", "xaccount_type": "xxx_IDP", "password": "xxxxxxx", "is_close_market_ms": "true", "cooperation_type": "1", "indirect_partner_id": "a0d736359ada40aab6502d1a828c1809" }  |