148      阿里云

概述及样例__使用手册（调用API）_API 网关-阿里云

您可以通过API网关，调用由其他阿里云用户或者第三方服务商开放的API服务。API网关将为您提供一系列管理服务与支撑。

调用API

您可以直接用API网关控制台为您提供的多语言调用示例来测试调用。您也可以自行编辑HTTP(s)请求调用API。签名方式您可以参照控制台的SDK示例下载。

API调用方式说明及示例如下：（调用API前期流程请参照《快速入门（调用API）》）

请求

请求地址

https://e710888d3ccb4638a723ff8d03837095-cn-qingdao.aliapi.com/demo/post

请求方法

POST

请求体

FormParam1=FormParamValue1&FormParam2=FormParamValue2 
//HTTP Request Body

请求头部

Host: e710888d3ccb4638a723ff8d03837095-cn-qingdao.aliapi.com
Date: Mon, 22 Aug 2016 11:21:04 GMT
User-Agent: Apache-HttpClient/4.1.2 (java 1.6)
Content-Type: application/x-www-form-urlencoded; charset=UTF-8 
//请求体类型，请根据实际请求体内容设置
Accept: application/json 
//请求响应体类型，部分API可以根据指定的响应类型来返回对应数据格式，建议手动指定此请求头，如果不设置，部分HTTP客户端会设置默认值*/*，导致签名错误
X-Ca-Request-Mode: debug 
//是否开启Debug模式，大小写不敏感，不设置默认关闭，一般API调试阶段可以打开此设置
X-Ca-Version: 1  
//API版本号，目前所有API仅支持版本号『1』，可以不设置此请求头，默认版本号为『1』
X-Ca-Signature-Headers: X-Ca-Request-Mode,X-Ca-Version,X-Ca-Stage,X-Ca-Key,X-Ca-Timestamp 
//参与签名的自定义请求头，服务端将根据此配置读取请求头进行签名，此处设置不包含Content-Type、Accept、Content-MD5、Date请求头，这些请求头已经包含在了基础的签名结构中，详情参照请求签名说明文档
X-Ca-Stage: RELEASE  
//请求API的Stage，目前支持TEST、RELEASE两个Stage，大小写不敏感，API提供者可以选择发布到哪个Stage，只有发布到指定Stage后API才可以调用，否则会提示API找不到或Invalid Url
X-Ca-Key: 60022326  
//请求的AppKey，请到API网关控制台生成，只有获得API授权后才可以调用，通过云市场等渠道购买的API默认已经给APP授过权，阿里云所有云产品共用一套AppKey体系，删除ApppKey请谨慎，避免影响到其他已经开通服务的云产品
X-Ca-Timestamp: 1471864864235 
//请求的时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟
X-Ca-Nonce:b931bc77-645a-4299-b24b-f3669be577ac  
//请求唯一标识，15分钟内AppKey+API+Nonce不能重复，与时间戳结合使用才能起到防重放作用
X-Ca-Signature: FJleSrCYPGCU7dMlLTG+UD3Bc5Elh3TV3CWHtSKh1Ys= 
//请求签名
CustomHeader: CustomHeaderValue  
//自定义请求头，此处仅作为示例，实际请求中根据API定义可以设置多个自定义请求头

响应

状态码

400  
//响应状态码，大于等于200小于300表示成功；大于等于400小于500为客户端错误；大于500为服务端错误

响应头

X-Ca-Request-Id: 7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF 
//请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪
X-Ca-Error-Message: Invalid Url  
//API网关返回的错误消息，当请求出现错误时API网关会通过响应头将错误消息返回给客户端
X-Ca-Debug-Info: {"ServiceLatency":0,"TotalLatency":2}  
//当打开Debug模式后会返回Debug信息，此信息后期可能会有变更，仅用做联调阶段参考

您调用API时，无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名信息。AppKey用于标识您的身份，AppSecret是用于加密签名字符串和服务器端验证签名字符串的密钥。详细加密签名的计算传递方式，请查看文档——[请求签名说明文档]