文档首页/ 全球SIM联接 GSL/ API参考/ 如何调用API/ 构造请求
更新时间：2023-11-20 GMT+08:00
查看PDF
分享

构造请求

本节介绍REST API请求的组成，以调用全球SIM联接查询SIM卡列表接口说明如何调用API，该API获取用户SIM卡列表信息。服务支持的全部API请参考API列表。

请求URI

请求URI由如下部分组成。

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

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

  • URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。
  • Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”，全球SIM联接服务在“华北-北京四”区域的Endpoint为“gsl.cn-north-4.myhuaweicloud.com”。
  • resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“查询SIM卡列表”API的resource-path为“/v1/sim-cards”。
  • query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如您需要查询SIM卡列表，则需使用“华北-北京四”区域的Endpoint（gsl.cn-north-4.myhuaweicloud.com），并在查询SIM卡列表的URI部分找到resource-path（/v1/sim-cards），拼接起来如下所示。

https://gsl.cn-north-4.myhuaweicloud.com/v1/sim-cards

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

请求方法

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

  • GET：请求服务器返回指定资源。
  • PUT：请求服务器更新指定资源。
  • POST：请求服务器新增资源或执行特殊操作。
  • DELETE：请求服务器删除指定资源，如删除对象等。
在查询SIM卡列表的URI部分，您可以看到其请求方法为“GET”，则其请求为： 
GET https://gsl.cn-north-4.myhuaweicloud.com/v1/sim-cards

请求消息头

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

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

  • Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。
  • X-Auth-Token：用户Token，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

对于查询SIM卡列表接口，由于需要认证，所以需要添加“Content-Type”和“X-Auth-Token”到头域，添加消息头后的请求如下所示。

GET https://gsl.cn-north-4.myhuaweicloud.com/v1/sim-cards
Content-Type: application/json
X-Auth-Token：******

到此请求需要的内容已具备齐全，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。返回内容，请参考返回结果。

父主题： 如何调用API

相关文档