数据结构

最近更新时间: 2026-11-07 00:16:28

SecurityGroup

安全组对象

被如下接口引用：DescribeSecurityGroups

名称 必选 允许NULL 类型 描述
SecurityGroupId 否 否 String 安全组实例ID，例如：sg-ohuuioma。
示例值： sg-ohuuioma。
SecurityGroupName 否 否 String 安全组名称，可任意命名，但不得超过60个字符。
示例值： security_for_bms
CreatedTime 否 否 Datetime_iso 安全组创建时间。
示例值： 2024-08-20T12:00:00+08:00:00

SecurityGroupPolicy

安全组规则对象

被如下接口引用：CreateSecurityGroupPolicies

名称 必选 允许NULL 类型 描述
Protocol 是 否 String 协议, 取值范围: TCP,UDP, ICMP。
示例值： TCP
Port 是 否 String 端口(all, 离散port,  range)。
示例值： 80
CidrBlock 是 否 String 网段或IP(互斥)。
示例值： 10.10.10.10
SecurityGroupId 是 否 String 安全组实例ID，例如：sg-ohuuioma。
示例值： sg-ohuuioma
Action 是 否 String ACCEPT 或 DROP。
示例值： ACCEPT 
PolicyDescription 否 否 String 安全组规则描述。
示例值： security for bms

OutbandInfo

BMS映射信息详情

被如下接口引用：DescribeOutbandIP

名称 必选 允许NULL 类型 描述
InstanceId 否 否 String BMS实例ID
示例值： bms-adafghjk
InstanceName 否 否 String BMS实例名称。
示例值： bms_name
UniqVpcId 否 否 String 私有网络ID
示例值： vpc-adffghjk
Vip 否 否 String 被映射的overlay IP
示例值： 10.10.10.10
Vport 否 否 String 被映射的服务器端口号
示例值： 80(KVM)
UniqSubnetId 否 否 String 子网信息
示例值： sunnet-1s2o5fdl

DeleteImageSet

删除image信息出参

被如下接口引用：DeleteImage

名称 必选 允许NULL 类型 描述
Detail 否 否 String Detail
示例值： success
ImageName 否 否 String ImageName
示例值： img-fc45e643
Result 否 否 Int64 Result，0代表删除成功
示例值： 0
ImageId 否 否 String ImageId
示例值： e4f1da-4076-4b04-8de8-fbd4cc72d463

SecurityGroupPolicySetUpdate

安全组规则集合

被如下接口引用：DescribeSecurityGroupPolicies、UpdateSecurityGroupPolicy

名称 必选 允许NULL 类型 描述
Egress 否 否 Array of SecurityGroupPolicyUpdate 出站规则。
示例值：查看
Ingress 否 否 Array of SecurityGroupPolicyUpdate 入站规则。
示例值：查看

VirtualPrivateCloud

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

被如下接口引用：DescribeInstances、RunInstances

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

HeartbeatSet

心跳网络组详细信息

被如下接口引用：DescribeHeartbeats

名称 必选 允许NULL 类型 描述
HeartbeatId 是 否 String 心跳网络组ID
示例值： HB-asdfghjk
Name 是 否 String 心跳网络组名称
示例值： Name
VlanId 是 否 String 心跳网络组所属VLAN
示例值： 2025
CurrentNum 是 否 Int64 绑定此心跳网络的BMS资源数
示例值： 100
CreateTimeIso 否 否 Datetime_iso 心跳网络组创建时间
示例值： 2024-09-11T11:30:50+08:00
UpdateTimeIso 否 否 Datetime_iso 心跳网络组更新时间
示例值： 2024-09-11T11:30:50+08:00

Tag

标签键值对

被如下接口引用：DescribeInstances、RunInstances

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

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
FlavorType 是 否 String 计费机型
示例值： M101-A3
CpuArch 是 是 String CPU机型，X86/ARM
示例值： X86
Soldout 是 否 Uint64 售卖状态
示例值： 0
UserDefined 是 否 Uint64 是否用户自定义机型
示例值： 0
CreateTimeIso 否 否 Datetime_iso ISO格式创建时间
示例值： 2024-09-11T11:30:50+08:00
NetworkPorts 否 否 Int64 机型网口数
示例值： 2
DcosShell 否 否 String dcos后置脚本
示例值： dcos.sh

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
    		•

    InternetAccessible

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

    被如下接口引用：RunInstances

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

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

    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-test-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、DescribeSecurityGroupPolicies、DescribeSecurityGroups

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

    OperatingSystem

    操作系统信息

    被如下接口引用：DescribeFlavors

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

    Disk

    描述了BMS硬盘的详细信息

    被如下接口引用：DescribeDisks

    名称 必选 允许NULL 类型 描述
    DiskId 是 否 String 硬盘ID。
    示例值： disk-d3e8e01b
    Placement 是 否 Placement 硬盘所在的位置。
    示例值：查看
    DiskName 是 否 String 硬盘名称。
    示例值： disk_name
    DiskSize 是 否 String 硬盘大小。
    示例值： 100G
    InstanceId 是 否 String 硬盘挂载的裸金属ID。
    示例值： bms-adafghjk
    DiskType 是 否 String 云盘介质类型。取值范围：
  • CLOUD_BASIC：表示普通云硬
  • CLOUD_PREMIUM：表示高性能云硬盘
  • CLOUD_SSD：SSD表示SSD云硬盘。
    示例值： SATA
    		•
    CreateTimeIso 否 否 Datetime_iso 硬盘的创建时间。
    示例值： 2024-09-11T11:30:50+08:00

    DisasterRecoverGroup

    置放群组信息

    被如下接口引用：DescribeDisasterRecoverGroups

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

    SecurityGroupPolicyUpdate

    更新安全组规则对象

    被如下接口引用：DescribeSecurityGroupPolicies、UpdateSecurityGroupPolicy

    名称 必选 允许NULL 类型 描述
    ID 否 否 Uint64 安全组规则ID
    示例值： 18
    PolicyIndex 否 否 Uint64 安全组规则下发顺序。
    示例值： 10
    Protocol 否 否 String 协议, 取值:范围 TCP,UDP, ICMP。
    示例值： TCP
    CidrBlock 否 否 String 网段或IP(互斥)。
    示例值： 10.10.10.10
    Port 否 否 String 端口(all, 离散port,  range)。
    示例值： 80
    SecurityGroupId 否 否 String 安全组实例ID，例如：sg-ohuuioma。
    示例值： sg-ohuuioma
    Action 否 否 String ACCEPT 或 DROP。
    示例值： DROP
    PolicyDescription 否 否 String 安全组规则描述
    示例值： security for bms
    CreatedTime 否 否 Datetime_iso 安全组创建时间
    示例值： 2024-08-03T12:00:00+08:00

    Placement

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

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

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

    DelOutbandInfo

    删除带外映射信息参数

    被如下接口引用：DeleteOutbandIP

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

    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
    CreateTimeIso 否 否 Datetime_iso BMS创建时间
    示例值： 2024-09-11T11:30:50+08:00
    Status 是 否 String 实例状态
    示例值： RUNNING
    CpuArch 否 否 String CPU类型，支持X86/ARM
    示例值： X86
    Tag 否 是 Array of Tag 实例标签
    示例值：查看
    Uuid 否 否 String 实例用户uuid
    示例值： 789116f0-dda7-4154-8ea6-f78283f8f847
    AppId 否 否 String 实例用户AppId
    示例值： 110000002171
    UserDefined 否 否 Uint64 是否自定义机型,0是标准，1是自定义
    示例值： 0
    PrivateIpv6Addresses 否 否 Array of String IPV6地址
    示例值： FF01::101
    GroupId 否 是 String 置放群组ID
    示例值： ps-asdfghjk
    HeartbeatId 否 是 String 心跳组ID
    示例值： HB-asdfghjk
    BackupIPs 否 是 String 备用IP
    示例值： 10.10.10.10;20.20.20.20
    DiskInfo 否 是 Array of DiskInfo 硬盘信息
    示例值：查看

    SecurityGroupPolicySet

    安全组规则集合

    被如下接口引用：CreateSecurityGroupPolicies

    名称 必选 允许NULL 类型 描述
    Ingress 否 否 Array of SecurityGroupPolicy 入站规则。
    示例值：查看
    Egress 否 否 Array of SecurityGroupPolicy 出站规则。
    示例值：查看

    BMCUserTasksResponse

    重置带外结果

    被如下接口引用：ResetOutbandInfo

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

    OutbandInfos

    带外网络信息

    被如下接口引用：DescribeOutbandInfo

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

    DiskInfo

    硬盘信息

    被如下接口引用：DescribeInstances

    名称 必选 允许NULL 类型 描述
    DiskName 否 否 String 硬盘名称
    示例值： nvme3n1

    EnhancedService

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

    被如下接口引用：ResetInstance、RunInstances

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

    OSDictionarySet

    用户自定义镜像详细信息

    被如下接口引用：DescribeImageList、ModifyTenantImage

    名称 必选 允许NULL 类型 描述
    ImageId 是 否 String 镜像ID
    示例值： c98b46d9-40c6-4dab-8e5b-ef166eb6eb5f
    ImageName 是 否 String 镜像名
    示例值： img-fc45e643
    ImageStatus 否 是 Int64 镜像状态，0是创建成功
    示例值： 0
    ImageSize 否 是 String 镜像大小
    示例值： 1080807303
    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://****/centos.iso
    AvailableModel 否 是 Int64 镜像使用服务器设备类型(0:通用服务器;1:黑石服务器)
    示例值： 1
    ImageFormat 否 是 String 镜像格式(iso/sqfs)
    示例值： ISO
    ZoneName 否 是 String 镜像所在可用区
    示例值： ap-rejcctest-ops-1
    ImageAlias 否 是 String 镜像别名
    示例值： image name
    TenantAppId 否 否 String 用户APPID
    示例值： 1255000109
    IdcName 否 是 String IDC名称
    示例值： IDC-FANG
    ImageFrom 否 是 String 镜像来源
    示例值： image from