{ "name": "cbs", "display_name": "云硬盘", "description": "介绍如何使用API对云硬盘和快照进行相关操作，如创建弹性云盘、创建快照或回滚快照等。", "domain": "storage", "api_version": "2017-03-12", "endpoint": "cbs.tencentcloudapi.com", "actions": [ { "name": "ApplyDiskBackup", "description": "本接口（ApplyDiskBackup）用于回滚备份点到原云硬盘。 * 仅支持回滚到原云硬盘上。对于数据盘备份点，如果您需要复制备份点数据到其它云硬盘上，请先使用[CreateSnapshot](/document/product/362/15648) 将备份点转换为快照，然后使用[CreateDisks](/document/product/362/16312) 接口创建新的弹性云硬盘，将快照数据复制到新购云硬盘上。 * 用于回滚的备份点必须处于NORMAL状态。备份点状态可以通过...", "status": "online", "parameters": [ { "name": "DiskBackupId", "type": "string", "required": true, "description": "云硬盘备份点ID，可以通过[DescribeDiskBackups](/document/product/362/80278)接口查询。", "example": "dbp-xxxxxxxx" }, { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘备份点原云硬盘ID，可以通过[DescribeDisks](/document/product/362/16315)接口查。", "example": "disk-xxxxxxxx" }, { "name": "AutoStopInstance", "type": "boolean", "required": false, "description": "回滚云硬盘备份点前是否自动关机，默认为FALSE，表示不自动关机", "example": "false" }, { "name": "AutoStartInstance", "type": "boolean", "required": false, "description": "回滚云硬盘备份点完成后是否自动开机，默认为FALSE，表示不自动开机; AutoStartInstance参数需要在AutoStopInstance为true时才能为true。", "example": "false" } ], "required": [ "DiskBackupId", "DiskId" ] }, { "name": "ApplySnapshot", "description": "本接口（ApplySnapshot）用于回滚快照到原云硬盘。 * 仅支持回滚到原云硬盘上。对于数据盘快照，如果您需要复制快照数据到其它云硬盘上，请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘，将快照数据复制到新购云盘上。 * 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。 * 如...", "status": "online", "parameters": [ { "name": "SnapshotId", "type": "string", "required": true, "description": "快照ID, 可通过[DescribeSnapshots](/document/product/362/15647)查询。", "example": "snap-3xvkxxmp" }, { "name": "DiskId", "type": "string", "required": true, "description": "快照原云硬盘ID，可通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "disk-ouxaxxt2" }, { "name": "AutoStopInstance", "type": "boolean", "required": false, "description": "回滚前是否执行自动关机，仅支持回滚快照至已挂载的云硬盘时传入。 此参数为true时，AutoStartInstance才能为true。", "example": "False" }, { "name": "AutoStartInstance", "type": "boolean", "required": false, "description": "回滚完成后是否自动开机，仅支持回滚快照至已挂载的云硬盘时传入。该参数传入时，需要同时传入AutoStopInstance参数。", "example": "False" } ], "required": [ "SnapshotId", "DiskId" ] }, { "name": "ApplySnapshotGroup", "description": "本接口（ApplySnapshotGroup）用于回滚快照组，将实例恢复到创建快照组时刻的状态。 * 1.可选择快照组全部或部分盘进行回滚； * 2.如果回滚的盘中包含已挂载的盘，要求这些盘必须挂载在同一实例上，且要求该实例已关机才能回滚； * 3.回滚为异步操作，接口返回成功不代表回滚成功，可通过调DescribeSnapshotGroups接口查询快照组的状态。", "status": "online", "parameters": [ { "name": "SnapshotGroupId", "type": "string", "required": true, "description": "回滚的快照组ID。", "example": "csnap-csoplz7u" }, { "name": "ApplyDisks", "type": "array", "required": true, "description": "回滚的快照组关联的快照ID，及快照对应的原云硬盘ID列表。", "example": "无", "item_type": "object", "children": [ { "name": "SnapshotId", "type": "string", "required": true, "description": "快照组关联的快照ID。", "example": "snap-cznei4gl" }, { "name": "DiskId", "type": "string", "required": true, "description": "快照组关联快照对应的原云硬盘ID。", "example": "disk-1ly0wu8c" } ] }, { "name": "AutoStopInstance", "type": "boolean", "required": false, "description": "回滚前是否执行自动关机。", "example": "false" }, { "name": "AutoStartInstance", "type": "boolean", "required": false, "description": "回滚完成后是否自动开机。", "example": "false" } ], "required": [ "SnapshotGroupId", "ApplyDisks" ] }, { "name": "AttachDisks", "description": "本接口（AttachDisks）用于挂载云硬盘。 * 支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘，则操作不执行，返回特定的错误码。 * 本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "云服务器实例ID。云盘将被挂载到此云服务器上，通过[DescribeInstances](/document/product/213/15728)接口查询。", "example": "ins-9oxguxa" }, { "name": "DiskIds", "type": "array", "required": true, "description": "将要被挂载的弹性云盘ID。通过[DescribeDisks](/document/product/362/16315)接口查询。单次最多可挂载10块弹性云盘。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "可选参数，不传该参数则仅执行挂载操作。传入`True`时，会在挂载成功后将云硬盘设置为随云主机销毁模式，仅对按量计费云硬盘有效。", "example": "TRUE" }, { "name": "AttachMode", "type": "string", "required": false, "description": "可选参数，用于控制云盘挂载时使用的挂载模式，目前仅对黑石裸金属机型有效。取值范围：PFVF", "example": "PF" } ], "required": [ "InstanceId", "DiskIds" ] }, { "name": "BindAutoSnapshotPolicy", "description": "本接口（BindAutoSnapshotPolicy）用于绑定云硬盘到指定的定期快照策略。 * 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。 * 当已绑定定期快照策略的云硬盘处于未使用状态（即弹性云盘未挂载或非弹性云盘的主机处于关机状态）将不会创建定期快照。", "status": "online", "parameters": [ { "name": "AutoSnapshotPolicyId", "type": "string", "required": true, "description": "要绑定的定期快照策略ID，通过[ DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/362/33556)接口查询。", "example": "asp-6xtxct37" }, { "name": "DiskIds", "type": "array", "required": false, "description": "要绑定的云硬盘ID列表，一次请求最多绑定80块云盘。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" } ], "required": [ "AutoSnapshotPolicyId" ] }, { "name": "CopyAutoSnapshotPolicyCrossAccount", "description": "针对白名单内用户实现自动快照策略的跨账号复制功能", "status": "online", "parameters": [ { "name": "AutoSnapshotPolicyIds", "type": "array", "required": true, "description": "要备份的定期快照策略ID列表", "example": "[\"asp-ljylgbyo\"]", "item_type": "string" }, { "name": "TargetAccountUin", "type": "string", "required": true, "description": "目标账户uin", "example": "597568700" } ], "required": [ "AutoSnapshotPolicyIds", "TargetAccountUin" ] }, { "name": "CopySnapshotCrossRegions", "description": "本接口（CopySnapshotCrossRegions）用于快照跨地域复制。 * 本接口为异步接口，当跨地域复制的请求下发成功后会返回一个新的快照ID，此时快照未立即复制到目标地域，可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态，判断是否复制完成。如果快照的状态为“NORMAL”，表示快照复制完成。 * 本接口实现的快照跨地域复制操作将产生跨地域流量，预计202...", "status": "online", "parameters": [ { "name": "DestinationRegions", "type": "array", "required": true, "description": "快照需要复制到的目标地域，各地域的标准取值可通过接口[DescribeRegions](https://cloud.tencent.com/document/product/213/9456)查询，且只能传入支持快照的地域。", "example": "[\"ap-beijing\"]", "item_type": "string" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "需要跨地域复制的源快照ID，可通过[DescribeSnapshots](/document/product/362/15647)查询。", "example": "snap-ckgjwkqh" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "新复制快照的名称，如果不传，则默认取值为“Copied 源快照ID from 地域名”。", "example": "snap-hfdadhusads" } ], "required": [ "DestinationRegions" ] }, { "name": "CreateAutoSnapshotPolicy", "description": "本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。 * 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。 * 每个地域可创建的快照有数量和容量的限制，具体请见腾讯云控制台快照页面提示，如果快照超配额，定期快照创建会失败。", "status": "online", "parameters": [ { "name": "Policy", "type": "array", "required": true, "description": "定期快照的执行策略。", "example": "无", "item_type": "object", "children": [ { "name": "Hour", "type": "array", "required": true, "description": "指定定期快照策略的触发时间。单位为小时，取值范围：[0, 23]。00:00 ~ 23:00 共 24 个时间点可选，1表示 01:00，依此类推。", "example": "[11,12,13]", "item_type": "integer" }, { "name": "DayOfWeek", "type": "array", "required": false, "description": "指定每周从周一到周日需要触发定期快照的日期，取值范围：[0, 6]。0表示周日触发，1-6分别表示周一至周六。", "example": "[0,1,2]", "item_type": "integer" }, { "name": "DayOfMonth", "type": "array", "required": false, "description": "指定每月从月初到月底需要触发定期快照的日期,取值范围：[1, 31]，1-31分别表示每月的具体日期，比如5表示每月的5号。注：若设置29、30、31等部分月份不存在的日期，则对应不存在日期的月份会跳过不打定期快照。", "example": "[2, 3, 4]", "item_type": "integer" }, { "name": "IntervalDays", "type": "integer", "required": false, "description": "指定创建定期快照的间隔天数，取值范围：[1, 365]，例如设置为5，则间隔5天即触发定期快照创建。注：当选择按天备份时，理论上第一次备份的时间为备份策略创建当天。如果当天备份策略创建的时间已经晚于设置的备份时间，那么将会等到第二个备份周期再进行第一次备份。", "example": "50" } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否创建定期快照的执行策略。TRUE表示只需获取首次开始备份的时间，不实际创建定期快照策略，FALSE表示创建，默认为FALSE。", "example": "false" }, { "name": "IsActivated", "type": "boolean", "required": false, "description": "是否激活定期快照策略，FALSE表示未激活，TRUE表示激活，默认为TRUE。", "example": "false" }, { "name": "AutoSnapshotPolicyName", "type": "string", "required": false, "description": "要创建的定期快照策略名。不传则默认为“未命名”。最大长度不能超60个字节。", "example": "backup_data_friday" }, { "name": "IsPermanent", "type": "boolean", "required": false, "description": "通过该定期快照策略创建的快照是否永久保留。FALSE表示非永久保留，TRUE表示永久保留，默认为FALSE。", "example": "false" }, { "name": "RetentionDays", "type": "integer", "required": false, "description": "通过该定期快照策略创建的快照保留天数，默认保留7天。如果指定本参数，则IsPermanent入参不可指定为TRUE，否则会产生冲突。", "example": "20" } ], "required": [ "Policy" ] }, { "name": "CreateDiskBackup", "description": "为云硬盘创建一个备份点。", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": true, "description": "要创建备份点的云硬盘名称。", "example": "disk-xxxxxxxx" }, { "name": "DiskBackupName", "type": "string", "required": false, "description": "云硬盘备份点名称。长度不能超过100个字符。", "example": "未命名" } ], "required": [ "DiskId" ] }, { "name": "CreateDisks", "description": "本接口（CreateDisks）用于创建云硬盘。 * 预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。 * 本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。 * 本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据Di...", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目。若不指定项目，将在默认项目下进行创建。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "云硬盘所属的[可用区](/document/product/213/15753#ZoneInfo)。该参数也可以通过调用 [DescribeZones](/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-shanghai-2" }, { "name": "CageId", "type": "string", "required": false, "description": "围笼Id，可通过 [DescribeDiskStoragePool](https://cloud.tencent.com/document/api/362/62143) 获取。作为入参时，表示对指定的CageId的资源进行操作，可为空。 作为出参时，表示资源所属围笼ID，可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cage-d0eqwu84" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID，可通过DescribeProject获取。不填默认为0，表示默认项目。", "example": "0" }, { "name": "ProjectName", "type": "string", "required": false, "description": "实例所属项目名称，可通过[DescribeProject](/document/api/651/78725)获取。 注意：此字段可能返回 null，表示取不到有效值。", "example": "name" }, { "name": "CdcName", "type": "string", "required": false, "description": "独享集群名字。作为入参时，忽略。作为出参时，表示云硬盘所属的独享集群名，可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CdcName" }, { "name": "CdcId", "type": "string", "required": false, "description": "实例所属的独享集群ID。可通过 [DescribeDiskStoragePool](https://cloud.tencent.com/document/api/362/62143) 获取。作为入参时，表示对指定的CdcId独享集群的资源进行操作，可为空。 作为出参时，表示资源所属的独享集群的ID，可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-8pz1i7hg" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "独享集群id。", "example": "cluster-es1mfycs" } ] }, { "name": "DiskChargeType", "type": "string", "required": true, "description": "云硬盘计费类型。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费CDCPAID：独享集群付费各类型价格请参考云硬盘[价格总览](/document/product/362/2413)。", "example": "PREPAID" }, { "name": "DiskType", "type": "string", "required": true, "description": "硬盘介质类型。取值范围：CLOUD_PREMIUM：表示高性能云硬盘CLOUD_BSSD：表示通用型SSD云硬盘CLOUD_SSD：表示SSD云硬盘CLOUD_HSSD：表示增强型SSD云硬盘CLOUD_TSSD：表示极速型SSD云硬盘。极速型SSD云硬盘（CLOUD_TSSD）仅支持随部分实例类型一同购买，暂不支持单独创建。", "example": "CLOUD_HSSD" }, { "name": "DiskName", "type": "string", "required": false, "description": "云盘显示名称。不传则默认为“未命名”。最大长度不能超60个字节。", "example": "imc-fs9x0bv9" }, { "name": "Tags", "type": "array", "required": false, "description": "云盘绑定的标签。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签健。", "example": "TagKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "TagValue" } ] }, { "name": "SnapshotId", "type": "string", "required": false, "description": "快照ID，如果传入则根据此快照创建云硬盘，快照类型必须为数据盘快照，可通过[DescribeSnapshots](/document/product/362/15647)接口查询快照，见输出参数DiskUsage解释。", "example": "snap-6mzlaea9" }, { "name": "DiskCount", "type": "integer", "required": false, "description": "创建云硬盘数量，不传则默认为1。单次请求最多可创建的云盘数有限制，具体参见[云硬盘使用限制](https://cloud.tencent.com/doc/product/362/5145)。", "example": "1" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "使用此参数可给云硬盘购买额外的性能，单位MB/s。当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）。", "example": "100" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "购买加密盘时自定义密钥，当传入该参数时，Encrypt参数不得为空。", "example": "7ffe44e1-f57a-11e9-be2f-525400ea888" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "云硬盘大小，单位为GiB。如果传入`SnapshotId`则可不传`DiskSize`，此时新建云盘的大小为快照大小如果传入`SnapshotId`同时传入`DiskSize`，则云盘大小必须大于或等于快照大小云盘大小取值范围参见云硬盘[产品分类](/document/product/362/2353)的说明。", "example": "500" }, { "name": "Shareable", "type": "boolean", "required": false, "description": "传入True时，云盘将创建为共享型云盘，默认为False。因共享型云盘不支持加密，此参数与Encrypt参数不可同时传入。", "example": "true" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "cls-juig7fub/pvc-920a4c2f-7e1f-40d5-a475-93c6871b18b4" }, { "name": "Encrypt", "type": "string", "required": false, "description": "传入该参数用于创建加密云盘，取值固定为ENCRYPT。因共享型云盘不支持加密，此参数与Shareable参数不可同时传入。", "example": "ENCRYPT" }, { "name": "DiskChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数指定包年包月云盘的购买时长、是否设置自动续费等属性。创建预付费云盘该参数必传，创建按小时后付费云盘无需传该参数。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买云硬盘的时长，默认单位为月，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "需要将云硬盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费.", "example": "2018-03-30 20:15:03" } ] }, { "name": "DeleteSnapshot", "type": "integer", "required": false, "description": "销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁，1表示非永久快照随云盘销毁而销毁，默认取0。快照是否永久保留可以通过[DescribeSnapshots](/document/api/362/15647)接口返回的快照详情的IsPermanent字段来判断，True表示永久快照，False表示非永久快照。", "example": "0" }, { "name": "AutoMountConfiguration", "type": "object", "required": false, "description": "创建云盘时指定自动挂载并初始化该数据盘。因加密盘不支持自动挂载及初始化，此参数与Encrypt参数不可同时传入。", "example": "无", "children": [ { "name": "InstanceId", "type": "array", "required": true, "description": "要挂载到的实例ID。", "example": "[\"ins-abcdefgh\"]", "item_type": "string" }, { "name": "MountPoint", "type": "array", "required": false, "description": "子机内的挂载点。", "example": "[\"/mnt/datadisk0\"]", "item_type": "string" }, { "name": "FileSystemType", "type": "string", "required": false, "description": "文件系统类型，支持的有 ext4、xfs。", "example": "ext4" } ] }, { "name": "DiskBackupQuota", "type": "integer", "required": false, "description": "指定云硬盘备份点配额。", "example": "0" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "创建云盘时是否开启性能突发。当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）且云盘大小不小于460GiB。", "example": "true" }, { "name": "EncryptType", "type": "string", "required": false, "description": "指定云硬盘加密类型，取值为ENCRYPT_V1和ENCRYPT_V2，分别表示第一代和第二代加密技术，两种加密技术互不兼容。推荐优先使用第二代加密技术ENCRYPT_V2，第一代加密技术仅支持在部分老旧机型使用。该参数仅当创建加密云硬盘时有效。", "example": "ENCRYPT_V2" } ], "required": [ "Placement", "DiskChargeType", "DiskType" ] }, { "name": "CreateSnapshot", "description": "本接口（CreateSnapshot）用于对指定云盘创建快照。 * 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询，见SnapshotAbility字段。 * 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。 * 当前支持将备份点转化为普通快照，转化之后可能会收取快照使用费用，备份点不保留，其占用的备份点配\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": false, "description": "需要创建快照的云硬盘ID，可通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "disk-l7mxexxc" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "快照名称，不传则新快照名称默认为“未命名”。", "example": "cloud-snap" }, { "name": "Deadline", "type": "string", "required": false, "description": "快照的到期时间，到期后该快照将会自动删除,需要传入UTC时间下的ISO-8601标准时间格式,例如:2022-01-08T09:47:55+00:00,。到期时间最小可设置为一天后的当前时间。", "example": "2022-01-08T09:47:55+00:00" }, { "name": "DiskBackupId", "type": "string", "required": false, "description": "云硬盘备份点ID。传入此参数时，将通过备份点创建快照。备份点 ID 可以通过[DescribeDiskBackups](/document/product/362/80278)接口查询。", "example": "dbp-l7mxexxc" }, { "name": "Tags", "type": "array", "required": false, "description": "快照绑定的标签。", "example": "[{\"value\": \"常规项目\", \"key\": \"项目类型\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签健。", "example": "TagKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "TagValue" } ] }, { "name": "DiskUsage", "type": "string", "required": false, "description": "快照关联云硬盘类型, SYSTEM_DISK: 系统盘, DATA_DISK: 数据盘,非必填参数，不填时快照类型与云盘类型保持一致， 该参数基于某些场景用户需要将系统盘创建出数据盘快照共享使用。", "example": "DATA_DISK" } ], "required": [] }, { "name": "CreateSnapshotGroup", "description": "本接口（CreateSnapshotGroup）用于创建快照组。 * 创建快照组的云硬盘列表必须挂载在同一实例上； * 可选择挂载在实例上的全部或部分盘创建快照组。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "需要创建快照组的云硬盘ID列表，必须选择挂载在同一实例上的盘列表。", "example": "[\"disk-6rag8jef\"]", "item_type": "string" }, { "name": "SnapshotGroupName", "type": "string", "required": false, "description": "快照组名称，快照组关联的快照也会继承快照组的名称。例如：快照组名称为testSnapshotGroup，快照组关联两个快照，则两个快照的名称分别为testSnapshotGroup_0，testSnapshotGroup_1。", "example": "testSnapGroup" }, { "name": "Tags", "type": "array", "required": false, "description": "快照组需要绑定的标签列表。", "example": "[{\"Key\": \"tagKey\", \"Value\": \"tagVal\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签健。", "example": "TagKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "TagValue" } ] } ], "required": [ "DiskIds" ] }, { "name": "DeleteAutoSnapshotPolicies", "description": "本接口（DeleteAutoSnapshotPolicies）用于删除定期快照策略。 * 支持批量操作。如果多个定期快照策略存在无法删除的，则操作不执行，以特定错误码返回。", "status": "online", "parameters": [ { "name": "AutoSnapshotPolicyIds", "type": "array", "required": true, "description": "要删除的定期快照策略ID列表，通过[ DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/362/33556)接口查询。", "example": "[\"asp-mrsrn243\",\"asp-3lpl7ev3\"]", "item_type": "string" } ], "required": [ "AutoSnapshotPolicyIds" ] }, { "name": "DeleteDiskBackups", "description": "批量删除指定的云硬盘备份点。", "status": "online", "parameters": [ { "name": "DiskBackupIds", "type": "array", "required": true, "description": "待删除的云硬盘备份点ID，可以通过[DescribeDiskBackups](/document/product/362/80278)接口查询。", "example": "[\"dbp-xxxxxxxx\"]", "item_type": "string" } ], "required": [ "DiskBackupIds" ] }, { "name": "DeleteSnapshotGroup", "description": "本接口（DeleteSnapshotGroup）用于删除快照组，一次调用仅支持删除一个快照组。 * 默认会删除快照组内的所有快照； * 如果快照组内的快照有关联镜像，则删除失败，所有快照均不会删除；如果需要同时删除快照绑定的镜像，可传入参数DeleteBindImages等于true。", "status": "online", "parameters": [ { "name": "SnapshotGroupId", "type": "string", "required": false, "description": "快照组ID。", "example": "csnap-gv9naz67" }, { "name": "SnapshotGroupIds", "type": "array", "required": false, "description": "快照组ID 列表。此参数与快照组 ID 至少传 1 个，同时传会与快照组 ID 合并。", "example": "[\"csnap-gv9naz66\"]", "item_type": "string" }, { "name": "DeleteBindImages", "type": "boolean", "required": false, "description": "是否同时删除快照组关联的镜像；取值为false，表示不删除快照组绑定的镜像，此时，如果快照组有绑定的镜像，删除会失败；取值为true，表示同时删除快照组绑定的镜像；默认值为false。", "example": "true" } ], "required": [] }, { "name": "DeleteSnapshots", "description": "本接口（DeleteSnapshots）用于删除快照。 * 快照必须处于NORMAL状态，快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。 * 支持批量操作。如果多个快照存在无法删除的快照，则操作不执行，以特定的错误码返回。", "status": "online", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": true, "description": "要删除的快照ID列表，可通过[DescribeSnapshots](/document/product/362/15647)查询。", "example": "[\"snap-gybrif0z\"]", "item_type": "string" }, { "name": "DeleteBindImages", "type": "boolean", "required": false, "description": "是否强制删除快照关联的镜像", "example": "true" } ], "required": [ "SnapshotIds" ] }, { "name": "DescribeAutoSnapshotPolicies", "description": "本接口（DescribeAutoSnapshotPolicies）用于查询定期快照策略。 * 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的定期快照策略表。", "status": "online", "parameters": [ { "name": "AutoSnapshotPolicyIds", "type": "array", "required": false, "description": "要查询的定期快照策略ID列表。参数不支持同时指定`AutoSnapshotPolicyIds`和`Filters`。", "example": "[\"asp-c9m1berf\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。参数不支持同时指定`AutoSnapshotPolicyIds`和`Filters`。 auto-snapshot-policy-id - Array of String - 是否必填：否 -（过滤条件）按定期快照策略ID进行过滤。定期快照策略ID形如：`asp-3stvwfxx`。 auto-snapshot-policy-state - Array of String - 是否必填：否 -（过滤条件）按定期快照策略的状态进行过滤。定期快照策略ID形如：`asp-3stvwfxx`。(NORMAL：正常 | ISOLATED：已隔离。) auto-snapshot-policy-name - Arra...", "example": "[{\"Name\":\"auto-snapshot-policy-state\",\"Values\":[\"NORMAL\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称", "example": "snapshot-state" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值", "example": "[\"NORMAL\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "输出定期快照列表的排列顺序。取值范围：ASC：升序排列DESC：降序排列。", "example": "ASC" }, { "name": "OrderField", "type": "string", "required": false, "description": "定期快照列表排序的依据字段。取值范围：CREATE_TIME：依据定期快照的创建时间排序，默认按创建时间排序。", "example": "CREATE_TIME" } ], "required": [] }, { "name": "DescribeDiskAssociatedAutoSnapshotPolicy", "description": "本接口（DescribeDiskAssociatedAutoSnapshotPolicy）用于查询云盘绑定的定期快照策略。", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": true, "description": "要查询的云硬盘ID，通过[DescribeDisks](https://cloud.tencent.com/document/api/362/16315)接口查询。", "example": "disk-lg4ckc93" } ], "required": [ "DiskId" ] }, { "name": "DescribeDiskBackups", "description": "本接口（DescribeDiskBackups）用于查询备份点的详细信息。 根据备份点ID、创建备份点的云硬盘ID、创建备份点的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器Filter。 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的备份点列表。", "status": "online", "parameters": [ { "name": "DiskBackupIds", "type": "array", "required": false, "description": "要查询备份点的ID列表。参数不支持同时指定 DiskBackupIds 和 Filters。", "example": "[\"dbp-704k734w\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定 DiskBackupIds 和 Filters。过滤条件：disk-backup-id - Array of String - 是否必填：否 -（过滤条件）按照备份点的ID过滤。备份点ID形如：dbp-11112222。disk-id - Array of String - 是否必填：否 -（过滤条件）按照创建备份点的云硬盘ID过滤。云硬盘ID形如：disk-srftydert。disk-usage - Array of String - 是否必填：否 -（过滤条件）按创建备份点的云硬盘类型过滤。 (SYSTEM_DISK：...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称", "example": "snapshot-state" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值", "example": "[\"NORMAL\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "20" }, { "name": "Order", "type": "string", "required": false, "description": "输出云硬盘备份点列表的排列顺序，默认排序：ASC。取值范围：ASC：升序排列DESC：降序排列。", "example": "ASC" }, { "name": "OrderField", "type": "string", "required": false, "description": "云硬盘备份点列表排序的依据字段。取值范围：CREATE_TIME：依据云硬盘备份点的创建时间排序默认按创建时间排序。", "example": "CREATE_TIME" } ], "required": [] }, { "name": "DescribeDiskConfigQuota", "description": "本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。", "status": "online", "parameters": [ { "name": "InquiryType", "type": "string", "required": true, "description": "查询类别，取值范围。 INQUIRY_CBS_CONFIG：查询云盘配置列表 INQUIRY_CVM_CONFIG：查询云盘与实例搭配的配置列表。", "example": "INQUIRY_CVM_CONFIG" }, { "name": "DiskChargeType", "type": "string", "required": false, "description": "付费模式。取值范围： PREPAID：预付费 POSTPAID_BY_HOUR：后付费。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceFamilies", "type": "array", "required": false, "description": "按照实例机型系列过滤。实例机型系列形如：S1、I1、M1等。详见[实例类型](https://cloud.tencent.com/document/product/213/11518)", "example": "[\"S3\"]", "item_type": "string" }, { "name": "DiskTypes", "type": "array", "required": false, "description": "硬盘介质类型。取值范围： CLOUD_BASIC：表示普通云硬盘 CLOUD_PREMIUM：表示高性能云硬盘 CLOUD_SSD：表示SSD云硬盘 CLOUD_HSSD：表示增强型SSD云硬盘。", "example": "[\"CLOUD_PREMIUM\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "查询一个或多个[可用区](/document/product/213/15753#ZoneInfo)下的配置。", "example": "[\"ap-guangzhou-7\"]", "item_type": "string" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例内存大小,单位GB。", "example": "4" }, { "name": "DiskUsage", "type": "string", "required": false, "description": "系统盘或数据盘。取值范围： SYSTEM_DISK：表示系统盘 DATA_DISK：表示数据盘。", "example": "DATA_DISK" }, { "name": "CPU", "type": "integer", "required": false, "description": "实例CPU核数。", "example": "2" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "专用集群ID。", "example": "cluster-ay3xxxxf" } ], "required": [ "InquiryType" ] }, { "name": "DescribeDiskStoragePool", "description": "本接口（DescribeDiskStoragePool）查询用户的云硬盘独享集群列表。 * 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息，不同的过滤条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘独享集群列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "20" }, { "name": "CdcIds", "type": "array", "required": false, "description": "指定需要查询的独享集群ID列表，该入参不能与Filters一起使用。", "example": "cdc-asdasd", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。参数不支持同时指定`CdcIds`和`Filters`。cdc-id - Array of String - 是否必填：否 -（过滤条件）按独享集群ID过滤。zone - Array of String - 是否必填：否 -（过滤条件）按独享集群所在[可用区](/document/product/213/15753#ZoneInfo)过滤。cage-id - Array of String - 是否必填：否 -（过滤条件）按独享集群所在围笼的ID过滤。disk-type - Array of String - 是否必填：否 -（过滤条件）按照云盘介质类型过...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称", "example": "snapshot-state" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值", "example": "[\"NORMAL\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "0" } ], "required": [] }, { "name": "DescribeDisks", "description": "本接口（DescribeDisks）用于查询云硬盘列表。 * 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。参数不支持同时指定`DiskIds`和`Filters`。 disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘) disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。) portable - Array of String - 是否必填：否 -（过滤条...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称", "example": "snapshot-state" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值", "example": "[\"NORMAL\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "云盘列表排序的依据字段。取值范围：CREATE_TIME：依据云盘的创建时间排序DEADLINE：依据云盘的到期时间排序默认按云盘创建时间排序。", "example": "CREATE_TIME" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "0" }, { "name": "ReturnBindAutoSnapshotPolicy", "type": "boolean", "required": false, "description": "云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。", "example": "false" }, { "name": "DiskIds", "type": "array", "required": false, "description": "按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。", "example": "[\"disk-xxxxxxxx\"]", "item_type": "string" }, { "name": "Order", "type": "string", "required": false, "description": "输出云盘列表的排列顺序。取值范围：ASC：升序排列DESC：降序排列。", "example": "ASC" } ], "required": [] }, { "name": "DescribeInstancesDiskNum", "description": "本接口（DescribeInstancesDiskNum）用于查询实例已挂载云硬盘数量。 * 支持批量操作，当传入多个云服务器实例ID，返回结果会分别列出每个云服务器挂载的云硬盘数量。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "云服务器实例ID，通过[DescribeInstances](/document/product/213/15728)接口查询。", "example": "[\"ins-9w5d2buw\",\"ins-jw0vit58\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeSnapshotGroups", "description": "本接口（DescribeSnapshotGroups）用于查询快照组列表。 * 可以根据快照组ID、快照组状态、快照组关联的快照ID等来查询快照组列表，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照组列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。snapshot-group-id - Array of String - 是否必填：否 -（过滤条件）按快照组ID过滤 snapshot-group-state - Array of String - 是否必填：否 -（过滤条件）按快照组状态过滤。(NORMAL: 正常 | CREATING:创建中 | ROLLBACKING:回滚中) snapshot-group-name - Array of String - 是否必填：否 -（过滤条件）按快照组名称过滤 snapshot-id - Array of String - 是否必填：否 -（过滤条件）按快照组内的快照ID过滤", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称", "example": "snapshot-state" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值", "example": "[\"NORMAL\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeSnapshotOverview", "description": "该接口用于查询用户快照使用概览，包括快照总容量、计费容量等信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSnapshotSharePermission", "description": "本接口（DescribeSnapshotSharePermission）用于查询快照的分享信息。", "status": "online", "parameters": [ { "name": "SnapshotId", "type": "string", "required": true, "description": "要查询快照的ID。可通过[DescribeSnapshots](https://cloud.tencent.com/document/api/362/15647)查询获取。", "example": "snap-xxxxxxxx" } ], "required": [ "SnapshotId" ] }, { "name": "DescribeSnapshots", "description": "本接口（DescribeSnapshots）用于查询快照的详细信息。 * 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照列表。", "status": "online", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": false, "description": "要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。", "example": "[\"snap-j1ytqxx7\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。参数不支持同时指定SnapshotIds和Filters。snapshot-id按照云硬盘快照ID进行过滤类型：String必选：否snapshot-name按照云硬盘快照名称进行过滤类型：String必选：否snapshot-state按照云硬盘快照状态进行过滤类型：String必选：否取值范围：NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中 COPYING_FROM_REMOTE：跨地域复制中 CHECKING_COPIED：复制校验中TORECYCLE：待回收disk-usage按照云硬盘使用...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称", "example": "snapshot-state" }, { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值", "example": "[\"NORMAL\"]", "item_type": "string" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "快照列表排序的依据字段。取值范围： CREATE_TIME：依据快照的创建时间排序 默认按创建时间排序", "example": "CREATE_TIME" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "0" }, { "name": "Order", "type": "string", "required": false, "description": "输出云盘列表的排列顺序。取值范围： ASC：升序排列 DESC：降序排列。", "example": "DESC" } ], "required": [] }, { "name": "DetachDisks", "description": "本接口（DetachDisks）用于卸载云硬盘。 * 支持批量操作，卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘，则操作不执行，返回特定的错误码。 * 本接口为异步接口，当请求成功返回时，云盘并未立即从主机卸载，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHED”变为“UNATTACHED”，则为卸载成功。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "将要卸载的云硬盘ID， 通过[DescribeDisks](/document/product/362/16315)接口查询，单次请求最多可卸载10块弹性云盘。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": false, "description": "对于非共享型云盘，会根据该参数校验是否与实际挂载的实例一致；对于共享型云盘，该参数表示要从哪个CVM实例上卸载云盘。", "example": "ins-arxix3xm" } ], "required": [ "DiskIds" ] }, { "name": "GetSnapOverview", "description": "为进一步规范化API命名，该接口决定预下线，新接口命名为：DescribeSnapshotOverview 获取快照概览信息", "status": "deprecated", "parameters": [], "required": [] }, { "name": "InitializeDisks", "description": "重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点： 1. 如果云硬盘是由快照创建的，则重新初始化会通过此快照重新回滚此云硬盘，即将云硬盘恢复为与快照一致的状态； 2. 如果云硬盘不是通过快照创建的，则重新初始化会清空此云硬盘的数据；请在重新初始化云硬盘前检查并备份必要的数据； 3. 当前仅未挂载的、非共享属性的\ufffd...", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "待重新初始化的云硬盘ID列表，可以通过[DescribeDisks](/document/product/362/16315)接口查询， 单次初始化限制20块以内", "example": "[\"disk-12sdf234\"]", "item_type": "string" } ], "required": [ "DiskIds" ] }, { "name": "InquirePriceModifyDiskBackupQuota", "description": "本接口（InquirePricePriceModifyDiskBackupQuota）用于修改云硬盘备份点配额询价。", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘ID， 通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "disk-l7mxexxc" }, { "name": "DiskBackupQuota", "type": "integer", "required": true, "description": "修改后的云硬盘备份点配额，即云盘可以拥有的备份点数量，单位为个。", "example": "1" } ], "required": [ "DiskId", "DiskBackupQuota" ] }, { "name": "InquirePriceModifyDiskExtraPerformance", "description": "本接口（InquirePriceModifyDiskExtraPerformance）用于调整云硬盘额外性能询价。", "status": "online", "parameters": [ { "name": "ThroughputPerformance", "type": "integer", "required": true, "description": "额外购买的云硬盘性能值，单位MiB/s。仅大小超过460GiB的增强型SSD（CLOUD_HSSD）和极速型SSD（CLOUD_TSSD）云硬盘才支持购买额外性能。", "example": "200" }, { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘ID， 通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "disk-dritwhhm" } ], "required": [ "ThroughputPerformance", "DiskId" ] }, { "name": "InquiryPriceCreateDisks", "description": "本接口（InquiryPriceCreateDisks）用于创建云硬盘询价。 * 支持查询创建多块云硬盘的价格，此时返回结果为总价格。", "status": "online", "parameters": [ { "name": "DiskChargeType", "type": "string", "required": true, "description": "云硬盘计费类型： PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：按小时后付费", "example": "PREPAID" }, { "name": "DiskType", "type": "string", "required": true, "description": "硬盘介质类型。取值范围： CLOUD_PREMIUM：表示高性能云硬盘 CLOUD_SSD：表示SSD云硬盘 CLOUD_HSSD：表示增强型SSD云硬盘 CLOUD_TSSD：表示极速型SSD云硬盘", "example": "CLOUD_TSSD" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "云硬盘大小，单位为GiB。云盘大小取值范围参见云硬盘[产品分类](/document/product/362/2353)的说明。", "example": "500" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "云硬盘所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "0" }, { "name": "DiskCount", "type": "integer", "required": false, "description": "购买云硬盘的数量。不填则默认为1。", "example": "1" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "额外购买的云硬盘性能值，单位MiB/s。仅大小超过460GiB的增强型SSD（CLOUD_HSSD）和极速型SSD（CLOUD_TSSD）云硬盘才支持购买额外性能。", "example": "100" }, { "name": "DiskChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数指定包年包月云盘的购买时长、是否设置自动续费等属性。创建预付费云盘该参数必传，创建按小时后付费云盘无需传该参数。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买云硬盘的时长，默认单位为月，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "需要将云硬盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费.", "example": "2018-03-30 20:15:03" } ] }, { "name": "DiskBackupQuota", "type": "integer", "required": false, "description": "指定云硬盘备份点配额。", "example": "0" } ], "required": [ "DiskChargeType", "DiskType", "DiskSize" ] }, { "name": "InquiryPriceRenewDisks", "description": "本接口（InquiryPriceRenewDisks）用于续费云硬盘询价。 * 只支持查询预付费模式的弹性云盘续费价格。 * 支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到实例续费后的到期时间来续费询价。 * 支持为多块云盘指定不同的续费时长，此时返回的价格为多块云盘续费的总价格。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "云硬盘ID， 通过DescribeDisks接口查询。", "example": "[\"disk-l9mxezxc\"]", "item_type": "string" }, { "name": "DiskChargePrepaids", "type": "array", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月云盘的购买时长。如果在该参数中指定CurInstanceDeadline，则会按对齐到子机到期时间来续费。如果是批量续费询价，该参数与Disks参数一一对应，元素数量需保持一致。", "example": "无", "item_type": "object", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买云硬盘的时长，默认单位为月，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "需要将云硬盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费.", "example": "2018-03-30 20:15:03" } ] }, { "name": "NewDeadline", "type": "string", "required": false, "description": "指定云硬盘新的到期时间，形式如：2017-12-17 00:00:00。参数NewDeadline和DiskChargePrepaids是两种指定询价时长的方式，两者必传一个。", "example": "2025-01-01 00:00:00" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "云硬盘所属项目ID。该参数可以通过调用DescribeProject 的返回值中的 projectId 字段来获取。 如传入则仅用于鉴权。", "example": "0" } ], "required": [ "DiskIds" ] }, { "name": "InquiryPriceResizeDisk", "description": "本接口（InquiryPriceResizeDisk）用于扩容云硬盘询价。", "status": "online", "parameters": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "云硬盘扩容后的大小，单位为GiB，不得小于当前云硬盘大小。云盘大小取值范围参见云硬盘[产品分类](/document/product/362/2353)的说明。", "example": "200" }, { "name": "DiskId", "type": "string", "required": false, "description": "云硬盘ID， 通过[DescribeDisks](/document/product/362/16315)接口查询。与参数DiskIds互斥。", "example": "disk-dw0bbzws" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "云硬盘所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。 如传入则仅用于鉴权。", "example": "1002189" }, { "name": "DiskIds", "type": "array", "required": false, "description": "云硬盘ID列表， 通过[DescribeDisks](/document/product/362/16315)接口查询。与参数DiskId互斥。", "example": "[\"disk-dw0bbzws\"]", "item_type": "string" } ], "required": [ "DiskSize" ] }, { "name": "ModifyAutoSnapshotPolicyAttribute", "description": "本接口（ModifyAutoSnapshotPolicyAttribute）用于修改定期快照策略属性。 * 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。 * 修改保留天数时必须保证不与是否永久保留属性冲突，否则整个操作失败，以特定的错误码返回。", "status": "online", "parameters": [ { "name": "AutoSnapshotPolicyId", "type": "string", "required": true, "description": "定期快照策略ID。可以通过[查询定期快照策略](https://cloud.tencent.com/document/product/362/33556)API查询。", "example": "asp-nqu08k2l" }, { "name": "IsActivated", "type": "boolean", "required": false, "description": "是否激活定期快照策略，`false`表示未激活，`true`表示激活；默认为`true`。", "example": "true" }, { "name": "IsPermanent", "type": "boolean", "required": false, "description": "通过该定期快照策略创建的快照是否永久保留。`false`表示非永久保留，`true`表示永久保留，默认为`false`。", "example": "true" }, { "name": "AutoSnapshotPolicyName", "type": "string", "required": false, "description": "要创建的定期快照策略名。不传则默认为“未命名”。最大长度不能超60个字节。", "example": "data_disk_auto_snapshot" }, { "name": "Policy", "type": "array", "required": false, "description": "定期快照的执行策略。", "example": "无", "item_type": "object", "children": [ { "name": "Hour", "type": "array", "required": true, "description": "指定定期快照策略的触发时间。单位为小时，取值范围：[0, 23]。00:00 ~ 23:00 共 24 个时间点可选，1表示 01:00，依此类推。", "example": "[11,12,13]", "item_type": "integer" }, { "name": "DayOfWeek", "type": "array", "required": false, "description": "指定每周从周一到周日需要触发定期快照的日期，取值范围：[0, 6]。0表示周日触发，1-6分别表示周一至周六。", "example": "[0,1,2]", "item_type": "integer" }, { "name": "DayOfMonth", "type": "array", "required": false, "description": "指定每月从月初到月底需要触发定期快照的日期,取值范围：[1, 31]，1-31分别表示每月的具体日期，比如5表示每月的5号。注：若设置29、30、31等部分月份不存在的日期，则对应不存在日期的月份会跳过不打定期快照。", "example": "[2, 3, 4]", "item_type": "integer" }, { "name": "IntervalDays", "type": "integer", "required": false, "description": "指定创建定期快照的间隔天数，取值范围：[1, 365]，例如设置为5，则间隔5天即触发定期快照创建。注：当选择按天备份时，理论上第一次备份的时间为备份策略创建当天。如果当天备份策略创建的时间已经晚于设置的备份时间，那么将会等到第二个备份周期再进行第一次备份。", "example": "50" } ] }, { "name": "RetentionDays", "type": "integer", "required": false, "description": "通过该定期快照策略创建的快照保留天数。如果指定本参数，则IsPermanent入参不可指定为TRUE，否则会产生冲突。", "example": "6" } ], "required": [ "AutoSnapshotPolicyId" ] }, { "name": "ModifyDiskAttributes", "description": "* 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。是否是弹性云盘可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。 * “云硬盘名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。 * 支持批量操作，如果传入多个云盘ID，则所有云盘修改为同一属性。如果存在不允许\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "一个或多个待操作的云硬盘ID，可以通过[DescribeDisks](/document/product/362/16315)接口查询。如果传入多个云盘ID，仅支持将所有云盘修改为同一属性。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" }, { "name": "DiskName", "type": "string", "required": false, "description": "新的云硬盘名称。", "example": "DataDisk-Production-01" }, { "name": "Portable", "type": "boolean", "required": false, "description": "是否为弹性云盘，FALSE表示非弹性云盘，TRUE表示弹性云盘。仅支持非弹性云盘修改为弹性云盘。", "example": "TRUE" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "新的云硬盘项目ID，只支持修改弹性云盘的项目ID。通过[DescribeProject](/document/api/378/4400)接口查询可用项目及其ID。", "example": "0" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "成功挂载到云主机后该云硬盘是否随云主机销毁，TRUE表示随云主机销毁，FALSE表示不随云主机销毁。仅支持按量计费云硬盘数据盘。", "example": "FALSE" }, { "name": "DiskType", "type": "string", "required": false, "description": "变更云盘类型时，可传入该参数，表示变更的目标类型，取值范围：CLOUD_PREMIUM：表示高性能云硬盘CLOUD_SSD：表示SSD云硬盘。当前不支持批量变更类型，即传入DiskType时，DiskIds仅支持传入一块云盘；变更云盘类型时不支持同时变更其他属性。 具体说明请参考[调整云硬盘类型](https://cloud.tencent.com/document/product/362/32540)", "example": "CLOUD_SSD" }, { "name": "BurstPerformanceOperation", "type": "string", "required": false, "description": "开启/关闭云盘性能突发功能，取值范围： CREATE：开启 CANCEL：关闭", "example": "CREATE" } ], "required": [ "DiskIds" ] }, { "name": "ModifyDiskBackupQuota", "description": "此接口 (ModifyDiskBackupQuota) 用于修改云硬盘备份点配额。", "status": "online", "parameters": [ { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘ID。可通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "disk-b1f7xvod" }, { "name": "DiskBackupQuota", "type": "integer", "required": true, "description": "调整之后的云硬盘备份点配额。取值范围为1 ~ 1024。", "example": "1" } ], "required": [ "DiskId", "DiskBackupQuota" ] }, { "name": "ModifyDiskExtraPerformance", "description": "本接口（ModifyDiskExtraPerformance）用于调整云硬盘额外的性能。 * 目前仅支持增强型SSD云硬盘(CLOUD_HSSD)和极速型SSD云硬盘（CLOUD_TSSD）。", "status": "online", "parameters": [ { "name": "ThroughputPerformance", "type": "integer", "required": true, "description": "额外购买的云硬盘性能值，单位MiB/s。", "example": "300" }, { "name": "DiskId", "type": "string", "required": true, "description": "需要购买额外性能值的云硬盘ID，可通过[DescribeDisks](/document/product/362/16315)接口查询。仅大小超过460GiB的增强型SSD（CLOUD_HSSD）和极速型SSD（CLOUD_TSSD）云硬盘才支持购买额外性能。", "example": "disk-dritwhhm" } ], "required": [ "ThroughputPerformance", "DiskId" ] }, { "name": "ModifyDisksChargeType", "description": "本接口 (ModifyDisksChargeType) 用于切换云硬盘的计费模式。 非弹性云硬盘不支持此接口，请通过修改实例计费模式接口将实例连同非弹性云硬盘一起转换。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "一个或多个待操作的云硬盘ID,可以通过[DescribeDisks](/document/product/362/16315)接口查询。每次请求批量云硬盘上限为100。", "example": "[\"disk-jwk0zvrg\"]", "item_type": "string" }, { "name": "DiskChargePrepaid", "type": "object", "required": false, "description": "设置为预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买云硬盘的时长，默认单位为月，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "需要将云硬盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费.", "example": "2018-03-30 20:15:03" } ] }, { "name": "DiskChargePostpaid", "type": "boolean", "required": false, "description": "设置为后付费模式", "example": "True" } ], "required": [ "DiskIds" ] }, { "name": "ModifyDisksRenewFlag", "description": "本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识，支持批量修改。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "一个或多个待操作的云硬盘ID，该参数可以通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "[\"disk-1esd341d\"]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "云硬盘的自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "AutoRenewPeriod", "type": "integer", "required": false, "description": "该参数支持设置云硬盘的自动续费周期，单位为月。取值范围：[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]", "example": "12" } ], "required": [ "DiskIds", "RenewFlag" ] }, { "name": "ModifySnapshotAttribute", "description": "本接口（ModifySnapshotAttribute）用于修改指定快照的属性。 * 本接口支持修改快照名称及到期时间，以及将非永久快照修改为永久快照。 * “快照名称”仅为方便用户管理之用，腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。", "status": "online", "parameters": [ { "name": "SnapshotId", "type": "string", "required": true, "description": "快照ID, 可通过[DescribeSnapshots](https://cloud.tencent.com/document/api/362/15647)查询。", "example": "snap-gybrif0z" }, { "name": "IsPermanent", "type": "boolean", "required": false, "description": "快照的保留方式，FALSE表示非永久保留，TRUE表示永久保留。", "example": "true" }, { "name": "SnapshotName", "type": "string", "required": false, "description": "新的快照名称。最长为60个字符。", "example": "snap_201711301143" }, { "name": "Deadline", "type": "string", "required": false, "description": "快照的到期时间；设置好快照将会被同时设置为非永久保留方式；超过到期时间后快照将会被自动删除。注：该参数仅在参数IsPermanent为False时生效。", "example": "2022-01-08T09:47:55+00:00" } ], "required": [ "SnapshotId" ] }, { "name": "ModifySnapshotsSharePermission", "description": "本接口（ModifySnapshotsSharePermission）用于修改快照分享信息。 分享快照后，被分享账户可以通过该快照创建云硬盘。 * 每个快照最多可分享给50个账户。 * 分享快照无法更改名称，描述，仅可用于创建云硬盘。 * 只支持分享到对方账户相同地域。 * 仅支持分享数据盘快照。", "status": "online", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": true, "description": "快照ID, 可通过[DescribeSnapshots](https://cloud.tencent.com/document/api/362/15647)查询获取。", "example": "[\"snap-j1ytqxx7\"]", "item_type": "string" }, { "name": "AccountIds", "type": "array", "required": true, "description": "接收分享快照的账号Id列表，array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/568)。账号ID不同于QQ号，查询用户账号ID请查看[账号信息](https://console.cloud.tencent.com/developer)中的账号ID栏。", "example": "[\"100001122000\"]", "item_type": "string" }, { "name": "Permission", "type": "string", "required": true, "description": "操作，包括 SHARE，CANCEL。其中SHARE代表分享操作，CANCEL代表取消分享操作。", "example": "\"SHARE\"" } ], "required": [ "SnapshotIds", "AccountIds", "Permission" ] }, { "name": "RenewDisk", "description": "本接口（RenewDisk）用于续费云硬盘。 * 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中DiskChargeType字段解释。 * 支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到子机续费后的到期时间来续费。", "status": "online", "parameters": [ { "name": "DiskChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月云硬盘的续费时长。在云硬盘与挂载的实例一起续费的场景下，可以指定参数CurInstanceDeadline，此时云硬盘会按对齐到实例续费后的到期时间来续费。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买云硬盘的时长，默认单位为月，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认取值：NOTIFY_AND_MANUAL_RENEW。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "需要将云硬盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费.", "example": "2018-03-30 20:15:03" } ] }, { "name": "DiskId", "type": "string", "required": true, "description": "云硬盘ID， 通过DescribeDisks接口查询。", "example": "disk-jwk0zvrg" } ], "required": [ "DiskChargePrepaid", "DiskId" ] }, { "name": "ResizeDisk", "description": "本接口（ResizeDisk）用于扩容云硬盘。 * 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。 * 本接口为异步接口，接口成功返回时，云盘并未立即扩容到指定大小，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "云硬盘扩容后的大小，单位为GB，必须大于当前云硬盘大小。云盘大小取值范围参见云硬盘[产品分类](/document/product/362/2353)的说明。", "example": "100" }, { "name": "DiskId", "type": "string", "required": false, "description": "云硬盘ID， 通过[DescribeDisks](/document/product/362/16315)接口查询。该字段仅供单块云硬盘扩容时传入。", "example": "disk-l7mxexxc" } ], "required": [ "DiskSize" ] }, { "name": "TerminateDisks", "description": "本接口（TerminateDisks）用于退还云硬盘。 * 不再使用的云盘，可通过本接口主动退还。 * 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。 * 支持批量操作，每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的，请求会以特定错误码返回。", "status": "online", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "需退还的云盘ID列表，通过[DescribeDisks](/document/product/362/16315)接口查询。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" }, { "name": "DeleteSnapshot", "type": "integer", "required": false, "description": "销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁，1表示非永久快照随云盘销毁而销毁，默认取0。快照是否永久保留可以通过DescribeSnapshots接口返回的快照详情的IsPermanent字段来判断，true表示永久快照，false表示非永久快照。", "example": "0" } ], "required": [ "DiskIds" ] }, { "name": "UnbindAutoSnapshotPolicy", "description": "本接口（UnbindAutoSnapshotPolicy）用于解除云硬盘绑定的定期快照策略。 * 支持批量操作，可一次解除多个云盘与同一定期快照策略的绑定。 * 如果传入的云盘未绑定到当前定期快照策略，接口将自动跳过，仅解绑与当前定期快照策略绑定的云盘。", "status": "online", "parameters": [ { "name": "AutoSnapshotPolicyId", "type": "string", "required": true, "description": "要解绑的定期快照策略ID。", "example": "asp-mrsrn243" }, { "name": "DiskIds", "type": "array", "required": false, "description": "要解绑定期快照策略的云盘ID列表。此参数与 InstanceIds 参数至少需要传入一个。", "example": "[\"disk-dw0bbzws\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "要解绑定期快照策略的实例ID列表。此参数与 DiskIds 参数至少需要传入一个。", "example": "[\"ins-locaa0iu\"]", "item_type": "string" } ], "required": [ "AutoSnapshotPolicyId" ] } ] }