tencentcloud-sdk-nodejs/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts

腾讯云 API NODEJS SDK

/**
 * DescribeSpecInfo请求参数结构体
 */
export interface DescribeSpecInfoRequest {
    /**
     * 待查询可用区。当前支持的可用区，请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。
     */
    Zone?: string;
}
/**
 * DescribeAuditConfig请求参数结构体
 */
export interface DescribeAuditConfigRequest {
    /**
     * 实例 ID，格式如：cmgo-xftsghuy，与云数据库控制台页面中显示的实例 ID 相同。
     */
    InstanceId: string;
}
/**
 * CreateDBInstance请求参数结构体
 */
export interface CreateDBInstanceRequest {
    /**
     * <ul><li>创建副本集实例，指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>创建分片集群实例，指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li></ul>
     */
    NodeNum: number;
    /**
     * <p>实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p>
     */
    Memory: number;
    /**
     * <p>实例硬盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p>
     */
    Volume: number;
    /**
     * <p>指版本信息。具体支持的版本信息 ，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</p><ul><li>MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。</li><li>MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。</li><li>MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。</li><li>MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。</li><li>MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。</li><li>MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。</li><li>MONGO_80_WT：MongoDB 8.0 WiredTiger存储引擎版本。</li></ul>
     */
    MongoVersion: string;
    /**
     * <p>实例数量, 最小值1，最大值为30。</p>
     */
    GoodsNum: number;
    /**
     * <p>可用区信息，输入格式如：ap-guangzhou-2。</p><ul><li>具体信息，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取。</li><li>该参数为主可用区，如果多可用区部署，Zone必须是AvailabilityZoneList中的一个。</li></ul>
     */
    Zone: string;
    /**
     * <p>指定购买实例的购买时长。取值可选：[1,2,3,4,5,6,7,8,9,10,11,12,24,36]；单位：月。</p>
     */
    Period: number;
    /**
     * <p>产品推荐规格类型：</p><ul><li>GE.LD.T1：本地盘（通用I型）。</li><li>GE.CD.T1：云盘（通用I型）。</li></ul><p>产品白名单规格类型：</p><ul><li>HIO10G：本地盘（高IO万兆型）。</li><li>HCD：云盘（云盘版）。</li></ul><p>注意：白名单规格类型为白名单控制，如若需要，请 <a href="https://console.cloud.tencent.com/workorder/category">提交工单</a> 申请</p>
     */
    MachineCode: string;
    /**
     * <p>实例架构类型。</p><ul><li>REPLSET：副本集。</li><li>SHARD：分片集群。</li></ul>
     */
    ClusterType: string;
    /**
     * <ul><li>创建副本集实例，指副本集数量，该参数只能为1。</li><li>创建分片集群实例，指分片的数量。请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询分片数量的取值范围，其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。</li></ul>
     */
    ReplicateSetNum: number;
    /**
     * <p>项目ID。</p><ul><li>若不设置该参数，则为默认项目。</li><li>在 <a href="https://console.cloud.tencent.com/project">MongoDB 控制台项目管理</a>页面，可获取项目ID。</li></ul>
     */
    ProjectId?: number;
    /**
     * <p>私有网络 ID。</p><ul><li>仅支持配置私有网络，必须选择一个与实例同一地域的私有网络。请登录<a href="https://console.cloud.tencent.com/vpc">私有网络控制台</a>获取可使用的私有网络 ID。</li><li>实例创建成功之后，支持更换私有网络。具体操作，请参见<a href="https://cloud.tencent.com/document/product/239/30910">更换网络</a>。</li></ul>
     */
    VpcId?: string;
    /**
     * <p>私有网络 VPC 的子网 ID。</p><ul><li>必须在已选的私有网络内指定一个子网。请登录<a href="https://console.cloud.tencent.com/vpc">私有网络控制台</a>获取可使用的子网 ID。</li><li>实例创建成功之后，支持更换私有网络及子网。具体操作，请参见<a href="https://cloud.tencent.com/document/product/239/30910">更换网络</a>。</li></ul>
     */
    SubnetId?: string;
    /**
     * <p>实例密码。设置要求如下：</p><ul><li>字符个数为[8,32]。</li><li>可输入[A,Z]、[a,z]、[0,9]范围内的字符。</li><li>可输入的特殊字符包括：感叹号“!”，at“@”，警号“#”、百分号“%”、插入号“^”、星号“*”、括号“()”、下划线“_”。</li><li>不能设置单一的字母或者数字。</li></ul>
     */
    Password?: string;
    /**
     * <p>实例标签信息。</p>
     */
    Tags?: Array<TagInfo>;
    /**
     * <p>自动续费标记。</p><ul><li>0：不自动续费。</li><li>1：自动续费。</li></ul>
     */
    AutoRenewFlag?: number;
    /**
     * <p>是否自动选择代金券。</p><ul><li>1：是。</li><li>0：否。默认为0。</li></ul>
     */
    AutoVoucher?: number;
    /**
     * <p>实例类型。</p><ul><li>1：正式实例。</li><li>3：只读实例。</li><li>4：灾备实例。</li><li>5：克隆实例。注意：克隆实例 RestoreTime 为必填项。</li></ul>
     */
    Clone?: number;
    /**
     * <p>父实例 ID。</p><ul><li>当参数<strong>Clone</strong>为3或者4时，即实例为只读或灾备实例时，该参数必须配置。</li><li>请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制父实例 ID。</li></ul>
     */
    Father?: string;
    /**
     * <p>安全组 ID。 请登录<a href="https://console.cloud.tencent.com/vpc/security-group">安全组控制台</a>页面获取与数据库实例同地域的安全组 ID。</p>
     */
    SecurityGroup?: Array<string>;
    /**
     * <p>克隆实例回档时间，当Clone取值为5或6时为必填。- 若为克隆实例，则必须配置该参数。输入格式示例：2021-08-13 16:30:00。- 回档时间范围：仅能回档7天内时间点的数据。</p>
     */
    RestoreTime?: string;
    /**
     * <p>实例名称。仅支持长度为128个字符的中文、英文、数字、下划线_、分隔符-。批量购买数据库实例时，支持通过自定义命名模式串与数字后缀自动升序功能，高效设置实例名称。</p><ul><li>基础模式：前缀＋自动升序编号（默认从1开始），<strong>lnstanceName</strong>仅需自定义实例名称前缀，例如设置为：cmgo，设置购买数量为5，则购买后，实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。</li><li>自定义起始序号模式：前缀+｛R:x｝（x为自定义起始序号）。<strong>InstanceName</strong>需填写“前缀｛R:x｝”，例如：cmgo｛R:3｝，设置购买数量为5，则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。</li><li>复合模式串：前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀，x与y分别为每一段前缀的起始序号。<strong>instanceName</strong>需填写复合模式串，例如：cmgo{R:10}_node{R:12}_db，设置批量购买数量为5，则实例名称为 cmgo10_node12_db, cmgo11_node13_db, cmgo12_node14_db, cmgo13_node15_db, cluster14_node16_db.</li></ul>
     */
    InstanceName?: string;
    /**
     * <p>若多可用区部署云数据库实例，指定多可用区列表。</p><ul><li>多可用区部署实例，参数 <strong>Zone</strong> 指定实例主可用区信息；<strong>AvailabilityZoneList</strong> 指定所有可用区信息，包含主可用区。输入格式如：[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。</li><li>通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 可获取云数据库不同地域规划的可用区信息，以便指定有效的可用区。</li><li>多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如：3节点集群不支持2个节点部署在同一个区。</li></ul>
     */
    AvailabilityZoneList?: Array<string>;
    /**
     * <p>Mongos CPU 核数，支持1、2、4、8、16。购买分片集群时，必须填写。</p>
     */
    MongosCpu?: number;
    /**
     * <p>Mongos 内存大小。</p><ul><li>购买分片集群时，必须填写。</li><li>单位：GB，支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。</li></ul>
     */
    MongosMemory?: number;
    /**
     * <p>Mongos 数量。购买分片集群时，必须填写。</p><ul><li>单可用区部署实例，其数量范围为[3,32]。</li><li>多可用区部署实例，其数量范围为[6,32]。</li></ul>
     */
    MongosNodeNum?: number;
    /**
     * <p>只读节点数量，取值范围[0,5]。</p>
     */
    ReadonlyNodeNum?: number;
    /**
     * <p>指只读节点所属可用区数组。跨可用区部署实例，参数<strong>ReadonlyNodeNum</strong>不为<strong>0</strong>时，必须配置该参数。</p>
     */
    ReadonlyNodeAvailabilityZoneList?: Array<string>;
    /**
     * <p>Hidden节点所属可用区。跨可用区部署实例，必须配置该参数。</p>
     */
    HiddenZone?: string;
    /**
     * <p>参数模板 ID。</p><ul><li>参数模板是预置了特定参数值的集合，可用于快速配置新的 MongoDB 实例。合理使用参数模板，能有效提升数据库的部署效率与运行性能。</li><li>参数模板 ID 可通过 <a href="https://cloud.tencent.com/document/product/240/109155">DescribeDBInstanceParamTpl </a>接口获取。请选择与实例版本与架构所对应的参数模板 ID。</li></ul>
     */
    ParamTemplateId?: string;
    /**
     * <p>数据库存储加密取值。</p><ul><li>No_Encryption：不采用存储加密。</li><li>TDE：开启 TDE 存储加密方式。</li></ul>
     */
    DataEncryption?: string;
    /**
     * <p>如选取 TDE 存储加密，须指定密钥来源。</p><ul><li>auto 自动生成密钥。</li><li>manual 手动指定密钥。</li></ul>
     */
    EncryptionKeySource?: string;
    /**
     * <p>密钥 ID。如密钥资源选取为指定自定义，须输入指定的密钥 ID。</p>
     */
    KeyId?: string;
    /**
     * <p>如果密钥来源为指定自定义密钥，须填写该字段指定密钥的地域信息。</p>
     */
    KmsRegion?: string;
    /**
     * <p>实例CPU核大小，单位：C。具体售卖的CPU规格，请通过接口 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 获取<br>注意：通用 I 型实例必须设置 CPU 大小。</p>
     */
    CpuCore?: number;
}
/**
 * CreateDBInstanceParamTpl返回参数结构体
 */
export interface CreateDBInstanceParamTplResponse {
    /**
     * 模板ID
     */
    TplId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAccountUsers请求参数结构体
 */
export interface DescribeAccountUsersRequest {
    /**
     * 指定待获取账号的实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
}
/**
 * DescribeDBInstanceParamTpl请求参数结构体
 */
export interface DescribeDBInstanceParamTplRequest {
    /**
     * 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
     */
    TplIds?: Array<string>;
    /**
     * 指定查询的模板名称。
     */
    TplNames?: Array<string>;
    /**
     * 指定所需查询的参数模板的数据库版本号。具体支持的版本信息，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
  - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本，
  - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本，
  - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。
  - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。
  - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。
  - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。
  - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。
  - MONGO_80_WT：MongoDB 8.0 WiredTiger存储引擎版本。
     */
    MongoVersion?: Array<string>;
    /**
     * 指定查询的模板类型。
  - DEFAULT：系统默认模板。
  - CUSTOMIZE：自定义模板。
     */
    TplType?: string;
}
/**
 * CreateBackupDBInstance返回参数结构体
 */
export interface CreateBackupDBInstanceResponse {
    /**
     * <p>查询备份流程的状态。</p>
     */
    AsyncRequestId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAuditLogs请求参数结构体
 */
export interface DescribeAuditLogsRequest {
    /**
     * 实例ID，格式如：cmgo-xftsghuy，与云数据库控制台页面中显示的实例 ID 相同。
     */
    InstanceId: string;
    /**
     * 开始时间，格式为："2017-07-12 10:29:20"。
     */
    StartTime: string;
    /**
     * 结束时间，格式为："2017-07-12 10:29:20"。
     */
    EndTime: string;
    /**
     * 过滤条件，可按设置的过滤条件过滤日志。
     */
    Filter?: AuditLogFilter;
    /**
     * 分页参数，指单次返回的数据条数。默认值为100，最大值为100。
     */
    Limit?: number;
    /**
     * 分页偏移量。
     */
    Offset?: number;
    /**
     * 审计日志的排序方式。
  <ul><li>ASC：升序。</li><li>DESC：降序。</li></ul>
     */
    Order?: string;
    /**
     * 审计日志的排序字段，包括：
  <ul><li>timestamp：时间戳。</li>
  <li>affectRows：影响行数。</li>
  <li>execTime：执行时间。</li></ul>
     */
    OrderBy?: string;
}
/**
 * 数据库实例价格
 */
export interface DBInstancePrice {
    /**
     * 实例单价。单位：元。
     */
    UnitPrice: number;
    /**
     * 实例原价。单位：元。
     */
    OriginalPrice: number;
    /**
     * 实例折扣价。单位：元。
     */
    DiscountPrice: number;
}
/**
 * DescribePasswordRotation返回参数结构体
 */
export interface DescribePasswordRotationResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * KillOps请求参数结构体
 */
export interface KillOpsRequest {
    /**
     * 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 待终止的操作。
     */
    Operations: Array<Operation>;
}
/**
 * EnablePasswordRotation请求参数结构体
 */
export type EnablePasswordRotationRequest = null;
/**
 * DropDBInstanceParamTpl返回参数结构体
 */
export interface DropDBInstanceParamTplResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteLogDownloadTask返回参数结构体
 */
export interface DeleteLogDownloadTaskResponse {
    /**
     * 任务状态，0:成功
     */
    Status?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * InquirePriceRenewDBInstances请求参数结构体
 */
export interface InquirePriceRenewDBInstancesRequest {
    /**
     * 实例ID。请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID，且单次最多同时查询5个实例。
     */
    InstanceIds: Array<string>;
    /**
     * 预付费模式（即包年包月）相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
     */
    InstanceChargePrepaid: InstanceChargePrepaid;
}
/**
 * DescribeDBInstanceNamespace返回参数结构体
 */
export interface DescribeDBInstanceNamespaceResponse {
    /**
     * 查询实例的数据库列表。若未使用 DbName 指定具体查询的数据库，则仅返回查询实例所有的数据库列表，而不返回 Collections 集合信息。
     */
    Databases?: Array<string>;
    /**
     * 查询的集合信息。指定 DbName 时，则仅返回该数据库下的集合列表。
     */
    Collections?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * FlushInstanceRouterConfig请求参数结构体
 */
export interface FlushInstanceRouterConfigRequest {
    /**
     * 实例ID
     */
    InstanceId: string;
}
/**
 * DescribeSlowLogs请求参数结构体
 */
export interface DescribeSlowLogsRequest {
    /**
     * 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 慢日志起始时间。
  - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。
  - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。
     */
    StartTime: string;
    /**
     * 慢日志终止时间。
  - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-02 12:00:00。
  - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。
     */
    EndTime: string;
    /**
     * 慢日志执行时间阈值，返回执行时间超过该阈值的慢日志，单位为毫秒(ms)，最小为100毫秒。
     */
    SlowMS: number;
    /**
     * 偏移量，最小值为0，最大值为10000，默认值为0。
     */
    Offset?: number;
    /**
     * 分页大小，最小值为1，最大值为100，默认值为20。
     */
    Limit?: number;
    /**
     * 慢日志返回格式。默认返回原生慢日志格式，4.4及以上版本可设置为json。
     */
    Format?: string;
}
/**
 * FlushInstanceRouterConfig返回参数结构体
 */
export interface FlushInstanceRouterConfigResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCurrentOp返回参数结构体
 */
export interface DescribeCurrentOpResponse {
    /**
     * 符合查询条件的操作总数。
     */
    TotalCount?: number;
    /**
     * 当前操作列表。
     */
    CurrentOps?: Array<CurrentOp>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * PromoteDBInstanceToActive请求参数结构体
 */
export interface PromoteDBInstanceToActiveRequest {
    /**
     * <p>指定需转为普通实例的灾备或只读实例 ID。请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制灾备或只读实例 ID。</p>
     */
    InstanceId: string;
    /**
     * <p>指定灾备或只读实例所属的主实例。请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制实例 ID。</p>
     */
    MasterId: string;
}
/**
 * 实例可修改参数Multi类型集合。
 */
export interface InstanceMultiParam {
    /**
     * 参数当前值。
     */
    CurrentValue?: string;
    /**
     * 参数默认值。
     */
    DefaultValue?: string;
    /**
     * 参考值范围。
     */
    EnumValue?: Array<string>;
    /**
     * 参数修改后是否需要重启才会生效。
  - 1：需要重启后生效。
  - 0：无需重启，设置成功即可生效。
     */
    NeedRestart?: string;
    /**
     * 参数名称。
     */
    ParamName?: string;
    /**
     * 是否为运行中参数值。
  - 1：运行中参数值。
  - 0：非运行中参数值。
     */
    Status?: number;
    /**
     * 参数说明。
     */
    Tips?: Array<string>;
    /**
     * 当前值的类型描述，默认为multi。
     */
    ValueType?: string;
}
/**
 * DescribeSRVConnectionDomain返回参数结构体
 */
export interface DescribeSRVConnectionDomainResponse {
    /**
     * 实例当前的srv域名信息。
     */
    Domain?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyInstanceParams返回参数结构体
 */
export interface ModifyInstanceParamsResponse {
    /**
     * <p>修改参数配置是否生效。</p><ul><li>true：参数修改后的值已生效。</li><li>false：执行失败。</li></ul>
     */
    Changed?: boolean;
    /**
     * <p>该参数暂时无意义(兼容前端保留)。</p>
     */
    TaskId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * SetInstanceMaintenance返回参数结构体
 */
export interface SetInstanceMaintenanceResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeInstanceSSL请求参数结构体
 */
export interface DescribeInstanceSSLRequest {
    /**
     * <p>实例ID，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同</p>
     */
    InstanceId: string;
}
/**
 * EnableTransparentDataEncryption请求参数结构体
 */
export interface EnableTransparentDataEncryptionRequest {
    /**
     * 实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。目前支持通用版本包含：4.4、5.0，云盘版暂不支持。
     */
    InstanceId: string;
    /**
     *  [密钥管理系统（Key Management Service，KMS）](https://cloud.tencent.com/document/product/573/18809)服务所在地域，例如 ap-shanghai。
     */
    KmsRegion: string;
    /**
     * 密钥 ID。若不设置该参数，不指定具体的密钥 ID，由腾讯云自动生成密钥。
     */
    KeyId?: string;
}
/**
 * DescribeBackupRules返回参数结构体
 */
export interface DescribeBackupRulesResponse {
    /**
     * 备份数据保留期限。单位为：天。
     */
    BackupSaveTime?: number;
    /**
     * 备份频率。备份时间间隔，单位小时。取值12，24
     */
    BackupFrequency?: number;
    /**
     * 自动备份开始时间。
     */
    BackupTime?: number;
    /**
     * 备份方式。
  - 0：逻辑备份。
  - 1：物理备份。
  - 3：快照备份。
  **说明**:
  1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。
  2. 实例开通存储加密，则备份方式不能为物理备份。
     */
    BackupMethod?: number;
    /**
     * 周几备份，0-6，逗号分割
     */
    ActiveWeekdays?: string;
    /**
     * 长期备份周期。weekly-按周，monthly-按月，空不开启。
     */
    LongTermInterval?: string;
    /**
     * 长期备份的日期，周0-6，月1-31
     */
    LongTermActiveDays?: string;
    /**
     * 长期备份保留时间
     */
    LongTermExpiredDays?: number;
    /**
     * 增量备份保留时间
     */
    OplogExpiredDays?: number;
    /**
     * 备份版本号。0-旧备份方式，1-高级备份
     */
    BackupVersion?: number;
    /**
     * 备份大小
     */
    BackupTotalSize?: BackupTotalSize;
    /**
     * 告警额度
     */
    AlertThreshold?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyBackupExpireTime返回参数结构体
 */
export interface ModifyBackupExpireTimeResponse {
    /**
     * <p>失败的备份ID</p>
     */
    FailedBackups?: Array<number | bigint>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 用于描述MongoDB数据库慢日志统计信息
 */
export interface SlowLogPattern {
    /**
     * 慢日志输出格式：库名.表名.命令。
     */
    Pattern?: string;
    /**
     * 记录慢日志时所带的queryHash 值，标识一类查询。
     */
    QueryHash?: string;
    /**
     * 最大执行时间。单位：毫秒。
     */
    MaxTime?: number;
    /**
     * 平均执行时间。单位：毫秒。
     */
    AverageTime?: number;
    /**
     * 慢日志条数。
     */
    Total?: number;
}
/**
 * 日志下载任务描述
 */
export interface Task {
    /**
     * 下载任务类型，0:慢日志，1:错误日志
     */
    TaskType?: number;
    /**
     * 任务ID
     */
    TaskId?: string;
    /**
     * 创建时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CreateTime?: string;
    /**
     * 更新时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    UpdateTime?: string;
    /**
     * 文件大小
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FileSize?: number;
    /**
     * 任务状态，0:初始化，1:运行中，2:成功，3:失败
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Status?: number;
    /**
     * 百分比
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Percent?: number;
    /**
     * 下载链接
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Url?: string;
}
/**
 * ModifySRVConnectionUrl返回参数结构体
 */
export interface ModifySRVConnectionUrlResponse {
    /**
     * 开启任务ID。
     */
    FlowId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * AssignProject返回参数结构体
 */
export interface AssignProjectResponse {
    /**
     * 返回的异步任务ID列表。
     */
    FlowIds?: Array<number | bigint>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 审计日志过滤条件
 */
export interface AuditLogFilter {
    /**
     * 客户端地址。
     */
    Host?: Array<string>;
    /**
     * 用户名。
     */
    User?: Array<string>;
    /**
     * 执行时间。单位为：ms。表示筛选执行时间大于该值的审计日志。
     */
    ExecTime?: number;
    /**
     * 影响行数。表示筛选影响行数大于该值的审计日志。
     */
    AffectRows?: number;
    /**
     * 操作类型。
     */
    Atype?: Array<string>;
    /**
     * 执行结果。
     */
    Result?: Array<string>;
    /**
     * 根据此关键字过滤日志
     */
    Param?: Array<string>;
}
/**
 * DescribeDBInstanceDeal返回参数结构体
 */
export interface DescribeDBInstanceDealResponse {
    /**
     * 订单状态。
  - 1：未支付。
  - 2：已支付。
  - 3：发货中。
  - 4：发货成功。
  - 5：发货失败。
  - 6：退款。
  - 7：订单关闭。
  - 8：超时未支付关闭。
     */
    Status?: number;
    /**
     * 订单原价。单位：元。
     */
    OriginalPrice?: number;
    /**
     * 订单折扣价格。单位：元。
     */
    DiscountPrice?: number;
    /**
     * 订单操作行为。
  - purchase：新购。
  - renew：续费。
  - upgrade：升配.
  - downgrade：降配.
  - refund：退货退款。
     */
    Action?: string;
    /**
     * 当前订单的实例 ID。
     */
    InstanceId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAuditInstanceList返回参数结构体
 */
export interface DescribeAuditInstanceListResponse {
    /**
     * 实例总数。
     */
    TotalCount?: number;
    /**
     * 审计实例详情。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Items?: Array<AuditInstance>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * OfflineIsolatedDBInstance返回参数结构体
 */
export interface OfflineIsolatedDBInstanceResponse {
    /**
     * 异步任务的请求 ID，可使用此 ID 查询异步任务的执行结果。
     */
    AsyncRequestId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * IsolateDBInstance返回参数结构体
 */
export interface IsolateDBInstanceResponse {
    /**
     * 异步任务的请求 ID，可使用此 ID 查询异步任务的执行结果。
     */
    AsyncRequestId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeInstanceParams请求参数结构体
 */
export interface DescribeInstanceParamsRequest {
    /**
     * 指定待查询参数列表的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
}
/**
 * CreateDBInstanceParamTpl请求参数结构体
 */
export interface CreateDBInstanceParamTplRequest {
    /**
     * 参数模板名称。
     */
    TplName: string;
    /**
     * 参数模板版本号。当**MirrorTplId**为空时，该字段必填。参数模板支持的售卖版本，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
  - MONGO_36_WT：MongoDB 3.6 WiredTiger存储引擎版本，
  - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本，
  - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。
  - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。
  - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。
  - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。
  - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。
  - MONGO_80_WT：MongoDB 8.0 WiredTiger存储引擎版本。
     */
    MongoVersion?: string;
    /**
     * 实例类型。当 MirrorTplId 为空值时，该参数必填。
  - REPLSET：副本集实例。
  - SHARD：分片实例。
  - STANDALONE：单节点实例。
     */
    ClusterType?: string;
    /**
     * 模板描述信息。
     */
    TplDesc?: string;
    /**
     * 模板参数，若不配置该参数，则以系统默认模板作为新版本参数。
     */
    Params?: Array<ParamType>;
    /**
     * 镜像模板 ID。若指定镜像模板，则以该模板为镜像，克隆出一个新的模板。
  **注意**：MirrorTplId 不为空值时，MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。
     */
    MirrorTplId?: string;
}
/**
 * DisableSRVConnectionUrl返回参数结构体
 */
export interface DisableSRVConnectionUrlResponse {
    /**
     * 开启任务ID。
     */
    FlowId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSecurityGroup请求参数结构体
 */
export interface DescribeSecurityGroupRequest {
    /**
     * 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
}
/**
 * RenameInstance请求参数结构体
 */
export interface RenameInstanceRequest {
    /**
     * 实例ID，格式如：cmgo-p8vnipr5。请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 自定义实例名称，要求为1～128 长度的任意字符。
     */
    NewName: string;
}
/**
 * DescribeBackupRules请求参数结构体
 */
export interface DescribeBackupRulesRequest {
    /**
     * 指定实例ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
}
/**
 * DescribeBackupDownloadTask返回参数结构体
 */
export interface DescribeBackupDownloadTaskResponse {
    /**
     * 满足查询条件的所有条数。
     */
    TotalCount?: number;
    /**
     * 下载任务列表。
     */
    Tasks?: Array<BackupDownloadTask>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 修改实例节点详情。
 */
export interface AddNodeList {
    /**
     * 需要新增的节点角色。
  - SECONDARY：Mongod 节点。
  - READONLY：只读节点。
  - MONGOS：Mongos 节点。
     */
    Role: string;
    /**
     * 节点所对应的可用区。当前支持的可用区，请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
  - 单可用区，所有节点在同一可用区。
  - 多可用区：当前标准规格是三可用区分布，主从节点不在同一可用区，需注意配置新增节点对应的可用区，且新增后必须满足任意2个可用区节点数大于第3个可用区原则。
     */
    Zone: string;
}
/**
 * EnablePasswordRotation返回参数结构体
 */
export interface EnablePasswordRotationResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 实例信息
 */
export interface DBInstanceInfo {
    /**
     * 实例ID
     */
    InstanceId?: string;
    /**
     * 地域信息
     */
    Region?: string;
}
/**
 * 数据库参数
 */
export interface ParamType {
    /**
     * 参数
     */
    Key: string;
    /**
     * 参数值
     */
    Value: string;
}
/**
 * SetAccountUserPrivilege返回参数结构体
 */
export interface SetAccountUserPrivilegeResponse {
    /**
     * 任务ID。
     */
    FlowId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * mongodb外网服务节点信息。
 */
export interface WanServiceNodeList {
    /**
     * 实例节点的vip及端口信息。
     */
    VipVport?: string;
    /**
     * CLB监听器监听端口，取值范围1~65535。
     */
    ListenerPort?: string;
}
/**
 * 按 Key 闪回的数据库及集合信息
 */
export interface FlashbackDatabase {
    /**
     * 按 Key 闪回目标数据所在库。
     */
    DBName: string;
    /**
     * 按 Key 闪回的数据库集合。
     */
    Collections: Array<FlashbackCollection>;
}
/**
 * ModifyDBInstanceLogToCLS返回参数结构体
 */
export interface ModifyDBInstanceLogToCLSResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyDBInstanceNetworkAddress请求参数结构体
 */
export interface ModifyDBInstanceNetworkAddressRequest {
    /**
     * 指定需修改网络的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
  
     */
    InstanceId: string;
    /**
     * 原 IP 地址保留时长。
  - 单位为分钟，0表示立即回收原 IP 地址。
  - 原 IP 将在约定时间后释放，在释放前原 IP和新 IP均可访问。
  
     */
    OldIpExpiredTime: number;
    /**
     * 切换后的私有网络 ID，若实例当前为基础网络，该字段无需配置。请通过接口 [DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568) 获取私有网络 ID。
     */
    NewUniqVpcId: string;
    /**
     * 切换后私有网络的子网 ID。若实例当前为基础网络，该字段无需配置。请通过接口 [DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568) 获取私有网络的子网 ID。
     */
    NewUniqSubnetId: string;
    /**
     * IP 地址信息，包含新 IP 地址与 原 IP 地址。
     */
    NetworkAddresses?: Array<ModifyNetworkAddress>;
}
/**
 * CreateDBInstanceHour返回参数结构体
 */
export interface CreateDBInstanceHourResponse {
    /**
     * <p>订单ID。</p>
     */
    DealId?: string;
    /**
     * <p>创建的实例ID列表。</p>
     */
    InstanceIds?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * InstanceEnableSSL请求参数结构体
 */
export interface InstanceEnableSSLRequest {
    /**
     * <p>实例ID</p>
     */
    InstanceId: string;
    /**
     * <p>配置是否要开启SSL访问。</p><ul><li>true：开启。</li><li>false：关闭。</li></ul>
     */
    Enable: boolean;
}
/**
 * DescribeDBInstanceNamespace请求参数结构体
 */
export interface DescribeDBInstanceNamespaceRequest {
    /**
     * 指定查询数据库所属的实例 ID，支持批量查询。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 指定查询的数据库名。为空时，返回当前实例的全部数据库列表。
     */
    DbName?: string;
}
/**
 * DescribeDBInstanceNodeProperty请求参数结构体
 */
export interface DescribeDBInstanceNodePropertyRequest {
    /**
     * 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID。
     */
    NodeIds?: Array<string>;
    /**
     * 节点角色。可选值包括：
  - PRIMARY：主节点。
  - SECONDARY：从节点。
  - READONLY：只读节点。
  - ARBITER：仲裁节点。
     */
    Roles?: Array<string>;
    /**
     * 该参数指定节点是否为 Hidden 节点，默认为 false。
     */
    OnlyHidden?: boolean;
    /**
     * 该参数指定选举新主节点的优先级。其取值范围为[0,100]，数值越高，优先级越高。
     */
    Priority?: number;
    /**
     * 该参数指定节点投票权。
  - 1：具有投票权。
  - 0：无投票权。
     */
    Votes?: number;
    /**
     * 节点标签。
     */
    Tags?: Array<NodeTag>;
}
/**
 * 日志详情
 */
export interface LogInfo {
    /**
     * 日志类别
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogComponent?: string;
    /**
     * 日志级别
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogLevel?: string;
    /**
     * 日志产生时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogTime?: string;
    /**
     * 日志详情
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogDetail?: string;
    /**
     * 日志连接信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogConnection?: string;
    /**
     * 日志id
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogId?: string;
}
/**
 * DeleteAccountUser请求参数结构体
 */
export interface DeleteAccountUserRequest {
    /**
     * 指定待删除账号的实例 ID。例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
  
     */
    InstanceId: string;
    /**
     * 配置待删除的账号名。
     */
    UserName: string;
    /**
     * 配置 mongouser 对应的密码。mongouser为系统默认账号，输入其对应的密码。
     */
    MongoUserPassword?: string;
}
/**
 * mongodb售卖规格。
 */
export interface SpecItem {
    /**
     * 规格信息标识。格式如：mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。
  - 节点类型：**mongo**，指 Mongod 节点；**mongos**，指 Mongos 节点；**cfgstr**，指 Configserver 节点。
  - 规格类型：**HIO10G**，指通用高HIO万兆型；**HCD**：指云盘版类型。
  - 内存规格：支持4、8、16、32、64、128、240、512。单位g：表示GB。128g 则表示128GB。
     */
    SpecCode?: string;
    /**
     * 售卖规格有效标志，取值范围如下：
  - 0：停止售卖。
  - 1：开放售卖。
     */
    Status?: number;
    /**
     * 计算资源规格，CPU核数。
     */
    Cpu?: number;
    /**
     * 内存规格，单位为：MB。
     */
    Memory?: number;
    /**
     * 默认磁盘规格，单位为：MB。
     */
    DefaultStorage?: number;
    /**
     * 最大磁盘规格，单位为：MB。
     */
    MaxStorage?: number;
    /**
     * 最小磁盘规格，单位为：MB。
     */
    MinStorage?: number;
    /**
     * 指每秒最大请求次数，单位为：次/秒。
     */
    Qps?: number;
    /**
     * 规格所支持的最大连接数限制。
     */
    Conns?: number;
    /**
     * 实例存储引擎版本信息。
  - MONGO_40_WT：MongoDB 4.0 WiredTiger存储引擎版本。
  - MONGO_42_WT：MongoDB 4.2 WiredTiger存储引擎版本。
  - MONGO_44_WT：MongoDB 4.4 WiredTiger存储引擎版本。
  - MONGO_50_WT：MongoDB 5.0 WiredTiger存储引擎版本。
  - MONGO_60_WT：MongoDB 6.0 WiredTiger存储引擎版本。
  - MONGO_70_WT：MongoDB 7.0 WiredTiger存储引擎版本。
  - MONGO_80_WT：MongoDB 8.0 WiredTiger存储引擎版本。
     */
    MongoVersionCode?: string;
    /**
     * 实例版本对应的数字版本。
  - MongoDB 3.2 版本：2。
  - MongoDB 3.6 版本：4。
  - MongoDB 4.0 版本：5。
  - MongoDB 4.2 版本：9。
  - MongoDB 4.4 版本：10。
  - MongoDB 5.0 版本：11。
  - MongoDB 6.0 版本：12。
  - MongoDB 7.0 版本：13。
  - MongoDB 8.0 版本：14。
     */
    MongoVersionValue?: number;
    /**
     * 实例版本信息。支持：4.2、4.4、5.0、6.0、7.0、8.0。
     */
    Version?: string;
    /**
     * 存储引擎，仅支持 WiredTiger。
     */
    EngineName?: string;
    /**
     * 集群类型，取值如下：
  - 1：分片集群。
  - 0：副本集集群。
     */
    ClusterType?: number;
    /**
     * 每个副本集最小节点数。
     */
    MinNodeNum?: number;
    /**
     * 每个副本集最大节点数。
     */
    MaxNodeNum?: number;
    /**
     * 最小分片数。
     */
    MinReplicateSetNum?: number;
    /**
     * 最大分片数。
     */
    MaxReplicateSetNum?: number;
    /**
     * 每个分片最小节点数。
     */
    MinReplicateSetNodeNum?: number;
    /**
     * 每个分片最大节点数。
     */
    MaxReplicateSetNodeNum?: number;
    /**
     * 集群的规格类型，取值范围如下：
  - HIO10G：通用高HIO万兆型。
  - HCD：云盘版类型。
     */
    MachineType?: string;
}
/**
 * 过滤条件
 */
export interface LogFilter {
    /**
     * 过滤条件名称
     */
    Type: string;
    /**
     * 过滤条件匹配类型，注意：此参数取值只能等于EQ
     */
    Compare: string;
    /**
     * 过滤条件匹配值
     */
    Value: Array<string>;
}
/**
 * DescribeDetailedSlowLogs请求参数结构体
 */
export interface DescribeDetailedSlowLogsRequest {
    /**
     * 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 指定查询慢日志的开始时间。- 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。
     */
    StartTime: string;
    /**
     * 指定查询慢日志的结束时间。
  - 格式：yyyy-mm-dd hh:mm:ss，如：2019-06-02 12:00:00。
  - 查询起止时间间隔不能超过24小时，只允许查询最近7天内慢日志。
     */
    EndTime: string;
    /**
     * 指定慢日志查询阈值，即查询执行时间大于此值的慢日志。单位：ms，默认值：100。
     */
    ExecTime?: number;
    /**
     * 指定查询慢日志的命令类型。
     */
    Commands?: Array<string>;
    /**
     * 全文搜索关键字，多个关键字间为或关系。
     */
    Texts?: Array<string>;
    /**
     * 指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。
     */
    NodeNames?: Array<string>;
    /**
     * 指定查询 queryHash 值。
     */
    QueryHash?: Array<string>;
    /**
     * 分页偏移量。默认值：0。取值范围：[0,100]。
  
     */
    Offset?: number;
    /**
     * 返回条数。默认值：20。取值范围：[0,10000]
     */
    Limit?: number;
    /**
     * 指定慢日志排序条件。
  - StartTime：按照慢日志生成时间排序。
  - ExecTime：按照慢日志执行时间排序。
     */
    OrderBy?: string;
    /**
     * 指定排序方式。
  - desc：倒序。
  - asc：顺序。
     */
    OrderByType?: string;
}
/**
 * ModifyInstanceAz返回参数结构体
 */
export interface ModifyInstanceAzResponse {
    /**
     * <p>可用区调整订单ID。</p>
     */
    DealId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpgradeDbInstanceVersion请求参数结构体
 */
export interface UpgradeDbInstanceVersionRequest {
    /**
     * 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
     */
    InstanceId: string;
    /**
     * 新升级的数据库版本。当前支持版本如下所示，支持旧版本向高版本升级，不支持跨版本升级。
  - MONGO_40_WT：4.0 版本。
  - MONGO_42_WT：4.2 版本。
  - MONGO_44_WT：4.4 版本
  - MONGO_50_WT：5.0 版本
  - MONGO_60_WT：6.0 版本。
  - MONGO_70_WT：7.0 版本。
  - MONGO_80_WT：8.0 版本。
     */
    MongoVersion: string;
    /**
     * 指定升级操作是否在维护时间内进行。
  - 0：立即升级。
  - 1：维护时间窗升级。
     */
    InMaintenance?: number;
}
/**
 * ModifyDBInstanceNetworkAddress返回参数结构体
 */
export interface ModifyDBInstanceNetworkAddressResponse {
    /**
     * 修改网络异步流程任务ID。
     */
    FlowId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteAuditLogFile返回参数结构体
 */
export interface DeleteAuditLogFileResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateAccountUser返回参数结构体
 */
export interface CreateAccountUserResponse {
    /**
     * 创建任务ID。
     */
    FlowId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSlowLogPatterns返回参数结构体
 */
export interface DescribeSlowLogPatternsResponse {
    /**
     * 慢日志统计信息总数
     */
    Count?: number;
    /**
     * 慢日志统计信息
     */
    SlowLogPatterns?: Array<SlowLogPattern>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 创建备份下载任务结果。
 */
export interface BackupDownloadTaskStatus {
    /**
     * 分片名。
     */
    ReplicaSetId?: string;
    /**
     * 任务当前状态。
  - 0：等待执行。
  - 1：正在下载。
  - 2：下载完成。
  - 3：下载失败。
  - 4：等待重试。
     */
    Status?: number;
}
/**
 * DescribeSlowLogs返回参数结构体
 */
export interface DescribeSlowLogsResponse {
    /**
     * 慢日志总数。
     */
    Count?: number;
    /**
     * 慢日志详情。
     */
    SlowLogs?: Array<string>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * InquirePriceModifyDBInstanceSpec请求参数结构体
 */
export interface InquirePriceModifyDBInstanceSpecRequest {
    /**
     * 实例 ID，例如：cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 变更配置后实例内存大小，单位：GB。具体售卖的内存规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
     */
    Memory: number;
    /**
     * 变更配置后实例磁盘大小，单位：GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
     */
    Volume: number;
    /**
     * 实例节点数量。请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
  - 副本集实例，指变更配置后实例的主从节点数量。
  - 分片集群实例，指变更配置后实例每一个分片的主从节点数。
  **说明**：切勿同时发起调整节点数、调整分片数、调整节点规格的任务。
     */
    NodeNum?: number;
    /**
     * 分片集群实例，指变更配置后实例的分片数量。取值范围：[2,36] 。
  **说明**：变更后的分片数量不能小于当前现有的数量。切勿同时发起调整节点数、调整分片数与调整节点规格的任务。
     */
    ReplicateSetNum?: number;
    /**
     * 变更配置后实例CPU大小，单位：C。具体售卖的CPU规格，请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
  注意：通用 I 型实例询价时必须传入与内存对应的 CPU 核数大小
     */
    Cpu?: number;
}
/**
 * 备份信息。
 */
export interface BackupInfo {
    /**
     * <p>实例ID。</p>
     */
    InstanceId?: string;
    /**
     * <p>备份方式。</p><ul><li>0：自动备份。</li><li>1：手动备份。</li></ul>
     */
    BackupType?: number;
    /**
     * <p>备份文件名称。</p>
     */
    BackupName?: string;
    /**
     * <p>备份任务备注信息。</p>
     */
    BackupDesc?: string;
    /**
     * <p>备份文件大小，单位：KB。</p>
     */
    BackupSize?: number;
    /**
     * <p>备份开始时间。</p>
     */
    StartTime?: string;
    /**
     * <p>备份结束时间。</p>
     */
    EndTime?: string;
    /**
     * <p>备份状态。</p><ul><li>1：备份中。</li><li>2：备份成功。</li></ul>
     */
    Status?: number;
    /**
     * <p>备份方式。</p><ul><li>0：逻辑备份。</li><li>1：物理备份。</li><li>3：快照备份。<br><strong>说明:</strong></li><li>通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份，暂不支持逻辑备份。</li><li>实例开通存储加密，则备份方式不能为物理备份。</li></ul>
     */
    BackupMethod?: number;
    /**
     * <p>备份记录 ID。</p>
     */
    BackId?: number;
    /**
     * <p>备份删除时间。</p>
     */
    DeleteTime?: string;
    /**
     * <p>异地备份地域。</p>
     */
    BackupRegion?: string;
    /**
     * <p>备份支持的回档时间。</p>
     */
    RestoreTime?: string;
}
/**
 * DescribeDBInstances请求参数结构体
 */
export interface DescribeDBInstancesRequest {
    /**
     * 实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceIds?: Array<string>;
    /**
     * 指定查询的实例类型。取值范围如下：
  - 0：所有实例。
  - 1：正式实例。
  - 2：临时实例
  - 3：只读实例。
  - -1：查询同时包括正式实例、只读实例与灾备实例。
     */
    InstanceType?: number;
    /**
     * 指定所查询实例的集群类型，取值范围如下：
  - 0：副本集实例。
  - 1：分片实例。
  - -1：副本集与分片实例。
     */
    ClusterType?: number;
    /**
     * 指定所查询实例的当前状态，取值范围如下所示：
  - 0：待初始化。
  - 1：流程处理中，例如：变更规格、参数修改等。
  - 2：实例正常运行中。
  - -2：已隔离（包年包月）。
  - -3：已隔离（按量计费）。
     */
    Status?: Array<number | bigint>;
    /**
     * 私有网络的 ID。
  - 基础网络则无需配置该参数。
  - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其 ID。
     */
    VpcId?: string;
    /**
     * 私有网络的子网ID。
  - 基础网络则无需配置该参数。
  - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中，单击私有网络名称，在**私有网络**页面获取其子网 ID。
     */
    SubnetId?: string;
    /**
     * 指定所查询实例的付费类型。
  - 0：查询按量计费实例。
  - 1：查询包年包月实例。
  - -1：查询按量计费与包年包月实例。
     */
    PayMode?: number;
    /**
     * 单次请求返回的数量。默认值为20，取值范围为(1,100]。
     */
    Limit?: number;
    /**
     * 偏移量，默认值为0。
     */
    Offset?: number;
    /**
     * 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
     */
    OrderBy?: string;
    /**
     * 配置返回结果的排序方式。
  - ASC：升序。
  - DESC：降序。
     */
    OrderByType?: string;
    /**
     * 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)，在右上角的账户信息下拉菜单中，选择项目管理查询项目。
     */
    ProjectIds?: Array<number | bigint>;
    /**
     * 指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。
     */
    SearchKey?: string;
    /**
     * 标签信息，包含标签键与标签值。
     */
    Tags?: Array<TagInfo>;
}
/**
 * InstanceEnableSSL返回参数结构体
 */
export interface InstanceEnableSSLResponse {
    /**
     * <p>SSL开启状态。</p><ul><li>0：关闭。</li><li>1：开启。</li></ul>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Status?: number;
    /**
     * <p>证书文件过期时间，格式为：2023-05-01 12:00:00。</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ExpiredTime?: string;
    /**
     * <p>证书文件的下载链接。</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CertUrl?: string;
    /**
     * <p>流程id</p>
     */
    FlowId?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 云数据库实例当前操作
 */
export interface CurrentOp {
    /**
     * 操作序号。
     */
    OpId?: number;
    /**
     * 操作所在的命名空间，形式如db.collection。
     */
    Ns?: string;
    /**
     * 操作执行语句。
     */
    Query?: string;
    /**
     * 操作类型。
  - none：特殊状态，空闲连接或内部任务等。
  - update：更新数据。
  - insert：插入操作。
  - query：查询操作。
  - command：命令操作。
  - getmore：获取更多数据。
  - remove：删除操作。
  - killcursors：释放查询游标的操作。
     */
    Op?: string;
    /**
     * 操作所在的分片名称。
     */
    ReplicaSetName?: string;
    /**
     * 操作所在的节点名称。
     */
    NodeName?: string;
    /**
     * 操作详细信息。
     */
    Operation?: string;
    /**
     * 节点角色。
  - primary：主节点。
  - secondary：从节点。
     */
    State?: string;
    /**
     * 操作已执行时间（ms）。
     */
    MicrosecsRunning?: number;
    /**
     * 当前操作所在节点信息。
     */
    ExecNode?: string;
}
/**
 * ModifyDBInstanceSpec请求参数结构体
 */
export interface ModifyDBInstanceSpecRequest {
    /**
     * <p>实例 ID。请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制实例 ID。</p>
     */
    InstanceId: string;
    /**
     * <p>实例配置变更后的内存大小。单位：GB。该参数为空值时，默认取实例当前的内存大小。当前所支持的内存规格，请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。<br><strong>注意</strong>：内存和磁盘必须同时升配或同时降配，即 Memory 与 Volume 需同时配置变更。</p>
     */
    Memory?: number;
    /**
     * <p>实例配置变更后的硬盘大小，单位：GB。该参数为空值时，默认取当前实例的磁盘大小。当前所支持的磁盘容量，请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。</p><ul><li>内存和磁盘必须同时升配或同时降配，即 Memory 与 Volume 需同时配置变更。</li><li>降配时，变更后的磁盘容量必须大于已用磁盘容量的1.2倍。</li></ul>
     */
    Volume?: number;
    /**
     * <p>(已废弃) 请使用ResizeOplog独立接口完成。</p><p>实例配置变更后 Oplog 的大小。</p><ul><li>单位：GB。</li><li>默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。</li></ul>
     * @deprecated
     */
    OplogSize?: number;
    /**
     * <p>实例变更后 mongod 的节点数（不包含 readonly 只读节点数）。</p><ul><li>副本集节点数：请通过 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo </a>接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。</li><li>分片集群每个分片节点数：请通过 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo </a>接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。<br><strong>说明</strong>：变更 mongod 或 mongos 的 CPU 与内存规格时，该参数可以不配置或者输入当前 mongod 或 mongos（不包含readonly）节点数量。</li></ul>
     */
    NodeNum?: number;
    /**
     * <p>实例变更后的分片数。</p><ul><li>请通过 <a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a> 接口返回的参数<strong>MinReplicateSetNum</strong>与<strong>MaxReplicateSetNum</strong>获取实例分片数取值范围。</li><li>实例分片数量只允许增加不允许减少。</li></ul>
     */
    ReplicateSetNum?: number;
    /**
     * <p>实例配置变更的切换时间。</p><ul><li>0：调整完成时，立即执行变配任务。默认为0。</li><li>1：在维护时间窗内，执行变配任务。<br><strong>说明</strong>：调整节点数和分片数不支持在<b>维护时间窗内</b>变更。</li></ul>
     */
    InMaintenance?: number;
    /**
     * <p>分片实例配置变更后的 mongos 内存大小。单位：GB。实例支持的规格，请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。</p>
     */
    MongosMemory?: string;
    /**
     * <p>新增节点列表，节点类型及可用区信息。</p>
     */
    AddNodeList?: Array<AddNodeList>;
    /**
     * <p>删除节点列表。<br><strong>注意</strong>：基于分片实例各片节点的一致性原则，删除分片实例节点时，只需指定0分片对应的节点即可，如：cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。</p>
     */
    RemoveNodeList?: Array<RemoveNodeList>;
    /**
     * <p>实例配置变更后的CPU大小。单位：C。该参数为空值时，默认取实例当前的 CPU 大小。当前所支持的CPU规格，请参见<a href="https://cloud.tencent.com/document/product/240/64125">产品规格</a>。</p>
     */
    Cpu?: number;
    /**
     * <p>实例配置变更后的产品规格类型。该参数为空值时，默认取实例当前的产品规格类型。<br>当前支持的产品规格类型如下：<br>产品推荐规格类型：</p><ul><li>GE.LD.T1：本地盘（通用I型）。</li><li>GE.CD.T1：云盘（通用I型）。</li></ul><p>产品白名单规格类型：</p><ul><li>HIO10G：本地盘（高IO万兆型）。</li><li>HCD：云盘（云盘版）。</li></ul><p>注意：</p><ol><li>白名单规格类型为白名单控制，如若需要，请 <a href="https://console.cloud.tencent.com/workorder/category">提交工单</a> 申请</li><li>通用 I 型不能变更到白名单规格类型</li></ol>
     */
    MachineCode?: string;
}
/**
 * DescribeLogDownloadTasks请求参数结构体
 */
export interface DescribeLogDownloadTasksRequest {
    /**
     * 实例 ID
     */
    InstanceId: string;
    /**
     * 查询条数
     */
    Limit?: number;
    /**
     * 页码
     */
    Offset?: number;
    /**
     * 下载任务的开始时间
     */
    StartTime?: string;
    /**
     * 下载任务的结束时间
     */
    EndTime?: string;
}
/**
 * 用户权限
 */
export interface Auth {
    /**
     * 当前账号具有的权限信息。
  - 0：无权限。
  - 1：只读。
  - 3：读写。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Mask: number;
    /**
     * 指具有当前账号权限的数据库名。
  - \* ：表示所有数据库。
  - db.name：表示特定 name 的数据库。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    NameSpace: string;
}
/**
 * FlashBackDBInstance请求参数结构体
 */
export interface FlashBackDBInstanceRequest {
    /**
     * 开启按 Key 回档的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需开启按 Key 回档的实例 ID。
     */
    InstanceId: string;
    /**
     * 指定数据回档的具体时间点，即将数据恢复到指定时间点的状态。
     */
    TargetFlashbackTime: string;
    /**
     * 指定回档数据的目标库表。
     */
    TargetDatabases: Array<FlashbackDatabase>;
    /**
     * 数据回档的目标实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制目标实例 ID。
     */
    TargetInstanceId?: string;
}
/**
 * TerminateDBInstances返回参数结构体
 */
export interface TerminateDBInstancesResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ResetDBInstancePassword请求参数结构体
 */
export interface ResetDBInstancePasswordRequest {
    /**
     * 指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
     */
    InstanceId: string;
    /**
     * 指定需修改密码的账号名称。可通过接口 [DescribeAccountUsers](https://cloud.tencent.com/document/product/240/80800) 获取账号列表，复制需修改密码的账号。
     */
    UserName: string;
    /**
     * 指定账户的新密码。密码复杂度要求：
  - 8-32个字符长度。
  - 至少包含字母、数字和字符（!@#%^\*()\_）中的两种。
     */
    Password: string;
}
/**
 * CreateAuditLogFile返回参数结构体
 */
export interface CreateAuditLogFileResponse {
    /**
     * 审计日志文件名称。
     */
    FileName?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 审计实例信息
 */
export interface AuditInstance {
    /**
     * 实例 ID。
     */
    InstanceId?: string;
    /**
     * 审计状态。
     */
    AuditStatus?: string;
    /**
     * 是否存在审计任务，0：无任务，1：创建中，2：关闭中
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AuditTask?: number;
    /**
     * 审计日志过期时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LogExpireDay?: number;
    /**
     * 高频日志过期时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    HighLogExpireDay?: number;
    /**
     * 低频日志过期时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LowLogExpireDay?: number;
    /**
     * 费用信息。
     */
    BillingAmount?: number;
    /**
     * 高频存储容量
  注意：此字段可能返回 null，表示取不到有效值。
     */
    HighRealStorage?: number;
    /**
     * 低频存储容量
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LowRealStorage?: number;
    /**
     * 实例详情。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    InstanceInfo?: InstanceInfo;
    /**
     * 性能分析
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PerformancesAnalyse?: number;
    /**
     * true表示全审计，false表示规则审计
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AuditAll?: boolean;
    /**
     * 实例审计最近一次的开通时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CreateAt?: string;
    /**
     * 实例绑定的规则模版ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    RuleTemplateIds?: Array<string>;
    /**
     * 是否开启投递：ON，OFF
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Deliver?: string;
    /**
     * 日志投递信息
     */
    DeliverSummary?: Array<DeliverSummary>;
    /**
     * 旧规则
     */
    OldRule?: boolean;
    /**
     * 实际存储容量
     */
    RealStorage?: number;
}
/**
 * 实例可修改参数 Integer 类型集合。
 */
export interface InstanceIntegerParam {
    /**
     * 参数当前值。
     */
    CurrentValue?: string;
    /**
     * 参数默认值。
     */
    DefaultValue?: string;
    /**
     * 参数最大值。
     */
    Max?: string;
    /**
     * 最小值。
     */
    Min?: string;
    /**
     * 参数修改之后是否需要重启生效。
  - 1:需要重启后生效。
  - 0：无需重启，设置成功即可生效。
     */
    NeedRestart?: string;
    /**
     * 参数名称。
     */
    ParamName?: string;
    /**
     * 参数说明。
     */
    Tips?: Array<string>;
    /**
     * 参数类型。
     */
    ValueType?: string;
    /**
     * 是否为运行中参数值。
  - 1：运行中参数值。
  - 0：非运行中参数值。
     */
    Status?: number;
    /**
     * 冗余字段，可忽略。
     */
    Unit?: string;
}
/**
 * ModifyInstanceAz请求参数结构体
 */
export interface ModifyInstanceAzRequest {
    /**
     * <p>实例 ID，例如：cmgo-p8vn****。请登录 <a href="https://console.cloud.tencent.com/mongodb">MongoDB 控制台</a>在实例列表复制实例 ID。</p>
     */
    InstanceId: string;
    /**
     * <p>主节点所在的可用区 ID。获取方式，请参见<a href="https://cloud.tencent.com/document/product/240/3637">地域和可用区</a>。</p>
     */
    PrimaryNodeZone: string;
    /**
     * <p>从节点所在的可用区 ID 列表。<br><strong>注意</strong>：不可包含主节点与 Hidden 节点所在的可用区。</p>
     */
    SecondaryNodeZone: Array<string>;
    /**
     * <p>若当前实例未配置 Hidden 节点，则无需传入此参数。</p>
     */
    HiddenNodeZone?: string;
    /**
     * <p>只读节点所在的可用区 ID 列表。<br><strong>注意</strong>：若当前实例已包含只读节点，则此参数为必填项。</p>
     */
    ReadonlyNodeZone?: Array<string>;
    /**
     * <p>指定切换可用区的执行时间策略。</p><ul><li>0：立即执行切换。</li><li>1：在设定的维护时间窗执行切换。具体信息，请参见<a href="https://cloud.tencent.com/document/product/240/19910">设置实例维护时间</a>。</li></ul>
     */
    InMaintenance?: number;
}
/**
 * 修改数据库地址
 */
export interface ModifyNetworkAddress {
    /**
     * 新IP地址。
     */
    NewIPA