1. 请求需要token验证,通过用户名和密码获取token后,在请求header中加上token和对应的值,如:{token:”8rl8iSwhP7wC/7uqDTD1kR/i12LNl/Uc4DfWeRmSjXSFbGCawOMqlw==”};
2. 当执行操作动作的时候,会返回task_id参数,该参数用于查询任务执行的中间状态;
3. 该文档至在版本v1.4时候可用
4. 公共返回参数:code/message,分别用于表示调用该API执行的状态,以及对该状态的描述
错误信息 |
使用HTTP CODE表示 |
|
http code |
描述 |
|
200 |
请求成功 |
|
404 |
Not Found |
|
405 |
请求方法错误 |
|
400 |
参数类型错误 |
|
500 |
程序内部错误 |
选项 | 描述 | |||||
功能说明 | 获取token | |||||
调用说明 | 名称 | 描述 | ||||
请求方式 | GET | |||||
请求类型 | HEADER_PARAM | |||||
请求路径 | http://api2.capitalonline.net/gic/v1/get_token/ | |||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||
username | True | String | 用户名 | |||
password | True | String | 密码 | |||
参数可选 | 无 | |||||
返回结果 | 说明 | 返回格式为json | ||||
返回参数 | 名称 | 类型 | 描述 | |||
Access-Token | string | 验证后得到的token | ||||
status | string | 验证用户名密码请求的状态 | ||||
返回示例 |
{ "status": "success", "Access-Token":"UIxWcrSg1v35AukDS2rRj94Q6S+XDiN2jLQHeMSpy4bdDY71lg3isg==" } |
选项 | 描述 | |||||||||
功能说明 | 对云主机执行开机、关机、重启和远程桌面(仅限windows)操作。 | |||||||||
调用说明 | 名称 | 描述 | ||||||||
请求方式 | POST | |||||||||
请求类型 | JSON | |||||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/action/ | |||||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||||
vm_id | True | String | 云主机的uuid | |||||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||||
action_type | True | String | [“POWERON”, ”POWEROFF”, “RESET”, ”RDPON”, “RDPOFF”] | |||||||
参数可选 | username | False | String | vm管理员权限用户名--(rdp操作必选) | ||||||
password | False | String | vm管理员权限的密码--(rdp操作必选) | |||||||
返回结果 | 说明 | 返回格式为json | ||||||||
返回参数 | 名称 | 类型 | 描述 | |||||||
vm_id | string | 请求操作的vm_id | ||||||||
status | string | 动作执行状态:[success, fail] | ||||||||
task_id | string | 任务的ID | ||||||||
code | string | 执行代码 | ||||||||
message | string | 执行信息 | ||||||||
返回示例 |
{ "status": "success", "message": "OperationSuccess", "code": 200, "vm_id": "fd28ee21-aeb4-44bd-b9c0-1c35a2975fc5", "task_id": "0513ebcf-5a85-11e5-bfea-e4f89c7eec2f" } |
|||||||||
错误信息 |
错误码定义:vm.InvalidOperation vm表示资源的名称 invalid_operation表示具体的详细错误信息 vm status is poweroff表示具体的提示信息 |
|||||||||
Error Code | Message | 描述 | ||||||||
vm. invalid_operation | vm status is [poweroff|poweron|staring|stopping|updating] | 云主机状态与当前操作冲突 | ||||||||
task is running in the queue, please wait task end | 云主机操作正在队列中 | |||||||||
vm status is creating | 云主机正在创建 | |||||||||
vm.operation_denied | permission denied | 权限被拒绝 | ||||||||
站点割接 | ||||||||||
资源互斥,等待资源执行任务完成后再做操作 | ||||||||||
rdp action only access windows os type | rdp操作只能是windows主机 | |||||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||||
parameter error, please check your parameter vm_id | vm_id不正确 | |||||||||
please check your parameter action_type | action_type参数错误 | |||||||||
please check parameter username or password | rdp操作必须要用户名密码 | |||||||||
vm.no_money | accounts less than the amount | 账户欠费 | ||||||||
invalid_operation | (异常信息) | 异常抛出 |
选项 | 描述 | |||||||
功能说明 | 删除云主机 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | DELETE | |||||||
请求类型 | ||||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/{vm_id} | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
{vm_id} | True | String | 云主机的uuid | |||||
参数可选 | 无 | |||||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
status | string | 执行的结果:[success, fail] | ||||||
task_id | string | 任务的ID | ||||||
code | string | 代码 | ||||||
message | string | 错误信息 | ||||||
返回示例 |
{ "status": "success", "message": "OperationSuccess", "code": 200, "vm_id": "fd28ee21-aeb4-44bd-b9c0-1c35a2975fc5", "task_id": "051334" } |
|||||||
错误信息 | 错误码定义: | |||||||
Error Code | message | 描述 | ||||||
vm. invalid_operation | task is running in the queue, please wait task end | 任务正在队列中 | ||||||
vm status is [deleting|starting|updadting] | 任务正在执行或处于某个状态,与当前操作冲突 | |||||||
vm.operation_denied | Permission Denied | 权限错误 | ||||||
invalid_operation | (异常错误) | 异常信息 |
选项 | 描述 | ||||||
功能说明 | 列出云主机 | ||||||
调用说明 | 名称 | 描述 | |||||
请求方式 | GET | ||||||
请求类型 | Parameter | ||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/list/ | ||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | |||
无 | |||||||
参数可选 | page | false | Int | 页码,不填默认第一页 | |||
app_id | false | String | 虚拟数据中心的uuid | ||||
返回结果 |
说明 | 返回格式为json | |||||
返回参数 | 名称 | 类型 | 描述 | ||||
code | string | 执行代码 | |||||
page | int | 当前页数 | |||||
page_count | Int | 总页数 | |||||
message | string | 错误信息 | |||||
data: | array | [{vm_id:””} ,{ vm_id:””}] | |||||
返回示例 |
{ "status": "success", "code": 200, "page_count": 1, "message": "get list success", "data": [ { "vm_name": "JPVM002",(云主机名称) "status": "running", (云主机状态) "disk_size": 60,(系统硬盘空间/GB) "ram": 1,(内存大小/GB) "app_id": "15cb5b6a-db20-42f5-a987-f589e98cb6a3",(虚拟中心uuid) "net": [ (网卡相关信息) { "pipe_type": "private",(网络类型:私网) "nc_mac": "00:50:56:9c:32:82",(网卡mac地址) "mask": 26,(掩码) "vm_id": "6dc686c1-7be4-4c75-bb93-f285cdf1fbb0",(云主机uuid) "nc_status": "ok",(网卡状态) "pipe_status": "ok",(网络状态) "nc_id": "2a934fe8-10a9-4a36-a173-77c5c0b6e8f2",(网卡uuid) "ip": "192.168.1.3",(ip地址) "ip_id": 19985783,(ip的id) "ip_type": "ip",(ip的类型) "nc_connect": 1,(网卡的连接状态:已连接) "vlan_id": 3059,(vlan的id) "ip_status": 1(ip的状态:可用) }, { "pipe_type": "public",(网络类型:公网) "nc_mac": "00:50:56:9c:64:55",(网卡mac地址) "mask": 29, (掩码) "vm_id": "6dc686c1-7be4-4c75-bb93-f285cdf1fbb0",(云主机uuid) "nc_status": "ok",(网卡状态) "pipe_status": "ok",(网络状态) "nc_id": "3b7d0752-4cf8-493f-a8fe-c7cd1d69c0b6",(网卡uuid) "ip": "118.193.84.107",(ip地址) "ip_id": 19985743, (ip的id) "ip_type": "ip",(ip的类型) "nc_connect": 1, (网卡的连接状态:已连接) "vlan_id": 2566, (vlan的id) "ip_status": 1(ip的状态:可用) }, { "pipe_type": "gic",(网络类型:公网) "nc_mac": "00:50:56:9c:3f:1b",(网卡mac地址) "mask": null, (掩码) "vm_id": "6dc686c1-7be4-4c75-bb93-f285cdf1fbb0",(云主机uuid) "nc_status": "ok",(网卡状态) "pipe_status": "ok",(网络状态) "nc_id": "f07d03d7-f080-4a37-a37e-0937917bfae8",(网卡uuid) "ip": null, (ip地址) "ip_id": null, (ip的id) "ip_type": null, (ip的类型) "nc_connect": 0, (网卡的连接状态:未连接) "vlan_id": 3055, (vlan的id) "ip_status": null(ip的状态:无) } ], "disks": [ { "iops_num": 2,(iops包数量) "disk_type": "high_disk",(硬盘累心) "disk_size": 100,(硬盘大小) "disk_id": "fa3c2952-5b22-11e7-9fd9-0242ac1106da"(硬盘uuid) } ] "vm_id": "6dc686c1-7be4-4c75-bb93-f285cdf1fbb0",(云主机uuid) "cpu": 1(cpu个数) } ], "page": 1(当前页数) } |
||||||
错误信息 | 错误码定义: | ||||||
Error code | Message | 描述 | |||||
vm.operation_denied | the 'page' can't be grant than total pages | 当前页不能大于总页数 | |||||
permission denied | 权限拒绝 | ||||||
invalid_operation | (异常信息) | 错误异常信息 |
选项 | 描述 | ||||||
功能说明 | 创建vm | ||||||
调用说明 | 名称 | 描述 | |||||
请求方式 | POST | ||||||
请求类型 | JSON | ||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/create/ | ||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | |||
vm_name | True | String | 云主机名称 | ||||
password | True | String | 云主机的管理员密码 | ||||
os_id | True | String | 云主机操作系统id,接口查询 | ||||
vm_count | True | Int | 云主机数量 | ||||
app_id | True | String | 云主机所属虚拟中心uuid | ||||
cpu | True | Int | cpu数量,单位(个)只可选[1,2,4,8,10,16,32] | ||||
ram | True | Int | 内存数量,单位(GB)只可选[1, 2, 4, 8, 12, 16, 24, 32, 48, 64, 96, 128] | ||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | ||||
disk_list | False | Array |
扩展盘列表 [ {“1”:”100|ssd_disk|5”}, {“2”: “200|high_disk”}, {“3”: “200|big_disk”} ] key表示磁盘序号(只是增加序号),value表示磁盘容量(100的倍数)|磁盘类型id|iops包大小,磁盘单位GB,单盘最大2TB,累计最多8块扩展盘;磁盘类型为空时,默认高性能磁盘 |
||||
参数可选 | goods_id | False | Int | 云主机商品id,传空默认创建性能型云主机 | |||
bill_type_id | False | String | 云主机计费类型,传空默认为按需计费,传month为包年包月计费 | ||||
bill_duration | False | Int | 云主机为包月计费时,购买月份数,只可选[1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36],默认为1,如果bill_type_id为空或minute,该参数无效 | ||||
is_auto_renewal | False | Int | 云主机为包月计费时,是否自动续约,只可选[0(续约关闭), 1(续约开启)],默认为1;如果bill_type_id为空或minute,该参数无效 | ||||
is_to_month | False | Int | 云主机为包月计费时,是否购买到月底,只可选[0(整月), 1(购买到月底)],默认为0,如果为1,计费周期首先购买到月底,再加购买的月份数;如果bill_type_id为空或minute,该参数无效 | ||||
wan | False | Dict | {“pipe_id”: “6a3ce526-287f-11e6-b7c1-0050569b4d9c”, “ip”:[“101.251.10.2”, “101.251.10.3”, “101.253.101.2”]} # 如果不建公网则传空数组,地址必须为该虚拟数据中心下购买的ip地址, 在app属性接口取出pipe_id | ||||
lan1 | False | Dict | {“pipe_id”: “6a3ce526-287f-11e6-b7c1-0050569b4d9c”, “ip”: [“10.0.0.2”, “10.0.0.3”, “10.0.0.4”]} # 如果不建私网则传空数组, 地址必须为该虚拟数据中心下购买的私网ip地址, 在app属性接口取出pipe_id | ||||
lan2 | False | Dict | {“pipe_id”: “6a3ce526-287f-11e6-b7c1-0050569b4d9c”, “ip”: [“172.16.0.2”, “172.16.0.3”, “172.16.0.4”] }# 如果不建私网则传空数组, 地址必须为该虚拟数据中心下购买的私网ip地址, 如果虚拟数据中心只有一个私网,则无法指定该参数,请指定lan1, 在app属性接口取出pipe_id | ||||
lan | False | List |
[{“pipe_id”: “6a3ce526-287f-11e6-b7c1-0050569b4d9c”, “ip”: [“10.0.0.2”, “10.0.0.3”, “10.0.0.4”]}] #如果当前数组有私网参数,则默认取当前数组中的私网参数,否则取lan1、lan2中的私网参数 |
||||
gpn | False | Array |
[ {“ip”: ”192.168.0.2”, “mask”: 24}, {“ip”: “192.168.0.3”, “mask”: 24}, {“ip”: ”192.168.0.4”, “mask”: 24} ] # 如果设置ip为空传空数组,如果无gpn,该配置无效 |
||||
dedicated_id | False | string | 专属云id | ||||
返回结果 | 说明 | 返回格式为json | |||||
返回参数 | 名称 | 类型 | 描述 | ||||
app_id | String | 虚拟数据中心的uuid | |||||
vm_count | Int | 虚拟机数量 | |||||
vm_name | String | 虚拟机名称 | |||||
os_id | String | 操作系统模版id | |||||
cpu | Int | cpu数量 | |||||
ram | Int | ram数量 | |||||
task_id | string | 任务的ID | |||||
code | string | 执行代码 | |||||
message | string | 错误信息 | |||||
code_msg | string | [success(成功) , false(失败)] | |||||
返回示例 |
{ "status": "success", "code": 200, "task_id": "76763", "app_id": "a15b681e-278f-43de-938f-8656c7c1b67b", “vm_count”:2, “vm_name”:”BeijingServer”, “os_id”: a15b681e-278f-43de-938f-8656c7cc17ac, “cpu”:2, “ram”:2, "message": "operation success" } |
||||||
错误信息 | 错误码定义: | ||||||
Error code | Message | 描述 | |||||
vm.no_money | accounts less than the amount | 账户欠费 | |||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 订单受限,等待审核 | |||||
vm.purchase_error | purchase error, please contact customer service | 计费出错 | |||||
vm.operation_error | permission denied | 权限错误 | |||||
vm.wan_incomplete | vm.wan_incomplete | 没有公网 | |||||
vm.parameter_error | parameter incomplete,please check your parameter:'cpu' or 'ram' | cpu/ram个数不对 | |||||
the count of extend disk must be less than 8, please check your parameter | 扩展盘个数大于8个 | ||||||
password does not meet the conditions | 密码不符合条件(最少6位最多20位,包含大小写数字特殊符号的三种组合) | ||||||
vm_name is not allow only contain numbers" | 主机名不允许为纯数字 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配(1c/8r不允许等) | ||||||
disk size is only allow step 100 and a sigle disk max size is 2000 | 硬盘大小只能是100的倍数,且单盘不允许超过2T | ||||||
vm_name is not allow repeat | 主机名已存在,不允许重复 | ||||||
parameter incomplete, please check your parameter | 参数不全 | ||||||
vm.operation_denied | "permission denied" | 权限拒绝 | |||||
invalid_operation | exception | 异常 | |||||
405 | Request Method Error | 请求方法错误 |
选项 | 描述 | |||||||
功能说明 | 更新云主机cpu/ram | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/update/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | Ture | String | 云主机的uuid | |||||
cpu | True | Int | cpu个数,不更新-不变 | |||||
ram | True | Int | 内存大小,单位GB,不更新-不变 | |||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||
disk_dict | True | Dict |
磁盘列表,只支持旧版云主机增加硬盘,扩展硬盘总数不能超过8块,原有硬盘大小不能修改,不能删除,不增加-空字典 { “1” : “100”, “2” : “500” } |
|||||
参数可选 | discount_code | False | String | 折扣码 | ||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
vm_id | String | 虚拟机id | ||||||
cpu | Int | cpu个数 | ||||||
ram | Int | ram个数 | ||||||
disk | String | disk列表 | ||||||
task_id | string | 任务的ID | ||||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 | ||||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配 | |||||||
vm.charge_error | charging error when update vm, please connect services | 计费出错 | ||||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 购买受限 等待审核 | ||||||
vm.permission_denied | permission denied | 权限拒绝 | ||||||
task is running in the queue, please wait task end | 资源互斥,等待任务完成 | |||||||
vm. operation_denied | 账户审核错误 | |||||||
站点割接 | ||||||||
invalid_operation | exception | 异常 |
选项 | 描述 | |||||||
功能说明 | 增加硬盘 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/add_disk/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | Ture | String | 云主机的uuid | |||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||
disk_dict | True | Dict |
磁盘列表,只支持增加硬盘,扩展硬盘总数不能超过8块 { “1” : “100|ssd_disk|2”, “2” : “500|high_disk” } |
|||||
参数可选 | discount_code | False | String | 折扣码 | ||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
vm_id | String | 虚拟机id | ||||||
cpu | Int | cpu个数 | ||||||
ram | Int | ram个数 | ||||||
disk | String | disk列表 | ||||||
task_id | string | 任务的ID | ||||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 | ||||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配 | |||||||
vm.charge_error | charging error when update vm, please connect services | 计费出错 | ||||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 购买受限 等待审核 | ||||||
vm.permission_denied | permission denied | 权限拒绝 | ||||||
task is running in the queue, please wait task end | 资源互斥,等待任务完成 | |||||||
vm. operation_denied | 账户审核错误 | |||||||
站点割接 | ||||||||
invalid_operation | exception | 异常 |
选项 | 描述 | |||||||
功能说明 | 硬盘扩容,只支持新版本的云主机 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/expand_disk/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | Ture | String | 云主机的uuid | |||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||
disk_id | True | String | 磁盘id | |||||
size | True | Int | 磁盘扩容后的大小 | |||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
vm_id | String | 虚拟机id | ||||||
cpu | Int | cpu个数 | ||||||
ram | Int | ram个数 | ||||||
disk | String | disk列表 | ||||||
task_id | string | 任务的ID | ||||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 | ||||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配 | |||||||
vm.charge_error | charging error when update vm, please connect services | 计费出错 | ||||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 购买受限 等待审核 | ||||||
vm.permission_denied | permission denied | 权限拒绝 | ||||||
task is running in the queue, please wait task end | 资源互斥,等待任务完成 | |||||||
vm. operation_denied | 账户审核错误 | |||||||
站点割接 | ||||||||
invalid_operation | exception | 异常 |
选项 | 描述 | |||||||
功能说明 | 删除硬盘,只支持新版本的云主机 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/del_disk/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | Ture | String | 云主机的uuid | |||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||
disk_id | True | String | 磁盘id | |||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
vm_id | String | 虚拟机id | ||||||
cpu | Int | cpu个数 | ||||||
ram | Int | ram个数 | ||||||
disk | String | disk列表 | ||||||
task_id | string | 任务的ID | ||||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 | ||||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配 | |||||||
vm.charge_error | charging error when update vm, please connect services | 计费出错 | ||||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 购买受限 等待审核 | ||||||
vm.permission_denied | permission denied | 权限拒绝 | ||||||
task is running in the queue, please wait task end | 资源互斥,等待任务完成 | |||||||
vm. operation_denied | 账户审核错误 | |||||||
站点割接 | ||||||||
invalid_operation | exception | 异常 |
选项 | 描述 | |||||||
功能说明 | 重装系统 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/resetos/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | Ture | String | 云主机的uuid | |||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||
os_id | True | String | 操作系统id | |||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 | ||||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配 | |||||||
vm.charge_error | charging error when update vm, please connect services | 计费出错 | ||||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 购买受限 等待审核 | ||||||
vm.permission_denied | permission denied | 权限拒绝 | ||||||
task is running in the queue, please wait task end | 资源互斥,等待任务完成 | |||||||
vm. operation_denied | 账户审核错误 | |||||||
站点割接 | ||||||||
invalid_operation | exception | 异常 |
选项 | 描述 | |||||||
功能说明 | 变更计费方式,只支持新的云主机 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/vm/update_bill/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | Ture | String | 云主机的uuid | |||||
area_id | True | String | 销售区域,人民币账户”CN”,美元账户”US” | |||||
bill_type_id | True | String | 计费方式id,可选[minute(按需计费), month(包月计费)] | |||||
参数可选 | bill_duration | False | Int | 云主机为包月计费时,购买月份数,只可选[1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36],默认为1,如果bill_type_id为空或minute,该参数无效 | ||||
is_auto_renewal | False | Int | 云主机为包月计费时,是否自动续约,只可选[0(续约关闭), 1(续约开启)],默认为1;如果bill_type_id为空或minute,该参数无效 | |||||
is_to_month | False | Int | 云主机为包月计费时,是否购买到月底,只可选[0(整月), 1(购买到月底)],默认为0,如果为1,计费周期首先购买到月底,再加购买的月份数;如果bill_type_id为空或minute,该参数无效 | |||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 | ||||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
vm.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
not allow cpu_number and ram_number | cpu和内存数量不匹配 | |||||||
vm.charge_error | charging error when update vm, please connect services | 计费出错 | ||||||
vm.purchase_exceeds_limit | order generation is successful, but the number of goods exceeds the limit, you need to wait for administrator review, task waiting to be executed | 购买受限 等待审核 | ||||||
vm.permission_denied | permission denied | 权限拒绝 | ||||||
task is running in the queue, please wait task end | 资源互斥,等待任务完成 | |||||||
vm. operation_denied | 账户审核错误 | |||||||
站点割接 | ||||||||
invalid_operation | exception | 异常 |
选项 | 描述 | |||||||
功能说明 | 对云主机的各类型网卡执行开、关操作 | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | JSON | |||||||
请求路径 | http://api2.capitalonline.net/gic/v1/nic/action/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
action_type | True | String | [“NICON”, ”NICOFF”]动作 | |||||
nic_id | True | String | 网卡uuid | |||||
参数可选 | 无 | |||||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
task_id | string | 任务的ID | ||||||
code | string | 返回代码 | ||||||
message | string | 错误信息 | ||||||
status | string | 执行的状态:[success, fail] | ||||||
返回示例 |
{ "status": "success", "message": "operation success", "code": 200, "nic_id": "af8b3f0c-a55f-4e09-8df9-25d73efadae8", "task_id": "7f3254cf-5aba-11e5-a4be-e4f89c7eec2f" } |
|||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
nic.operation_denied | permission denied | 权限拒绝 | ||||||
invalid nic_id | 无效nic_id | |||||||
nic.invalid_operation | task is running in the queue, please wait task end | 等待任务执行结束 | ||||||
nic status Is [error/processing] and nic connect is [on/off] | 操作冲突 | |||||||
please check your paramete | 参数错误 | |||||||
invalid_operation | (错误异常信息) | 错误异常提示信息 |
选项 | 描述 | |||||||
功能说明 | 绑定(解绑)IP | |||||||
调用说明 | 名称 | 描述 | ||||||
请求方式 | POST | |||||||
请求类型 | ||||||||
请求路径 | http://api2.capitalonline.net/gic/v1/ vm/update_ip/ | |||||||
参数必选 | 名称 | 要求 | 类型 | 描述 | ||||
vm_id | True | String | 云主机的uuid | |||||
vm_cards | True | List | 云主机网卡信息 | |||||
card_id | True | String | 网卡id | |||||
address | True | String | 要绑定的ipv4地址 | |||||
参数可选 | ipv6_bind | False | Int | IPv6标志(默认0) | ||||
返回结果 | 说明 | 返回格式为json | ||||||
返回参数 | 名称 | 类型 | 描述 | |||||
code_msg | string | success | ||||||
code | string | 执行代码 | ||||||
message | string | 错误信息 | ||||||
data | String | |||||||
status | string | [success(成功) , false(失败)] | ||||||
返回示例 |
{ "status": "success", "code_msg": "success", "message": "operation success”, "code": "0000", "data": {} } |
|||||||
错误信息 | 错误码定义: | |||||||
Error code | Message | 描述 | ||||||
image.operation_denied | permission denied | 权限拒绝 | ||||||
image.parameter_error | parameter incomplete, please check your parameter | 参数不全 | ||||||
invalid_operation | (错误异常信息) | 错误异常信息提示 | ||||||
image.invalid_operation | please check your parameter | 参数错误 |