首云,首都在线,全球一体化平台 首云,首都在线,全球一体化平台

公共信息定义

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

程序内部错误
 

1.获取token

选项 描述
功能说明 获取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=="
}
 

2.获取task执行状态

选项 描述
功能说明 获取任务状态
调用说明 名称 描述
请求方式 GET
请求类型 Parameter
请求路径 http://api2.capitalonline.net/gic/v1/task_status/
参数必选 名称 要求 类型 描述
task_id True String 任务的uuid
参数可选 无
返回结果 说明 返回格式为json
返回参数 名称 类型 描述
task_id String Task的uuid
message String 提示信息
remark String 任务失败提示信息
status String 任务执行的状态[NEW,DOING,FINISH,ERROR],分别对应新增，正在执行，完成，错误
返回示例 {
    "status": "FINISH",
"message": "Success",
"remark": ""
    "task_id": "0513ebcf-5a85-11e5-bfea-e4f89c7eec2f"
}
错误信息 错误码定义：
Error code Message 描述
fail permission denied 权限错误
 

3.查询os列表接口

选项 描述
功能说明 查询平台支持的os的id列表
调用说明 名称 描述
请求方式 GET
请求类型  
请求路径 http://api2.capitalonline.net/gic/v1/os/list/
参数必选 名称 要求 类型 描述
无      
参数可选 无
返回结果 说明 返回格式为json
返回参数 名称 类型 描述
data Array 查询数据
code String 查询状态码
message String 查询信息
status String 任务执行的状态[NEW,DOING,FINISH,ERROR],分别对应新增，正在执行，完成，错误
返回示例 {
    "status": "success",
    "message": "success",
"code": "os_list.operation_success,
"data":[
{
"id":"017288de-cf6a-43cd-b020-649078d654bb",
"name":"CDS-OS-Redhat6.2-64bit-General-V1"
},
{
"id":"067b97ab-0cd8-4bd6-b973-c988ad839649",
"name":"CDS-OS-Redhat5.9-64bit-General-V1"
},
 
]
"
}
错误信息 错误码定义：
Error code Message 描述
invalid_operation no os data 查询列表为空
 

4.查询数据中心及对应公网类型

选项 描述
功能说明 查询数据中心id及其所有的公网类型的id
调用说明 名称 描述
请求方式 GET
请求类型  
请求路径 http://api2.capitalonline.net/gic/v1/site/list/
参数必选 名称 要求 类型 描述
无      
参数可选 无
返回结果 说明 返回格式为json
返回参数 名称 类型 描述
data String 返回查询数据，没有为[]
code String 返回状态码
message String 消息
status String 任务执行的状态[NEW,DOING,FINISH,ERROR],分别对应新增，正在执行，完成，错误
返回示例 {
    "status": "success",
    "message": "success",
"code": "site_list.operation_success",
“data”:[
{
“id”:” 1af1d06e-e2ad-41e7-97b0-ed77417fd3d4”,
“name”:”德国1”,
“pipe_goods”:[{“id”:”249”, ”name”:”BGP”}]},
“vm_goods”: [{“id”: “101”, “name”: “高性能云主机”, “bill_type”: [{“id”: “minute”, “name”: “按需计费”]], “disk_type”: [{“id”: “high_disk”, “name”: “高性能硬盘”}]
{
“id”:” 31f105b5-389e-4989-9944-8ecf76e9d764”,
“name”:”东京1”,
“pipe_goods”:[{“id”:”51”, ”name”:”BGP”},
{“id”:”275”, ”name”:”五线BGP”}]},
“vm_goods”: [{“id”: “200”, “name”: “标准型云主机”, “bill_type”: [{“id”: “month”, “name”: “包月计费”]], “disk_type”: [{“id”: “high_disk”, “name”: “高性能硬盘”}]
]
}
错误信息 错误码定义：
Error code Message 描述
     
 
7x24服务热线
400-810-5300
关于
法律声明
生态合作
首云,首都在线,全球一体化平台 foot-微信 Created with Sketch. 关注首云
价格计算器
7*24小时服务热线
400-810-5300 咨询/购买/备案/建议&投诉
5*8小时售前服务热线
400-810-7006
扫描上方二维码
微信咨询