选项

描述

功能说明

获取可加入专属云私网信息

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/create/

参数必选

无

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

site_id

节点id

string

zone_name

地区名称

array

app_id

虚拟数据中心id

string

app_name

虚拟数据中心名称

string

private

私网信息

string

pipe_id

私网id

string

address

私网地址

string

返回示例

{

        "status":"success",

        "message":"success",

        "code":"200",

        "data":[

            {

                "site_id":"xxx",

                "zone_name":"中国大陆-北京-可用区A",

                "app_id":"xxx",

                "app_name":"xxx",

                "private":[

                    {

                        "pipe_id":"xxx",

                        "address":"xxx"

                    }

                ]

            }

        ]

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.no_money

accounts less than the amount

账户欠费

operation_denied

站点割接

gpn.purchase_error

purchase error,  please contact customer service

计费出错

invalid_operation

exception

异常

选项

描述

功能说明

获取专属云组信息

调用说明

名称

描述

请求方式

GET

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/bandwidth/gpn/{gpn_id}

参数必选

无

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

id

专属云组id

string

name

专属云组名称

string

返回示例

{

        "status": "success",

        "message": "success",

        "code": "200",

        "data": [

            {

                "id":"15cb5b6a-db20-42f5-a987-f589e98cb6a3",

                "name":"专属云组1"

            },

            {

                "id":"15cb5b6a-db20-42f5-a987-f589e98cb6a3",

                "name":"专属云组2"

            },

        ]

    }

错误信息

错误码定义：

Error code

Message

描述

invalid_operation

（异常错误信息）

异常提示

选项

描述

功能说明

获取专属云规格信息

调用说明

名称

描述

请求方式

GET

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/{gpn_id}

参数必选

名称

要求

类型

描述

site_id

True

String

节点id

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

id

规格id

string

cpu

cpu

smallint

ram

ram

smallint

qos

qos

smallint

返回示例

{

        "status": "success",

        "message": "success",

        "code": "200",

        "data": [

            {

                "id":"15cb5b6a-db20-42f5-a987-f589e98cb6a3",

                "cpu":"1",

                "ram":"2",

                "qos":"20"

            },

            {

                "id":"15cb5b6a-db20-42f5-a987-f589e98cb6a3",

                "cpu":"2",

                "ram":"4",

                "qos":"30"

            },

        ]

    }

错误信息

错误码定义：

Error code

Message code

描述

gpn.operation_denied

permission denied

权限拒绝

gpn.invalid_operation

task is running in the queue, please wait task end

有任务在执行，需要等待任务结束

invalid_operation

（异常错误信息）

异常错误信息提示

选项

描述

功能说明

专属云创建

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/update/

参数必选

名称

要求

类型

描述

app_id

True

string

虚拟中心id

dedicated_name

True

string

专属云名称

group_name

True

string

分组名称

spec_id

True

string

规格id(get_spec)

pipe_id

True

string

私网id(get_pipe)

名称

要求

类型

描述

参数可选

group_id

False

string

分组id(get_dedicated_group)

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

信息说明

string

code

执行代码

string

data

返回信息

array

res_op_id

任务id

string

返回示例

示例：

    {

        "status": "success",

        "message": "success",

        "code": "200",

        "data": {

            "res_op_id":"xxxxxx"

        }

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.no_money

accounts less than the amount

余额不足

gpn.operation_denied

站点割接

资源互斥

task is running in the queue, please wait task end

等待任务执行完毕

gpn.purchase error

please contact customer service

计费出错

invalid_operation

exception

异常

选项

描述

功能说明

查看专属云

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/app/add/

参数必选

无

名称

要求

类型

描述

参数可选

dedicated_id

False

string

专属云id

group_id

False

string

专属云组id

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

app_id

String

虚拟数据中心的uuid

gpn_id

String

云互联的uuid

task_id

string

任务的ID

code

string

执行代码

message

string

错误信息

status

string

[success(成功) , false(失败)]

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

id

专属云id

string

name

专属云名称

string

spec_id

规格id

string

pipe_id

私网id

string

pipe_name

私网名称

string

group_id

专属云组id

string

group_name

专属云组名称

string

app_id

虚拟数据中心id

string

返回示例

    示例：

    {

        "status": "success",

        "message": "success",

        "code": "200",

        "data": [

            {

                "id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "name":"专属云1",

                "spec_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "pipe_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "pipe_name":"私网1",

                "group_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "group_name":"专属云组1",

                "app_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "app_name":"虚拟数据中心1",

                "cpu":"20",

                "ram":"40",

                "qos":"200",

                "unused_cpu":"12",

                "unused_ram":"20"   

                },

            {

                "id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "name":"专属云2",

                "spec_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "pipe_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "pipe_name":"私网1",

                "group_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "group_name":"专属云组1",

                "app_id":"e8786eaa-04d8-11e8-a91d-0242ac1113b7",

                "app_name":"虚拟数据中心1",

                "cpu":"20",

                "ram":"40",

                "qos":"200",

                "unused_cpu":"12",

                "unused_ram":"20"

            }

        ]

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.paremeter_error

parameter incomplete, please check your parameter

参数不全

please check your parameter app_id or gic_id

参数错误

gpn.operation_denied

permission denied

权限拒绝

gpn.invalid_operation

task is running in the queue, please wait task end

正在排队等待操作该资源的任务结束

invalid_operation

（异常错误信息）

异常错误信息提示

选项

描述

功能说明

删除专属云

调用说明

名称

描述

请求方式

DELETE

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/app/remove/

参数必选

无

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

dedicated_id

专属云id

string

res_op_id

任务id

string

返回示例

示例：

    {

        "status": "success",

        "message": "success",

        "code": 200,

        "data":{

            "dedicated_id": "0baf2627-a074-41ba-9878-8ce105d0bceb",

        }

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.paremeter_error

please check your parameter app_id or gpn_id

参数错误

parameter incomplete, please check your parameter

参数不全

invalid_operation

（错误异常信息）

错误异常信息提示

选项

描述

功能说明

变更规格

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/update/

参数必选

名称

要求

类型

描述

dedicated_id

True

string

专属云id

spec_id

True

string

规格id

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

dedicated_id

专属云id

string

spec_id

规格id

string

cpu

cpu

string

ram

ram

string

qos

内联链路

string

res_op_id

任务id

string

返回示例

示例：

    {

        "status": "success",

        "message": "success",

        "code": 200,

        "data":{

            "dedicated_id": "4423aa3b-177b-4637-913b-60906ee2e38f",

            "spec_id":"0baf2627-a074-41ba-9878-8ce105d0bceb",

            "cpu":"200",

            "ram":"200",

            "qos":"200",

            "res_op_id":"4565" ,

        }

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.no_money

accounts less than the amount

余额不足

gpn.operation_denied

站点割接

资源互斥

task is running in the queue, please wait task end

等待任务执行完毕

gpn.purchase error

please contact customer service

计费出错

invalid_operation

exception

异常

选项

描述

功能说明

变更私网(内联链路)

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/update/

参数必选

名称

要求

类型

描述

dedicated_id

True

string

专属云id

spec_id

True

string

规格id

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

dedicated_id

专属云id

string

pipe_id

私网id

string

pipe_name

私网名称

string

res_op_id

任务id

string

返回示例

示例：

    {

        "status": "success",

        "message": "success",

        "code": 200,

        "data":{

            "dedicated_id": "4423aa3b-177b-4637-913b-60906ee2e38f",

            "pipe_id": "4423aa3b-177b-4637-913b-60906ee2e38f",

            "pipe_name": "私网1",

            "res_op_id":"4565" ,

        }

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.no_money

accounts less than the amount

余额不足

gpn.operation_denied

站点割接

资源互斥

task is running in the queue, please wait task end

等待任务执行完毕

gpn.purchase error

please contact customer service

计费出错

invalid_operation

exception

异常

选项

描述

功能说明

变更私网(内联链路)

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/update/

参数必选

名称

要求

类型

描述

vm_id

True

string

云主机id

dedicated_id

True

string

专属云id

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

dedicated_id

专属云id

string

vm_id

云主机id

string

res_op_id

任务id

string

返回示例

示例：

    {

        "status": "success",

        "message": "success",

        "code": 200,

        "data":{

            "vm_id": "4423aa3b-177b-4637-913b-60906ee2e38f",

            "dedicated_id": "4423aa3b-177b-4637-913b-60906ee2e38f",

        }

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.no_money

accounts less than the amount

余额不足

gpn.operation_denied

站点割接

资源互斥

task is running in the queue, please wait task end

等待任务执行完毕

gpn.purchase error

please contact customer service

计费出错

invalid_operation

exception

异常

选项

描述

功能说明

云主机移出专属云

调用说明

名称

描述

请求方式

POST

请求类型

JSON

请求路径

http://api2.capitalonline.net/gic/v1/gpn/update/

参数必选

名称

要求

类型

描述

vm_id

True

string

云主机id

参数可选

无

返回结果

说明

返回格式为json

返回参数

名称

类型

描述

status

状态

string

message

错误信息

string

code

执行代码

string

data

返回信息

array

dedicated_id

专属云id

string

vm_id

云主机id

string

res_op_id

任务id

string

返回示例

示例：

    {

        "status": "success",

        "message": "success",

        "code": 200,

        "data":{

            "vm_id": "4423aa3b-177b-4637-913b-60906ee2e38f"

        }

    }

错误信息

错误码定义：

Error code

Message

描述

gpn.no_money

accounts less than the amount

余额不足

gpn.operation_denied

站点割接

资源互斥

task is running in the queue, please wait task end

等待任务执行完毕

gpn.purchase error

please contact customer service

计费出错

invalid_operation

exception

异常