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

Size: px

Start display at page:

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

虹匡扶
5 years ago
Views:

1 移动云云主机备份 API 接口文档本文档的程序或内容受版权法的保护, 未经移动云的书面许可, 不得擅自泄漏拷贝或复制本文档资料的全部或部分第 II 页

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

3 1. 1. API 访问 1.1 调用方法方法服务地址 :API 服务将为每个资源池提供不同接入地址, 具体为 : 1) 华南节点 2:api-guangzhou-2.cmecloud.cn(http https) 2) 华北节点 1:api-beijing-1.cmecloud.cn(http), api-beijing-1.cmecloud.cn:8443(https) 传输 : 移动云 API 基于 HTTP/HTTPS 通道发送请求请求 :API 包含 HTTP GET( 查询 ) POST( 新增 ) PUT( 修改 ) DELETE( 删除 ) 请求, 所有的订购退订请求入口只在华南节点 2 提供返回 : 请求体以及返回结构体中使用的均为 json 格式, 不支持 XML 格式报文编码 : 请求及返回结果都使用 UTF-8 字符集进行编码 1.2 公共参数公共请求参数公共请求参数是指每个 API 调用的请求中都需要包含的参数名称类型是否必须描述 Version String 是 API 版本号, 为日期形式 :YYYY-MM-DD, 本版本对应为 AccessKey String 是移动云颁发给用户的密钥对应的 keyid( 公钥 ) Timestamp String 是请求的时间戳日期格式按照 ISO8601 标准表示, 并需要使用 UTC 时间格式为 : YYYY-MM-DDThh:mm:ssZ 例如, T12:00:00Z( 为北京时间 2016 年 12 月 5 日 12 点 0 分 0 秒 ) 时间戳有效时间为 5 分钟 Signature String 是经由密钥加密生成的签名结果串, 关于签名的计算方法, 请参见 < 签名机制 > SignatureMethod String 是签名方式, 目前支持 HMAC-SHA1 SignatureVersion String 是签名算法版本, 目前版本是 V2.0 SignatureNonce String 是用户发送请求的唯一随机数, 防止重放攻击用户在不同请求间要使用不同的随机数值公共请求参数示例如下 :

4 &AccessKey=9d81ffbeaaf db5df577bb3299 &Timestamp= T14:54:11Z &Signature=8c01e0104e0e14f9445bd ad8335 &SignatureMethod=HmacSHA1 &SignatureVersion=V2.0 &SignatureNonce= 公共返回参数用户发送的每次接口调用请求, 无论成功与否, 系统都会返回一个唯一识别码 RequestId 给用户 "RequestId": "4C467B D-87BC-AC049166F216", /* 返回结果数据 */ 1.3 签名机制移动云 API 服务会对每个访问的请求进行身份验证, 所以无论使用 HTTP 还是 HTTPS 协议提交请求, 都需要在请求中包含签名 (Signature) 信息用户通过 Access Key 和 Sectet Key 对称加密的方法来验证请求的发送者身份 Access Key 和 Secret Key 由移动云官方颁发给访问者 ( 可以通过移动云官方网站申请和管理 ), 其中 Access Key ID 用于标识访问者的身份 ; Secret Key 用于对请求签名字符串进行摘要加密, 同时也是 API 服务器端验证签名字符串的密钥,Secret Key 必须严格保密, 只有移动云和用户知道用户在访问时, 按照下面的方法对请求进行签名处理 : 以获取用户密钥对为例, 假设使用的 Access Key Id 是 testid, Access Key Secret 是 testsecret 那么签名前的请求 URL 为 : amp= t15:15:11z&signaturemethod=hmacsha1&signatureversion=v2.0&signaturen once=9d81ffbeaaf db5df577bb 使用请求参数构造规范化的请求字符串 (Canonicalized Query String) a) 参数排序按照参数名称的字典顺序对请求中所有的请求参数 ( 包括公共请求参数和接口的自定义参数, 但不能包括公共请求参数中提到的 Signature 参数本身 ) 进行排序注 : 当使用 GET 方法提交请求时, 这些参数就是请求 URI 中的参数部分 ( 即 URI 中? 之后由 & 连接的部分 ) b) 参数编码对排序之后的请求参数的名称和值分别用 UTF-8 字符集进行 URL 编码编码的规则如下 : i. 对于字符 A-Z a-z 0-9 以及字符 - _. ~ 不编码 ; ii. 对于其他字符编码成 %XY 的格式, 其中 XY 是字符对应 ASCII 码的 16 进制表示比如英文的双引号 ( ) 对应的编码就是 %22 iii. 对于扩展的 UTF-8 字符, 编码成 %XY%ZA 的格式 ;

5 iv. 需要说明的是英文空格 ( ) 要被编码是 %20, 而不是加号 (+) 注 : 该编码方式和一般采用的 application/x-www-form-urlencoded MIME 格式编码算法 ( 比如 Java 标准库中的 java.net.urlencoder 的实现 ) 相似, 但又有所不同实现时, 可以先用标准库的方式进行编码, 然后把编码后的字符串中加号 (+) 替换成 %20 星号(*) 替换成 %2A %7E 替换回波浪号 (~), 即可得到上述规则描述的编码字符串 c) 将编码后的参数名称和值用英文等号 (=) 进行连接 d) 将等号连接得到的参数组合按步骤 (a) 排好的顺序依次使用 & 符号连接, 即得到规范化请求字符串 AccessKey=testid&SignatureMethod=HmacSHA1&SignatureNonce=9d81ffbeaaf db5 df577bb3299&signatureversion=v2.0&timestamp= t15%3a15%3a11z&version= 将上一步构造的规范化字符串按照下面的规则构造成待签名的字符串 : StringToSign = HTTPMethod + \n percentencode(servletpath)+ \n shaencode( CanonicalizedQueryString) a) 其中 HTTPMethod 是提交请求用的 HTTP 方法, 比如 GET b) percentencode( / ) 是按照 1.b 中描述的 URL 编码规则对字符 / 进行编码得到的值, 即 %2F c) shaencode 是指对上一步获得的字符串进行摘要加密, 加密算法为 SHA-256 d) 将这 3 个字符串相连, 得到待签名字符串 : GET %2Fapi%2Fkeypair 25fb697a06bc8a16a0a f5cba35aded3818e15f088e4e17cd394aa07af 3. 使用密钥加密得到最终签名 a) 按照 RFC2104 的定义, 计算待签名字符串 StringToSign 的 HMAC 值, 即得到签名值 Signature 注意 : 计算签名时使用的 Key 就是字符串 BC_SIGNATURE& 加上用户持有的 Access Key Secret, 使用的哈希算法是 SHA1 拼接后的 Access Key Secret:BC_SIGNATURE&testsecret b) 将得到的签名值作为 Signature 参数添加到请求参数中, 即完成对请求签名的过程注意 : 得到的签名值在作为最后的请求参数值提交给 ECS 服务器的时候, 要和其他参数一样, 按照 RFC3986 的规则进行 URL 编码得到最终 url: amp= t15:15:11z&signature= a b2a82c56d9b007362&sign aturemethod=hmacsha1&signatureversion=v2.0&signaturenonce=9d81ffbeaaf db5df5 77bb3299

6 2. 云主机备份 2.1 购买云主机备份服务 URL 路径 :/api/order/serverbackup HTTP 方法 :POST 请求参数 : 元素名称是否必须类型描述 poolid 是 String 资源池 ID,CIDC-RP-01 华南节点 1,CIDC-RP-02 华南节点 2,CIDC-RP-03 华北节点 1 请求实例 : T15:32:11Z&Signature=0fc0af056659d87d1460b220185aa42fd3f45d73&SignatureMetho d=hmacsha1&signaturenonce=206&signatureversion=v2.0 返回实例 "state": "OK", "body": "CIDC-O-22f1b2ec7d784f5f8d482eb67dc1afa9", "requestid": "b427c940c0eb4bcca8d95da7ad236940" 2.2 云主机备份列表 URL 路径 :/api/server/backup HTTP 方法 :GET 请求参数 : 元素名称是否必须类型描述 serverid 否 String 虚拟机 ID name 否 String 虚拟机备份名称 page 否 Integer 页数 size 否 Integer 每页显示数量返回参数 : 元素名称类型描述 id String 虚拟机备份 ID serverid String 虚拟机 ID

7 name String 虚拟机备份名称 backupsize Integer 虚拟机备份大小虚拟机状态,1:ACTIVE, 2:BUILD, 3:REBUILD, 4:SUSPENDED,5:PAUSED, 6:RESIZE, 7:VERIFY_RESIZE, 8:REVERT_RESIZE, 9:PASSWORD,10:REBOOT, status Integer 11:HARD_REBOOT, 12:DELETED, 13:UNKNOWN,14:ERROR, 15:STOPPED, 16:SHUTOFF, 17:MIGRATING, 18: UNRECOGNIZED, 19:BACKUPING, 20:RESTORING backupstatus Integer 虚拟机备份状态 systemdisk String 系统盘 ID createdtime Date 虚拟机备份创建时间 modifiedtime Date 虚拟机备份修改时间请求示例 : 公共请求参数 > 返回示例 : "body" : "content" : [, "id" : "87c57d4b-fda2-40a bfd708a6fb52" "serverid" : "434a c edfd" "name" : "yu2ae" "backupsize" : 2508 "status" : 0 "backupstatus" : 1 "systemdisk" : "0a50ac16-26a4-425f-b95e-f170c6ed5865" "createdtime" : " :51:19" "modifiedtime" : null "id" : "e453cfbf-4d84-4d8a-b9d1-a62ad288e909" "serverid" : "434a c edfd" "name" : "yuevmbackup" "backupsize" : 2508

8 , "status" : 1 "backupstatus" : 1 "systemdisk" : "0a50ac16-26a4-425f-b95e-f170c6ed5865" "createdtime" : " :45:22" "modifiedtime" : null, "id" : "9670c963-ffd5-462c-8e5c-d15225c10226" "serverid" : "7f1b7e88-8fb3-42fd-bffe-a9c2f12f3ad1" "name" : "senlinbackup" "backupsize" : 3012 "status" : 0 "backupstatus" : 1 "systemdisk" : "e7470d3d-119c-4397-b97f-13077d5f85a7" "createdtime" : " :06:20" "modifiedtime" : null ] "total" : 3 "requestid": "2937d70b5dca4eb5a38dd6c8a3f02ec5" 2.3 创建云主机备份 URL 路径 :/api/server/backup HTTP 方法 :POST 请求参数 : 元素名称是否必须类型描述 serverid 是 String 虚拟机 ID 虚拟机备份名称,5-22 位 name 是 String 的中文英文数字下划线的组合返回参数 : 元素名称类型描述 id String 虚拟机备份 ID serverid String 虚拟机 ID name String 虚拟机备份名称 backupsize Integer 虚拟机备份大小

9 status Integer 虚拟机状态,1:ACTIVE, 2:BUILD, 3:REBUILD, 4:SUSPENDED,5:PAUSED, 6:RESIZE, 7:VERIFY_RESIZE, 8:REVERT_RESIZE, 9:PASSWORD,10:REBOOT, 11:HARD_REBOOT, 12:DELETED, 13:UNKNOWN,14:ERROR, 15:STOPPED, 16:SHUTOFF, 17:MIGRATING, 18: UNRECOGNIZED, 19:BACKUPING, 20:RESTORING backupstatus Integer 虚拟机备份状态 systemdisk String 系统盘 ID createdtime Date 虚拟机备份创建时间 modifiedtime Date 虚拟机备份修改时间请求示例 : 公共请求参数 > "name":"test", "serverid":"434a c edfd" 返回示例 : "body": "id": "c c29e-450e-b4dd-ea5e9e419825", "serverid": "434a c edfd", "name": "test", "backupsize": 0, "status": 0, "backupstatus": 3, "systemdisk": "e453cfbf-4d84-4d8a-b9d1-a62ad288e909", "createdtime": " :47:49", "modifiedtime": null, "requestid": "ae69c8a8c6c741d0add3e99ac07c6918"

10 2.4 删除云主机备份 URL 路径 :/api/server/backup/id HTTP 方法 :DELETE 请求参数 : 元素名称是否必须类型描述 id 是 String 虚拟机备份 ID 返回参数 : 无请求示例 : 共请求参数 > 公返回示例 : "requestid": "23f12ac1ae574d37a8a1708d " 2.5 恢复云主机 URL 路径 :/api/server/backup/restore HTTP 方法 :POST 请求参数 : 元素名称是否必须类型描述 id 是 String 虚拟机备份 ID serverid 是 String 虚拟机 ID 返回参数 : 无请求示例 : 公共请求参数 > "id":"748d374d-21f0-4be2-9bfb-55c9fa2b0ef2", "serverid":"434a c edfd" 返回示例 : "requestid": "eb76975c943b4982a29a01005c26b421"

目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制安全组... 错误! 未定义书签 2.1 安全组列表... 错误! 未定义书签 2.2 创

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

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

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