文档首页

租户端计算裸金属服务器（BMS）数据结构

数据结构

最近更新时间: 2024-09-11 15:04:54

Filter

>描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等> * 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。> * 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。>> 以[DescribeInstances]接口的Filter为例。若我们需要查询可用区（zone）为广州一区并且实例计费模式（instance-charge-type）为包年包月或者按量计费的实例时，可如下实现：Filters.1.Name=zone&Filters.1.Values.1=ap-guangzhou-1&Filters.2.Name=instance-charge-type&Filters.2.Values.1=PREPAID&Filters.3.Values.2=POSTPAID_BY_HOUR

被如下接口引用：DescribeDisasterRecoverGroups、DescribeDisks、DescribeFlavors、DescribeHeartbeats、DescribeInstances

名称	必选	允许NULL	类型	描述
Name	是	否	String	需要过滤的字段。
Values	是	否	Array of String	字段的过滤值。

OutbandInfo

BMS映射信息详情

被如下接口引用：DescribeOutbandIP

名称	必选	允许NULL	类型	描述
InstanceId	否	否	Array of String	BMS实例ID
InstanceName	否	否	Array of String	BMS实例名称。
UniqVpcId	否	否	Array of String	私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台]查询；也可以调用接口 [DescribeVpcEx] ，从接口返回中的`unVpcId`字段获取。
Vip	否	否	Array of String	被映射的overlay IP
Vport	否	否	Array of Int64	被映射的服务器端口号

HeartbeatSet

心跳网络组详细信息

被如下接口引用：DescribeHeartbeats

名称	必选	允许NULL	类型	描述
HeartbeatId	是	否	String	心跳网络组ID
Name	是	否	String	心跳网络组名称
VlanId	是	否	String	心跳网络组所属VLAN
CurrentNum	是	否	String	绑定此心跳网络的BMS资源数
CreatedTime	是	否	Datetime	心跳网络组创建时间
UpdateTime	否	是	Datetime	心跳网络组更新时间

DelOutbandInfo

删除带外映射信息参数

被如下接口引用：DeleteOutbandIP

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	BMS实例ID
VpcId	是	否	String	私有网络ID
Vport	是	否	Int64	被映射端口号
Vip	是	否	String	被映射的underlay IP

InternetAccessible

描述了实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等

被如下接口引用：RunInstances

名称	必选	允许NULL	类型	描述
InternetMaxBandwidthOut	否	否	Int64	公网出带宽上限，单位：Mbps。默认值：0Mbps。
PublicIpAssigned	否	否	Bool	是否分配公网IP。取值范围：<br><li>TRUE：表示分配公网IP<br><li>FALSE：表示不分配公网IP<br><br>当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。
InternetServiceProvider	否	否	String	取值范围{"CTCC":电信，”CUCC“：联通，”CMCC“：移动， ”BGP“：外网CAP}

VirtualPrivateCloud

描述了VPC相关信息，包括子网，IP信息等

被如下接口引用：DescribeInstances、RunInstances

名称	必选	允许NULL	类型	描述
VpcId	是	否	String	私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台]查询；也可以调用接口 [DescribeVpcEx] ，从接口返回中的`unVpcId`字段获取。
SubnetId	是	否	String	私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台]查询；也可以调用接口 [DescribeSubnetEx]，从接口返回中的`unSubnetId`字段获取。
PrivateIpAddresses	否	否	Array of String	私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。
Ipv6Address	否	否	Bool	是否分配IPv6地址

LoginSettings

描述了实例登录相关配置与信息。

被如下接口引用：ResetInstance、RunInstances

名称	必选	允许NULL	类型	描述
Password	是	是	String	实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：<br><li>Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) `~ ! @ # $ % ^ & * - + = \| { } [ ] : ; ' , . ? / ]中的特殊符号。<br><li>Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( )` ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。<br><br>若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。
KeyIds	否	否	Array of String	密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
KeepImageLogin	否	否	String	保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围：<br><li>TRUE：表示保持镜像的登录设置<br><li>FALSE：表示不保持镜像的登录设置<br><br>默认取值：FALSE。

EnhancedService

描述了实例的增强服务启用情况与其设置，如云安全，云监控、云哨等实例 Agent

被如下接口引用：ResetInstance、RunInstances

名称	必选	允许NULL	类型	描述
SecurityService	否	否	Bool	开启云安全服务。若不指定该参数，则默认不开启云安全服务
MonitorService	否	否	Bool	开启云监控服务。若不指定该参数，则默认不开启云监控服务。
WhistleService	否	否	Bool	开启云哨监控服务。若不指定该参数，则默认不开启云哨监控服务。

Tag

标签键值对

被如下接口引用：DescribeInstances、RunInstances

名称	必选	允许NULL	类型	描述
TagKey	是	否	String	标签键
TagValue	是	否	String	标签值

Externals

扩展数据

被如下接口引用：

名称	必选	允许NULL	类型	描述

Instance

描述实例的信息

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
Placement	是	否	Placement	实例所在的位置。
InstanceId	是	否	String	实例`ID`。
InstanceName	是	否	String	实例名称。
RaidType	是	否	String	Raid类型。
OperatingSystemType	是	否	String	操作系统类型。
OperatingSystem	是	否	String	操作系统发行版本
PrivateIpAddresses	是	是	Array of String	实例主网卡的内网`IP`列表。
VirtualPrivateCloud	是	否	VirtualPrivateCloud	实例所属虚拟私有网络信息。
FlavorId	是	否	String	套餐信息。
CreatedTime	是	否	Datetime	创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。
Status	是	否	String	实例状态
CpuArch	否	否	String	CPU类型，支持X86/ARM
Tag	否	是	Array of Tag	实例标签
Uuid	否	否	String	实例用户uuid
AppId	否	否	String	实例用户AppId
UserDefined	否	否	Uint64	是否自定义机型

Disk

描述了BMS硬盘的详细信息

被如下接口引用：DescribeDisks

名称	必选	允许NULL	类型	描述
DiskId	是	否	String	硬盘ID。
Placement	是	否	Placement	硬盘所在的位置。
DiskName	是	否	String	硬盘名称。
DiskSize	是	否	String	硬盘大小。
InstanceId	是	否	String	硬盘挂载的云主机ID。
DiskType	是	否	String	云盘介质类型。取值范围：<br><li>CLOUD_BASIC：表示普通云硬<br><li>CLOUD_PREMIUM：表示高性能云硬盘<br><li>CLOUD_SSD：SSD表示SSD云硬盘。
CreatedTime	是	否	Datetime	硬盘的创建时间。

DisasterRecoverGroup

置放群组信息

被如下接口引用：DescribeDisasterRecoverGroups

名称	必选	允许NULL	类型	描述
DisasterRecoverGroupId	是	否	String	分散置放群组id。
Name	是	否	String	分散置放群组名称，长度1-60个字符。
Type	是	否	String	分散置放群组类型，取值范围：<br><li>RACK：机架层级（跨交换机）<br><li>RACK_SAME_SW：机架层级（同交换机)
CurrentNum	是	否	Int64	分散置放群组内bms服务器当前数量。
CreateTime	否	是	Datetime_iso	分散置放群组创建时间。
UpdateTime	否	是	Datetime_iso	分散置放群组更新时间。

Placement

描述了实例的抽象位置，包括其所在的可用区，所属的项目等

被如下接口引用：DescribeDisks、DescribeFlavors、DescribeInstances、RunInstances

名称	必选	允许NULL	类型	描述
Zone	是	否	String	实例所属的可用区。
ProjectId	否	否	Int64	实例所属项目ID。

OutbandInfos

带外网络信息

被如下接口引用：DescribeOutbandInfo

名称	必选	允许NULL	类型	描述
Password	是	否	String	带外密码
Sn	是	否	String	服务器sn
User	是	否	String	带外用户名

ActionTimer

定时任务

被如下接口引用：

名称	必选	允许NULL	类型	描述
TimerAction	否	否	String	定时器
ActionTime	否	否	String	执行时间
Externals	是	否	Externals	扩展数据

OperatingSystem

操作系统信息

被如下接口引用：DescribeFlavors

名称	必选	允许NULL	类型	描述
Linux	否	是	Array of String	支持的linux系统列表
Windows	否	是	Array of String	支持的windows系统列表
Other	否	是	Array of String	支持的Other系统

TagSpecification

创建云主机实例时同时绑定的标签对说明

被如下接口引用：

名称	必选	允许NULL	类型	描述
ResourceType	是	否	String	标签绑定的资源类型
Tags	是	否	Array of Tag	标签对列表

Flavor

套餐详情

被如下接口引用：DescribeFlavors

名称	必选	允许NULL	类型	描述
FlavorId	是	否	String	套餐ID。
FlavorName	是	否	String	套餐名称。
Placement	是	否	Placement	实例所在的位置。
RaidType	是	否	Array of String	支持的Raid类型。
OperatingSystem	是	否	OperatingSystem	支持的系统列表。
Cpu	是	否	String	cpu信息。
Memory	是	否	String	内存信息。
SystemDisk	是	否	String	硬盘信息。
NetSpeed	是	否	String	网卡信息
CreatedTime	是	否	Datetime_iso	创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。
FlavorType	是	否	String	计费机型
CpuArch	是	是	String	CPU机型，X86/ARM
Soldout	是	否	Uint64	售卖状态
UserDefined	是	否	Uint64	是否用户自定义机型
NetworkPorts	否	否	Int64	机型网口数
DcosShell	否	否	String	dcos后置脚本