文档首页> > API参考> 接口使用方法> REST API介绍

REST API介绍

更新时间: 2018-12-07 12:01

数据接入服务(DIS)提供REST(Representational State Transfer)API。

REST从资源的角度来观察整个网络,分布在各处的资源由URI(Uniform Resource Identifier)确定,而客户端的应用通过URL(Unified Resource Locator)来获取资源。

URL的一般格式为:https://Endpoint/uri

URL中的参数说明如表1所示。

表1 URL中的参数说明

参数

说明

Endpoint

请求使用的服务器名,从终端节点及区域说明中获取。

uri

资源路径,也即API访问路径。从具体接口的URI模块获取。

REST API请求/响应对可以分为五个部分:

  • 请求URI
  • 请求消息头
  • 请求消息体
  • 响应消息头
  • 响应消息体

请求URI

请求URI由如下部分组成:

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

表2 URL中的参数说明

参数

说明

URI-scheme

表示用于传输请求的协议。DIS的API必须采用https。

Endpoint

指定承载REST服务端点的服务器域名或IP,从地区和终端节点中获取。

resource-path

资源路径,即API访问路径。从具体接口的URI模块获取。

query-string

可选参数,例如API版本或资源选择标准。

请求消息头

请求消息头包含如下两部分:

  • HTTP方法(也称为操作或动词),用于指明以何种方式来访问指定的资源。

    DIS的REST API支持的方法如表3所示。

    表3 HTTP方法

    方法

    说明

    GET

    请求服务器返回指定资源。

    POST

    请求服务器新增资源或执行特殊操作。

    PUT

    请求服务器更新指定资源。

    DELETE

    请求服务器删除指定资源,如删除对象等。

    HEAD

    请求服务器资源头部。

    PATCH

    请求服务器更新资源的部分内容。

    当资源不存在的时候,PATCH可能会去创建一个新的资源。

  • 可选的附加请求头字段,如指定的URI和HTTP方法所要求的字段。

    公共请求消息头字段请参见表4,其中请求认证信息请参见获取请求认证

    表4 请求消息头

    消息头名称

    是否必选

    类型

    说明

    Content-Type

    String

    资源内容的类型。例如:application/json。

    默认值:无。

    X-Sdk-Date

    String

    请求发起端的日期和时间。格式为:YYYYMMDD'T'HHMMSS'Z'。例如:20180820T101459Z。

    默认值:无。

    Authorization

    String

    请求消息中可带的鉴权信息。

    SDK-HMAC-SHA256 Credential=QRUP2R3QFNAOVAWMYHZW/20160202/northchina/test/sdk_request, SignedHeaders=host;x-sdk-date, Signature=9d8b56b055c0e1f7a9498d881a7cb726be91b4f0cde1773b0b1557e987a480ce

    默认值:无。

    Host

    String

    请求的服务信息。

    默认值:无。

请求消息体

请求消息体以JSON格式封装和发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。

HTTP请求的正文针对不同的URI对象有不同的必须字段和可选字段。

响应消息头

响应消息头包含如下两部分:

  • 一个HTTP状态代码,请参见状态码
  • 附加响应头字段,如支持请求的响应所需,如Content-type响应消息头。

    公共响应消息头字段请参见表5

    表5 响应消息头

    消息头名称

    类型

    说明

    Content-Type

    String

    资源内容的类型。例如:application/json。

    默认值:无。

    Date

    String

    DIS系统响应的时间。例如:Mon, 15 Jul 2013 21:08:05 GMT。

    默认值:无。

响应消息体

响应消息体为JSON格式的文本,与响应消息头中Content-type对应,传递除响应消息头之外的内容。

发起请求

共有三种方式可以基于已构建好的请求消息发起请求,分别为:

  • cURL

    cURL是一个命令行工具,用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端,可以发送HTTP请求给服务端,并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/

  • 编码

    通过编码调用接口,组装请求消息,并发送处理请求消息。

  • REST客户端

    Mozilla、Google都为REST提供了图形化的浏览器插件,发送处理请求消息。

    针对Firefox,请参见Firefox REST Client

    针对Chrome,请参见Postman Interceptor

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

在文档使用中是否遇到以下问题







请至少选择或填写一项反馈信息

字符长度不能超过100

反馈内容不能为空!

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区
点我,12·12惊喜等着你哦~