使用说明

构造请求

请求URL

请求URL由如下部分组成:

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

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

 URL参数说明

参数

描述

URI-scheme

移动云API基于HTTPS通道发送请求

Endpoint

接入域名:ecloud.10086.cn

resource-path

接口地址

query-string

请求参数

 

请求方法

方法

说明

POST

请求服务器接口。

 

请求消息头

公共请求消息头是所有API请求都必需的参数。为减少内容重复,公共请求就不在各API详情中列出了。

名称

描述

示例

Content-type

指定请求消息体中的MIME类型

application/json

Content-Length

指定请求消息体的长度

3456

 

请求消息体

该部分可选。请求消息体通常以结构化JSON格式加密后发出,传递除请求消息头之外的内容。

若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。

公共请求参数是指每个API调用的请求中都需要包含的参数。

 

公共请求参数

名称

参数类型

是否必须

参数描述

Version

string

是

API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2016-12-05。

AccessKey

string

是

移动云颁发给用户的密钥对应的keyId(公钥)。

Timestamp

string

是

请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ  。例如,2016-12-05T12:00:00Z(为北京时间 2016 年 12 月 5 日 12 点 0 分 0 秒)。时间戳有效时间为5分钟

Signature

string

是

经由密钥加密生成的签名结果串,关于签名的计算方法,请参见<签名机制>。

SignatureMethod

string

是

签名方式,目前支持 HMAC-SHA1。

SignatureVersion

string

是

签名算法版本,目前版本是 V2.0。

SignatureNonce

string

是

用户发送请求的唯一随机数,防止重放攻击。用户在不同请求间要使用不同的随机数值

 

 

 

返回结果

响应消息头

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

一个HTTP状态代码,从2xx成功代码到4xx或5xx错误代码,或者可以返回服务定义的状态码。

附加响应头字段,如Content-Type响应消息头。

详细的公共响应消息头字段请参考下表

名称

描述

示例

Content-Length

服务端返回的消息实体的传输长度,以字节为单位

3456

Date

服务响应时的日期和时间. 格式由RFC 822定义.

Date: Tue, 15 Nov 1994 08:12:31 GMT

Content-type

消息体的MIME类型

text/plain; charset=utf-8

 

响应消息体

该部分可选。响应消息体通常以结构化JSON格式加密后返回,传递除响应消息头之外的内容。

 

 

错误信息

返回结果中如果存在 Error 字段,则表示调用 API 接口失败。 Error 中的 Code 字段表示错误码,所有业务都可能出现的错误码为公共错误码,下表列出了公共错误码。

HTTP状态码

错误代码

描述

语义

400

Bad Request

The Identity service failed to parse the request as expected. 

身份服务未能按预期解析请求

500

Internal Server Error

服务器内部错误,无法完成请求

服务器内部错误,无法完成请求

302

Move Temporarily

临时移动。请求的资源已被临时的移动到新URI,返回信息会包括新的URI,浏览器会自动定向到新URI

临时移动。请求的资源已被临时的移动到新URI,返回信息会包括新的URI,浏览器会自动定向到新URI

本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。