API描述

<p><strong>1. ListBmsTypes</strong></p> <p><strong>接口描述</strong></p> <p>列出BMS类型</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>regionId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>地域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>zoneId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>可用区</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>podId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>高可用域UUID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>productSeriesId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>产品系列</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>ProductSeries</p> </td> <td> <p>List&lt;ProductSeriesBean&gt;</p> </td> <td> <p>产品系列信息列表</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>2. CreateBmsInstance</strong></p> <p><strong>接口描述</strong></p> <p>创建BMS物理机</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>regionId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>地域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>zoneId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>可用区</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>podId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>高可用域UUID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>bmsHadomainId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>高可用域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>bmsTypeCode</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>物理机类型</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>vpcId</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>私有网络</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>networkId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>subnetId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>子网</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>bmsOsTypeCode</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>操作系统类型</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>raidType</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>磁盘阵列类型</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>displayName</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>显示名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>count</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>数量</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>period</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>月数</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>initPassword</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>自定义登陆密码</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>hostName</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>自定义主机名</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>autoRenewflag</p> </td> <td> <p>Boolean</p> </td> <td> <p>是</p> </td> <td> <p>自动续费标识</p> <ul> <li>true为自动续费</li> <li>false为否</li> </ul> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>jobId</p> </td> <td> <p>String</p> </td> <td> <p>任务ID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>3. ListBmsInstances</strong></p> <p><strong>接口描述</strong></p> <p>列出BMS实例</p> <p><strong>请求参数</strong></p> <table border="1"> <thead> <tr> <th> <p>参数名称</p> </th> <th> <p>参数类型</p> </th> <th> <p>是否必须</p> </th> <th> <p>参数描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>id</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>实例ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>name</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>实例名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>privateIpAddress</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>私有IP地址</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>zoneId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>可用区</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>regionId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>地域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>status</p> </td> <td> <p>BmsInstanceStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>状态</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>errorFlag</p> </td> <td> <p>BmsInstanceErrorStatus[]</p> </td> <td> <p>否</p> </td> <td> <p>错误标记</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>pageNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>页码</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>pageSize</p> </td> <td> <p>Integer</p> </td> <td> <p>否</p> </td> <td> <p>每页条数</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>securityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>安全组UUID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>notSecurityGroupId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>非安全组UUID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>networkId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>网络域ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>uuids</p> </td> <td> <p>String[]</p> </td> <td> <p>否</p> </td> <td> <p>物理机UUID数组列表</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>vpcId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>VPC的UUID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>totalCount</p> </td> <td> <p>Long</p> </td> <td> <p>总条数</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>bmsInstances</p> </td> <td> <p>List&lt;BmsInstanceBean&gt;</p> </td> <td> <p>物理机实例列表</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>4. StopBmsInstance</strong></p> <p><strong>接口描述</strong></p> <p>关闭物理机</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>id</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>实例ID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>jobId</p> </td> <td> <p>String</p> </td> <td> <p>任务ID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>5. StartBmsInstance</strong></p> <p><strong>接口描述</strong></p> <p>启动物理机</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>id</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>实例ID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <thead> <tr> <th> <p>参数名称</p> </th> <th> <p>参数类型</p> </th> <th> <p>参数描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>jobId</p> </td> <td> <p>String</p> </td> <td> <p>任务ID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>6. GetBmsInstance</strong></p> <p><strong>接口描述</strong></p> <p>查询物理机详情</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>id</p> </td> <td> <p>String</p> </td> <td> <p>是</p> </td> <td> <p>实例ID</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <thead> <tr> <th> <p>参数名称</p> </th> <th> <p>参数类型</p> </th> <th> <p>参数描述</p> </th> <th> <p>备注</p> </th> </tr> </thead> <tbody> <tr> <td> <p>regionId</p> </td> <td> <p>String</p> </td> <td> <p>地域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>regionInnerId</p> </td> <td> <p>Long</p> </td> <td> <p>地域ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>regionCode</p> </td> <td> <p>String</p> </td> <td> <p>地域编码</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>regionName</p> </td> <td> <p>String</p> </td> <td> <p>地域名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>zoneInnerId</p> </td> <td> <p>String</p> </td> <td> <p>可用区</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>zoneCode</p> </td> <td> <p>String</p> </td> <td> <p>可用区编码</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>zoneName</p> </td> <td> <p>String</p> </td> <td> <p>可用区名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>hadomianId</p> </td> <td> <p>String</p> </td> <td> <p>高可用域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>hadomainCode</p> </td> <td> <p>String</p> </td> <td> <p>高可用域编码</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>hadomainName</p> </td> <td> <p>String</p> </td> <td> <p>高可用域名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>networkName</p> </td> <td> <p>String</p> </td> <td> <p>网络域名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>networkId</p> </td> <td> <p>String</p> </td> <td> <p>网络域</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>subnetName</p> </td> <td> <p>String</p> </td> <td> <p>子网络名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>subnetId</p> </td> <td> <p>String</p> </td> <td> <p>子网络ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>vpcName</p> </td> <td> <p>String</p> </td> <td> <p>私有网络名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>vpcId</p> </td> <td> <p>String</p> </td> <td> <p>私有网络ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>osTypeId</p> </td> <td> <p>String</p> </td> <td> <p>操作系统ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>osTypeCode</p> </td> <td> <p>String</p> </td> <td> <p>操作系统名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>bmsType</p> </td> <td> <p>String</p> </td> <td> <p>物理机类型</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>id</p> </td> <td> <p>String</p> </td> <td> <p>实例ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>name</p> </td> <td> <p>String</p> </td> <td> <p>实例名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>raidType</p> </td> <td> <p>String</p> </td> <td> <p>磁盘阵列类型</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>privateIpAddress</p> </td> <td> <p>String</p> </td> <td> <p>私有IP地址</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>displayName</p> </td> <td> <p>String</p> </td> <td> <p>显示名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>initUsername</p> </td> <td> <p>String</p> </td> <td> <p>初始用户名</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>initPassword</p> </td> <td> <p>String</p> </td> <td> <p>初始密码</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>cpuNumber</p> </td> <td> <p>Integer</p> </td> <td> <p>CPU数量</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>memory</p> </td> <td> <p>Integer</p> </td> <td> <p>内存</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>createDate</p> </td> <td> <p>Timestamp</p> </td> <td> <p>创建日期</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>createAccount</p> </td> <td> <p>String</p> </td> <td> <p>创建账户</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>productSeriesId</p> </td> <td> <p>String</p> </td> <td> <p>产品系列</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>productSeriesInnerId</p> </td> <td> <p>Long</p> </td> <td> <p>产品系列ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>productSeriesName</p> </td> <td> <p>String</p> </td> <td> <p>产品系列名称</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>unitPrice</p> </td> <td> <p>String</p> </td> <td> <p>单价</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>expirationTime</p> </td> <td> <p>Date</p> </td> <td> <p>到期时间</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>autoRenewflag</p> </td> <td> <p>Boolean</p> </td> <td> <p>自动续费标志</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>forbidFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>禁止操作标志</p> <ul> <li>true为禁止操作</li> <li>false为否</li> </ul> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>natIp</p> </td> <td> <p>String</p> </td> <td> <p>vpc3.1 nat ip</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>keyId</p> </td> <td> <p>String</p> </td> <td> <p>关联密钥对ID</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>cidsFlag</p> </td> <td> <p>Boolean</p> </td> <td> <p>注册cids标志</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>sn</p> </td> <td> <p>String</p> </td> <td> <p>物理机sn</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>osCategory</p> </td> <td> <p>String</p> </td> <td> <p>操作系统大类</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>tpmMonitorFlag</p> </td> <td> <p>String</p> </td> <td> <p>tpm信息监控标识:</p> <ul> <li>Y为开</li> <li>N为关(N时不会收到邮件信息提醒)</li> </ul> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>ioUuid</p> </td> <td> <p>String</p> </td> <td> <p>规则主机名。根据规则定义生成的主机名</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>networkCard</p> </td> <td> <p>String</p> </td> <td> <p>网卡信息</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>gpuCard</p> </td> <td> <p>String</p> </td> <td> <p>gpu卡信息</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>7. GetBmsSummary</strong></p> <p><strong>接口描述</strong></p> <p>查询物理机概览</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>regionId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>地域</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>bmsInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>快过期物理机实例总数(&lt;7天)</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>expiredBmsInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>已过期物理机实例总数</p> </td> <td>&nbsp;</td> </tr> <tr> <td> <p>bmsInstanceSum</p> </td> <td> <p>Long</p> </td> <td> <p>物理机实例总数</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p>&nbsp;</p> <p><strong>8. getBmsInstanceOverallView</strong></p> <p><strong>接口描述</strong></p> <p>获取物理机实例总览</p> <p><strong>请求参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>是否必须</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>regionId</p> </td> <td> <p>String</p> </td> <td> <p>否</p> </td> <td> <p>地域</p> </td> <td>&nbsp;</td> </tr> </tbody> </table> <p><strong>响应参数</strong></p> <table border="1"> <tbody> <tr> <td> <p><strong>参数名称</strong></p> </td> <td> <p><strong>参数类型</strong></p> </td> <td> <p><strong>参数描述</strong></p> </td> <td> <p><strong>备注</strong></p> </td> </tr> <tr> <td> <p>bmsInstanceOverallViewBeans</p> </td> <td> <p>List&lt;BmsInstanceOverallViewBean&gt;</p> </td> <td> <p>物理机实例总览信息列表</p> </td> <td>&nbsp;</td> </tr> </tbody> </table>
以上内容是否解决了您的问题?
请补全提交信息!
联系我们

电话咨询

400-151-8800

邮件咨询

fincloud@ocft.com

在线客服

工单支持

解决云产品相关技术问题