OPENAPI 参考手册简介简介欢迎使用阿里云 ACE(Aliyun Cloud Engine) ACE(Aliyun Cloud Engine) 是一款弹性分布式的应用托管环境, 支持 Java php 多种语言环境帮助开发者快速开发和部署服务端应用程序, 并且简化了系统维护工作搭载了

Size: px

Start display at page:

Download "OPENAPI 参考手册简介简介欢迎使用阿里云 ACE(Aliyun Cloud Engine) ACE(Aliyun Cloud Engine) 是一款弹性分布式的应用托管环境, 支持 Java php 多种语言环境帮助开发者快速开发和部署服务端应用程序, 并且简化了系统维护工作搭载了"

和琨鲍
7 years ago
Views:

1 云引擎 ACE OPENAPI 参考手册

2 OPENAPI 参考手册简介简介欢迎使用阿里云 ACE(Aliyun Cloud Engine) ACE(Aliyun Cloud Engine) 是一款弹性分布式的应用托管环境, 支持 Java php 多种语言环境帮助开发者快速开发和部署服务端应用程序, 并且简化了系统维护工作搭载了丰富的分布式扩展服务, 为应用程序提供强大助力请确保在使用这些接口前, 已充分了解 ACE 产品说明使用协议和收费方式术语表术语全称中文说明 App Application 应用 Region Region 地域用户托管在 ACE 上的应用程序, 例如网站或后台任务等代表资源所在的地域, 每个地域包含一组数据中心业务限制资源规格限制说明在本文档的接口说明部分, 凡出现对参数可选值可用规格等方面与官网上给出的资源规格限制发生矛盾时, 均以官网上给出的值为准 API 概览 API 概览监控相关 API API GetMonitorData 描述根据参数, 查询某个应用对应的监控数据日志相关 API API 描述 1

3 DescribeAppLogs 根据参数, 查询某个应用对应的日志调用方式调用方式调用方式对 ACE API 接口调用是通过向 ACE API 的服务端地址发送 HTTP(HTTPS) GET 或 POST 请求, 并按照接口说明在请求中加入相应请求参数来完成的 ; 根据请求的处理情况, 系统会返回处理结果主要根据以下四点来说明 : i. 请求结构 ii. 公共参数 iii. 返回结果 iv. 签名机制请求结构请求结构服务地址 ACE API 的服务接入地址为 : ace.[regionid].aliyuncs.com 通信协议支持通过 HTTP 或 HTTPS 通道进行请求通信为了获得更高的安全性, 推荐您使用 HTTPS 通道发送请求请求方法支持 HTTP GET 方法发送请求, 这种方式下请求参数需要包含在请求的 URL 中请求参数每个请求都需要指定要执行的操作, 即 Action 参数 ( 例如 GetMonitorData), 以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数字符编码请求及返回结果都使用 UTF-8 字符集进行编码 2

4 公共参数公共参数公共请求参数公共请求参数是指每个接口都需要使用到的请求参数名称类型是否必须描述 Format String 否 Version String 是 AccessKeyId String 是 Signature String 是 SignatureMethod String 是 TimeStamp String 是 SignatureVersion String 是 SignatureNonce String 是返回消息的格式化方式 ; 取值 :JSON or XML; 默认值 :XML 版本号为日期形式 :YYYY-MM-DD 本版本对应为阿里云颁发给用户的访问服务所用的密钥 ID 取值 : 请在阿里云官网的用户中心 - 我的服务 - 安全认证页面中查看和申请签名结果串, 关于签名的计算方法, 请参见签名机制签名方式, 目前支持 HMAC-SHA1, 取值 :HMAC-SHA1 请求的时间戳日期格式按照 ISO8601 标准表示, 并需要使用 UTC 时间格式为 :YYYY-MM- DDThh:mm:ssZ; 例如, T12:00:00Z( 为北京时间 2013 年 1 月 10 日 20 点 0 分 0 秒签名算法版本, 目前版本是 1.0, 取值 :1.0 唯一随机数, 用于防止网络重放攻击用户在不同请求间要使用不同的随机数值示例 &Formatxml &AccessKyId=testid 3

5 &ActionGetMonitorData &SignatueMethod=Hmac-SHA1 &SignatueNonce=NwDAxvLU6tFE0DVb &Version &SignatueVersion=1.0 &Signatue=FZnIrdNSLax4lnWf6NkKDc7mp54%3D 公共返回参数用户发送的每次接口调用请求, 无论成功与否, 系统都会返回一个唯一识别码 RequestID 给用户示例 <?xml version="1.0" encoding="utf-8"?> <! 结果的根结点 --> < 接口名称 +Response> <! 返回请求标签 --> <RequestId>4C467B D-87BC-AC049166F216</RequestId> </ 接口名称 +Response> 返回结果返回结果调用 API 服务后返回数据采用统一格式, 返回的 HTTP 状态码为 2xx, 代表调用成功 ; 返回 4xx 或 5xx 的 HTTP 状态码代表调用失败调用成功返回的数据格式主要有 XML 和 JSON 两种, 外部系统可以在请求时传入参数来制定返回的数据格式, 默认为 XML 格式本文档中的返回示例为了便于用户查看, 做了格式化处理, 实际返回结果是没有进行换行缩进等处理的成功结果 XML 示例 XML 返回结果包括请求是否成功信息和具体的业务数据示例如下 : <?xml version="1.0" encoding="utf-8"?> <! 结果的根结点 --> < 接口名称 +Response> <! 返回请求标签 --> <RequestId>4C467B D-87BC-AC049166F216</RequestId> <! 返回结果数据 --> </ 接口名称 +Response> JSON 示例 "RequestId":"4C467B D-87BC-AC049166F216", /* 返回结果数据 */ } 错误结果 4

6 调用接口出错后, 将不会返回结果数据调用方可根据附表错误代码表来定位错误原因当调用出错时,HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码返回的消息体中是具体的错误代码及错误信息另外还包含一个全局唯一的请求 ID:RequestID 和一个您该次请求访问的站点 ID:HostID 在调用方找不到错误原因, 可以联系阿里云客服, 并提供该 HostID 和 RequestID, 以便我们尽快帮您解决问题 XML 示例 <?xml version="1.0" encoding="utf-8"?> <Error> <RequestId> E A-A6C4-0E7863B733A5</RequestId> <HostId>ace.cn-hangzhou.aliyuncs.com</HostId> <Code>UnsupportedOperation</Code> <Message>The specified action is not supported.</message> </Error> JSON 示例 } "RequestId":"7463B73D-35CC-4D19-A010-6B8D65D242EF", "HostId":"ace.cn-hangzhou.aliyuncs.com", "Code":"UnsupportedOperation", "Message":"The specified action is not supported." 签名机制签名机制 ACE 服务会对每个访问的请求进行身份验证, 所以无论使用 HTTP 还是 HTTPS 协议提交请求, 都需要在请求中包含签名 (Signature) 信息 ACE 通过使用 Access Key ID 和 Access Key Secret 进行对称加密的方法来验证请求的发送者身份 Access Key ID 和 Access Key Secret 由阿里云官方颁发给访问者 ( 可以通过阿里云官方网站申请和管理 ), 其中 Access Key ID 用于标识访问者的身份 ;Access Key Secret 是用于加密签名字符串和服务器端验证签名字符串的密钥, 必须严格保密, 只有阿里云和用户知道签名方法用户在访问时, 按照下面的方法对请求进行签名处理使用请求参数构造规范化的请求字符串 (Canonicalized Query String) 按照参数名称的字典顺序对请求中所有的请求参数 ( 包括文档中描述的公共请求参数和给定了的请求接口的自定义参数, 但不能包括公共请求参数中提到 Signature 参数本身 ) 进行排序注 : 当使用 GET 方法提交请求时, 这些参数就是请求 URI 中的参数部分 ( 即 URI 中? 之后由 & 连接的部分 ) 5

7 对每个请求参数的名称和值进行编码名称和值要使用 UTF-8 字符集进行 URL 编码, 如下 i. 对于字符 A-Z a-z 0-9 以及字符 - _. ~ 不编码 ; ii. 对于其他字符编码成 %XY 的格式, 其中 XY 是字符对应 ASCII 码的 16 进制表示比如英文的双引号 ( ) 对应的编码就是 %22 iii. 对于 ASCII 字符之外的 UTF-8 字符, 在进行 UTF-8 编码后按照两个字节按 (ii) 描述的方式编码 ; iv. 需要说明的是英文空格 ( ) 要被编码是 %20, 而不是加号 (+) 注 : 一般支持 URL 编码的库 ( 比如 Java 中的 java.net.urlencoder) 都是按照 application/x-wwwform-urlencoded 的 MIME 类型的规则进行编码的实现时可以直接使用这类方式进行编码, 把编码后的字符串中加号 (+) 替换成 %20 星号(*) 替换成 %2A %7E 替换回波浪号 (~), 即可得到上述规则描述的编码字符串对编码后的参数名称和值使用英文等号 (=) 进行连接再把英文等号连接得到的字符串按参数名称的字典顺序依次使用 & 符号连接, 即得到规范化请求字符串使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串 : StringToSign= HTTPMethod + & + percentencode( / ) + & + percentencode(canonicalizedquerystring) 其中 HTTPMethod 是提交请求用的 HTTP 方法, 比 GET percentencode( / ) 是按照 1.b 中描述的 URL 编码规则对字符 / 进行编码得到的值, 即 %2F percentencode(canonicalizedquerystring) 是对第 1 步中构造的规范化请求字符串按 1.b 中描述的 URL 编码规则编码后得到的字符串按照 RFC2104 的定义, 使用上面的用于签名的字符串计算签名 HMAC 值注意 : 计算签名时使用的 Key 就是用户持有的 Access Key Secret 并加上一个 & 字符 (ASCII:38), 使用的哈希算法是 SHA1 按照 Base64 编码规则把上面的 HMAC 值编码成字符串, 即得到签名值 (Signature) 将得到的签名值作为 Signature 参数添加到请求参数中, 即完成对请求签名的过程注意 : 得到的签名值在作为最后的请求参数值提交给 ACE 服务器的时候, 要和其他参数一样, 按照 RFC3986 的规则进行 URL 编码 ) 签名示例以 GetMonitorData 为例, 签名前的请求 URL 为 : &Formatxml &AccessKyId=testid 6

8 &ActionGetMonitorData &SignatueMethod=Hmac-SHA1 &SignatueNonce=NwDAxvLU6tFE0DVb &Version &SignatueVersion=1.0 那么 StringToSign 就是 : GET&2F&AccessKyID%3Dtestid %26Action%3DGetMonitorData %26Format%3Dxml %26SignatureMethod%3DHmac-SHA1 %26SignatureNonce%3DNwDAxvLU6tFE0DVb %26SignatureVersion%3D1.0 %26Timestamp%3D T10%253A33%253A56Z %26Version%3D 假如使用的 Access Key Id 是 testid,access Key Secret 是 testsecret, 用于计算 HMAC 的 Key 就是 testsecret, 则计算得到的签名值是 : `FZnIrdNSLax4lnWf6NkKDc7mp54=` 签名后的请求 URL 为 ( 注意增加了 Signature 参数 ): &Formatxml &AccessKyId=testid &ActionGetMonitorData &SignatueMethod=Hmac-SHA1 &SignatueNonce=NwDAxvLU6tFE0DVb &Version &SignatueVersion=1.0 &Signatue=FZnIrdNSLax4lnWf6NkKDc7mp54%3D 监控数据相关 API 获取监控数据 GetMonitorData 描述根据用户指定的应用 ID 和监控项查询对应的监控数据注意, 返回的监控数据有一定的数量限制请求参数名称类型是否必须描述 Action String 是操作接口名, 系统规定参数取值 :GetMonitorData 7

9 AppId String 是应用编号 Item String 是 StartTime String 是 EndTime String 否 CurPage Integer 否 PageSize Integer 否查询的监控项名取值 :cpu memory thread younggccount younggctime fullgccount fullgctime newsize oldsize network_speed_in network_speed_out network_flow_in network_flow_out pv request 查询开始时间日期格式按照 ISO8601 标准表示, 并需要使用 UTC 时间格式为 :YYYY-MM- DDThh:mm:ssZ; 例如, T12:00:00Z( 为北京时间 2013 年 1 月 10 日 20 点 0 分 0 秒 ) 查询结束时间, 日期格式同 StartTime 默认为 : 当前时间查询起始页码默认值 :1 每页显示的记录数默认值 :20 返回参数名称类型描述 < 公共参数 > 详见 < 公共返回参数 > NextPageNum Data String MonitorDataType 下一次开始查询的页码, 如果为 0, 则表示没有更多的数据监控数据 MonitorDataType 的集合 MonitorDataType 描述描述某个时间点的监控项数据节点名 Item 8

10 子节点名称类型描述 Timestamp Long 监控采集时间, 精确到 ms Value Float 监控值示例请求示例 &ActionGetMonitorData &AppId7712 &Itemmemory &StartTie= T00:00:00Z &EndTime T00:00:00Z &CurPage1 &PageSiz=20 &< 公共请求参数 > 返回示例 XML 格式 <?xml version="1.0" encoding="utf-8"?> <GetMonitorDataResponse> <NextPageNum>2</NextPageNum> <Data> <Item> <Timestamp> </Timestamp> <Value> </Value> </Item> <Item> <Timestamp> </Timestamp> <Value> </Value> </Item> </Data> </GetMonitorDataResponse> JSON 格式 "data": "item": [ "timestamp": , "value": }, "timestamp": , 9

11 } "value": }] }, "nextpagenum":2 日志相关 API 获取应用日志 DescribeAppLogs 描述根据用户指定的应用 ID 和时间查询对应的日志请求参数名称类型是否必须描述 Action String 是操作接口名, 系统规定参数取值 :DescribeAppLogs AppId String 是应用编号 StartTime String 是 EndTime String 否 PageNumber Integer 否 PageSize Integer 否查询开始时间日期格式使用 GMT+8 时间格式为 :YYYY-MM-DD hh:mm:ss; 例如, :00:00( 为北京时间 2013 年 1 月 10 日 12 点 0 分 0 秒 ) 查询结束时间, 日期格式同 StartTime 默认为 : 当前时间查询起始页码默认值 :1 每页显示的记录数默认值 :20 返回参数名称类型描述 < 公共参数 > 详见 < 公共返回参数 > PageRecordCount Integer 查询到的日志条数 10

12 Items List 日志列表示例请求示例 &ActionDescribeAppLogs &AppId7712 &StartTie= %3A00%3A00 &EndTime %3A01%3A00 &PageNumer=1 &PageSiz=20 &< 公共请求参数 > 返回示例 XML 格式 <?xml version="1.0" encoding="utf-8"?> <DescribeAppLogsResponse> <PageRecordCount>2</PageRecordCount> <Items> <AppLog> <LogTime> :00:00</LogTime> <LogContent>[INFO] org.springframework.beans.factory.xml.defaultdocumentloader.loaddocu ment...</logcontent> </AppLog> <AppLog> <LogTime> :00:00</LogTime> <LogContent>[INFO] org.springframework.beans.factory.xml.defaultdocumentloader.loaddocu ment...</logcontent> </AppLog> </Items> </DescribeAppLogsResponse> JSON 格式 "Items": "AppLog": [ "LogTime":" :00:00", "LogContent":"[INFO] org.springframework.beans.factory.xml.defaultdocumentloader.loaddo cument..." }, "LogTime":" :00:00", "LogContent":"[INFO] org.springframework.beans.factory.xml.defaultdocumentloader.loaddo cument..." }] 11

13 } }, "PageRecordCount":2 附录错误代码表错误代码表说明错误代码和英文描述是错误返回信息可见的, 中午描述只用于文档解释和补充说明, 错误返回信息不可见错误代码和英文描述的组合标示一个错误返回, 有相同错误代码时, 依赖英文描述区分不同的错误返回错误代码英文描述中文描述 Http 状态码 NoPrivilege User is not authorized to operate on the specified app 用户没有权限操作该应用 403 InvalidDateFormat StartTime Or EndTime is not valid Date. 查询开始时间和查询结束时间格式不正确 400 更新历史更新历史 API 版本 : 最近更新时间 : 发布时间更新说明增加日志和监控相关 API 增加日志和监控相关 API 12

目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制云主机备份购买云主机备份服务云主机备份列表...

目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制云主机备份购买云主机备份服务云主机备份列表... 移动云云主机备份 API 接口文档本文档的程序或内容受版权法的保护, 未经移动云的书面许可, 不得擅自泄漏拷贝或复制本文档资料的全部或部分第 II 页目录移动云 1. API 访问... 4 1.1 调用方法方法... 4 1.2 公共参数... 4 1.2.1 公共请求参数... 4 1.2.2 公共返回参数... 5 1.3 签名机制... 5 2. 云主机备份... 7 2.1 购买云主机备份服务...

OPENAPI 参考手册 简介 简介 欢迎使用阿里云 ACE(Aliyun Cloud Engine) ACE(Aliyun Cloud Engine) 是一款弹性 分布式的应用托管环境, 支持 Java php 多种语言环境 帮助开发者快速开发和部署服务端应用程序, 并且简化了系统维护工作 搭载了

OPENAPI 参考手册简介简介欢迎使用阿里云 ACE(Aliyun Cloud Engine) ACE(Aliyun Cloud Engine) 是一款弹性分布式的应用托管环境, 支持 Java php 多种语言环境帮助开发者快速开发和部署服务端应用程序, 并且简化了系统维护工作搭载了