目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制性能型云硬盘硬盘列表接口描述

Size: px

Start display at page:

Download "目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制性能型云硬盘硬盘列表接口描述"

汶作籍
5 years ago
Views:

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

2 目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制性能型云硬盘硬盘列表接口描述接口参数使用示例硬盘详情接口描述接口参数使用示例云硬盘更新接口描述接口参数使用示例创建云硬盘接口描述接口参数使用示例删除云硬盘接口描述接口参数本文档的程序或内容受版权法的保护, 未经移动云的书面许可, 不得擅自泄漏拷贝或复制本文档资料的全部或部分第 III 页

3 2.5.3 使用示例... 17

4 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 是 API 版本号, 为日期形式 :YYYY-MM-DD, 本版本对应为 AccessKey 是移动云颁发给用户的密钥对应的 keyid( 公钥 ) Timestamp 是请求的时间戳日期格式按照 ISO8601 标准表示, 并需要使用 UTC 时间格式为 : YYYY-MM-DDThh:mm:ssZ 例如, T12:00:00Z( 为北京时间 2016 年 12 月 5 日 12 点 0 分 0 秒 ) 时间戳有效时间为 5 分钟 Signature 是经由密钥加密生成的签名结果串, 关于签名的计算方法, 请参见 < 签名机制 > SignatureMethod 是签名方式, 目前支持 HMAC-SHA1 SignatureVersion 是签名算法版本, 目前版本是 V2.0 SignatureNonce 是用户发送请求的唯一随机数, 防止重放攻击用户在不同请求间要使用不同的随机数值公共请求参数示例如下 :

5 &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 ) 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 的格式 ;

6 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= 将上一步构造的规范化字符串按照下面的规则构造成待签名的字符串 : ToSign = HTTPMethod + \n percentencode(servletpath)+ \n shaencode( CanonicalizedQuery) a) 其中 HTTPMethod 是提交请求用的 HTTP 方法, 比如 GET b) percentencode( / ) 是按照 1.b 中描述的 URL 编码规则对字符 / 进行编码得到的值, 即 %2F c) shaencode 是指对上一步获得的字符串进行摘要加密, 加密算法为 SHA-256 d) 将这 3 个字符串相连, 得到待签名字符串 : GET %2Fapi%2Fkeypair 25fb697a06bc8a16a0a f5cba35aded3818e15f088e4e17cd394aa07af 3. 使用密钥加密得到最终签名 a) 按照 RFC2104 的定义, 计算待签名字符串 ToSign 的 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

7 2. 性能型云硬盘 2.1 硬盘列表接口描述本接口用于查看所有创建硬盘的列表使用限制 : URL 路径 :/api/pbs HTTP 方法 :GET 接口参数请求参数 : 元素名称是否必须类型描述 page 否 Integer 分页起始页 0 开始 size 否 Integer 分页大小, 默认为 10 硬盘名称,, 为 5~22 的中 name 否文英文数字下划线的组合, 模糊查询 serverid 否虚机 id unbind 否 Boolean true 查询还未绑定虚机的硬盘, 否则查询所有返回参数 : 元素名称类型描述 id 硬盘 id name 硬盘名称, 为 5~22 的中文英文数字下划线的组合 description 硬盘描述硬盘状态 : 0(AVAILABLE),1(ATTACHING),2(BACKIN G_UP),3(CREATING),4(DELETING),5(DO WNLOADING),6(UPLOADING),7(ERROR),8 status (ERROR_DELETING),9(ERROR_RESTORING ),10(IN_USE),11(RESTORING),12(REST ORING_BACKUP),13(UNRECOGNIZED),14( DELETED).15(DETACHING),16(BEFORE_A TTACH) sourcevolumeid 以卷为源创建卷时的源卷 ID( 克隆 )

8 availabilityzone 卷所属区域 backupid 以快照为源创建卷时的快照 ID 硬盘大小, 最大为 1T, 请根据自己的实 size Integer 际情况选择更适合的容量, 单位默认为 GB volumetype 硬盘类型,fujitsu-ipsan( 性能型 ) metadata 元数据, 集群 id serverid 虚机 id createdtime Date 创建时间, 创建成功时的当前时间 modifiedtime Date 修改时间, 修改成功时的当前时间 attachmentid 挂载 ID servername 虚机名称 isfrozen Integer 是否冻结,0 未冻结,1 已冻结 total Integer 总数 requestid 请求序列号使用示例请求样例 : &Timestamp= T15:57:11Z&Signature=0c89311af0e24e3dffc0b0b44f34ae58c0b17956 &SignatureMethod=HmacSHA1&SignatureVersion=V2.0&SignatureNonce= 返回 : { "body": { "content": [ { "id": "0d23ccde-1ead ae8-78f6e8929b8d", "name": "BS543074", "description": null, "status": 0, "sourcevolumeid": null, "availabilityzone": "nova", "backupid": null, "size": 1024, "volumetype": "fujitsu-ipsan ", "metadata": null, "serverid": "", "createdtime": " :06:21", "modifiedtime": " :28:13", "attachmentid": null,

9 , "servername": null, "isfrozen": 0, ], {, { "id": "e587fa71-a7c1-414e-834d-ffec ", "name": "BS620238", "description": null, "status": 10, "sourcevolumeid": null, "availabilityzone": "nova", "backupid": null, "size": 500, "volumetype": "fujitsu-ipsan ", "metadata": null, "serverid": "3169f a086-91ffc7634d5a", "createdtime": " :13:06", "modifiedtime": " :57:24", "attachmentid": null, "servername": "glltest", "isfrozen": 0 "id": "74a6baa1-bb70-459f a67be5a3d9", "name": "BS257572", "description": null, "status": 0, "sourcevolumeid": null, "availabilityzone": "nova", "backupid": null, "size": 4096, "volumetype": "fujitsu-ipsan ", "metadata": null, "serverid": null, "createdtime": " :31:07", "modifiedtime": null, "attachmentid": null, "servername": null, "isfrozen": 0 "total": 36 "requestid": " bc5bb4e26816ae982b00c8793"

10 2.2 硬盘详情接口描述本接口用于查看硬盘的详细信息使用限制 : URL 路径 :/api/pbs/{volumeid HTTP 方法 :GET 接口参数请求参数 : 元素名称是否必须类型描述 volumeid 是 string 硬盘 id 返回参数 : 元素名称类型描述 id 硬盘 id name 硬盘名称, 为 5~22 的中文英文数字下划线的组合 description 硬盘描述硬盘状态 : 0(AVAILABLE),1(ATTACHING),2(BACKIN G_UP),3(CREATING),4(DELETING),5(DO WNLOADING),6(UPLOADING),7(ERROR),8 status (ERROR_DELETING),9(ERROR_RESTORING ),10(IN_USE),11(RESTORING),12(REST ORING_BACKUP),13(UNRECOGNIZED),14( DELETED).15(DETACHING),16(BEFORE_A TTACH) sourcevolumeid 以卷为源创建卷时的源卷 ID( 克隆 ) availabilityzone 卷所属区域 backupid 以快照为源创建卷时的快照 ID 硬盘大小, 最大为 1T, 请根据自己的实 size Integer 际情况选择更适合的容量, 单位默认为 GB volumetype 硬盘类型,fujitsu-ipsan( 性能型 ) metadata 元数据, 集群 id serverid 虚机 id

11 createdtime Date 创建时间, 创建成功时的当前时间 modifiedtime Date 修改时间, 修改成功时的当前时间 attachmentid 挂载 ID, servername 虚机名称 isfrozen Integer 是否冻结,0 未冻结,1 已冻结 requestid 请求序列号使用示例请求样例 : 9fd ae3b62c253dfa9b9479&Timestamp= T16:26:11Z&Signature=1034e5a4 4ccabc8b28a9f1232e89bdb62ed8f27d&SignatureMethod=HmacSHA1&SignatureVersion=V2.0&S ignaturenonce= 返回 : { "body": { "id": "7cc33542-fce0-498a-9cfd-84ac8096cfde", "name": "BS764942", "description": null, "status": 0, "sourcevolumeid": null, "availabilityzone": "nova", "backupid": null, "size": 500, "volumetype": " fujitsu-ipsan ", "metadata": null, "serverid": "", "createdtime": " :49:39", "modifiedtime": " :58:15", "attachmentid": null, "servername": null, "isfrozen": 0, "requestid": "3bff8939a ac6053cf319df2da"

12 2.3 云硬盘更新接口描述本接口用于更新云硬盘使用限制 : URL 路径 :/api/pbs HTTP 方法 :PUT 接口参数请求参数 : 元素名称是否必须类型描述 id 是 string 硬盘 id 硬盘名称, 为 5~22 的中 name 是文英文数字下划线的组合返回参数 : 元素名称类型描述 id 硬盘 id name 硬盘名称, 为 5~22 的中文英文数字下划线的组合 description 硬盘描述硬盘状态 : 0(AVAILABLE),1(ATTACHING),2(BACKIN G_UP),3(CREATING),4(DELETING),5(DO WNLOADING),6(UPLOADING),7(ERROR),8 status (ERROR_DELETING),9(ERROR_RESTORING ),10(IN_USE),11(RESTORING),12(REST ORING_BACKUP),13(UNRECOGNIZED),14( DELETED).15(DETACHING),16(BEFORE_A TTACH) sourcevolumeid 以卷为源创建卷时的源卷 ID( 克隆 ) availabilityzone 卷所属区域 backupid 以快照为源创建卷时的快照 ID 硬盘大小, 最大为 1T, 请根据自己的实 size Integer 际情况选择更适合的容量, 单位默认为 GB volumetype 硬盘类型,fujitsu-ipsan( 性能型 ) metadata 元数据, 集群 id

13 serverid 虚机 id createdtime Date 创建时间, 创建成功时的当前时间 modifiedtime Date 修改时间, 修改成功时的当前时间 attachmentid 挂载 ID servername 虚机名称 isfrozen Integer 是否冻结,0 未冻结,1 已冻结 requestid 请求序列号使用示例请求样例 : &Timestamp= T16:26:11Z&Signature=1034e5a44ccabc8b28a9f1232e89bdb62ed8f27 d&signaturemethod=hmacsha1&signatureversion=v2.0&signaturenonce= 请求体 : {"id":"7cc33542-fce0-498a-9cfd-84ac8096cfde ", "name":" BS764942" 返回 : { "body": { "id": "7cc33542-fce0-498a-9cfd-84ac8096cfde", "name": "BS764942", "description": null, "status": 0, "sourcevolumeid": null, "availabilityzone": "nova", "backupid": null, "size": 500, "volumetype": " fujitsu-ipsan ", "metadata": null, "serverid": "", "createdtime": " :49:39", "modifiedtime": " :58:15", "attachmentid": null, "servername": null, "isfrozen": 0, "requestid": "3bff8939a ac6053cf319df2da"

14 2.4 创建云硬盘接口描述本接口用于创建云硬盘 1) 本接口仅用于创建一块性能型云硬盘, 如果希望将它挂载到同一资源池内的云主机实例需要单独调用挂载云硬盘接口, 请参见计算部分接口 URL 路径 :/api /order/volume HTTP 方法 :POST 接口参数请求参数 : 元素名称是否必须类型 disk 是 Integer 描述硬盘大小, 最大为 1T, 请根据自己的实际情况选择更适合的容量, 单位默认为 GB volumetype 是硬盘类型,ebs( 性能型 ) 资源池 ID, 创建硬盘时选择的资源所对应的唯一 poolid 是的 ID, CIDC-RP-02 华南节点 2,CIDC-RP-03 华北节点 1 month 或者 hour, 请根据 paytype 是实际情况选择适合的计费方式返回参数 : 元素名称类型描述 state 操作状态, OK( 成功 ), ERROR ( 错误 ),EXCEPTION( 异常 ),FORBIDDEN( 禁止 ) errorcode 错误编码 body 订单 id, 用户创建硬盘生成订单时所对应的唯一 ID 标识

15 2.4.3 使用示例请求样例 : &Timestamp= T22:34:11Z&Signature=6e683855cc0abd92ad9d7869bff81447e3c3cafa &SignatureMethod=HmacSHA1&SignatureVersion=V2.0&SignatureNonce=206 请求体 : {"disk":"500", "volumetype":"ebs", "poolid":"cidc-rp-02", "paytype":"hour" 返回 : {"requestid": "238df5b531b94e6a88f06e021a3422a9", "state":"ok", "body":"cidc-o-80ef5c71e8534a d8ecfb6b83" 2.5 删除云硬盘接口描述本接口用于删除云硬盘 1) 订单创建后 30 分钟, 才可以调用本接口删除云硬盘 URL 路径 :/api/order/order/{extid HTTP 方法 :DELETE 接口参数请求参数 : 是否元素名称类型必须 extid 是描述订单项 id, 用户创建硬盘生成订单时所对应的唯一 ID 标识返回参数 : 元素名称类型描述

16 state 操作状态, OK( 成功 ), ERROR ( 错误 ),EXCEPTION( 异常 ),FORBIDDEN( 禁止 ) errorcode 错误编码 body 返回体使用示例请求样例 : 9d81ffbeaaf db5df577bb3299&Timestamp= T17:40:34Z&Version= &Signature=496c9b784d220ca13ecc39864abaffef9da632ff&SignatureMethod=HmacSHA1&Signa turenonce=35com587eb94691cf1&signatureversion=v2.0 返回 : {"state":"ok", " requestid ":"345df5b531b94e6a88f06e021a3422a9" 或者 URL 路径 :/api/order/resource/{resourceid HTTP 方法 :DELETE 请求参数 : 元素名称是否必须类型 resourceid 是描述资源 id, 创建硬盘时选择的资源所对应的唯一的 ID 返回参数 : 元素名称类型描述操作状态, OK( 成功 ), ERROR ( 错 state 误 ),EXCEPTION( 异常 ),FORBIDDEN( 禁止 ) errorcode 错误编码 body 返回体请求样例 : = &Signature=496c9b784d220ca13ecc39864abaffef9da632ff&SignatureMethod=Hma

17 csha1&signaturenonce=35com587eb94691cf1&signatureversion=v2.0 返回 : {"state":"ok", " requestid ":"378df5b531b94e6a88f06r567a3422a9"

目录移动云 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 购买云主机备份服务...

目录 移动云 1. API 访问 调用方法方法 公共参数 公共请求参数 公共返回参数 签名机制 性能型云硬盘 硬盘列表 接口描述

目录移动云 1. API 访问调用方法方法公共参数公共请求参数公共返回参数签名机制性能型云硬盘硬盘列表接口描述