/*
* 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.Cdb.V20170320.Models
{
using Newtonsoft.Json;
using System.Collections.Generic;
using TencentCloud.Common;
public class DescribeDBInstancesRequest : AbstractModel
{
///
/// 项目 ID，可使用 [查询项目列表](https://cloud.tencent.com/document/product/378/4400) 接口查询项目 ID。
///
[JsonProperty("ProjectId")]
public long? ProjectId{ get; set; }
///
/// 实例类型，可取值：1 - 主实例，2 - 灾备实例，3 - 只读实例。
///
[JsonProperty("InstanceTypes")]
public ulong?[] InstanceTypes{ get; set; }
///
/// 实例的内网 IP 地址。
///
[JsonProperty("Vips")]
public string[] Vips{ get; set; }
///
/// 实例状态，可取值：
0 - 创建中
1 - 运行中
4 - 正在进行隔离操作
5 - 隔离中（可在回收站恢复开机）
///
[JsonProperty("Status")]
public ulong?[] Status{ get; set; }
///
/// 偏移量，默认值为 0。
///
[JsonProperty("Offset")]
public ulong? Offset{ get; set; }
///
/// 单次请求返回的数量，默认值为 20，最大值为 2000。
///
[JsonProperty("Limit")]
public ulong? Limit{ get; set; }
///
/// 安全组 ID。当使用安全组 ID 为过滤条件时，需指定 WithSecurityGroup 参数为 1。
///
[JsonProperty("SecurityGroupId")]
public string SecurityGroupId{ get; set; }
///
/// 付费类型，可取值：0 - 包年包月，1 - 小时计费。
///
[JsonProperty("PayTypes")]
public ulong?[] PayTypes{ get; set; }
///
/// 实例名称。
///
[JsonProperty("InstanceNames")]
public string[] InstanceNames{ get; set; }
///
/// 实例任务状态，可能取值：
0 - 没有任务
1 - 升级中
2 - 数据导入中
3 - 开放Slave中
4 - 外网访问开通中
5 - 批量操作执行中
6 - 回档中
7 - 外网访问关闭中
8 - 密码修改中
9 - 实例名修改中
10 - 重启中
12 - 自建迁移中
13 - 删除库表中
14 - 灾备实例创建同步中
15 - 升级待切换
16 - 升级切换中
17 - 升级切换完成
///
[JsonProperty("TaskStatus")]
public ulong?[] TaskStatus{ get; set; }
///
/// 实例数据库引擎版本，可能取值：5.1、5.5、5.6 和 5.7。
///
[JsonProperty("EngineVersions")]
public string[] EngineVersions{ get; set; }
///
/// 私有网络的 ID。
///
[JsonProperty("VpcIds")]
public ulong?[] VpcIds{ get; set; }
///
/// 可用区的 ID。
///
[JsonProperty("ZoneIds")]
public ulong?[] ZoneIds{ get; set; }
///
/// 子网 ID。
///
[JsonProperty("SubnetIds")]
public ulong?[] SubnetIds{ get; set; }
///
/// 是否锁定标记。
///
[JsonProperty("CdbErrors")]
public long?[] CdbErrors{ get; set; }
///
/// 返回结果集排序的字段，目前支持："InstanceId"，"InstanceName"，"CreateTime"，"DeadlineTime"。
///
[JsonProperty("OrderBy")]
public string OrderBy{ get; set; }
///
/// 返回结果集排序方式，目前支持："ASC" 或者 "DESC"。
///
[JsonProperty("OrderDirection")]
public string OrderDirection{ get; set; }
///
/// 是否以安全组 ID 为过滤条件。
///
[JsonProperty("WithSecurityGroup")]
public long? WithSecurityGroup{ get; set; }
///
/// 是否包含独享集群详细信息，可取值：0 - 不包含，1 - 包含。
///
[JsonProperty("WithExCluster")]
public long? WithExCluster{ get; set; }
///
/// 独享集群 ID。
///
[JsonProperty("ExClusterId")]
public string ExClusterId{ get; set; }
///
/// 实例 ID。
///
[JsonProperty("InstanceIds")]
public string[] InstanceIds{ get; set; }
///
/// 初始化标记，可取值：0 - 未初始化，1 - 初始化。
///
[JsonProperty("InitFlag")]
public long? InitFlag{ get; set; }
///
/// 是否包含灾备关系对应的实例，可取值：0 - 不包含，1 - 包含。默认取值为1。如果拉取主实例，则灾备关系的数据在DrInfo字段中， 如果拉取灾备实例， 则灾备关系的数据在MasterInfo字段中。灾备关系中只包含部分基本的数据，详细的数据需要自行调接口拉取。
///
[JsonProperty("WithDr")]
public long? WithDr{ get; set; }
///
/// 是否包含只读实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
///
[JsonProperty("WithRo")]
public long? WithRo{ get; set; }
///
/// 是否包含主实例，可取值：0 - 不包含，1 - 包含。默认取值为1。
///
[JsonProperty("WithMaster")]
public long? WithMaster{ get; set; }
///
/// 置放群组ID列表。
///
[JsonProperty("DeployGroupIds")]
public string[] DeployGroupIds{ get; set; }
///
/// For internal usage only. DO NOT USE IT.
///
internal override void ToMap(Dictionary map, string prefix)
{
this.SetParamSimple(map, prefix + "ProjectId", this.ProjectId);
this.SetParamArraySimple(map, prefix + "InstanceTypes.", this.InstanceTypes);
this.SetParamArraySimple(map, prefix + "Vips.", this.Vips);
this.SetParamArraySimple(map, prefix + "Status.", this.Status);
this.SetParamSimple(map, prefix + "Offset", this.Offset);
this.SetParamSimple(map, prefix + "Limit", this.Limit);
this.SetParamSimple(map, prefix + "SecurityGroupId", this.SecurityGroupId);
this.SetParamArraySimple(map, prefix + "PayTypes.", this.PayTypes);
this.SetParamArraySimple(map, prefix + "InstanceNames.", this.InstanceNames);
this.SetParamArraySimple(map, prefix + "TaskStatus.", this.TaskStatus);
this.SetParamArraySimple(map, prefix + "EngineVersions.", this.EngineVersions);
this.SetParamArraySimple(map, prefix + "VpcIds.", this.VpcIds);
this.SetParamArraySimple(map, prefix + "ZoneIds.", this.ZoneIds);
this.SetParamArraySimple(map, prefix + "SubnetIds.", this.SubnetIds);
this.SetParamArraySimple(map, prefix + "CdbErrors.", this.CdbErrors);
this.SetParamSimple(map, prefix + "OrderBy", this.OrderBy);
this.SetParamSimple(map, prefix + "OrderDirection", this.OrderDirection);
this.SetParamSimple(map, prefix + "WithSecurityGroup", this.WithSecurityGroup);
this.SetParamSimple(map, prefix + "WithExCluster", this.WithExCluster);
this.SetParamSimple(map, prefix + "ExClusterId", this.ExClusterId);
this.SetParamArraySimple(map, prefix + "InstanceIds.", this.InstanceIds);
this.SetParamSimple(map, prefix + "InitFlag", this.InitFlag);
this.SetParamSimple(map, prefix + "WithDr", this.WithDr);
this.SetParamSimple(map, prefix + "WithRo", this.WithRo);
this.SetParamSimple(map, prefix + "WithMaster", this.WithMaster);
this.SetParamArraySimple(map, prefix + "DeployGroupIds.", this.DeployGroupIds);
}
}
}