有奖捉虫:云通信与企业服务文档专题,速来> HOT

AdvancedRetentionPolicy

定期快照高级保留策略,四个参数都为必选参数

被如下接口引用:DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy。

名称 类型 必选 描述
Days Integer 保留最新快照Days天内的每天最新的一个快照,取值范围:[0, 100]
注意:此字段可能返回 null,表示取不到有效值。
示例值:6
Weeks Integer 保留最新快照Weeks周内的每周最新的一个快照,取值范围:[0, 100]
注意:此字段可能返回 null,表示取不到有效值。
示例值:8
Months Integer 保留最新快照Months月内的每月最新的一个快照, 取值范围:[0, 100]
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
Years Integer 保留最新快照Years年内的每年最新的一个快照,取值范围:[0, 100]
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

AttachDetail

描述一个实例已挂载和可挂载数据盘的数量。

被如下接口引用:DescribeInstancesDiskNum。

名称 类型 描述
InstanceId String 实例ID。
示例值:ins-jw0vit58
AttachedDiskCount Integer 实例已挂载数据盘的数量。
示例值:1
MaxAttachCount Integer 实例最大可挂载数据盘的数量。
示例值:20

AutoMountConfiguration

描述了新购云硬盘时自动将云硬盘初始化并挂载至云服务器内部的配置。

被如下接口引用:CreateDisks。

名称 类型 必选 描述
InstanceId Array of String 要挂载到的实例ID。
示例值:["ins-abcdefgh"]
MountPoint Array of String 子机内的挂载点。
示例值:["/mnt/datadisk0"]
FileSystemType String 文件系统类型,支持的有 ext4、xfs。
示例值:ext4

AutoSnapshotPolicy

描述了定期快照策略的详细信息

被如下接口引用:DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy。

名称 类型 描述
DiskIdSet Array of String 已绑定当前定期快照策略的云盘ID列表。
示例值:["disk-pe1vkgim"]
IsActivated Boolean 定期快照策略是否激活。
示例值:true
AutoSnapshotPolicyState String 定期快照策略的状态。取值范围:
  • NORMAL:正常
  • ISOLATED:已隔离。
    示例值:NORMAL
  • IsCopyToRemote Integer 是否是跨账号复制快照快照, 1:是, 0: 不是
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    IsPermanent Boolean 使用该定期快照策略创建出来的快照是否永久保留。
    示例值:false
    NextTriggerTime Timestamp 定期快照下次触发的时间。
    示例值:2022-05-31 11:00:00
    AutoSnapshotPolicyName String 定期快照策略名称。
    示例值:test
    AutoSnapshotPolicyId String 定期快照策略ID。
    示例值:asp-nz3ytdwj
    Policy Array of Policy 定期快照的执行策略。
    CreateTime Timestamp 定期快照策略的创建时间。
    示例值:2022-01-11 10:45:51
    RetentionDays Integer 使用该定期快照策略创建出来的快照保留天数。
    示例值:1
    CopyToAccountUin String 复制的目标账户ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    InstanceIdSet Array of String 已绑定当前定期快照策略的实例ID列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["ins-og3j7lue"]
    RetentionMonths Integer 该定期快照创建的快照可以保留的月数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    RetentionAmount Integer 该定期快照创建的快照最大保留数量。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:5
    AdvancedRetentionPolicy AdvancedRetentionPolicy 定期快照高级保留策略。
    注意:此字段可能返回 null,表示取不到有效值。
    CopyFromAccountUin String 该复制快照策略的源端账户ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    Tags Array of Tag 标签。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    Cdc

    描述独享集群的详细信息。

    被如下接口引用:DescribeDiskStoragePool。

    名称 类型 描述
    CageId String 独享集群围笼ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cage-xxxxxxxx
    CdcState String 独享集群状态。取值范围:
  • NORMAL:正常;
  • CLOSED:关闭,此时将不可使用该独享集群创建新的云硬盘;
  • FAULT:独享集群状态异常,此时独享集群将不可操作,腾讯云运维团队将会及时修复该集群;
  • ISOLATED:因未及时续费导致独享集群被隔离,此时将不可使用该独享集群创建新的云硬盘,对应的云硬盘也将不可操作。
    示例值:NORMAL
  • Zone String 独享集群所属的可用区ID。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-shenzhen-fsi-2
    CdcName String 独享集群实例名称。
    示例值:test
    CdcResource CdcSize 独享集群的资源容量大小。
    注意:此字段可能返回 null,表示取不到有效值。
    CdcId String 独享集群实例id。
    示例值:cdc-xxxxxxxx
    DiskType String 独享集群类型。取值范围:
  • CLOUD_BASIC:表示普通云硬盘集群
  • CLOUD_PREMIUM:表示高性能云硬盘集群
  • CLOUD_SSD:SSD表示SSD云硬盘集群。
    示例值:CLOUD_PREMIUM
  • ExpiredTime Timestamp 独享集群到期时间。
    示例值:2029-01-01 00:00:00
    CreatedTime Timestamp ISO8601 存储池创建时间。
    示例值:2018-01-01 00:00:00
    DiskNumber Integer 当前集群中已创建的云盘数量。
    示例值:1

    CdcSize

    显示独享集群的大小

    被如下接口引用:DescribeDiskStoragePool。

    名称 类型 描述
    DiskTotal Integer 独享集群的总容量大小,单位GiB
    示例值:200
    DiskAvailable Integer 独享集群的可用容量大小,单位GiB
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100000

    DetailPrice

    描述购买云盘时的费用明细。

    被如下接口引用:InquiryPriceRenewDisks, InquiryPriceResizeDisk。

    名称 类型 描述
    PriceTitle String 描述计费项目名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:DiskSpace
    PriceName String 描述计费项目显示名称,用户控制台展示。
    示例值:云盘空间
    OriginalPrice Float 预付费云盘预支费用的原价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100.0
    DiscountPrice Float 预付费云盘预支费用的折扣价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100.0
    UnitPrice Float 后付费云盘原单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10.0
    UnitPriceDiscount Float 后付费云盘折扣单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10.0
    ChargeUnit String 后付费云盘的计价单元,取值范围:HOUR:表示后付费云盘的计价单元是按小时计算。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:HOUR
    OriginalPriceHigh String 高精度预付费云盘预支费用的原价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100
    DiscountPriceHigh String 高精度预付费云盘预支费用的折扣价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100
    UnitPriceHigh String 高精度后付费云盘原单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100
    UnitPriceDiscountHigh String 高精度后付费云盘折扣单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:100

    Disk

    描述了云硬盘的详细信息

    被如下接口引用:DescribeDisks。

    名称 类型 描述
    DeleteWithInstance Boolean 云盘是否与挂载的实例一起销毁。
  • true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
  • false:销毁实例时不销毁云盘。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
  • RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:NOTIFY_AND_AUTO_RENEW
  • DiskType String 硬盘介质类型。取值范围:
  • CLOUD_BASIC:表示普通云硬盘
  • CLOUD_PREMIUM:表示高性能云硬盘
  • CLOUD_BSSD:表示通用型SSD云硬盘
  • CLOUD_SSD:表示SSD云硬盘
  • CLOUD_HSSD:表示增强型SSD云硬盘
  • CLOUD_TSSD:表示极速型SSD云硬盘。
    示例值:CLOUD_SSD
  • DiskState String 云盘状态。取值范围:
  • UNATTACHED:未挂载
  • ATTACHING:挂载中
  • ATTACHED:已挂载
  • DETACHING:解挂中
  • EXPANDING:扩容中
  • ROLLBACKING:回滚中
  • TORECYCLE:待回收
  • DUMPING:拷贝硬盘中。
    示例值:UNATTACHED
  • SnapshotCount Integer 云盘拥有的快照总数。
    示例值:0
    AutoRenewFlagError Boolean 云盘已挂载到子机,且子机与云盘都是包年包月。
  • true:子机设置了自动续费标识,但云盘未设置
  • false:云盘自动续费标识正常。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
  • Rollbacking Boolean 云盘是否处于快照回滚状态。取值范围:
  • false:表示不处于快照回滚状态
  • true:表示处于快照回滚状态。
    示例值:false
  • InstanceIdList Array of String 对于非共享型云盘,该参数为空数组。对于共享型云盘,则表示该云盘当前被挂载到的CVM实例InstanceId
    示例值:[]
    Encrypt Boolean 云盘是否为加密盘。取值范围:
  • false:表示非加密盘
  • true:表示加密盘。
    示例值:false
  • DiskName String 云硬盘名称。
    示例值:unname
    BackupDisk Boolean 云硬盘因欠费销毁或者到期销毁时, 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁,不进行数据备份。
    示例值:true
    Tags Array of Tag 与云盘绑定的标签,云盘未绑定标签则取值为空。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    InstanceId String 云硬盘挂载的云主机ID。
    示例值:ins-xxxxxxx
    AttachMode String 云盘的挂载类型。取值范围:
  • PF: PF挂载
  • VF: VF挂载
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:PF
  • AutoSnapshotPolicyIds Array of String 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    ThroughputPerformance Integer 云硬盘额外性能值,单位MB/s。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Migrating Boolean 云盘是否处于类型变更中。取值范围:
  • false:表示云盘不处于类型变更中
  • true:表示云盘已发起类型变更,正处于迁移中。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
  • DiskId String 云硬盘ID。
    示例值:disk-xxxxxxxx
    SnapshotSize Integer 云盘拥有的快照总容量,单位为MB。
    示例值:0
    Placement Placement 云硬盘所在的位置。
    示例值:{"Zone":"ap-guangzhou-2","ProjectId":0}
    IsReturnable Boolean 判断预付费的云盘是否支持主动退还。
  • true:支持主动退还
  • false:不支持主动退还。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
  • DeadlineTime Timestamp 云硬盘的到期时间。
    示例值:2021-02-01 12:00:00
    Attached Boolean 云盘是否挂载到云主机上。取值范围:
  • false:表示未挂载
  • true:表示已挂载。
    示例值:false
  • DiskSize Integer 云硬盘大小,单位GB。
    示例值:50
    MigratePercent Integer 云盘类型变更的迁移进度,取值0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    DiskUsage String 云硬盘类型。取值范围:
  • SYSTEM_DISK:系统盘
  • DATA_DISK:数据盘。
    示例值:SYSTEM_DISK
  • DiskChargeType String 付费模式。取值范围:
  • PREPAID:预付费,即包年包月
  • POSTPAID_BY_HOUR:后付费,即按量计费。
    示例值:PREPAID
  • Portable Boolean 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。
    示例值:true
    SnapshotAbility Boolean 云盘是否具备创建快照的能力。取值范围:
  • false表示不具备
  • true表示具备。
    示例值:true
  • DeadlineError Boolean 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。
  • true:云盘到期时间早于实例。
  • false:云盘到期时间晚于实例。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
  • RollbackPercent Integer 云盘快照回滚的进度。
    示例值:0
    DifferDaysOfDeadline Integer 当前时间距离盘到期的天数(仅对预付费盘有意义)。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:20
    ReturnFailCode Integer 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:
  • 1:云硬盘已经退还
  • 2:云硬盘已过期
  • 3:云盘不支持退还
  • 8:超过可退还数量的限制。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
  • Shareable Boolean 云盘是否为共享型云盘。
    示例值:false
    CreateTime Timestamp 云硬盘的创建时间。
    示例值:2021-01-01 12:00:00
    DeleteSnapshot Integer 销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁,1表示非永久快照随云盘销毁而销毁,默认取0。快照是否永久保留可以通过DescribeSnapshots接口返回的快照详情的IsPermanent字段来判断,true表示永久快照,false表示非永久快照。
    示例值:0
    DiskBackupQuota Integer 云硬盘备份点配额。表示最大可以保留的备份点数量。
    示例值:0
    DiskBackupCount Integer 云硬盘备份点已使用的数量。
    示例值:0
    InstanceType String 云硬盘挂载实例的类型。取值范围:
  • CVM
  • EKS
    示例值:CVM
  • LastAttachInsId String 云硬盘最后一次挂载的实例ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ins-xxx
    ErrorPrompt String 云硬盘最后一次操作错误提示
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    BurstPerformance Boolean 云盘是否开启性能突发
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false

    DiskBackup

    云硬盘备份点。

    被如下接口引用:DescribeDiskBackups。

    名称 类型 描述
    DiskBackupId String 云硬盘备份点的ID。
    示例值:dbp-xxxxxxxx
    DiskId String 云硬盘备份点关联的云硬盘ID。
    示例值:disk-xxxxxxxx
    DiskSize Integer 云硬盘大小,单位GB。
    示例值:50
    DiskUsage String 云硬盘类型。取值范围:
  • SYSTEM_DISK:系统盘
  • DATA_DISK:数据盘。
    示例值:DATA_DISK
  • DiskBackupName String 备份点名称。
    示例值:Untitled
    DiskBackupState String 云硬盘备份点状态。取值范围:
  • NORMAL:正常
  • CREATING:创建中
  • ROLLBACKING:回滚中
    示例值:NORMAL
  • Percent Integer 云硬盘创建进度百分比。
    示例值:100
    CreateTime Timestamp ISO8601 云硬盘备份点的创建时间。
    示例值:2022-01-01T12:00:00+08:00
    Encrypt Boolean 云盘是否为加密盘。取值范围:
  • false:表示非加密盘
  • true:表示加密盘。
    示例值:false
  • DiskChargePrepaid

    描述了实例的计费模式

    被如下接口引用:CreateDisks, InquiryPriceCreateDisks, InquiryPriceRenewDisks, ModifyDisksChargeType, RenewDisk。

    名称 类型 必选 描述
    Period Integer 购买云盘的时长,默认单位为月,取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。
    示例值:1
    RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

    默认取值:NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费。
    示例值:NOTIFY_AND_AUTO_RENEW
  • CurInstanceDeadline Timestamp 需要将云盘的到期时间与挂载的子机对齐时,可传入该参数。该参数表示子机当前的到期时间,此时Period如果传入,则表示子机需要续费的时长,云盘会自动按对齐到子机续费后的到期时间续费,示例取值:2018-03-30 20:15:03。
    示例值:2018-03-30 20:15:03

    DiskConfig

    云盘配置。

    被如下接口引用:DescribeDiskConfigQuota。

    名称 类型 描述
    Available Boolean 配置是否可用。
    示例值:false
    DiskChargeType String 付费模式。取值范围:
  • PREPAID:表示预付费,即包年包月
  • POSTPAID_BY_HOUR:表示后付费,即按量计费。
    示例值:POSTPAID_BY_HOUR
  • Zone String 云硬盘所属的可用区
    示例值:ap-guangzhou-2
    InstanceFamily String 实例机型系列。详见实例类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:N1
    DiskType String 云盘介质类型。取值范围:
  • CLOUD_BASIC:表示普通云硬盘
  • CLOUD_PREMIUM:表示高性能云硬盘
  • CLOUD_SSD:SSD表示SSD云硬盘。
    示例值:CLOUD_BASIC
  • StepSize Integer 云盘大小变化的最小步长,单位GB。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:10
    ExtraPerformanceRange Array of Integer 额外的性能区间。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    DeviceClass String 实例机型。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    DiskUsage String 云盘类型。取值范围:
  • SYSTEM_DISK:表示系统盘
  • DATA_DISK:表示数据盘。
    示例值:DATA_DISK
  • MinDiskSize Integer 最小可配置云盘大小,单位GB。
    示例值:10
    MaxDiskSize Integer 最大可配置云盘大小,单位GB。
    示例值:32000
    Price Price 描述预付费或后付费云盘的价格。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"UnitPriceDiscount":0.09,"UnitPrice":0.09,"ChargeDiskSize":100,"ChargeUnit":"HOUR"}

    Filter

    描述键值对过滤器,用于条件过滤查询。

    被如下接口引用:DescribeAutoSnapshotPolicies, DescribeDiskBackups, DescribeDiskStoragePool, DescribeDisks, DescribeSnapshots。

    名称 类型 必选 描述
    Name String 过滤键的名称。
    示例值:disk-usage
    Values Array of String 一个或者多个过滤值。
    示例值:["SYSTEM_DISK"]

    Image

    镜像。

    被如下接口引用:DescribeSnapshots。

    名称 类型 描述
    ImageName String 镜像名称。
    示例值:test
    ImageId String 镜像实例ID。
    示例值:img-xxxxxxxx

    Placement

    描述了实例的抽象位置,包括其所在的可用区,所属的项目,以及所属的独享集群的ID和名字。

    被如下接口引用:CreateDisks, DescribeDisks, DescribeSnapshots。

    名称 类型 必选 描述
    Zone String 云硬盘所属的可用区。该参数也可以通过调用 DescribeZones 的返回值中的Zone字段来获取。
    示例值:ap-shanghai-2
    CageId String 围笼Id。作为入参时,表示对指定的CageId的资源进行操作,可为空。 作为出参时,表示资源所属围笼ID,可为空。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cage-xxxxxxxx
    ProjectId Integer 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    示例值:0
    ProjectName String 实例所属项目名称。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Default Project
    CdcName String 独享集群名字。作为入参时,忽略。作为出参时,表示云硬盘所属的独享集群名,可为空。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CdcName
    CdcId String 实例所属的独享集群ID。作为入参时,表示对指定的CdcId独享集群的资源进行操作,可为空。 作为出参时,表示资源所属的独享集群的ID,可为空。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:cdc-xxxxxxxx
    DedicatedClusterId String 独享集群id。
    示例值:cluster-xxxxxxxx

    Policy

    描述了定期快照的执行策略。可理解为在DayOfWeek/DayOfMonth指定的几天中,或者是IntervalDays设定的间隔的几天,在Hour指定的时刻点执行该条定期快照策。注:DayOfWeek/DayOfMonth/IntervalDays为互斥规则,仅可设置其中一条策略规则。

    被如下接口引用:CreateAutoSnapshotPolicy, DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy, ModifyAutoSnapshotPolicyAttribute。

    名称 类型 必选 描述
    Hour Array of Integer 指定定期快照策略的触发时间。单位为小时,取值范围:[0, 23]。00:00 ~ 23:00 共 24 个时间点可选,1表示 01:00,依此类推。
    示例值:[11,12,13]
    DayOfWeek Array of Integer 指定每周从周一到周日需要触发定期快照的日期,取值范围:[0, 6]。0表示周日触发,1-6分别表示周一至周六。
    示例值:[0,1,2]
    DayOfMonth Array of Integer 指定每月从月初到月底需要触发定期快照的日期,取值范围:[1, 31],1-31分别表示每月的具体日期,比如5表示每月的5号。注:若设置29、30、31等部分月份不存在的日期,则对应不存在日期的月份会跳过不打定期快照。
    示例值:[2, 3, 4]
    IntervalDays Integer 指定创建定期快照的间隔天数,取值范围:[1, 365],例如设置为5,则间隔5天即触发定期快照创建。注:当选择按天备份时,理论上第一次备份的时间为备份策略创建当天。如果当天备份策略创建的时间已经晚于设置的备份时间,那么将会等到第二个备份周期再进行第一次备份。
    示例值:50

    PrepayPrice

    预付费订单的费用。

    被如下接口引用:InquiryPriceRenewDisks, InquiryPriceResizeDisk。

    名称 类型 描述
    DiscountPrice Float 预付费云盘或快照预支费用的折扣价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    ChargeUnit String 后付费云盘的计价单元,取值范围:
  • HOUR:表示后付费云盘的计价单元是按小时计算。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"h"
  • UnitPriceHigh String 高精度后付费云盘原单价, 单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    OriginalPriceHigh String 高精度预付费云盘或快照预支费用的原价,单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    OriginalPrice Float 预付费云盘或快照预支费用的原价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    UnitPriceDiscount Float 后付费云盘折扣单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    UnitPriceDiscountHigh String 高精度后付费云盘折扣单价, 单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    DiscountPriceHigh String 高精度预付费云盘或快照预支费用的折扣价,单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    UnitPrice Float 后付费云盘原单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    DetailPrices Array of DetailPrice 计费项目明细列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]

    Price

    描述预付费或后付费云盘的价格。

    被如下接口引用:DescribeDiskConfigQuota, InquirePriceModifyDiskBackupQuota, InquirePriceModifyDiskExtraPerformance, InquiryPriceCreateDisks。

    名称 类型 描述
    UnitPriceDiscount Float 后付费云盘折扣单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    DiscountPrice Float 预付费云盘预支费用的折扣价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    UnitPrice Float 后付费云盘原单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    UnitPriceHigh String 高精度后付费云盘原单价, 单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    OriginalPriceHigh String 高精度预付费云盘预支费用的原价, 单位:元 。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    OriginalPrice Float 预付费云盘预支费用的原价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1.0
    DiscountPriceHigh String 高精度预付费云盘预支费用的折扣价, 单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    UnitPriceDiscountHigh String 高精度后付费云盘折扣单价, 单位:元
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"1.00"
    ChargeUnit String 后付费云盘的计价单元,取值范围:
  • HOUR:表示后付费云盘的计价单元是按小时计算。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"h"
  • SharePermission

    快照分享信息集合

    被如下接口引用:DescribeSnapshotSharePermission。

    名称 类型 描述
    CreatedTime Timestamp 快照分享的时间
    示例值:2023-02-26 01:21:03
    AccountId String 分享的账号Id
    示例值:100022975249

    Snapshot

    描述了快照的详细信息

    被如下接口引用:DescribeSnapshots。

    名称 类型 描述
    Placement Placement 快照所在的位置。
    CopyFromRemote Boolean 是否为跨地域复制的快照。取值范围:
  • true:表示为跨地域复制的快照。
  • false:本地域的快照。
    示例值:false
  • SnapshotState String 快照的状态。取值范围:
  • NORMAL:正常
  • CREATING:创建中
  • ROLLBACKING:回滚中
  • COPYING_FROM_REMOTE:跨地域复制中
  • CHECKING_COPIED:复制校验中
  • TORECYCLE:待回收。
    示例值:NORMAL
  • IsPermanent Boolean 是否为永久快照。取值范围:
  • true:永久快照
  • false:非永久快照。
    示例值:true
  • SnapshotName String 快照名称,用户自定义的快照别名。调用ModifySnapshotAttribute可修改此字段。
    示例值:test
    DeadlineTime Timestamp 快照到期时间。如果快照为永久保留,此字段为空。
    示例值:2021-11-24 16:00:00
    Percent Integer 快照创建进度百分比,快照创建成功后此字段恒为100。
    示例值:100
    Images Array of Image 快照关联的镜像列表。
    ShareReference Integer 快照当前被共享数。
    示例值:0
    SnapshotType String 快照类型,目前该项取值可以为PRIVATE_SNAPSHOT或者SHARED_SNAPSHOT
    示例值:PRIVATE_SNAPSHOT
    DiskSize Integer 创建此快照的云硬盘大小,单位GB。
    示例值:10
    DiskId String 创建此快照的云硬盘ID。
    示例值:disk-xxxxxxxx
    CopyingToRegions Array of String 快照正在跨地域复制的目的地域,默认取值为[]。
    示例值:[]
    Encrypt Boolean 是否为加密盘创建的快照。取值范围:
  • true:该快照为加密盘创建的
  • false:非加密盘创建的快照。
    示例值:false
  • CreateTime Timestamp 快照的创建时间。
    示例值:2019-07-15 00:00:00
    ImageCount Integer 快照关联的镜像个数。
    示例值:0
    DiskUsage String 创建此快照的云硬盘类型。取值范围:
  • SYSTEM_DISK:系统盘
  • DATA_DISK:数据盘。
    示例值:SYSTEM_DISK
  • SnapshotId String 快照ID。
    示例值:snap-xxxxxxx
    TimeStartShare Date 快照开始共享的时间。
    示例值:2021-07-15
    Tags Array of Tag 快照绑定的标签列表。

    SnapshotCopyResult

    描述快照跨地域复制的结果。

    被如下接口引用:CopySnapshotCrossRegions。

    名称 类型 描述
    SnapshotId String 复制到目标地域的新快照ID。
    示例值:snap-hdbc13ad
    Message String 指示具体错误信息,成功时为空字符串。
    示例值:""
    Code String 错误码,成功时取值为“Success”。
    示例值:"Success"
    DestinationRegion String 跨地复制的目标地域。
    示例值:"ap-guangzhou"

    Tag

    标签。

    被如下接口引用:CreateDisks, CreateSnapshot, DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy, DescribeDisks, DescribeSnapshots。

    名称 类型 必选 描述
    Key String 标签健。
    示例值:TagKey
    Value String 标签值。
    示例值:TagValue