接口使用方法
数据集服务API符合RESTful API设计理论。REST从资源的角度观察整个网络，分布在各处的资源由URI（Uniform Resource Identifier）确定，客户端的应用通过URL（Unified Resource Locator）获取资源。URL的一般格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径。
数据集服务接口采用HTTPS传输协议，请求/响应报文使用JSON报文，媒体类型表示为Application/json。
REST从资源的角度来观察整个网络，提供创建、查询、更新、删掉等方法访问服务的资源。
REST API请求/响应对可以分为五个部分：
- 请求URI
- 请求消息头
- 请求消息体
- 响应消息头
- 响应消息体
请求URI
- URI格式
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在这单独拿出来强调。
- URI中的参数说明
参数
描述
URI-scheme
表示用于传输请求的协议。
Endpoint
指定承载REST服务端点的服务器域名或IP，从地区和终端节点中获取。
resource-path
资源路径，也即API访问路径。从具体接口的URI模块获取，例如“v3/auth/tokens”。
Query string
可选参数，例如API版本或资源选择标准。
请求消息头
请求消息头包含如下两部分。
- HTTP方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
表1 HTTP方法 方法
说明
GET
请求服务器返回指定资源。
PUT
请求服务器更新指定资源。
POST
请求服务器新增资源或执行特殊操作。
DELETE
请求服务器删除指定资源，如删除对象等。
HEAD
请求服务器资源头部。
PATCH
请求服务器更新资源的部分内容。
当资源不存在的时候，PATCH可能会去创建一个新的资源。
- 可选的附加请求头字段，如指定的URI和HTTP方法所要求的字段。详细的公共请求消息头字段请参见表 公共请求消息头，其中请求认证信息请参见获取请求认证。
表2 公共请求消息头 名称
描述
是否必选
示例
Content-Type
消息体的类型（格式）
是
application/json
X-Auth-Token
Token认证信息，通过Token认证获取。
当使用Token方式认证时，必须填充该字段。
-
X-Sdk-Date
请求发送的时间。
当使用AK/SK认证时，必须填该字段。
20151222T034042Z
Authorization
签名认证信息该值来源于请求签名结果。
当使用AK/SK认证时，必须填该字段。
SDK-HMACSHA256
Credential=ZIRRKMTWPTQFQI1WKNKB/20151222/cnnorth-1/ec2/sdk_request,
SignedHeaders=content-type;host;x-sdk-date,
Signature=7972cc9145876d174b3862188a0f61819431fa71c8a8a060809ea8b898e3eaa9
Host:www.myhuaweicloud.com
请求消息体
请求消息体通常以结构化格式（如JSON）发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。
若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
响应消息头
响应消息头包含如下两部分。
- 一个HTTP状态代码，从2xx成功代码到4xx或5xx错误代码。 或者可以返回服务定义的状态码，如API文档中所示。
- 附加响应头字段，如支持请求的响应所需，如Content-type响应消息头。详细的公共响应消息头字段请参见表 响应消息头。
响应消息体
响应消息体通常以结构化格式（如JSON）返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。
发起请求
共有三种方式可以基于已构建好的请求消息发起请求，分别为：
- cURL
cURL是一个命令行工具，用来执行各种URL操作和信息传输。cURL充当的是HTTP客户端，可以发送HTTP请求给服务端，并接收响应消息。cURL适用于接口调试。关于cURL详细信息请参见https://curl.haxx.se/。
- 编码
- REST客户端
Mozilla、Google都为REST提供了图形化的浏览器插件，发送处理请求消息。针对Firefox，请参见Firefox RESTClient。针对Chrome，请参见Chrome RESTClient。
