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

数据结构

最近更新时间: 2025-03-12 16:34:37

InternetAccessible

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

被如下接口引用：RunInstances

名称 必选 允许NULL 类型 描述
InternetMaxBandwidthOut 否 否 Int64 公网出带宽上限，单位：Mbps。默认值：0Mbps。
示例值： 100
PublicIpAssigned 否 否 Bool 是否分配公网IP。取值范围：
  • TRUE：表示分配公网IP
  • FALSE：表示不分配公网IP

    当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。
    示例值： 1
    		•
    InternetServiceProvider 否 否 String 取值范围{"CTCC":电信，”CUCC“：联通，”CMCC“：移动， ”BGP“：外网CAP}
    示例值： CMCC

    Disk

    描述了BMS硬盘的详细信息

    被如下接口引用：DescribeDisks

    名称 必选 允许NULL 类型 描述
    DiskId 是 否 String 硬盘ID。
    示例值： dcsk_id
    Placement 是 否 Placement 硬盘所在的位置。
    示例值：查看
    DiskName 是 否 String 硬盘名称。
    示例值： dcsk_name
    DiskSize 是 否 String 硬盘大小。
    示例值： 100G
    InstanceId 是 否 String 硬盘挂载的云主机ID。
    示例值： bms-adafghjk
    DiskType 是 否 String 云盘介质类型。取值范围：
  • CLOUD_BASIC：表示普通云硬
  • CLOUD_PREMIUM：表示高性能云硬盘
  • CLOUD_SSD：SSD表示SSD云硬盘。
    示例值： disk
    		•
    CreatedTime 是 否 Datetime 硬盘的创建时间。
    示例值： 2014-08-03 12:00:00

    DelOutbandInfo

    删除带外映射信息参数

    被如下接口引用：DeleteOutbandIP

    名称 必选 允许NULL 类型 描述
    InstanceId 是 否 String BMS实例ID
    示例值： bms-adafghjk
    VpcId 是 否 String 私有网络ID
    示例值： 65535
    Vport 是 否 String 被映射端口号
    示例值： 80
    Vip 是 否 String 被映射的underlay IP
    示例值： 10.10.10.10

    DeleteImageSet

    删除image信息出参

    被如下接口引用：DeleteImage

    名称 必选 允许NULL 类型 描述
    Detail 否 否 String Detail
    示例值： success
    ImageName 否 否 String ImageName
    示例值： img-fc45e643
    Result 否 否 String Result
    示例值： 0
    ImageId 否 否 String ImageId
    示例值： image-adfasdf

    OSDictionarySet

    用户自定义镜像详细信息

    被如下接口引用：DescribeImageList

    名称 必选 允许NULL 类型 描述
    ImageId 是 否 Int64 镜像ID
    示例值： image-adsfghjk
    ImageName 是 否 String 镜像名
    示例值： img-fc45e643
    ImageStatus 否 是 Int64 镜像状态
    示例值： 1
    ImageSize 否 是 String 镜像大小
    示例值： 100G
    OsType 否 是 String 系统类型
    示例值： Linux
    SystemArch 否 是 String 系统架构
    示例值： X86
    SystemPlatform 否 是 String 系统平台
    示例值： redhat
    SystemVersions 否 是 String 系统版本
    示例值： 7.2
    ImageDescribe 否 是 String 镜像描述
    示例值： 11CentOS-7-aarch64-Everything-2009 (1).iso
    ImageType 否 是 Int64 镜像类型
    示例值： 0
    ImageUrl 否 是 String 镜像url
    示例值： https://bms-arm-1255000076.cos.ap-shenzhen-region-jcctest
    AvailableModel 否 是 Int64 镜像使用服务器设备类型(0:通用服务器;1:黑石服务器)
    示例值： 1
    ImageFormat 否 是 String 镜像格式(iso/sqfs)
    示例值： ISO
    ZoneName 否 是 String 镜像所在可用区
    示例值： 50001000
    ImageAlias 否 是 String 镜像别名
    示例值： cetenos

    Externals

    扩展数据

    被如下接口引用：

    名称 必选 允许NULL 类型 描述

    TagSpecification

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

    被如下接口引用：

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

    LoginSettings

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

    被如下接口引用：ResetInstance、RunInstances

    名称 必选 允许NULL 类型 描述
    Password 是 是 String 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：
  • Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = 
    		•
    KeyIds 否 否 Array of String 密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
    示例值： key123
    KeepImageLogin 否 否 String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围：
  • TRUE：表示保持镜像的登录设置
  • FALSE：表示不保持镜像的登录设置

    默认取值：FALSE。
    示例值： TRUE
    		•

    Instance

    描述实例的信息

    被如下接口引用：DescribeInstances

    名称 必选 允许NULL 类型 描述
    Placement 是 否 Placement 实例所在的位置。
    示例值：查看
    InstanceId 是 否 String 实例ID。
    示例值： bms-adafghjk
    InstanceName 是 否 String 实例名称。
    示例值： bms_name
    RaidType 是 否 String Raid类型。
    示例值： NORAID
    OperatingSystemType 是 否 String 操作系统类型。
    示例值： Linux
    OperatingSystem 是 否 String 操作系统发行版本
    示例值： tlinux2.1
    PrivateIpAddresses 是 是 Array of String 实例主网卡的内网IP列表。
    示例值： 10.10.10.10
    VirtualPrivateCloud 是 否 VirtualPrivateCloud 实例所属虚拟私有网络信息。
    示例值：查看
    FlavorId 是 否 String 套餐信息。
    示例值： flavor-sadfghjhk
    CreatedTime 是 否 Datetime 创建时间。按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。
    示例值： 2014-08-03 12:00:00
    Status 是 否 String 实例状态
    示例值： 0
    CpuArch 否 否 String CPU类型，支持X86/ARM
    示例值： X86
    Tag 否 是 Array of Tag 实例标签
    示例值：查看
    Uuid 否 否 String 实例用户uuid
    示例值： dsaf-fadsf-gerwafga
    AppId 否 否 String 实例用户AppId
    示例值： 110000002171
    UserDefined 否 否 Uint64 是否自定义机型
    示例值： 0
    PrivateIpv6Addresses 否 否 String IPV6地址
    示例值： FF01::101
    GroupId 否 否 String 置放群组ID
    示例值： ps-asdfghjk
    HeartbeatId 否 否 String 心跳组ID
    示例值： HB-asdfghjk
    BackupIPs 否 否 String 备用IP
    示例值： 10.10.10.10

    VirtualPrivateCloud

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

    被如下接口引用：DescribeInstances、RunInstances

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

    ActionTimer

    定时任务

    被如下接口引用：

    名称 必选 允许NULL 类型 描述
    TimerAction 否 否 String 定时器
    示例值：  2014-08-02 
    ActionTime 否 否 String 执行时间
    示例值：  2014-08-02 
    Externals 是 否 Externals 扩展数据
    示例值：查看

    Flavor

    套餐详情

    被如下接口引用：DescribeFlavors

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

    OutbandInfos

    带外网络信息

    被如下接口引用：DescribeOutbandInfo

    名称 必选 允许NULL 类型 描述
    Password 是 否 String 带外密码
    示例值： pass_word
    Sn 是 否 String 服务器sn
    示例值： adfsadg44ads584f
    User 是 否 String 带外用户名
    示例值： bms

    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、DescribeImageList、DescribeInstances

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

    HeartbeatSet

    心跳网络组详细信息

    被如下接口引用：DescribeHeartbeats

    名称 必选 允许NULL 类型 描述
    HeartbeatId 是 否 String 心跳网络组ID
    示例值： HB-asdfghjk
    Name 是 否 String 心跳网络组名称
    示例值： Name
    VlanId 是 否 String 心跳网络组所属VLAN
    示例值： test
    CurrentNum 是 否 String 绑定此心跳网络的BMS资源数
    示例值： 100
    CreatedTime 是 否 Datetime 心跳网络组创建时间
    示例值： 2014-08-03 12:00:00
    UpdateTime 否 是 Datetime 心跳网络组更新时间
    示例值： 2014-08-03 12:00:00

    BMCUserTasksResponse

    重置带外结果

    被如下接口引用：ResetOutbandInfo

    名称 必选 允许NULL 类型 描述
    Detail 否 否 String 任务详情
    示例值： success
    Result 否 否 Int64 任务结果
    示例值： 0
    SvrSn 否 否 String 服务器sn
    示例值： 218551302
    TaskId 否 否 String 任务ID
    示例值： 2ff48d5a-f7de-4653-88fd-54e94f75fd60

    EnhancedService

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

    被如下接口引用：ResetInstance、RunInstances

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

    Tag

    标签键值对

    被如下接口引用：DescribeInstances、RunInstances

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

    Placement

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

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

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

    OutbandInfo

    BMS映射信息详情

    被如下接口引用：DescribeOutbandIP

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

    DisasterRecoverGroup

    置放群组信息

    被如下接口引用：DescribeDisasterRecoverGroups

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

    ImageFieldsEnumSet

    镜像管理个字段枚举值出参

    被如下接口引用：

    名称 必选 允许NULL 类型 描述
    OsType 否 否 Array of String 操作系统枚举值
    示例值： linux
    SystemArch 否 否 Array of String 系统架构枚举值
    示例值： X86
    SystemPlatform 否 否 Array of String 系统平台枚举值
    示例值： redhat
    ImageType 否 否 Array of String 镜像格式枚举值
    示例值： 1
    ZoneName 否 否 Array of String 可用区枚举值
    示例值： 50001000
    ImageFormat 否 否 Array of String 镜像格式;IOS/sqfs/等
    示例值： ISO

    OperatingSystem

    操作系统信息

    被如下接口引用：DescribeFlavors

    名称 必选 允许NULL 类型 描述
    Linux 否 是 Array of String 支持的linux系统列表
    示例值： tlinux2.4
    Windows 否 是 Array of String 支持的windows系统列表
    示例值： win2000
    Other 否 是 Array of String 支持的Other系统
    示例值： kylin