裸金属云服务器
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>裸金属云服务器

数据结构

最近更新时间：2023-08-17 01:20:40

我的收藏

本页目录：

CpuInfo

cpu信息

被如下接口引用：DescribeHardwareSpecification。

名称 类型 描述
CpuId Integer CPU的ID
CpuDescription String CPU型号描述
Series Integer 机型序列
ContainRaidCard Array of Integer 支持的RAID方式，0：有RAID卡，1：没有RAID卡

CustomImage

自定义镜像信息

被如下接口引用：DescribeCustomImages。

名称 类型 描述
ImageId String 镜像ID
ImageName String 镜像别名
ImageStatus Integer 镜像状态码
OsClass String 镜像OS名
OsVersion String 镜像OS版本
OsBit Integer OS是64还是32位
ImageSize Integer 镜像大小(M)
CreateTime Timestamp 创建时间
PartitionInfoSet Array of PartitionInfo 分区信息
DeviceClassCode String 适用机型
ImageDescription String 备注
OsTypeId Integer 原始镜像id

CustomImageProcess

镜像制作进度列表

被如下接口引用：DescribeCustomImageProcess。

名称 类型 描述
StepName String 步骤
StartTime Timestamp 此步骤开始时间
StepType Integer 0: 已完成 1: 当前进行 2: 未开始

DeviceAlias

设备ID与别名

被如下接口引用：ModifyDeviceAliases。

名称 类型 必选 描述
InstanceId String 是 设备ID
Alias String 是 设备别名

DeviceClass

物理机设备类型

被如下接口引用：DescribeDeviceClass。

名称 类型 描述
DeviceClassCode String 机型ID
CpuDescription String CPU描述
MemDescription String 内存描述
DiskDescription String 硬盘描述
HaveRaidCard Integer 是否支持RAID. 0:不支持; 1:支持
NicDescription String 网卡描述
GpuDescription String GPU描述
Discount Float 单价折扣
注意：此字段可能返回 null，表示取不到有效值。
UnitPrice Integer 用户刊例价格
注意：此字段可能返回 null，表示取不到有效值。
RealPrice Integer 实际价格
注意：此字段可能返回 null，表示取不到有效值。
NormalPrice Integer 官网刊例价格
注意：此字段可能返回 null，表示取不到有效值。
DeviceType String 设备使用场景类型
Series Integer 机型系列
Cpu Integer cpu的核心数。仅是物理服务器未开启超线程的核心数， 超线程的核心数为Cpu*2
Mem Integer 内存容量。单位G

DeviceClassPartitionInfo

RAID和设备分区结构

被如下接口引用：DescribeDeviceClassPartition。

名称 类型 描述
RaidId Integer RAID类型ID
Raid String RAID名称
RaidDisplay String RAID名称（前台展示用）
SystemDiskSize Integer 系统盘总大小（单位GiB）
SysRootSpace Integer 系统盘/分区默认大小（单位GiB）
SysSwaporuefiSpace Integer 系统盘swap分区默认大小（单位GiB）
SysUsrlocalSpace Integer 系统盘/usr/local分区默认大小（单位GiB）
SysDataSpace Integer 系统盘/data分区默认大小（单位GiB）
SysIsUefiType Integer 设备是否是uefi启动方式。0:legacy启动; 1:uefi启动
DataDiskSize Integer 数据盘总大小
DeviceDiskSizeInfoSet Array of DeviceDiskSizeInfo 硬盘列表

DeviceDiskSizeInfo

硬盘大小的描述

被如下接口引用：DescribeDeviceClassPartition, DescribeDevicePartition。

名称 类型 描述
DiskName String 硬盘名称
DiskSize Integer 硬盘大小（单位GiB）

DeviceHardwareInfo

设备硬件配置信息

被如下接口引用：DescribeDeviceHardwareInfo。

名称 类型 描述
InstanceId String 设备实例 ID
IsElastic Integer 是否自定义机型
CpmPayMode Integer 机型计费模式，1 为预付费，2 为后付费
CpuId Integer 自定义机型，CPU 型号 ID（非自定义机型返回0）
Mem Integer 自定义机型，内存大小, 单位 GB（非自定义机型返回0）
ContainRaidCard Integer 是否有 RAID 卡，0：没有 RAID 卡； 1：有 RAID 卡
SystemDiskTypeId Integer 自定义机型系统盘类型ID（若没有则返回0）
SystemDiskCount Integer 自定义机型系统盘数量（若没有则返回0）
DataDiskTypeId Integer 自定义机型数据盘类型 ID（若没有则返回0）
DataDiskCount Integer 自定义机型数据盘数量（若没有则返回0）
CpuDescription String CPU 型号描述
MemDescription String 内存描述
DiskDescription String 磁盘描述
NicDescription String 网卡描述
RaidDescription String 是否支持 RAID 的描述
Cpu Integer cpu的核心数。仅是物理服务器未开启超线程的核心数， 超线程的核心数为Cpu*2
DeviceClassCode String 机型外部代号

DeviceInfo

物理机信息

被如下接口引用：DescribeDevices。

名称 类型 描述
InstanceId String 设备唯一ID
示例值：cpm-1a2b3c4d
VpcId String 私有网络ID
示例值：vpc-1a2b3c4d
SubnetId String 子网ID
示例值：subnet-1a2b3c4d
DeviceStatus Integer 设备状态ID，取值：
  • 1：申领设备中
  • 2：初始化中
  • 4：运营中
  • 7：隔离中
  • 8：已隔离
  • 10：解隔离中
  • 16：故障中

    • 示例值：4
    OperateStatus Integer 设备操作状态ID，取值：
  • 1：运行中
  • 2：正在关机
  • 3：已关机
  • 5：正在开机
  • 7：重启中
  • 9：重装中
  • 12：绑定EIP
  • 13：解绑EIP
  • 14：绑定LB
  • 15：解绑LB
  • 19：更换IP中
  • 20：制作镜像中
  • 21：制作镜像失败
  • 23：故障待重装
  • 24：无备件待退回

    • 示例值：1
    OsTypeId Integer 操作系统ID，参考接口查询操作系统信息(DescribeOsInfo)
    示例值：2
    RaidId Integer RAID类型ID，参考接口查询机型RAID方式以及系统盘大小(DescribeDeviceClassPartition)
    示例值：5
    Alias String 设备别名
    示例值：设备名称
    AppId Integer 用户AppId
    示例值：1251001000
    Zone String 可用区
    示例值：ap-guangzhou-bls-1
    WanIp String 外网IP
    示例值：123.123.12.3.123
    LanIp String 内网IP
    示例值：10.0.0.1
    DeliverTime Timestamp 设备交付时间
    示例值：2020-02-02 21:00:00
    Deadline Timestamp 设备到期时间
    示例值：2020-02-02 21:00:00
    AutoRenewFlag Integer 自动续费标识。0: 不自动续费; 1:自动续费
    示例值：1
    DeviceClassCode String 设备类型
    示例值：PS100v3
    Tags Array of Tag 标签列表
    示例值：tag
    CpmPayMode Integer 计费模式。1: 预付费; 2: 后付费; 3:预付费转后付费中
    示例值：1
    DhcpIp String 带外IP
    示例值：10.1.0.1
    VpcName String 所在私有网络别名
    示例值：vpc名称
    SubnetName String 所在子网别名
    示例值：子网名称
    VpcCidrBlock String 所在私有网络CIDR
    示例值：10.0.0.0/16
    SubnetCidrBlock String 所在子网CIDR
    示例值：10.0.0.0/24
    IsLuckyDevice Integer 标识是否是竞价实例。0: 普通设备; 1: 竞价实例设备
    示例值：1
    MaintainStatus String 标识机器维保状态。Maintain: 在保; WillExpire: 即将过保; Expire: 已过保
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：Maintain
    MaintainMessage String 维保信息描述
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：有厂商维保服务，可继续使用

    DeviceOperationLog

    设备操作日志

    被如下接口引用：DescribeDeviceOperationLog。

    名称 类型 描述
    Id Integer 日志的ID
    InstanceId String 设备ID
    TaskId Integer 日志对应的操作任务ID
    TaskName String 操作任务名称
    TaskDescription String 操作任务中文名称
    StartTime Timestamp 操作开始时间
    EndTime Timestamp 操作结束时间
    Status Integer 操作状态，0: 正在执行中；1：任务成功； 2: 任务失败。
    OpUin String 操作者
    LogDescription String 操作描述

    DevicePartition

    物理机分区格式

    被如下接口引用：DescribeDevicePartition。

    名称 类型 描述
    SystemDiskSize Integer 系统盘大小
    DataDiskSize Integer 数据盘大小
    SysIsUefiType Boolean 是否兼容Uefi
    SysRootSpace Integer root分区大小
    SysSwaporuefiSpace Integer Swaporuefi分区大小
    SysUsrlocalSpace Integer Usrlocal分区大小
    SysDataSpace Integer data分区大小
    DeviceDiskSizeInfoSet Array of DeviceDiskSizeInfo 硬盘大小详情

    DevicePositionInfo

    物理机机架信息

    被如下接口引用：DescribeDevicePosition。

    名称 类型 描述
    InstanceId String 设备ID
    Zone String 所在可用区
    VpcId String 私有网络ID
    SubnetId String 子网ID
    LanIp String 业务IP
    Alias String 实例别名
    RckName String 机架名称
    PosCode Integer 机位
    SwitchName String 交换机名称
    DeliverTime Timestamp 设备交付时间
    Deadline Timestamp 过期时间

    DevicePriceInfo

    服务器价格信息

    被如下接口引用：DescribeDevicePriceInfo。

    名称 类型 描述
    InstanceId String 物理机ID
    DeviceClassCode String 设备型号
    IsElastic Integer 是否是弹性机型，1：是，0：否
    CpmPayMode Integer 付费模式ID, 1:预付费; 2:后付费; 3:预付费转后付费中
    CpuDescription String Cpu信息描述
    MemDescription String 内存信息描述
    DiskDescription String 硬盘信息描述
    NicDescription String 网卡信息描述
    GpuDescription String Gpu信息描述
    RaidDescription String Raid信息描述
    Price Integer 客户的单价
    NormalPrice Integer 刊例单价
    TotalCost Integer 原价
    RealTotalCost Integer 折扣价
    TimeSpan Integer 计费时长
    TimeUnit String 计费时长单位, M:按月计费; D:按天计费
    GoodsCount Integer 商品数量

    DiskInfo

    自定义机型磁盘的描述

    被如下接口引用：DescribeHardwareSpecification。

    名称 类型 描述
    DiskTypeId Integer 磁盘ID
    Size Integer 磁盘的容量，单位为G
    DiskDescription String 磁盘信息描述

    FailedTaskInfo

    运行失败的自定义脚本信息

    被如下接口引用：RunUserCmd。

    名称 类型 描述
    InstanceId String 运行脚本的设备ID
    ErrorMsg String 失败原因

    HostedDeviceOutBandInfo

    托管设备带外信息

    被如下接口引用：DescribeHostedDeviceOutBandInfo。

    名称 类型 描述
    InstanceId String 物理机ID
    OutBandIp String 带外IP
    VpnIp String VPN的IP
    VpnPort Integer VPN的端口

    OsInfo

    操作系统类型

    被如下接口引用：DescribeOsInfo。

    名称 类型 描述
    OsTypeId Integer 操作系统ID
    OsName String 操作系统名称
    OsDescription String 操作系统名称描述
    OsEnglishDescription String 操作系统英文名称
    OsClass String 操作系统的分类，如CentOs Debian
    ImageTag String 标识镜像分类。public:公共镜像; private: 专属镜像
    MaxPartitionSize Integer 操作系统，ext4文件下所支持的最大的磁盘大小。单位为T
    OsMinorVersion String 黑石版本号
    注意：此字段可能返回 null，表示取不到有效值。
    OsMinorClass String 黑石版本
    注意：此字段可能返回 null，表示取不到有效值。

    PartitionInfo

    描述设备分区信息

    被如下接口引用：DescribeCustomImages。

    名称 类型 描述
    Name String 分区名称
    Size Integer 分区大小

    PsaRegulation

    一条预授权规则

    被如下接口引用：DescribePsaRegulations。

    名称 类型 描述
    PsaId String 规则ID
    PsaName String 规则别名
    TagCount Integer 关联标签数量
    InstanceCount Integer 关联实例数量
    RepairCount Integer 故障实例数量
    RepairLimit Integer 故障实例上限
    CreateTime Timestamp 创建时间
    PsaDescription String 规则备注
    Tags Array of Tag 关联标签
    TaskTypeIds Array of Integer 关联故障类型id

    RegionInfo

    地域信息

    被如下接口引用：DescribeRegions。

    名称 类型 描述
    Region String 地域ID
    RegionId Integer 地域整型ID
    RegionDescription String 地域描述
    ZoneInfoSet Array of ZoneInfo 该地域下的可用区信息

    SubtaskStatus

    各实例对应的异步任务执行结果

    被如下接口引用：DescribeOperationResult。

    名称 类型 描述
    InstanceId String 实例ID
    TaskStatus Integer 实例ID对应任务的状态，取值如下：

    1：成功

    2：失败

    3：部分成功，部分失败

    4：未完成

    5：部分成功，部分未完成

    6：部分未完成，部分失败

    7：部分未完成，部分失败，部分成功

    SuccessTaskInfo

    成功运行的自定义脚本信息

    被如下接口引用：RunUserCmd。

    名称 类型 描述
    InstanceId String 运行脚本的设备ID
    TaskId Integer 黑石异步任务ID
    CmdTaskId String 黑石自定义脚本运行任务ID

    Tag

    标签键与值

    被如下接口引用：BuyDevices, DescribeDevices, DescribePsaRegulations。

    名称 类型 必选 描述
    TagKey String 是 标签键
    TagValues Array of String 是 标签键对应的值

    TaskInfo

    维护平台维修任务信息

    被如下接口引用：DescribeTaskInfo。

    名称 类型 描述
    TaskId String 任务id
    InstanceId String 主机id
    Alias String 主机别名
    TaskTypeId Integer 故障类型id
    TaskStatus Integer 任务状态id
    CreateTime Timestamp 创建时间
    AuthTime Timestamp 授权时间
    EndTime Timestamp 结束时间
    TaskDetail String 任务详情
    DeviceStatus Integer 设备状态
    OperateStatus Integer 设备操作状态
    Zone String 可用区
    Region String 地域
    VpcId String 所属网络
    SubnetId String 所在子网
    SubnetName String 子网名
    VpcName String VPC名
    VpcCidrBlock String VpcCidrBlock
    SubnetCidrBlock String SubnetCidrBlock
    WanIp String 公网ip
    LanIp String 内网IP
    MgtIp String 管理IP
    TaskTypeName String 故障类中文名
    注意：此字段可能返回 null，表示取不到有效值。
    TaskSubType String 故障类型，取值：unconfirmed (不明确故障)；redundancy (有冗余故障)；nonredundancy (无冗余故障)
    注意：此字段可能返回 null，表示取不到有效值。

    TaskOperationLog

    维修任务操作日志

    被如下接口引用：DescribeTaskOperationLog。

    名称 类型 描述
    TaskStep String 操作步骤
    Operator String 操作人
    OperationDetail String 操作描述
    OperationTime Timestamp 操作时间

    TaskType

    故障id对应故障名列表

    被如下接口引用：DescribeRepairTaskConstant。

    名称 类型 描述
    TypeId Integer 故障类ID
    TypeName String 故障类中文名
    TaskSubType String 故障类型父类

    UserCmd

    脚本信息

    被如下接口引用：DescribeUserCmds。

    名称 类型 描述
    Alias String 用户自定义脚本名
    AppId Integer AppId
    AutoId Integer 脚本自增ID
    CmdId String 脚本ID
    Content String 脚本内容
    CreateTime Timestamp 创建时间
    ModifyTime Timestamp 修改时间
    OsType String 命令适用的操作系统类型

    UserCmdTask

    自定义脚本任务信息

    被如下接口引用：DescribeUserCmdTasks。

    名称 类型 描述
    TaskId String 任务ID
    Status Integer 任务状态ID，取值: -1(进行中) 0(结束)
    Alias String 脚本名称
    CmdId String 脚本ID
    InstanceCount Integer 运行实例数量
    SuccessCount Integer 运行成功数量
    FailureCount Integer 运行失败数量
    RunBeginTime Timestamp 执行开始时间
    RunEndTime Timestamp 执行结束时间

    UserCmdTaskInfo

    自定义脚本任务详细信息

    被如下接口引用：DescribeUserCmdTaskInfo。

    名称 类型 描述
    AutoId Integer 自动编号，可忽略
    TaskId String 任务ID
    RunBeginTime Timestamp 任务开始时间
    RunEndTime Timestamp 任务结束时间
    Status Integer 任务状态ID，取值为 -1：进行中；0：成功；>0：失败错误码
    InstanceName String 设备别名
    InstanceId String 设备ID
    VpcName String 私有网络名
    VpcId String 私有网络整型ID
    VpcCidrBlock String 私有网络Cidr
    SubnetName String 子网名
    SubnetId String 子网ID
    SubnetCidrBlock String 子网Cidr
    LanIp String 内网IP
    CmdContent String 脚本内容，base64编码后的值
    CmdParam String 脚本参数，base64编码后的值
    CmdResult String 脚本执行结果，base64编码后的值
    AppId Integer 用户AppId
    LastShellExit Integer 用户执行脚本结束退出的返回值，没有返回值为-1

    ZoneInfo

    可用区信息

    被如下接口引用：DescribeRegions。

    名称 类型 描述
    Zone String 可用区ID
    ZoneId Integer 可用区整型ID
    ZoneDescription String 可用区描述
    中国站
    文档反馈
    文档活动
    message-icon联系我们
    目录