云主机开放API文档

API列表

POST 主机列表

POST /xcloud/trade/v1/host/list

{
  "authTimestamp": "1702452601870",
  "instanceCode": "08dfaf63fa1049e1ae1c6569bd3cd453"
}

请求参数

名称	位置	类型	必选	说明
region	body	string	否	区域 cn-wlcb：北京，hk：香港
serviceStatus	body	string	否	服务状态 notOpened：未开通，inUsed：使用中，renewalPeriod：续费期，normal：正常
hostIp	body	string	否	主机IP模糊查询
hostName	body	string	否	主机名模糊查询
serviceCode	body	string	否	服务编号模糊查询
instanceCode	body	string	否	实例编号模糊查询
remark	body	string	否	备注模糊查询
vagueSearch	body	string	否	模糊查询条件（包含主机名称、备注、实例编号、主机ip）

{
  "status": true,
  "code": "200",
  "res": [
    {
      "agentCode": "xxxxxx",
      "region": "cn-wlcb",
      "zone": "cn-wlcb-01",
      "thirdId": null,
      "instanceCode": "8d41485f656440a983162a57d91233fb",
      "instanceType": "host",
      "serviceCode": "PPP54670271142931",
      "serviceStatus": "notOpened",
      "serviceStatusDesc": "待开通",
      "startTime": null,
      "endTime": null,
      "goodsCode": "20804521483022",
      "goodsName": null,
      "id": 622,
      "hostName": "centos-1gb-beijing-01",
      "hostState": null,
      "hostStateDesc": null,
      "regionName": "北京",
      "zoneName": "北京",
      "machineType": "O",
      "cpuPlatform": null,
      "imageId": "uimage-guw10x",
      "imageName": "CentOS 8.2 64位",
      "tag": null,
      "remark": null,
      "createTime": "2023-09-06 17:59:59",
      "modifyTime": null,
      "cpuCount": 1,
      "memorySize": 1024,
      "diskSet": [
        {
          "diskType": "CLOUD_RSSD",
          "isBoot": "True",
          "encrypted": null,
          "type": null,
          "diskId": null,
          "name": null,
          "drive": null,
          "size": 72,
          "backupType": null,
          "backupNum": null
        }
      ],
      "ipSet": [
        {
          "ipMode": null,
          "fDefault": null,
          "mac": null,
          "weight": null,
          "type": "Bgp",
          "ipid": null,
          "ip": null,
          "bandwidth": 1,
          "vpcId": null,
          "subnetId": null,
          "networkInterfaceId": null,
          "private": false
        }
      ],
      "hostIp": null,
      "osType": "CentOS",
      "osName": "CentOS 8.2 64位",
      "secGroupId": null,
      "alarmTemplateId": null,
      "keyPairs": null,
      "image": null
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	返回参数
»» agentCode	string	false	none	用户编号
»» region	string	false	none	区域
»» zone	string	false	none	可用区
»» instanceCode	string	false	none	实例编号
»» instanceType	string	false	none	实例类型 host主机
»» serviceCode	string	false	none	服务编号
»» serviceStatus	string	false	none	服务状态
»» serviceStatusDesc	string	false	none	服务状态描述
»» startTime	string	false	none	服务开始时间
»» endTime	string	false	none	服务结束时间
»» goodsCode	string	false	none	商品编号
»» goodsName	string	false	none	商品名称
»» hostName	string	false	none	主机名称
»» hostState	string	false	none	主机状态
»» hostStateDesc	string	false	none	主机状态描述
»» regionName	string	false	none	区域描述
»» zoneName	string	false	none	可用区描述
»» machineType	string	false	none	主机类型:(1.OS;2.OPRO)
»» cpuPlatform	string	false	none	cpu平台:1.Intel/Auto;2.Amd/Auto;3.Intel/Broadwell
»» imageId	string	false	none	基础镜像ID（指当前自定义镜像的来源镜像）
»» imageName	string	false	none	镜像名称
»» tag	string	false	none	业务组名称
»» remark	string	false	none	备注
»» createTime	string	false	none	创建时间
»» modifyTime	string	false	none	更新时间
»» cpuCount	integer	false	none	CPU核数，单位: 个
»» memorySize	integer	false	none	内存大小，单位: MB
»» diskSet	[object]	false	none	主机绑定的磁盘集合
»»» diskType	string	false	none	磁盘类型 CLOUD_RSSD：RSSD云盘、CLOUD_SSD：SSD云盘、CLOUD_NORMAL：普通云盘
»»» isBoot	string	false	none	是否是系统盘 True是 False否
»»» encrypted	string	false	none	加密字符串
»»» type	string	false	none	类型
»»» diskId	string	false	none	磁盘ID
»»» name	string	false	none	磁盘名称
»»» drive	string	false	none	驱动
»»» size	integer	false	none	磁盘大小单位GB
»»» backupType	string	false	none	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
»»» backupNum	integer	false	none	备份数
»» ipSet	[object]	false	none	IP实例集合
»»» ipMode	string	false	none	IPv4/IPv6
»»» fDefault	string	false	none	内网 Private 类型下，表示是否为默认网卡。true: 是默认网卡；其他值：不是。
»»» mac	string	false	none	内网 Private 类型下，当前网卡的Mac。
»»» weight	integer	false	none	当前EIP的权重。权重最大的为当前的出口IP。
»»» type	string	false	none	国际: International，BGP: Bgp，内网: Private
»»» ipid	string	false	none	外网IP资源ID 。(内网IP无对应的资源ID)
»»» ip	string	false	none	IP地址
»»» bandwidth	integer	false	none	IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
»»» vpcId	string	false	none	安全组所属 VPC ID
»»» subnetId	string	false	none	IP地址对应的子网 ID。（北京一不支持，字段返回为空）
»»» networkInterfaceId	string	false	none	弹性网卡为默认网卡时，返回对应的 ID 值
»»» private	boolean	false	none	是否是内网
»» hostIp	string	false	none	主机IP
»» osType	string	false	none	操作系统类别。返回"Linux"或者"Windows"
»» osName	string	false	none	操作系统名称
»» secGroupId	string	false	none	安全组id
»» alarmTemplateId	string	false	none	告警模板id
»» keyPairs	string	false	none	密钥对数组
»» image	object	false	none	镜像
»»» zone	string	true	none	可用区 cn-wlcb-01：北京、hk-02：香港
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	string	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）

POST 获取可用区

POST /xcloud/trade/v1/regionZones

请求参数

名称	位置	类型	必选	说明
无	-	-	否	（依然需要按规范传递标准参数，如时间戳authTimestamp）

{
  "status": true,
  "code": "200",
  "res": [
    {
      "zone": "cn-wlcb-01",
      "comment": "北京",
      "region": "cn-wlcb"
    },
    {
      "zone": "hk-02",
      "comment": "香港",
      "region": "hk"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	返回参数
»» region	string	true	none	区域
»» zone	string	true	none	可用区
»» comment	string	true	none	描述

POST 获取安全组

POST /xcloud/trade/v1/securityGroupList

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	可用区

{
  "status": true,
  "code": "200",
  "res": [
    {
      "securityGroupCode": "64c645ff7d8c4557a774daaddb5c6322",
      "remark": "",
      "region": "cn-wlcb",
      "regionName": null,
      "zone": "cn-wlcb-01",
      "zoneName": null,
      "secGroupRules": "4",
      "ruleNumber": null,
      "bind": null,
      "bindNumber": null,
      "agentCode": "xxxxxx",
      "securityGroupName": "tian-1",
      "secGroupRecommendation": "noweb",
      "secGrpTempOSType": null,
      "vpcCode": null,
      "tag": "xxxxxx",
      "createTime": "2023-08-21 15:53:38",
      "modifyTime": null,
      "default": false
    },
    {
      "securityGroupCode": "df7dcbb366864dd9b04202c9b2ac8d60",
      "remark": "",
      "region": "cn-wlcb",
      "regionName": null,
      "zone": "cn-wlcb-01",
      "zoneName": null,
      "secGroupRules": "1,2,3",
      "ruleNumber": null,
      "bind": null,
      "bindNumber": null,
      "agentCode": "xxxxxx",
      "securityGroupName": "tian--331",
      "secGroupRecommendation": "noweb",
      "secGrpTempOSType": null,
      "vpcCode": null,
      "tag": "xxxxxx",
      "createTime": "2023-08-21 16:30:53",
      "modifyTime": null,
      "default": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	返回参数
»» securityGroupCode	string	true	none	安全组code
»» secGroupRules	string	true	none	安全规则Id
»» ruleNumber	integer	true	none	规则数量
»» bind	boolean	true	none	是否绑定资源
»» bindNumber	integer	true	none	绑定资源数量
»» securityGroupName	string	true	none	安全组名称，Name/Tag/Remark 不能都为空
»» secGroupRecommendation	string	true	none	安全组推荐模版，可选填：“web”, "noweb"
»» secGrpTempOSType	string	true	none	安全组推荐的web系统类型: WINDOWS, LINUX,CUSTOM
»» vpcCode	string	true	none	VPC ID
»» default	boolean	true	none	是否默认安全组：true:默认安全组 false:非默认安全组
»» remark	string	true	none	备注
»» region	string	true	none	区域
»» regionName	string	true	none	区域描述
»» zone	string	true	none	可用区
»» zoneName	string	true	none	可用区描述
»» agentCode	string	true	none	用户编号
»» tag	string	true	none	安全组标记
»» createTime	string	true	none	创建时间
»» modifyTime	string	true	none	更新时间

POST 获取线路类型

POST /xcloud/trade/v1/eip/line

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	可用区

{
  "status": true,
  "code": "200",
  "res": [
    {
      "maxBandwidth": "1000",
      "zone": "cn-wlcb-01",
      "line": "BGP",
      "comment": "北京可用区",
      "region": "cn-wlcb",
      "value": "Bgp"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	返回参数
»» maxBandwidth	string	false	none	最大带宽
»» zone	string	false	none	可用区
»» line	string	false	none	线路
»» comment	string	false	none	描述
»» region	string	false	none	区域
»» value	string	false	none	线路值

POST 获取可购买时长及折扣

POST /xcloud/trade/v1/getBuyTimeLimit

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceType": "host",
  "cpu": 2,
  "memory": 2048
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	可用区
» instanceType	body	string	是	实例类型 host：主机
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB

{
  "status": true,
  "code": "200",
  "res": [
    {
      "buyAmount": 1,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 2,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 3,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 10,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 1,
      "buyUnit": "Y",
      "discount": 1
    },
    {
      "buyAmount": 2,
      "buyUnit": "Y",
      "discount": 1
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	none
»» buyAmount	integer	true	none	购买时长
»» buyUnit	string	true	none	购买时长单位
»» discount	integer	true	none	折扣

POST 获取可购买实例配置

POST /xcloud/trade/v1/host/getAvailableConfig

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "machineType": "O"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	可用区
» machineType	body	string	是	指定机型 O：快杰型

{
  "status": true,
  "code": "200",
  "res": [
    {
      "disks": [
        {
          "retCode": null,
          "message": null,
          "action": null,
          "requestId": null,
          "name": "cloudDisk",
          "bootDisk": [
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "name": "CLOUD_RSSD",
              "instantResize": true,
              "maximalSize": 500,
              "features": [
                "SNAPSHOT"
              ]
            }
          ],
          "dataDisk": [
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "minimalSize": 20,
              "name": "CLOUD_RSSD",
              "maximalSize": 32000,
              "features": [
                "SNAPSHOT"
              ]
            },
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "minimalSize": 20,
              "name": "CLOUD_SSD",
              "maximalSize": 8000,
              "features": [
                "SNAPSHOT"
              ]
            },
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "minimalSize": 20,
              "name": "CLOUD_NORMAL",
              "maximalSize": 8000,
              "features": [
                "SNAPSHOT"
              ]
            }
          ]
        }
      ],
      "machineSizes": [
        {
          "retCode": null,
          "message": null,
          "action": null,
          "requestId": null,
          "gpu": 0,
          "collection": [
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "cpu": 1,
              "memory": [
                1,
                2,
                4,
                8
              ],
              "minimalCpuPlatform": null
            },
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "cpu": 2,
              "memory": [
                2,
                4
              ],
              "minimalCpuPlatform": null
            },
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "cpu": 4,
              "memory": [
                8
              ],
              "minimalCpuPlatform": null
            },
            {
              "retCode": null,
              "message": null,
              "action": null,
              "requestId": null,
              "cpu": 8,
              "memory": [
                8
              ],
              "minimalCpuPlatform": null
            }
          ]
        }
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	none
»» disks	[object]	false	none	none
»»» name	string	false	none	磁盘名称
»»» bootDisk	[object]	false	none	系统盘
»»»» name	string	false	none	系统盘类别，包含普通云盘（CLOUD_NORMAL、SSD云盘、CLOUD_SSD和RSSD云盘、CLOUD_RSSD。普通本地盘只包含普通本地盘、LOCAL_NORMAL一种。SSD本地盘只包含SSD本地盘、LOCAL_SSD一种）
»»»» instantResize	boolean	false	none	系统盘是否允许扩容，如果是本地盘，则不允许扩容，InstantResize为false
»»»» maximalSize	integer	false	none	单位G MaximalSize为磁盘最大值
»»»» features	[string]	false	none	磁盘可支持的服务 SNAPSHOT快照
»»» dataDisk	[object]	false	none	数据盘
»»»» minimalSize	integer	true	none	单位G 磁盘最小值，如果没有该字段，最小值取基础镜像Size值即可（linux为20G，windows为40G）。
»»»» name	string	true	none	数据盘类别，包含普通云盘（CLOUD_NORMAL、SSD云盘、CLOUD_SSD和RSSD云盘、CLOUD_RSSD。普通本地盘只包含普通本地盘、LOCAL_NORMAL一种。SSD本地盘只包含SSD本地盘、LOCAL_SSD一种。）
»»»» maximalSize	integer	true	none	单位G MaximalSize为磁盘最大值
»»»» features	[string]	true	none	磁盘可支持的服务 SNAPSHOT快照
»» machineSizes	[object]	false	none	none
»»» gpu	integer	false	none	Gpu为GPU可支持的规格即GPU颗数，非GPU机型，Gpu为0
»»» collection	[object]	false	none	CPU和内存可支持的规格
»»»» cpu	integer	true	none	CPU规格
»»»» memory	[integer]	true	none	内存规格实际使用需要*1024

POST 获取系统镜像

POST /xcloud/trade/v1/host/images

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "imageType": "Base"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	可用区
» imageType	body	string	是	镜像类型镜像类型。标准镜像：Base，自定义镜像：Custom

{
  "status": true,
  "code": "200",
  "res": {
    "Windows": [
      {
        "zone": "cn-wlcb-01",
        "imageId": "uimage-bl2izv",
        "imageName": "Windows 2019 64位",
        "imageOs": "Windows",
        "imageVersion": "2019",
        "imageBit": "64位",
        "imageLang": "",
        "osType": "Windows",
        "osName": "Windows 2019 64位",
        "imageType": "Base",
        "imageSize": "40",
        "state": "Available",
        "tag": null,
        "features": [
          "NetEnhanced",
          "NetEnhanced_Ultra",
          "RssdAttachable"
        ],
        "x86": true
      },
      {
        "zone": "cn-wlcb-01",
        "imageId": "uimage-fxu5pn",
        "imageName": "Windows 2016 64位",
        "imageOs": "Windows",
        "imageVersion": "2016",
        "imageBit": "64位",
        "imageLang": "",
        "osType": "Windows",
        "osName": "Windows 2016 64位",
        "imageType": "Base",
        "imageSize": "40",
        "state": "Available",
        "tag": null,
        "features": [
          "NetEnhanced",
          "RssdAttachable"
        ],
        "x86": true
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	object	true	none	none
»» Windows	[object]	true	none	none
»»» zone	string	true	none	可用区
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	null	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）
»»» x86	boolean	true	none	判断镜像的特性是否是X86架构
»» Ubuntu	[object]	true	none	none
»»» zone	string	true	none	可用区
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	null	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）
»»» x86	boolean	true	none	判断镜像的特性是否是X86架构
»» RedHat	[object]	true	none	none
»»» zone	string	true	none	可用区
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	null	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）
»»» x86	boolean	true	none	判断镜像的特性是否是X86架构
»» Rocky	[object]	true	none	none
»»» zone	string	true	none	可用区
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	null	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）
»»» x86	boolean	true	none	判断镜像的特性是否是X86架构
»» Debian	[object]	true	none	none
»»» zone	string	true	none	可用区
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	null	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）
»»» x86	boolean	true	none	判断镜像的特性是否是X86架构
»» CentOS	[object]	true	none	none
»»» zone	string	true	none	可用区
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	null	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）
»»» x86	boolean	true	none	判断镜像的特性是否是X86架构

POST 主机立即购买

POST /xcloud/trade/v1/host/buyNow

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 2,
  "cpu": 1,
  "memory": 2048,
  "diskSet": [
    {
      "diskType": "CLOUD_RSSD",
      "isBoot": "True",
      "size": 40,
      "backupType": "SNAPSHOT",
      "backupNum": 0
    },
    {
      "diskType": "CLOUD_RSSD",
      "isBoot": "False",
      "size": 20,
      "backupType": "SNAPSHOT",
      "backupNum": 0
    }
  ],
  "autoCreate": true,
  "ipSet": [
    {
      "type": "Bgp",
      "bandwidth": 1
    }
  ],
  "image": {
    "imageId": "uimage-bl2izv",
    "imageName": "Windows 2019 64位",
    "imageOs": "Windows",
    "imageType": "Base",
    "osName": "Windows 2019 64位"
  },
  "password": "brgtlh2bdqfmil95@",
  "hostName": "xinnethost-test2",
  "secGroupId": 56
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» autoCreate	body	boolean	否	是否自动创建 true是/false否
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次
» buyNum	body	integer	是	购买数量
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB
» diskSet	body	[object]	是	磁盘列表必须存在系统盘最大大小为2
»» diskType	body	string	是	磁盘类型
»» isBoot	body	string	是	是否是系统盘 True是 False否
»» size	body	integer	是	磁盘大小单位GB
»» backupType	body	string	否	备份类型，DATAARK:数据方舟，SNAPSHOT:快照, 不传表示不开启
»» backupNum	body	integer	否	备份数
» ipSet	body	[object]	否	外网ip和带宽
»» type	body	string	是	国际: Internation，BGP: Bgp，内网: Private
»» bandwidth	body	integer	是	IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
» hostName	body	string	是	主机名称
» image	body	object	是	镜像
»» imageId	body	string	是	镜像id
»» imageName	body	string	否	镜像名称
»» imageOs	body	string	否	系统
»» imageType	body	string	是	镜像类型
»» osName	body	string	是	系统名称
» password	body	string	是	主机密码
» secGroupId	body	string	否	安全组ID
» monitorAgent	body	string	否	监控代理标识,true:开启,false:未开启

{
  "status": true,
  "code": "200",
  "res": [
    "X658be4709304f390ccdfab02",
    "X658be4709304f390ccdfab03"
  ]
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	[string]	true	none	服务编号列表

POST 主机升级配置

POST /xcloud/trade/v1/host/upgrade

{
  "authTimestamp": "1702452601870",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "cpu": 1,
  "memory": 2048,
  "diskSet": [
    {
      "diskId": "bsi-ac7ca464",
      "diskType": "CLOUD_RSSD",
      "isBoot": "True",
      "size": 60,
      "backupType": "SNAPSHOT",
      "backupNum": 0
    },
    {
      "diskId": "bsr-rcjdedc4ak8",
      "diskType": "CLOUD_RSSD",
      "isBoot": "False",
      "size": 40,
      "backupType": "SNAPSHOT",
      "backupNum": 0
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB
» diskSet	body	[object]	是	磁盘列表必须存在系统盘最大大小为2
»» diskId	body	string	否	磁盘id 原有配置升级必传不传为增加磁盘
»» diskType	body	string	是	磁盘类型
»» isBoot	body	string	是	是否是系统盘 True是 False否
»» size	body	integer	是	磁盘大小单位GB
»» backupType	body	string	否	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
»» backupNum	body	integer	否	备份数

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 主机升级带宽

POST /xcloud/trade/v1/host/resizeBandWidth

{
  "authTimestamp": "1702452601870",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "ipSet": [
    {
      "ipid": "eip-rciof3c4a4u",
      "type": "Bgp",
      "bandwidth": 2
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» ipSet	body	[object]	否	外网ip和带宽
»» ipid	body	string	否	外网ip id，不传为新增ip和带宽，传为修改ip和带宽
»» type	body	string	是	国际: Internation，BGP: Bgp，内网: Private
»» bandwidth	body	integer	是	IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 开通主机

POST /xcloud/trade/v1/host/open

{
  "authTimestamp": "1702452601870",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be"
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机开通是否成功 true成功、false失败

POST 主机重装系统

POST /xcloud/trade/v1/host/reinstallSystem

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "password": "brgtlh2bdqfmil95#",
  "imageId": "uimage-fxu5pn"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号
» password	body	string	是	主机密码
» imageId	body	string	是	镜像id

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机重装系统是否成功 true成功、false失败

POST 主机重置密码

POST /xcloud/trade/v1/host/resetPassword

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "password": "brgtlh2bdqfmil95#"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号
» password	body	string	是	主机密码

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机重置密码是否成功 true成功、false失败

POST 主机启动

POST /xcloud/trade/v1/host/startup

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机启动是否成功 true成功、false失败

POST 主机关闭

POST /xcloud/trade/v1/host/stop

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机关闭是否成功 true成功、false失败

POST 主机重启

POST /xcloud/trade/v1/host/reboot

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机重启是否成功 true成功、false失败

POST 主机断电

POST /xcloud/trade/v1/host/powerOff

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机断电是否成功 true成功、false失败

POST 主机修改名称

POST /xcloud/trade/v1/host/modifyName

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "hostName": "xinnethost-test222"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号
» hostName	body	string	是	主机名称

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机修改名称是否成功 true成功、false失败

POST 主机修改备注

POST /xcloud/trade/v1/host/modifyRemark

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "remark": "xinnethost-test222-remark"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号
» remark	body	string	是	主机备注长度最大255

{
  "status": true,
  "code": "200",
  "res": true
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	boolean	true	none	主机修改备注是否成功 true成功、false失败

POST 主机远程登录

POST /xcloud/trade/v1/host/getVNCLink

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	none
»» redirectUrl	string	true	none	跳转地址

POST 主机立即购买价格计算

POST /xcloud/trade/v1/host/calculatePrice

{
  "authTimestamp": "1702452601870",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "cpu": 1,
  "memory": 1024,
  "diskSet": [
    {
      "diskType": "CLOUD_RSSD",
      "isBoot": "True",
      "size": 40,
      "backupType": "SNAPSHOT",
      "backupNum": 1
    },
    {
      "diskType": "CLOUD_RSSD",
      "isBoot": "False",
      "size": 20,
      "backupType": "SNAPSHOT",
      "backupNum": 1
    }
  ],
  "ipSet": [
    {
      "type": "Bgp",
      "bandwidth": 1
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次
» buyNum	body	integer	是	购买数量
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB
» diskSet	body	[object]	是	磁盘列表必须存在系统盘最大大小为2
»» diskType	body	string	是	磁盘类型
»» isBoot	body	string	是	是否是系统盘 True是 False否
»» size	body	integer	是	磁盘大小单位GB
»» backupType	body	string	否	备份类型，DATAARK:数据方舟，SNAPSHOT:快照, 不传表示不开启
»» backupNum	body	integer	否	备份数
» ipSet	body	[object]	否	外网ip和带宽
»» type	body	string	是	国际: Internation，BGP: Bgp，内网: Private
»» bandwidth	body	integer	是	IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 140,
    "originalPrice": 140,
    "hostPrice": 28,
    "hostOriginalPrice": 28,
    "hostDisCount": 1,
    "eipPrice": 55,
    "eipOriginalPrice": 55,
    "eipDisCount": 1,
    "diskPrices": [
      {
        "isBoot": "True",
        "diskPrice": 22,
        "diskOriginalPrice": 22,
        "diskDisCount": 1,
        "backupPrice": 16,
        "backupOriginalPrice": 16,
        "backupDisCount": 1
      },
      {
        "isBoot": "False",
        "diskPrice": 11,
        "diskOriginalPrice": 11,
        "diskDisCount": 1,
        "backupPrice": 8,
        "backupOriginalPrice": 8,
        "backupDisCount": 1
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» res	object	true	none	none
»» totalPrice	integer	true	none	总价
»» originalPrice	integer	true	none	原价
»» hostPrice	integer	true	none	主机价格
»» hostOriginalPrice	integer	true	none	主机原价
»» hostDisCount	integer	true	none	主机折扣
»» eipPrice	integer	true	none	外网ip价格
»» eipOriginalPrice	integer	true	none	外网ip原价
»» eipDisCount	integer	true	none	外网ip折扣
»» diskPrices	[object]	true	none	磁盘价格集合
»»» isBoot	string	true	none	是否是系统盘 True是 False否
»»» diskPrice	integer	true	none	磁盘价格
»»» diskOriginalPrice	integer	true	none	磁盘原价
»»» diskDisCount	integer	true	none	磁盘折扣
»»» backupPrice	integer	true	none	磁盘备份价格
»»» backupOriginalPrice	integer	true	none	磁盘备份原价
»»» backupDisCount	integer	true	none	磁盘备份折扣

POST 主机升级配置价格计算

POST /xcloud/trade/v1/host/calculateHostUpgradePrice

{
  "authTimestamp": "1702452601870",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "cpu": 1,
  "memory": 2048,
  "diskSet": [
    {
      "diskId": "bsi-ac7ca464",
      "diskType": "CLOUD_RSSD",
      "isBoot": "True",
      "size": 70,
      "backupType": "SNAPSHOT",
      "backupNum": 0
    },
    {
      "diskId": "bsr-rcjdedc4ak8",
      "diskType": "CLOUD_RSSD",
      "isBoot": "False",
      "size": 50,
      "backupType": "SNAPSHOT",
      "backupNum": 0
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB
» diskSet	body	[object]	是	磁盘列表必须存在系统盘最大大小为2
»» diskId	body	string	否	磁盘id 原有配置升级必传不传为增加磁盘
»» diskType	body	string	是	磁盘类型
»» isBoot	body	string	是	是否是系统盘 True是 False否
»» size	body	integer	是	磁盘大小单位GB
»» backupType	body	string	否	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
»» backupNum	body	integer	否	备份数

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 17.72,
    "originalPrice": 17.72,
    "buyAmount": 28,
    "buyUnit": "D"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» res	object	true	none	none
»» totalPrice	number	true	none	总价
»» originalPrice	number	true	none	原价
»» buyAmount	integer	true	none	none
»» buyUnit	string	true	none	none

POST 主机升级带宽价格计算

POST /xcloud/trade/v1/host/calculateBandwidthPrice

{
  "authTimestamp": "1702452601870",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "ipSet": [
    {
      "ipid": "eip-rciof3c4a4u",
      "type": "Bgp",
      "bandwidth": 5
    }
  ]
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» ipSet	body	[object]	否	外网ip和带宽
»» ipid	body	string	否	外网ip id，不传为新增ip和带宽，传为修改ip和带宽
»» type	body	string	是	国际: Internation，BGP: Bgp，内网: Private
»» bandwidth	body	integer	是	IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 46.67,
    "originalPrice": null,
    "buyAmount": 28,
    "buyUnit": "D"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» res	object	true	none	none
»» totalPrice	number	true	none	none
»» buyAmount	integer	true	none	none
»» buyUnit	string	true	none	none

POST 立即续费

POST /xcloud/trade/v1/renew/renewNow

{
  "authTimestamp": "1702452601870",
  "instanceCode": "1f37676f65be421cb63b21e2bfc4e47b",
  "instanceType": "host",
  "buyAmount": "1",
  "buyUnit": "M"
}

请求参数

名称	位置	类型	必选	说明
» buyAmount	body	integer	是	购买时长（主界面续费选择续费时长时传递）
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次（主界面续费选择续费时长时传递）
» instanceType	body	string	是	实例类型：host主机
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 续费-价格计算

POST /xcloud/trade/v1/renew/calculatePrice

{
  "authTimestamp": "1702452601870",
  "instanceCode": "1f37676f65be421cb63b21e2bfc4e47b",
  "instanceType": "host",
  "buyAmount": "1",
  "buyUnit": "M"
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» instanceType	body	string	是	实例类型：host主机
» buyAmount	body	string	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 168,
    "originalPrice": 168,
    "buyAmount": null,
    "buyUnit": null,
    "hostPrice": 56,
    "hostOriginalPrice": 56,
    "hostDisCount": 1,
    "eipPrice": 55,
    "eipOriginalPrice": 55,
    "eipDisCount": 1,
    "diskPrices": [
      {
        "isBoot": "True",
        "diskPrice": 22,
        "diskOriginalPrice": 22,
        "diskDisCount": 1,
        "backupPrice": 16,
        "backupOriginalPrice": 16,
        "backupDisCount": 1
      },
      {
        "isBoot": "False",
        "diskPrice": 11,
        "diskOriginalPrice": 11,
        "diskDisCount": 1,
        "backupPrice": 8,
        "backupOriginalPrice": 8,
        "backupDisCount": 1
      }
    ]
  }
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	object	true	none	none
»» totalPrice	integer	true	none	总价
»» originalPrice	integer	true	none	原价
»» hostPrice	integer	true	none	主机价格
»» hostOriginalPrice	integer	true	none	主机原价
»» hostDisCount	integer	true	none	主机折扣
»» eipPrice	integer	true	none	外网ip价格
»» eipOriginalPrice	integer	true	none	外网ip原价
»» eipDisCount	integer	true	none	外网ip折扣
»» diskPrices	[object]	true	none	磁盘价格集合
»»» isBoot	string	true	none	是否是系统盘 True是 False否
»»» diskPrice	integer	true	none	磁盘价格
»»» diskOriginalPrice	integer	true	none	磁盘原价
»»» diskDisCount	integer	true	none	磁盘折扣
»»» backupPrice	integer	true	none	磁盘备份价格
»»» backupOriginalPrice	integer	true	none	磁盘备份原价
»»» backupDisCount	integer	true	none	磁盘备份折扣

POST 续费-获取可购买时长及折扣

POST /xcloud/trade/v1/renew/getBuyTimeLimit

{
  "authTimestamp": "1702452601870",
  "instanceCode": "1f37676f65be421cb63b21e2bfc4e47b",
  "instanceType": "host"
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» instanceType	body	string	是	实例类型：host主机

{
  "status": true,
  "code": "200",
  "res": [
    {
      "buyAmount": 1,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 2,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 3,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 4,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 5,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 6,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 7,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 8,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 9,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 10,
      "buyUnit": "M",
      "discount": 1
    },
    {
      "buyAmount": 1,
      "buyUnit": "Y",
      "discount": 1
    },
    {
      "buyAmount": 2,
      "buyUnit": "Y",
      "discount": 1
    },
    {
      "buyAmount": 3,
      "buyUnit": "Y",
      "discount": 1
    },
    {
      "buyAmount": 4,
      "buyUnit": "Y",
      "discount": 1
    },
    {
      "buyAmount": 5,
      "buyUnit": "Y",
      "discount": 1
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» buyAmount	integer	true	none	购买时长
»» buyUnit	string	true	none	购买时长单位
»» discount	integer	true	none	折扣

POST 创建磁盘备份

POST /xcloud/trade/v1/disk/backup/create

{
  "authTimestamp": "1702452601870",
  "backupName": "测试备份创建",
  "diskId": "bsi-9af09bc10",
  "instanceCode": "05257b5b975943a99b1db393dfb483e4"
}

请求参数

名称	位置	类型	必选	中文名	说明
» backupName	body	string	是	备份名称	none
» diskId	body	string	是	磁盘ID	none
» instanceCode	body	string	是	主机编码	none

{
  "status": true,
  "code": "200",
  "res": "bsiSnap-sjgb5j7knda"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» msg	string	true	none	描述	描述
» res	string	true	none	结果	快照ID

POST 删除磁盘备份

POST /xcloud/trade/v1/disk/backup/delete

{
  "authTimestamp": "1702452601870",
  "snapshotId": "bsiSnap-sj2rn9u990g",
  "diskId": "bsi-9af09bc1",
  "instanceCode": "05257b5b975943a99b1db393dfb483e4"
}

请求参数

名称	位置	类型	必选	中文名	说明
» snapshotId	body	string	是	快照ID	none
» diskId	body	string	是	磁盘ID	none
» instanceCode	body	string	是	实例编码	none

{
  "status": true,
  "code": "200",
  "res": "删除磁盘备份成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» msg	string	true	none	描述	描述
» res	string	true	none	结果	操作结果

POST 获取磁盘备份列表

POST /xcloud/trade/v1/disk/backup/list

{
  "authTimestamp": "1702452601870",
  "instanceCode": "05257b5b975943a99b1db393dfb483e4",
  "diskId": "bsi-9af09bc1",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "selectType": "auto",
  "snapshotType": "minor"
}

请求参数

名称	位置	类型	必选	中文名	说明
» instanceCode	body	string	是	主机编码	none
» diskId	body	string	是	磁盘ID	none
» region	body	string	是	区域	none
» zone	body	string	是	可用区	none
» selectType	body	string	是	查询类型(manual,auto)	manual手动备份,auto自动备份
» snapshotType	body	string	否	快照类型(minor,major)	"minor" 小时级别增量备份，"major" 天级别增量备份
» next	body	integer	否	页码	默认第一页
» size	body	integer	否	每页数据量	默认每页10条

{
  "status": true,
  "code": "200",
  "res": {
    "total": 1,
    "page": 1,
    "size": 10,
    "current": 1,
    "elements": [
      {
        "zone": "cn-wlcb-01",
        "region": "cn-wlcb",
        "snapshotId": "",
        "diskId": "bsi-9af09bc1",
        "backupName": "小时备份_16时",
        "diskType": "SysUDisk",
        "createTime": 1704873600,
        "status": "ready",
        "snapshotType": "minor",
        "backupType": 0,
        "diskStatus": "InUse",
        "diskStatusDesc": "已挂载",
        "regionName": "北京",
        "zoneName": "北京",
        "diskName": null
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» msg	string	true	none	描述	描述
» res	object	true	none	结果	结果
»» total	integer	true	none	总数	none
»» page	integer	true	none	总页数	none
»» size	integer	true	none	每页条数	none
»» current	integer	true	none	当前页	none
»» elements	[object]	true	none		none
»»» zone	string	false	none	可用区	none
»»» region	string	false	none	区域	none
»»» snapshotId	string	false	none	快照ID	none
»»» diskId	string	false	none	磁盘ID	none
»»» backupName	string	false	none	备份名称	none
»»» diskType	string	false	none	磁盘类型	"SysVdisk" 本地盘系统盘；"DataVdisk" 本地盘数据盘；"SysUDisk" 云盘系统盘；"DataUDisk" 云盘数据盘
»»» createTime	integer	false	none	创建时间	none
»»» status	string	false	none	快照状态	快照状态，"ready" 表示等待merge ，"finish" 表示已经merge完成
»»» snapshotType	string	false	none	备份类型	"minor" 小时级别增量备份，"major" 天级别增量备份，"base" base备份，"user" 用户手动备份
»»» backupType	integer	false	none	备份方式	1 表示手动快照, 0表示自动快照
»»» diskStatus	string	false	none	磁盘状态	云盘状态。All(所有状态)，Available(可用)，Attaching(挂载中)，InUse(已挂载)， Detaching(卸载中)， Initializating(分配中)，Failed(创建失败)，Cloning(克隆中)，Restoring(恢复中)，RestoreFailed(恢复失败)。默认值：All
»»» diskStatusDesc	string	false	none		none
»»» regionName	string	false	none	区域名称	none
»»» zoneName	string	false	none	可用区名称	none
»»» diskName	string	false	none	磁盘名称	none

POST 获取磁盘秒级备份时间

POST /xcloud/trade/v1/disk/backup/second

{
  "authTimestamp": "1702452601870",
  "diskId": "bsi-9af09bc1",
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "05257b5b975943a99b1db393dfb483e4"
}

请求参数

名称	位置	类型	必选	中文名	说明
» instanceCode	body	string	是	主机编码	none
» diskId	body	string	是	磁盘ID	none
» region	body	string	是	区域	none
» zone	body	string	是	可用区	none

{
  "status": true,
  "code": "200",
  "res": {
    "diskId": "bsi-9af09bc1",
    "startTime": 1704873601,
    "latestTime": 1704962907
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» msg	string	true	none	描述	描述
» res	object	true	none	结果	结果
»» diskId	string	true	none	磁盘ID	none
»» startTime	integer	true	none	开始时间	秒级别快照数据开始时间
»» latestTime	integer	true	none	结束时间	秒级别快照数据最新时间

POST 磁盘备份恢复

POST /xcloud/trade/v1/disk/backup/restore

{
  "authTimestamp": "1702452601870",
  "instanceCode": "05257b5b975943a99b1db393dfb483e4",
  "diskId": "bsi-9af09bc1",
  "snapshotId": "bsiSnap-sjesgiizcux"
}

请求参数

名称	位置	类型	必选	中文名	说明
» instanceCode	body	string	是	主机编码	none
» diskId	body	string	是	磁盘ID	none
» snapshotId	body	string	否	快照ID	非必填
» restoreTime	body	integer	否	恢复盘的时间戳	非必填(当快照ID为空时，以时间戳时间恢复备份)

{
  "status": true,
  "code": "200",
  "res": "磁盘备份恢复成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» msg	string	false	none	描述	描述
» res	string	true	none	结果	结果

POST 磁盘立即购买

POST /xcloud/v1/disk/buyNow

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 2,
  "diskType": "CLOUD_RSSD",
  "isBoot": "False",
  "size": 20,
  "backupType": "SNAPSHOT",
  "openBackup": true,
  "attachHost": true,
  "hostInstanceCode": "xxxxxxxxxxxxxxxxxxxxxxx",
  "name": "2024051401"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月
» buyNum	body	integer	是	购买数量
» diskType	body	string	是	磁盘类型
» size	body	string	是	磁盘大小单位G
» name	body	string	是	磁盘名称
» backupType	body	string	是	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
» openBackup	body	boolean	是	是否开启快照
» attachHost	body	boolean	是	是否挂载主机(必须挂载主机)
» hostInstanceCode	body	string	是	挂载主机实例编号

{
  "status": true,
  "code": "200",
  "res": [
    "X658be4709304f390ccdfab02",
    "X658be4709304f390ccdfab03"
  ]
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述
» res	[string]	true	none	服务编号列表

POST 磁盘立即续费

POST /xcloud/v1/disk/renew/renewNow

{
  "instanceCode": "07a9813954f64900b6349ada21efe404",
  "instanceType": "disk",
  "buyAmount": "1",
  "buyUnit": "M"
}

请求参数

名称	位置	类型	必选	说明
» buyAmount	body	integer	是	购买时长（主界面续费选择续费时长时传递）
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次（主界面续费选择续费时长时传递）
» instanceType	body	string	是	实例类型：disk磁盘
» instanceCode	body	string	是	实例编号

{
  "status": true,
  "code": "200"
}

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 磁盘续费-价格计算

POST /xcloud/v1/disk/renew/calculatePrice

{
  "instanceCode": "07a9813954f64900b6349ada21efe404",
  "instanceType": "disk",
  "buyAmount": "1",
  "buyUnit": "M"
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» instanceType	body	string	是	实例类型：disk主机
» buyAmount	body	string	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次

{
  "status": false,
  "code": "400",
  "msg": "接口调用失败"
}

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 38,
    "originalPrice": 38,
    "buyAmount": null,
    "buyUnit": null,
    "diskPrice": null,
    "diskOriginalPrice": null,
    "diskDisCount": 1,
    "backupPrice": null,
    "backupOriginalPrice": null,
    "backupDisCount": null
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» totalPrice	integer	true	none	none
»» originalPrice	integer	true	none	none
»» buyAmount	null	true	none	none
»» buyUnit	null	true	none	none
»» diskPrice	null	true	none	none
»» diskOriginalPrice	null	true	none	none
»» diskDisCount	integer	true	none	none
»» backupPrice	null	true	none	none
»» backupOriginalPrice	null	true	none	none
»» backupDisCount	null	true	none	none

POST 磁盘列表

POST /xcloud/v1/disk/list

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» serviceStatus	body	string	否	服务状态 notOpened：未开通，inUsed：使用中，renewalPeriod：续费期，normal：正常
» serviceCode	body	string	否	磁盘服务编号模糊查询
» instanceCode	body	string	否	磁盘实例编号模糊查询

{
  "status": true,
  "code": "200",
  "res": [
    {
      "agentCode": "xxxxxx",
      "region": "cn-wlcb",
      "zone": "cn-wlcb-01",
      "thirdId": "bsr-xeqpic9sirt",
      "instanceCode": "83736c443c564d3f95146574eefbf724",
      "instanceType": "disk",
      "serviceCode": "X66418780905f63e6f9a02a7b",
      "serviceStatus": "normal",
      "serviceStatusDesc": "正常",
      "startTime": "2024-05-13 15:46:51",
      "endTime": "2024-06-13 15:46:51",
      "goodsCode": "71033174254756",
      "goodsName": null,
      "id": 243,
      "name": "20240516midify",
      "deviceName": null,
      "diskState": "Available",
      "diskStateDesc": "可用",
      "regionName": "北京",
      "zoneName": "北京",
      "size": 40,
      "tag": "xxxxxx-X66418780905f63e6f9a02a7b",
      "createTime": "2024-05-13 11:26:49",
      "modifyTime": null,
      "diskType": "CLOUD_RSSD",
      "hostId": null,
      "hostName": null,
      "hostIp": null,
      "backupMode": "SNAPSHOT",
      "snapshotCount": 2,
      "snapshotLimit": 3,
      "attachHost": false,
      "openSnapshot": true,
      "boot": false
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	[object]	true	none	none
»» agentCode	string	false	none	none
»» region	string	false	none	none
»» zone	string	false	none	none
»» thirdId	string	false	none	none
»» instanceCode	string	false	none	none
»» instanceType	string	false	none	none
»» serviceCode	string	false	none	none
»» serviceStatus	string	false	none	none
»» serviceStatusDesc	string	false	none	none
»» startTime	string	false	none	none
»» endTime	string	false	none	none
»» goodsCode	string	false	none	none
»» goodsName	null	false	none	none
»» id	integer	false	none	none
»» name	string	false	none	none
»» deviceName	null	false	none	none
»» diskState	string	false	none	none
»» diskStateDesc	string	false	none	none
»» regionName	string	false	none	none
»» zoneName	string	false	none	none
»» size	integer	false	none	none
»» tag	string	false	none	none
»» createTime	string	false	none	none
»» modifyTime	null	false	none	none
»» diskType	string	false	none	none
»» hostId	null	false	none	none
»» hostName	null	false	none	none
»» hostIp	null	false	none	none
»» backupMode	string	false	none	none
»» snapshotCount	integer	false	none	none
»» snapshotLimit	integer	false	none	none
»» attachHost	boolean	false	none	none
»» openSnapshot	boolean	false	none	none
»» boot	boolean	false	none	none

POST 获取磁盘可挂载主机列表

POST /xcloud/v1/disk/attachable/hostList

{
  "instanceCode": "08dfaf63fa1049e1ae1c6569bd3cd453"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港

{
  "status": true,
  "code": "200",
  "res": [
    {
      "agentCode": "xxxxxx",
      "region": "cn-wlcb",
      "zone": "cn-wlcb-01",
      "thirdId": null,
      "instanceCode": "8d41485f656440a983162a57d91233fb",
      "instanceType": "host",
      "serviceCode": "PPP54670271142931",
      "serviceStatus": "notOpened",
      "serviceStatusDesc": "待开通",
      "startTime": null,
      "endTime": null,
      "goodsCode": "20804521483022",
      "goodsName": null,
      "id": 622,
      "hostName": "centos-1gb-beijing-01",
      "hostState": null,
      "hostStateDesc": null,
      "regionName": "北京",
      "zoneName": "北京",
      "machineType": "O",
      "cpuPlatform": null,
      "imageId": "uimage-guw10x",
      "imageName": "CentOS 8.2 64位",
      "tag": null,
      "remark": null,
      "createTime": "2023-09-06 17:59:59",
      "modifyTime": null,
      "cpuCount": 1,
      "memorySize": 1024,
      "diskSet": [
        {
          "diskType": "CLOUD_RSSD",
          "isBoot": "True",
          "encrypted": null,
          "type": null,
          "diskId": null,
          "name": null,
          "drive": null,
          "size": 72,
          "backupType": null,
          "backupNum": null
        }
      ],
      "ipSet": [
        {
          "ipMode": null,
          "fDefault": null,
          "mac": null,
          "weight": null,
          "type": "Bgp",
          "ipid": null,
          "ip": null,
          "bandwidth": 1,
          "vpcId": null,
          "subnetId": null,
          "networkInterfaceId": null,
          "private": false
        }
      ],
      "hostIp": null,
      "osType": "CentOS",
      "osName": "CentOS 8.2 64位",
      "secGroupId": null,
      "alarmTemplateId": null,
      "keyPairs": null,
      "image": null
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	[object]	true	none	返回参数
»» agentCode	string	false	none	用户编号
»» region	string	false	none	区域
»» zone	string	false	none	可用区
»» instanceCode	string	false	none	实例编号
»» instanceType	string	false	none	实例类型 host主机
»» serviceCode	string	false	none	服务编号
»» serviceStatus	string	false	none	服务状态
»» serviceStatusDesc	string	false	none	服务状态描述
»» startTime	string	false	none	服务开始时间
»» endTime	string	false	none	服务结束时间
»» goodsCode	string	false	none	商品编号
»» goodsName	string	false	none	商品名称
»» hostName	string	false	none	主机名称
»» hostState	string	false	none	主机状态
»» hostStateDesc	string	false	none	主机状态描述
»» regionName	string	false	none	区域描述
»» zoneName	string	false	none	可用区描述
»» machineType	string	false	none	主机类型:(1.OS;2.OPRO)
»» cpuPlatform	string	false	none	cpu平台:1.Intel/Auto;2.Amd/Auto;3.Intel/Broadwell
»» imageId	string	false	none	基础镜像ID（指当前自定义镜像的来源镜像）
»» imageName	string	false	none	镜像名称
»» tag	string	false	none	业务组名称
»» remark	string	false	none	备注
»» createTime	string	false	none	创建时间
»» modifyTime	string	false	none	更新时间
»» cpuCount	integer	false	none	CPU核数，单位: 个
»» memorySize	integer	false	none	内存大小，单位: MB
»» diskSet	[object]	false	none	主机绑定的磁盘集合
»»» diskType	string	false	none	磁盘类型 CLOUD_RSSD：RSSD云盘、CLOUD_SSD：SSD云盘、CLOUD_NORMAL：普通云盘
»»» isBoot	string	false	none	是否是系统盘 True是 False否
»»» encrypted	string	false	none	加密字符串
»»» type	string	false	none	类型
»»» diskId	string	false	none	磁盘ID
»»» name	string	false	none	磁盘名称
»»» drive	string	false	none	驱动
»»» size	integer	false	none	磁盘大小单位MB
»»» backupType	string	false	none	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
»»» backupNum	integer	false	none	备份数
»» ipSet	[object]	false	none	IP实例集合
»»» ipMode	string	false	none	IPv4/IPv6
»»» fDefault	string	false	none	内网 Private 类型下，表示是否为默认网卡。true: 是默认网卡；其他值：不是。
»»» mac	string	false	none	内网 Private 类型下，当前网卡的Mac。
»»» weight	integer	false	none	当前EIP的权重。权重最大的为当前的出口IP。
»»» type	string	false	none	国际: International，BGP: Bgp，内网: Private
»»» ipid	string	false	none	外网IP资源ID 。(内网IP无对应的资源ID)
»»» ip	string	false	none	IP地址
»»» bandwidth	integer	false	none	IP对应的带宽, 单位: Mb (内网IP不显示带宽信息)
»»» vpcId	string	false	none	安全组所属 VPC ID
»»» subnetId	string	false	none	IP地址对应的子网 ID。（北京一不支持，字段返回为空）
»»» networkInterfaceId	string	false	none	弹性网卡为默认网卡时，返回对应的 ID 值
»»» private	boolean	false	none	是否是内网
»» hostIp	string	false	none	主机IP
»» osType	string	false	none	操作系统类别。返回"Linux"或者"Windows"
»» osName	string	false	none	操作系统名称
»» secGroupId	string	false	none	安全组id
»» alarmTemplateId	string	false	none	告警模板id
»» keyPairs	string	false	none	密钥对数组
»» image	object	false	none	镜像
»»» zone	string	true	none	可用区 cn-wlcb-01：北京、hk-02：香港
»»» imageId	string	true	none	镜像id
»»» imageName	string	true	none	镜像名称
»»» imageOs	string	true	none	系统
»»» imageVersion	string	true	none	版本
»»» imageBit	string	true	none	位数
»»» imageLang	string	true	none	语言
»»» osType	string	true	none	操作系统类型：Linux，Windows
»»» osName	string	true	none	操作系统名称
»»» imageType	string	true	none	镜像类型标准镜像：Base，行业镜像：Business，自定义镜像：Custom
»»» imageSize	string	true	none	镜像大小
»»» state	string	true	none	镜像状态，可用：Available，制作中：Making，不可用：Unavailable，复制中：Copying
»»» tag	string	true	none	标签
»»» features	[string]	true	none	特殊状态标识，目前包含NetEnhnced（网络增强1.0） , NetEnhanced_Ultra（网络增强2.0） , HotPlug(热升级), GPU（GPU镜像） ,CloudInit, IPv6（支持IPv6网络） ,RssdAttachable（支持RSSD云盘） ,Vgpu_AMD（支持AMD的vgpu） ,Vgpu_NVIDIA（支持NVIDIA的vgpu） ,Aarch64_Type（支持arm64架构）

POST 磁盘挂载主机

POST /xcloud/v1/disk/attachDisk

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "diskCode": "07a9813954f64900b6349ada21efe404",
  "hostInstanceCode": "b36e0c49ad044cf9b8d635616c1e19eb"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	地域
» diskCode	body	string	是	磁盘实例编号
» hostInstanceCode	body	string	是	挂载主机实例编号

{
  "status": true,
  "code": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	string	true	none		返回code 200成功 400失败

POST 修改快照名称及备注名称

POST /xcloud/v1/disk/modifySnapshotNameOrRemark

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "83736c443c564d3f95146574eefbf724",
  "snapshotId": "bsrSnap-xiwa4fzhs5a",
  "snapshotDescription": "123",
  "snapshotName": "20240516000"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	地域
» instanceCode	body	string	是	磁盘实例编号
» snapshotId	body	string	是	快照id
» snapshotName	body	string	是	快照名称
» snapshotDescription	body	string	是	快照描述

{
  "status": true,
  "code": "200",
  "res": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	boolean	true	none	none

POST 修改磁盘名称

POST /xcloud/v1/disk/modifyDiskName

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceCode": "83736c443c564d3f95146574eefbf724",
  "name": "20240516midify"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	地域
» instanceCode	body	string	是	磁盘实例编号
» name	body	string	是	磁盘名称

{
  "status": true,
  "code": "200",
  "res": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	boolean	true	none	none

POST 磁盘卸载主机

POST /xcloud/v1/disk/detachDisk

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "diskCode": "07a9813954f64900b6349ada21efe404",
  "hostInstanceCode": "b36e0c49ad044cf9b8d635616c1e19eb"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	地域
» diskCode	body	string	是	磁盘实例编号
» hostInstanceCode	body	string	是	挂载主机实例编号

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

POST 获取磁盘可购买时长及折扣

POST /xcloud/v1/disk/getBuyTimeLimit

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "instanceType": "disk",
  "diskType": "CLOUD_RSSD"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	区域 cn-wlcb：北京、hk香港
» zone	body	string	是	可用区
» instanceType	body	string	是	实例类型 disk：磁盘
» diskType	body	string	是	磁盘类型

{
  "status": true,
  "code": "200",
  "res": [
    {
      "buyAmount": 1,
      "buyUnit": "M",
      "discount": 1
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	[object]	true	none	none
»» buyAmount	integer	false	none	none
»» buyUnit	string	false	none	none
»» discount	integer	false	none	none

POST 磁盘立即购买价格计算

POST /xcloud/v1/disk/calculatePrice

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "diskType": "CLOUD_RSSD",
  "boot": "False",
  "size": 80,
  "backupType": "SNAPSHOT",
  "openBackup": true,
  "name": "33333222"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次
» buyNum	body	integer	是	购买数量
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB
» diskType	body	string	是	磁盘类型
» boot	body	string	是	是否是系统盘 True是 False否
» size	body	string	是	磁盘大小单位MB
» backupType	body	string	是	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
» openBackup	body	string	是	是否开启快照

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 76,
    "originalPrice": 76,
    "buyAmount": null,
    "buyUnit": null,
    "diskPrice": null,
    "diskOriginalPrice": null,
    "diskDisCount": 1,
    "backupPrice": null,
    "backupOriginalPrice": null,
    "backupDisCount": null
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» res	object	true	none	none
»» totalPrice	integer	true	none	总价
»» originalPrice	string	true	none	原价
»» diskDisCount	string	true	none	折扣

POST 磁盘扩容立即购买价格计算

POST /xcloud/v1/disk/calculateDiskResizePrice

{
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "size": "40",
  "diskCode": "ee71355c82524d319cf7d010db84c08a"
}

请求参数

名称	位置	类型	必选	说明
» size	body	string	是	磁盘大小单位MB
» diskCode	body	string	是	磁盘实例编号
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月
» buyNum	body	integer	是	购买数量

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 34.2,
    "originalPrice": null,
    "buyAmount": 27,
    "buyUnit": "D"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» totalPrice	number	true	none	总价
»» originalPrice	null	true	none	none
»» buyAmount	integer	true	none	购买时长
»» buyUnit	string	true	none	购买单位

POST 磁盘扩容立即购买

POST /xcloud/v1/disk/resizeBuyNow

{
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "size": "80",
  "diskCode": "83736c443c564d3f95146574eefbf724"
}

请求参数

名称	位置	类型	必选	说明
» size	body	string	是	磁盘大小单位MB
» diskCode	body	string	是	磁盘实例编号
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月
» buyNum	body	integer	是	购买数量

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 34.2,
    "originalPrice": null,
    "buyAmount": 27,
    "buyUnit": "D"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» totalPrice	number	true	none	none
»» originalPrice	null	true	none	none
»» buyAmount	integer	true	none	none
»» buyUnit	string	true	none	none

POST 从快照创建磁盘立即购买价格计算

POST /xcloud/v1/disk/calculateDiskCloneBySnapshotPrice

{
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "isBoot": "False",
  "backupType": "SNAPSHOT",
  "openBackup": true,
  "name": "ceshi051303",
  "snapshotTime": 1715595531,
  "diskCode": "83736c443c564d3f95146574eefbf724"
}

请求参数

名称	位置	类型	必选	说明
» size	body	string	是	磁盘大小单位MB
» diskCode	body	string	是	磁盘实例编号
» snapshotTime	body	integer	是	从指定备份的备份时间点不能为空
» name	body	string	是	磁盘名称
» buyNum	body	number	是	购买数量
» buyUnit	body	string	是	购买时长单位
» buyAmount	body	number	是	购买时长
» backupType	body	string	是	备份类型，固定为 SNAPSHOT
» openBackup	body	boolean	是	是否开启快照

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 38,
    "originalPrice": 38,
    "buyAmount": null,
    "buyUnit": null,
    "diskPrice": null,
    "diskOriginalPrice": null,
    "diskDisCount": 1,
    "backupPrice": null,
    "backupOriginalPrice": null,
    "backupDisCount": null
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» totalPrice	integer	true	none	none
»» originalPrice	integer	true	none	none
»» buyAmount	null	true	none	none
»» buyUnit	null	true	none	none
»» diskPrice	null	true	none	none
»» diskOriginalPrice	null	true	none	none
»» diskDisCount	integer	true	none	none
»» backupPrice	null	true	none	none
»» backupOriginalPrice	null	true	none	none
»» backupDisCount	null	true	none	none

POST 从快照创建磁盘立即购买

POST /xcloud/v1/disk/buyCloneSnapshot

{
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "isBoot": "False",
  "backupType": "SNAPSHOT",
  "openBackup": true,
  "name": "ceshi051303",
  "snapshotTime": 1715595531,
  "diskCode": "83736c443c564d3f95146574eefbf724"
}

请求参数

名称	位置	类型	必选	说明
» size	body	string	是	磁盘大小单位MB
» diskCode	body	string	是	磁盘实例编号
» snapshotTime	body	integer	是	从指定备份的备份时间点不能为空
» name	body	string	是	磁盘名称
» openBackup	body	boolean	是	是否开启快照
» attachHost	body	boolean	是	是否挂载主机(必须挂载主机)
» hostInstanceCode	body	boolean	是	挂载主机实例编号

{
  "status": true,
  "code": "200",
  "res": [
    "X66457c0f13ab7ded736b7e50"
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	[string]	true	none	none

POST 磁盘克隆立即购买价格计算

POST /xcloud/v1/disk/calculateDiskClonePrice

{
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "boot": false,
  "openBackup": true,
  "backupType": "SNAPSHOT",
  "name": "8888888888",
  "diskCode": "6e253bb731f143a9bcc684aeedc9e7b6"
}

请求参数

名称	位置	类型	必选	说明
» diskCode	body	string	是	磁盘实例编号
» name	body	string	是	磁盘名称
» isOpenBackup	body	boolean	是	是否开启快照(必须开启)
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月
» buyNum	body	integer	是	购买数量
» backupType	body	string	是	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
» boot	body	boolean	是	是否是系统盘

{
  "status": true,
  "code": "200",
  "res": {
    "totalPrice": 76,
    "originalPrice": 76,
    "buyAmount": null,
    "buyUnit": null,
    "diskPrice": null,
    "diskOriginalPrice": null,
    "diskDisCount": 1,
    "backupPrice": null,
    "backupOriginalPrice": null,
    "backupDisCount": null
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» totalPrice	integer	true	none	none
»» originalPrice	integer	true	none	none
»» buyAmount	null	true	none	none
»» buyUnit	null	true	none	none
»» diskPrice	null	true	none	none
»» diskOriginalPrice	null	true	none	none
»» diskDisCount	integer	true	none	none
»» backupPrice	null	true	none	none
»» backupOriginalPrice	null	true	none	none
»» backupDisCount	null	true	none	none

POST 磁盘克隆立即购买

POST /xcloud/v1/disk/cloneBuyNow

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "diskType": "CLOUD_RSSD",
  "backupType": "SNAPSHOT",
  "openBackup": true,
  "attachHost": false,
  "hostInstanceCode": "",
  "name": "999999",
  "diskCode": "6e253bb731f143a9bcc684aeedc9e7b6"
}

请求参数

名称	位置	类型	必选	说明
» diskCode	body	string	是	磁盘实例编号
» name	body	string	是	磁盘名称
» openBackup	body	boolean	是	是否开启快照(必须开启)
» attachHost	body	boolean	是	是否挂载主机(必须挂载主机)
» hostInstanceCode	body	boolean	是	挂载主机实例编号
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月
» buyNum	body	integer	是	购买数量
» backupType	body	string	是	备份类型，DATAARK:数据方舟，SNAPSHOT:快照

{
  "status": true,
  "code": "200",
  "res": [
    "X66457d1913ab7ded736b7e51"
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	[string]	true	none	none

POST 获取磁盘可购买配置

POST /xcloud/v1/disk/getAvailableConfig

{
  "region": "cn-wlcb",
  "zone": "cn-wlcb-01",
  "buyAmount": 1,
  "buyUnit": "M",
  "buyNum": 1,
  "diskType": "CLOUD_RSSD",
  "isBoot": "False",
  "size": 80,
  "backupType": "SNAPSHOT",
  "openBackup": true,
  "name": "33333222"
}

请求参数

名称	位置	类型	必选	说明
» region	body	string	是	地域
» zone	body	string	是	可用区
» buyAmount	body	integer	是	购买时长
» buyUnit	body	string	是	购买时长单位 Y年 M月 C次
» buyNum	body	integer	是	购买数量
» cpu	body	integer	是	CPU核数，单位: 个
» memory	body	integer	是	内存大小，单位: MB
» diskType	body	string	是	磁盘类型
» isBoot	body	string	是	是否是系统盘 True是 False否
» size	body	string	是	磁盘大小单位MB
» backupType	body	string	是	备份类型，DATAARK:数据方舟，SNAPSHOT:快照
» openBackup	body	string	是	是否开启快照

{
  "status": true,
  "code": "200",
  "res": {
    "name": "cloudDisk",
    "dataDisk": [
      {
        "minimalSize": 20,
        "name": "CLOUD_RSSD",
        "maximalSize": 32000,
        "features": [
          "SNAPSHOT"
        ]
      },
      {
        "minimalSize": 20,
        "name": "CLOUD_NORMAL",
        "maximalSize": 8000,
        "features": [
          "SNAPSHOT"
        ]
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» name	string	true	none	none
»» dataDisk	[object]	true	none	none
»»» minimalSize	integer	true	none	最小容量
»»» name	string	true	none	磁盘类型名称
»»» maximalSize	integer	true	none	最大容量
»»» features	[string]	true	none	快照名称

POST 磁盘续费-获取可购买时长及折扣

POST /xcloud/v1/disk/renew/getBuyTimeLimit

{
  "instanceCode": "07a9813954f64900b6349ada21efe404",
  "instanceType": "disk"
}

请求参数

名称	位置	类型	必选	说明
» instanceCode	body	string	是	实例编号
» instanceType	body	string	是	实例类型：disk主机

{
  "status": true,
  "code": "200",
  "res": [
    {
      "buyAmount": 1,
      "buyUnit": "M",
      "discount": 1
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	none
» code	string	true	none	none
» res	object	true	none	none
»» buyAmount	integer	true	none	购买时长
»» buyUnit	string	true	none	购买时长单位
»» discount	integer	true	none	折扣

POST 查询漏洞扫描次数

POST /xcloud/v1/scan/queryScanCount

请求参数

名称	位置	类型	必选	说明
无	-	-	否	（需要传递标准参数，如时间戳authTimestamp）

{
  "status": true,
  "code": "200",
  "res": 5
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	integer	true	none	剩余扫描次数

POST 创建漏洞扫描任务

POST /xcloud/v1/scan/create

{
  "name": "test-scan",
  "targetContent": "http://example.com"
}

请求参数

名称	位置	类型	必选	说明
» name	body	string	是	任务名称
» targetContent	body	string	是	扫描目标内容

{
  "status": true,
  "code": "200",
  "res": true
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	boolean	true	none	创建是否成功

POST 查询漏洞扫描任务列表

POST /xcloud/v1/scan/list

{
  "next": 1,
  "size": 10,
  "condition": "test"
}

请求参数

名称	位置	类型	必选	说明
» next	body	integer	是	页码，从1开始
» size	body	integer	是	每页数量，建议不超过50
» condition	body	string	否	搜索条件，基于扫描任务名称和扫描内容做模糊查询

{
  "status": true,
  "code": "200",
  "res": {
    "total": 1,
    "page": 1,
    "size": 10,
    "current": 1,
    "elements": [
      {
        "id": 130,
        "agentCode": "agent35132",
        "taskCode": "7a67a901c5374d5fae760bdc4a6ccade",
        "scanId": "416",
        "scanName": "测试数据01",
        "scanContent": "www.das4d84as5d4as.cn",
        "scanInfo": "{\"createTime\":\"2025-10-17 09:23:07\",\"currentStatus\":\"9\",\"domainReverse\":\"0\",\"endTime\":\"1760664266\",\"groupId\":\"1\",\"groupName\":\"默认分类\",\"id\":\"416\",\"lastResultId\":\"434\",\"name\":\"XCLOUD_测试数据01\",\"objectName\":\"xincache-vhost-scan-report/Xinnet_漏洞扫描报告_www.das4d84as5d4as.cn_730101\",\"policyId\":\"19\",\"policyType\":\"1\",\"process\":\"100\",\"reportId\":\"407\",\"startTime\":\"1760664193\",\"subdomainDetect\":\"0\",\"targetContent\":\"www.das4d84as5d4as.cn\",\"targetType\":\"1\",\"vulHigh\":0,\"vulInfo\":1,\"vulLow\":8,\"vulMedium\":1,\"vulSum\":10,\"wafDetect\":\"1\"}",
        "scanStatus": "RUNNING_SUCCESS",
        "createTime": "2025-10-17 09:23:07"
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» res	object	true	none	结果	结果
»» total	integer	true	none	总数	none
»» page	integer	true	none	总页数	none
»» size	integer	true	none	每页条数	none
»» current	integer	true	none	当前页	none
»» elements	[object]	true	none		none
»»» id	integer	true	none	任务ID	none
»»» agentCode	string	true	none	代理编码	none
»»» taskCode	string	true	none	任务编码	none
»»» scanId	string	true	none	扫描ID	none
»»» scanName	string	true	none	扫描名称	none
»»» scanContent	string	true	none	扫描内容	none
»»» scanStatus	string	true	none	扫描状态	none
»»» createTime	string	true	none	创建时间	none
»»» scanInfo	string	true	none	扫描结果信息	none
»»»» createTime	string	true	none	创建时间	none
»»»» policyType	string	false	none	策略类型	none
»»»» policyId	string	false	none	策略ID	none
»»»» wafDetect	string	false	none	WAF检测开关	none
»»»» domainReverse	string	false	none	域名反查开关	none
»»»» subdomainDetect	string	false	none	子域名检测开关	none
»»»» lastResultId	string	false	none	最后结果ID	none
»»»» vulSum	integer	false	none	漏洞总数	none
»»»» vulHigh	integer	false	none	高危漏洞数	none
»»»» vulMedium	integer	false	none	中危漏洞数	none
»»»» vulLow	integer	false	none	低危漏洞数	none
»»»» vulInfo	integer	false	none	信息漏洞数	none
»»»» reportId	string	false	none	报告ID	none
»»»» objectName	string	false	none	对象名称	none

POST 查询漏洞扫描任务详情

POST /xcloud/v1/scan/queryInfo

{
  "scanId": "12345"
}

请求参数

名称	位置	类型	必选	说明
» scanId	body	string	是	扫描任务ID

{
  "status": true,
  "code": "200",
  "res": {
    "id": 130,
    "agentCode": "agent35132",
    "taskCode": "7a67a901c5374d5fae760bdc4a6ccade",
    "scanId": "416",
    "scanName": "测试数据01",
    "scanContent": "www.das4d84as5d4as.cn",
    "scanInfo": "{\"createTime\":\"2025-10-17 09:23:07\",\"currentStatus\":\"9\",\"domainReverse\":\"0\",\"endTime\":\"1760664266\",\"groupId\":\"1\",\"groupName\":\"默认分类\",\"id\":\"416\",\"lastResultId\":\"434\",\"name\":\"XCLOUD_测试数据01\",\"objectName\":\"xincache-vhost-scan-report/Xinnet_漏洞扫描报告_www.das4d84as5d4as.cn_730101\",\"policyId\":\"19\",\"policyType\":\"1\",\"process\":\"100\",\"reportId\":\"407\",\"startTime\":\"1760664193\",\"subdomainDetect\":\"0\",\"targetContent\":\"www.das4d84as5d4as.cn\",\"targetType\":\"1\",\"vulHigh\":0,\"vulInfo\":1,\"vulLow\":8,\"vulMedium\":1,\"vulSum\":10,\"wafDetect\":\"1\"}",
    "scanStatus": "RUNNING_SUCCESS",
    "createTime": "2025-10-17 09:23:07"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	object	true	none	返回参数
»» id	integer	true	none	任务ID
»» agentCode	string	true	none	代理编码
»» taskCode	string	true	none	任务编码
»» scanId	string	true	none	扫描ID
»» scanName	string	true	none	扫描名称
»» scanContent	string	true	none	扫描内容
»» scanStatus	string	true	none	扫描状态
»» createTime	string	true	none	创建时间
»» scanInfo	string	true	none	扫描结果信息
»»» createTime	string	true	none	创建时间
»»» policyType	string	false	none	策略类型
»»» policyId	string	false	none	策略ID
»»» wafDetect	string	false	none	WAF检测开关
»»» domainReverse	string	false	none	域名反查开关
»»» subdomainDetect	string	false	none	子域名检测开关
»»» lastResultId	string	false	none	最后结果ID
»»» vulSum	integer	false	none	漏洞总数
»»» vulHigh	integer	false	none	高危漏洞数
»»» vulMedium	integer	false	none	中危漏洞数
»»» vulLow	integer	false	none	低危漏洞数
»»» vulInfo	integer	false	none	信息漏洞数
»»» reportId	string	false	none	报告ID
»»» objectName	string	false	none	对象名称

POST 查询漏洞扫描结果列表

POST /xcloud/v1/scan/queryVul

{
  "scanId": "12345",
  "lastResultId": "0",
  "next": 1,
  "size": 10,
  "condition": ""
}

请求参数

名称	位置	类型	必选	说明
» scanId	body	string	是	扫描任务ID
» lastResultId	body	string	是	扫描结果信息的lastResultId
» next	body	integer	是	页码，从1开始
» size	body	integer	是	每页数量，建议不超过50
» condition	body	string	否	搜索条件

{
  "status": true,
  "code": "200",
  "res": {
    "total": 1,
    "page": 1,
    "size": 10,
    "current": 1,
    "elements": [
      {
        "cve": "",
        "domain": [
          "http://www.das4d84as5d4as.cn"
        ],
        "name": "SSL证书配置检测",
        "qod": 90,
        "qodType": "remote_app",
        "url": [
          "http://www.das4d84as5d4as.cn"
        ],
        "vulFamily": "安全配置错误",
        "vulLevel": 2,
        "vulOutput": [
          "http://www.das4d84as5d4as.cn"
        ],
        "vulId": "af4e5b10-31ab-423f-a16e-2057fd99edc5"
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none	状态	成功 true 失败false
» code	string	true	none	状态编码	成功200 失败400
» res	object	true	none	结果	结果
»» total	integer	true	none	总数	none
»» page	integer	true	none	总页数	none
»» size	integer	true	none	每页条数	none
»» current	integer	true	none	当前页	none
»» elements	[object]	true	none		none
»»» cve	string	false	none	CVE编号	none
»»» name	string	true	none	漏洞名称	none
»»» vulLevel	integer	true	none	漏洞等级，3:高危 2：中危 1：低危 0：信息	none
»»» vulFamily	string	false	none	漏洞分类	none
»»» domain	[string]	false	none	漏洞域名列表	none
»»» url	[string]	false	none	漏洞URL列表	none
»»» vulId	string	false	none	漏洞ID	none
»»» qod	integer	false	none	Quality of Detection	none
»»» qodType	string	false	none	QoD类型	none
»»» vulOutput	[string]	false	none	漏洞输出信息列表	none

POST 查询漏洞扫描结果详情

POST /xcloud/v1/scan/queryVulRecord

{
  "vulRecordId": "vul123"
}

请求参数

名称	位置	类型	必选	说明
» vulRecordId	body	string	是	漏洞详情ID（取查询漏洞扫描结果列表的返回结果里的vulId漏洞ID字段）

{
  "status": true,
  "code": "200",
  "res": {
    "vulId": "af4e5b10-31ab-423f-a16e-2057fd99edc5",
    "vulName": "SSL证书配置检测",
    "vulDesc": "目标Web服务未配置有效的SSL/TLS证书。未加密的通信可能导致数据泄露、中间人攻击等安全风险，建议尽快部署由可信CA签发的有效证书。",
    "vulSolu": "建议整改措施\n部署由可信CA（如Let\"s Encrypt、DigiCert等）签发的SSL证书。\n配置Web服务器强制HTTP跳转HTTPS（301重定向）。\n定期监控证书有效期，设置到期提醒，避免证书过期。\n",
    "vulRef": "",
    "cve": "",
    "cnvd": "",
    "cnnvd": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	object	true	none	返回参数
»» vulId	string	false	none	漏洞ID
»» vulName	string	false	none	漏洞名称
»» vulDesc	string	false	none	漏洞描述
»» vulSolu	string	false	none	漏洞修复建议
»» vulRef	string	false	none	漏洞参考链接
»» cve	string	false	none	CVE编号
»» cnvd	string	false	none	CNVD编号
»» cnnvd	string	false	none	CNNVD编号

POST 获取报表下载链接

POST /xcloud/v1/scan/getDownloadUrl

{
  "objectName": "report/12345.pdf"
}

请求参数

名称	位置	类型	必选	说明
» objectName	body	string	是	漏洞扫描报告文件地址

{
  "status": true,
  "code": "200",
  "res": "https://example.com/download/report/12345.pdf"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	请求状态 true成功 false失败
» code	string	true	none	返回code 200成功 400失败
» res	string	true	none	下载链接

POST 获取联系人列表

POST /xcloud/v1/account/contacts

{
  "authTimestamp": "1702452601870"
}

请求参数

名称	位置	类型	必选	说明
» authTimestamp	body	string	是	请求发起的时间戳

{
  "status": true,
  "code": "200",
  "res": [
    {
      "id": 12345,
      "agentCode": "xxxxxx",
      "contactsName": "张三"
    }
  ]
}

{
  "status": false,
  "code": "400",
  "msg": "查询联系人失败"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	false	none	描述
» res	[object]	true	none	联系人列表
»» id	integer	false	none	联系人 ID
»» agentCode	string	false	none	用户编号
»» contactsName	string	false	none	联系人姓名

POST 创建主机面板账号

POST /xcloud/v1/account/add

{
  "authTimestamp": "1702452601870",
  "account": "paneluser01",
  "password": "Abc12345!",
  "instanceCode": "bf52a05182c94b7b99e703f723dd98be",
  "instanceType": "host",
  "contactId": 12345
}

请求参数

名称	位置	类型	必选	说明
» account	body	string	是	面板登录账号名称
» password	body	string	是	账号密码（明文），长度 6-36，仅允许字母、数字及 `()`~!@#$%^&*-+=_\|{ }[]:;'"
» instanceCode	body	string	是	主机实例编号
» instanceType	body	string	是	实例类型，主机传 `host`
» contactId	body	integer	是	联系人 ID（需为当前用户下已存在的联系人）

{
  "status": true,
  "code": "200",
  "msg": "注册成功"
}

{
  "status": false,
  "code": "400",
  "msg": "账号已存在"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 重置主机面板账号密码

POST /xcloud/v1/account/update

{
  "authTimestamp": "1702452601870",
  "account": "paneluser01",
  "password": "NewAbc12345!"
}

请求参数

名称	位置	类型	必选	说明
» account	body	string	是	面板登录账号名称
» password	body	string	是	新密码（明文），长度 6-36，仅允许字母、数字及 `()`~!@#$%^&*-+=_\|{ }[]:;'"

{
  "status": true,
  "code": "200",
  "msg": "修改成功"
}

{
  "status": false,
  "code": "400",
  "msg": "账号不存在"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

POST 删除主机面板账号

POST /xcloud/v1/account/delete

{
  "authTimestamp": "1702452601870",
  "account": "paneluser01"
}

请求参数

名称	位置	类型	必选	说明
» account	body	string	是	面板登录账号名称

{
  "status": true,
  "code": "200",
  "msg": "删除成功"
}

{
  "status": false,
  "code": "400",
  "msg": "账号不存在"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» status	boolean	true	none	接口请求是否成功 true成功、false失败
» code	string	true	none	code 200 正常
» msg	string	true	none	描述

Last modified: 12 August 2026