平安云 - 云以致用智造未来

ListDedicatedEbsProductSeries

接口描述

查询专属云磁盘产品系列

请求参数

参数名称	参数类型	是否必须	参数描述	备注
InstanceProductSeriesId	String	是	云主机实例产品系列Id
RegionId	String	否	地域
ZoneId	String	否	可用区

响应参数

参数名称	参数类型	参数描述	备注
ProductSeries	List<ProductSeriesBean>	产品系列信息列表

CreateDedicatedHost

接口描述

创建专属宿主机
专属宿主机有自己独有的标签确定专属宿主机

请求参数

参数名称	参数类型	是否必须	参数描述	备注
ZoneId	String	是	可用区Id 专属宿主机的可用区,创建的时候由用户选择必传字段,类型：n(正整数);
PodId	String	是	高可用域Id 专属宿主机的高可用域,创建的时候由用户选择必传字段,类型：n(正整数) 会进行实体校验,校验失败,抛出异常 InvalidParameterException
HostTypeId	String	是	产品规格Id 产品类型,管理员配置属性必传字段会进行实体校验,校验失败,抛出异常 InvalidParameterException
VirtaulType	HypervisorType	是	虚拟类型专属宿主机默认类型 KVM 必传字段
ChargeType	ChargeType	是	计费方式专属宿主机暂只支持月付费必传字段
Period	Integer	是	期数必传字段
Count	Integer	是	数量必传字段
DisplayName	String	否	显示名称必传字段请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符

响应参数

参数名称	参数类型	参数描述	备注
ChargeType	ChargeType	计费类型专属宿主机目前只支持包月
ProductCode	String	产品标识码专属宿主机的产品标识
OrderId	String	订单Id
Status	OrderStatus	订单状态
ProductCode	String	产品标识码专属宿主机的产品标识

DestroyDedicatedHost

接口描述

删除专属宿主机
如果选择删除的专属宿主机状态为 : Pending Destroying Destroyed 会抛出 PacloudException
删除的宿主机为软删除，修改状态 EnableFlag =false 以及status = destroyed

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属宿主机Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException

响应参数

参数名称

参数类型

参数描述

备注

GetDedicatedEcsSummary

接口描述

获取专属宿主机概览
获取专属宿主机的相关信息如：台数,内存大小,cpu,磁盘空间,实例总数等
入参为 regionID

请求参数

参数名称	参数类型	是否必须	参数描述	备注
RegionId	String	是	地域Id 必传字段,会进行实体校验,判断是否存在该地域，校验不过抛出异常 InvalidParameterException

响应参数

参数名称	参数类型	参数描述	备注
HostSum	Long	宿主机总数单位:台
InstanceSum	Long	云主机实例总数单位：个
DiskSum	Long	磁盘总数单位：个

ListDedicatedHostTypes

接口描述

查询专属宿主机规格
支持专属宿主机规格查询，专属宿主机规格为管理员配置
用于创建专属宿主机提供规格配置

请求参数

参数名称	参数类型	是否必须	参数描述	备注
RegionId	String	是	地域Id 必传字段数据来自于 base 服务
ZoneId	String	是	可用域id 必传字段数据来自于 base 服务
PodUuid	String	是	高可用域id 必传字段数据来自于 iaas 服务

响应参数

参数名称	参数类型	参数描述	备注
DedicatedHostTypes	List<DedicatedHostTypeBean>	专属宿主机规格信息列表管理员配置的专属宿主机规格信息包含定价，内存，cpu 等信息详情点开Bean
TotalCount	Long	专属宿主机总数所有配置的有效专属宿主机总数

ListDedicatedHosts

接口描述

查询专属宿主机
分页查询专属宿主机，支持条件查询，支持排序，默认 id desc 排序方式

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Name	String	否	专属宿主机名称
ZoneName	String	否	可用区名称专属宿主机在创建需要选定具体可用区，例如可用区A。可以通过ListZonesAction接口查询可用区信息。
Status	HostStatus[]	否	专属宿主机状态判断当前宿主机的创建或运行状态
PageNumber	Integer	否	分页页码
PageSize	Integer	否	分页大小
OrderBy	String	否	排序关键字默认按时间排序
OrderType	String	否	排序方式排序方式有DESC和ASC,默认按DESC排序
RegionId	String	否	地域Id 会进行实体校验,数据来源于 base 服务 ,不存在该实体校验失败,抛出异常 InvalidParameterException
PodId	String	否	高可用域Id 会进行实体校验,数据来源于 iaas 服务 ,不存在该实体校验失败,抛出异常 InvalidParameterException
ZoneId	String	否	可用区Id 会进行实体校验,数据来源于 base 服务 ,不存在该实体校验失败,抛出异常 InvalidParameterException

响应参数

参数名称	参数类型	参数描述	备注
DedicatedHosts	List<DedicatedHostBean>	专属宿主机信息列表用于专属宿主机页面展示详细信息
TotalCount	Long	数量有效专属宿主机数量

ModifyHostAttribute

接口描述

修改专属宿主机属性
主要针对专属宿主机 disPlayName 提供修改。
根据 uuid 找到对应专属宿主机，修改disPlayName属性

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属宿主机Id 会进行实体校验,数据来自于 Table:dedicated_host 校验失败,抛出异常 InvalidParameterException
DisplayName	String	否	专属宿主机显示名称请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符

响应参数

参数名称

参数类型

参数描述

备注

RenewDedicatedHost

接口描述

专属宿主机续费
专属宿主机续费需要校验宿主机续费类型是否为包月否则抛出异常 IncorrectStatusException
续费条件包括专属宿主机状态不能为Pending Createfial Destory 等失效状态
针对新的期数进行续费

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属宿主机Id 会进行实体校验,数据来自于 Table:dedicated_host 校验失败,抛出异常 InvalidParameterException
Period	Integer	是	专属宿主机续费期数

响应参数

参数名称	参数类型	参数描述	备注
OrderId	String	订单Id
Status	OrderStatus	订单状态
ProductCode	String

ChangeDedicatedInstanceType

接口描述

修改专属云主机规格
修改规格期间,主机必须关机,修改值跟原值有差异,配额有效机器无其他操作等,否则抛出异常 InvalidParameterException
修改为异步 job 任务方式执行,返回jobuuid 可根据jobuuid 查看任务是否执行成功

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属云主机Id 必传字段
CPUNumber	Integer	是	专属云主机 CPU 核数必传字段
Memory	Integer	是	专属云主机内存必传字段

响应参数

参数名称	参数类型	参数描述	备注
JobId	String	任务 Id

DestroyDedicatedInstance

接口描述

删除专属云主机实例
只支持停止状态、创建失败状态的云主机进行删除
接口为异步 job 执行删除返回job uuid 可查询jobuuid 看任务是否执行成功

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属云主机Id 必传字段会进行实体校验,校验失败,抛出异常 InvalidParameterException
CheckDependency	Boolean	否	是否检查资源依赖关系，默认true 在删除的如果检测到有依赖关系则需要先删除依赖资源

响应参数

参数名称	参数类型	参数描述	备注
JobId	String	任务 Id

ListDedicatedInstanceCpus

接口描述

查询所有专属云主机类型的cpu
获取所有专属云主机核心数种类

请求参数

参数名称

参数类型

是否必须

参数描述

备注

响应参数

参数名称	参数类型	参数描述	备注
Cpus	List<Integer>	专属云主机CPU信息列表

ListDedicatedInstanceMemorys

接口描述

查询所有专属云主机的内存
获取所有专属云主机所有内存种类

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Cpu	Integer	否	专属云主机CPU数专属物理机上创建的云主机的CPU 核心数

响应参数

参数名称	参数类型	参数描述	备注
Memorys	List<Integer>	专属云主机内存信息列表

ListDedicatedInstanceTypes

接口描述

根据专属系列查询专属规格

请求参数

参数名称	参数类型	是否必须	参数描述	备注
ProductSeriesId	String	是	产品系列Id 可以通过ListProductSeries接口查询产品系列信息。。

响应参数

参数名称	参数类型	参数描述	备注
InstanceTypeBeanList	List<InstanceTypeBean>	云主机类型信息列表

RunDedicatedInstances

接口描述

创建专属云主机
批量创建专属云主机在专属宿主机上
创建为异步创建返回jobuuid 可用返回的uuid 去查询是否创建成功

请求参数

参数名称	参数类型	是否必须	参数描述	备注
RegionId	String	是	地域Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListRegionsAction 查询详细信息
ZoneId	String	是	可用区Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListZonesAction 查询详细信息
PodId	String	是	高可用域Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListPodsAction 查询详细信息
NetworkId	String	否	网络域Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListNetWorksAction 查询详细信息
SubnetId	String	否	子网Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListSubnetsAction 查询详细信息
ImageId	String	是	操作系统镜像Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListImagesAction 查询详细信息
DisplayName	String	否	显示名称请填写中文, 英文字母, 数字, 空格，@ 和 _, -, 最长128个字符
Count	Integer	是	数量
FunctionNames	String	否	方法名称安全配置用于判断是否安装免费HIDS
DiskType	String	否	产品规格必传字段,可通过base 服务 DTO 方式查询详细信息门户中每种云磁盘类型都对应着相应的云磁盘产品规格，例如SSD型云硬盘对应的产品规格名称为ebs.s1。
DiskSizes	Integer	否	磁盘大小列表单个磁盘的大小取值范围为20-2000
DiskCount	Integer	否	磁盘数量
HostId	String	是	主机Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过ListDedicatedHostsAction 查询详细信息
VmhostNames	String[]	否	虚拟机主机名称列表每个主机名以字母开头, 允许字母, 数字, -, 最长45个字符多个主机名称以英文逗号隔开
SecurityGroupId	String	否	安全组Uuid
InstanceType	String	是	产品规格
GeneratePasswordType	GeneratePasswordType	否	云主机生成密码方式，默认为自定义
CustomPassword	String	否	自定义密码，若密码生成方式为Custom(自定义),则keyId为必传参数请输入8 - 16 个字符，必须同时包含三项（大写字母A-Z、小写字母a-z、数字0-9、 !@#$%^& 中的特殊符号）
PrivateKey	String	否	私钥
Ip	String	否	指定ip, 多个ip需进行字符串拼接，ip之间使用英文逗号(,)进行分隔
IsSpecifyIp	Boolean	否	是否指定ip true:表示指定 false:表示不指定

响应参数

参数名称	参数类型	参数描述	备注
JobIds	List<String>

StartDedicatedInstance

接口描述

启动专属云主机
启动的云主机状态不能为 Stopped 否则抛出异常 IncorrectStatusException
接口为异步job 执行返回job uuid 可根据job uuid 查询任务执行情况

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属云主机 UUId 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过 ListInstancesAction 查询详细信息

响应参数

参数名称	参数类型	参数描述	备注
JobId	String	任务 Id

StopDedicatedInstance

接口描述

关闭专属云主机
在Running 的云主机不可关闭
接口为异步 job 接口返回job uuid 可根据uuid 查询接口关闭任务是否执行成功

请求参数

参数名称	参数类型	是否必须	参数描述	备注
Id	String	是	专属云主机Id 会进行实体校验,校验失败,抛出异常 InvalidParameterException 必传字段,可通过 ListInstancesAction 查询详细信息

响应参数

参数名称	参数类型	参数描述	备注
JobId	String	任务 Id

以上内容是否解决了您的问题？是否