Files

86 lines
5.8 KiB
C#
Raw Permalink Normal View History

/*
* Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
namespace TencentCloud.Cbs.V20170312.Models
{
using Newtonsoft.Json;
using System.Collections.Generic;
using TencentCloud.Common;
public class DescribeDisksRequest : AbstractModel
{
/// <summary>
/// 按照一个或者多个云硬盘ID查询。云硬盘ID形如`disk-11112222`此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节。参数不支持同时指定`DiskIds`和`Filters`。
/// </summary>
[JsonProperty("DiskIds")]
public string[] DiskIds{ get; set; }
/// <summary>
/// 过滤条件。参数不支持同时指定`DiskIds`和`Filters`。<br><li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按云盘类型过滤。 (SYSTEM_DISK表示系统盘 | DATA_DISK表示数据盘)<br><li>disk-charge-type - Array of String - 是否必填:否 -(过滤条件)按照云硬盘计费模式过滤。 (PREPAID表示预付费即包年包月 | POSTPAID_BY_HOUR表示后付费即按量计费。)<br><li>portable - Array of String - 是否必填:否 -(过滤条件)按是否为弹性云盘过滤。 (TRUE表示弹性云盘 | FALSE表示非弹性云盘。)<br><li>project-id - Array of Integer - 是否必填:否 -过滤条件按云硬盘所属项目ID过滤。<br><li>disk-id - Array of String - 是否必填:否 -过滤条件按照云硬盘ID过滤。云盘ID形如`disk-11112222`。<br><li>disk-name - Array of String - 是否必填:否 -(过滤条件)按照云盘名称过滤。<br><li>disk-type - Array of String - 是否必填:否 -(过滤条件)按照云盘介质类型过滤。(CLOUD_BASIC表示普通云硬盘 | CLOUD_PREMIUM表示高性能云硬盘。| CLOUD_SSDSSD表示SSD云硬盘。)<br><li>disk-state - Array of String - 是否必填:否 -(过滤条件)按照云盘状态过滤。(UNATTACHED未挂载 | ATTACHING挂载中 | ATTACHED已挂载 | DETACHING解挂中 | EXPANDING扩容中 | ROLLBACKING回滚中 | TORECYCLE待回收。)<br><li>instance-id - Array of String - 是否必填:否 -过滤条件按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。<br><li>zone - Array of String - 是否必填:否 -(过滤条件)按照[可用区](/document/product/213/15753#ZoneInfo)过滤。<br><li>instance-ip-address - Array of String - 是否必填:否 -过滤条件按云盘所挂载云主机的内网或外网IP过滤。<br><li>instance-name - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载的实例名称过滤。<br><li>tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键进行过滤。<br><li>tag-value - Array of String - 是否必填:否 -(过滤条件)照标签值进行过滤。<br><li>tag:tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
/// </summary>
[JsonProperty("Filters")]
public Filter[] Filters{ get; set; }
/// <summary>
/// 偏移量默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
/// </summary>
[JsonProperty("Offset")]
public ulong? Offset{ get; set; }
/// <summary>
/// 返回数量默认为20最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
/// </summary>
[JsonProperty("Limit")]
public ulong? Limit{ get; set; }
/// <summary>
/// 输出云盘列表的排列顺序。取值范围:<br><li>ASC升序排列<br><li>DESC降序排列。
/// </summary>
[JsonProperty("Order")]
public string Order{ get; set; }
/// <summary>
/// 云盘列表排序的依据字段。取值范围:<br><li>CREATE_TIME依据云盘的创建时间排序<br><li>DEADLINE依据云盘的到期时间排序<br>默认按云盘创建时间排序。
/// </summary>
[JsonProperty("OrderField")]
public string OrderField{ get; set; }
/// <summary>
/// 云盘详情中是否需要返回云盘绑定的定期快照策略IDTRUE表示需要返回FALSE表示不返回。
/// </summary>
[JsonProperty("ReturnBindAutoSnapshotPolicy")]
public bool? ReturnBindAutoSnapshotPolicy{ get; set; }
/// <summary>
/// For internal usage only. DO NOT USE IT.
/// </summary>
internal override void ToMap(Dictionary<string, string> map, string prefix)
{
this.SetParamArraySimple(map, prefix + "DiskIds.", this.DiskIds);
this.SetParamArrayObj(map, prefix + "Filters.", this.Filters);
this.SetParamSimple(map, prefix + "Offset", this.Offset);
this.SetParamSimple(map, prefix + "Limit", this.Limit);
this.SetParamSimple(map, prefix + "Order", this.Order);
this.SetParamSimple(map, prefix + "OrderField", this.OrderField);
this.SetParamSimple(map, prefix + "ReturnBindAutoSnapshotPolicy", this.ReturnBindAutoSnapshotPolicy);
}
}
}