tencentcloud-sdk-nodejs/tencentcloud/services/cfs/v20190719/cfs_models.d.ts

腾讯云 API NODEJS SDK

/**
 * CreateMigrationTask请求参数结构体
 */
export interface CreateMigrationTaskRequest {
    /**
     * <p>迁移任务名称</p>
     */
    TaskName: string;
    /**
     * <p>迁移方式标志位，默认为0。0：桶迁移；1：清单迁移</p>
     */
    MigrationType: number;
    /**
     * <p>迁移模式，默认为0。0: 全量迁移</p>
     */
    MigrationMode: number;
    /**
     * <p>数据源账号的 SecretId</p>
     */
    SrcSecretId: string;
    /**
     * <p>数据源账号的 SecretKey</p>
     */
    SrcSecretKey: string;
    /**
     * <p>文件系统实例 ID，通过查询文件系统 <a href="https://cloud.tencent.com/document/product/582/38170">DescribeCfsFileSystems</a> 获取</p>
     */
    FileSystemId: string;
    /**
     * <p>文件系统路径</p>
     */
    FsPath: string;
    /**
     * <p>同名文件迁移时覆盖策略，默认为0。0: 最后修改时间优先；1: 全覆盖；2: 不覆盖</p>
     */
    CoverType: number;
    /**
     * <p>数据源服务商</p><p>枚举值：</p><ul><li>COS： 腾讯云COS</li><li>OSS： 阿里云OSS</li><li>OBS： 华为云OBS</li><li>BOS： 百度云BOS</li><li>TOS： 火山引擎TOS</li></ul>
     */
    SrcService: string;
    /**
     * <p>数据源桶名称；桶迁移时，BucketName 和 BucketAddress 必填其一，清单迁移时无需填写此参数</p>
     */
    BucketName?: string;
    /**
     * <p>数据源桶地域</p>
     */
    BucketRegion?: string;
    /**
     * <p>数据源桶地址；桶迁移时，BucketName 和 BucketAddress 必填其一，清单迁移时无需填写此参数</p>
     */
    BucketAddress?: string;
    /**
     * <p>清单地址，迁移方式为清单迁移时必填</p>
     */
    ListAddress?: string;
    /**
     * <p>目标文件系统名称</p>
     */
    FsName?: string;
    /**
     * <p>源桶路径，默认为 /</p>
     */
    BucketPath?: string;
    /**
     * <p>迁移方向；0：对象存储迁移至文件系统，1：文件系统迁移至对象存储。默认为0</p>
     */
    Direction?: number;
}
/**
 * ScaleUpFileSystem返回参数结构体
 */
export interface ScaleUpFileSystemResponse {
    /**
     * 文件系统Id
     */
    FileSystemId?: string;
    /**
     * 扩容的目标容量（单位GiB）
     */
    TargetCapacity?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 文件系统快照统计
 */
export interface SnapshotStatistics {
    /**
     * 地域
     */
    Region?: string;
    /**
     * 快照总个数
     */
    SnapshotNumber?: number;
    /**
     * 快照总容量，单位是MiB
     */
    SnapshotSize?: number;
}
/**
 * CreateLifecycleDataTask请求参数结构体
 */
export interface CreateLifecycleDataTaskRequest {
    /**
     * <p>文件系统唯一 ID</p>
     */
    FileSystemId: string;
    /**
     * <p>生命周期任务类型；archive：沉降；restore：预热；release：数据释放；metaload：元数据加载</p>
     */
    Type: string;
    /**
     * <p>任务名称</p>
     */
    TaskName: string;
    /**
     * <p>需要沉降的路径或文件，仅支持传入1个路径，不允许为空。</p>
     */
    TaskPath?: string;
    /**
     * <p>数据流动 ID ，该接口可以通过 DescribeDataFlow 查询</p>
     */
    DataFlowId?: string;
    /**
     * <p>当CFSTurbo内的文件和外置存储存在同名情况时，是否覆盖。  ture：覆盖  false：不覆盖（同时也不会释放热存数据）  为空时，默认为false</p>
     */
    IsOverwrite?: boolean;
    /**
     * <p>【新增】数据清单文件路径，清单文件内每行一条待处理文件的完整路径。与 TaskPath 二选一。路径必须以 /cfs 开头，且必须为 CFS 文件系统内已存在的文件。示例值：/cfs/lists/archive_list.txt</p>
     */
    ListPath?: string;
}
/**
 * DescribeCfsPGroups返回参数结构体
 */
export interface DescribeCfsPGroupsResponse {
    /**
     * 权限组信息列表
     */
    PGroupList?: Array<PGroupInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyDataFlow返回参数结构体
 */
export interface ModifyDataFlowResponse {
    /**
     * 数据流动管理 ID
     */
    DataFlowId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeMountTargets返回参数结构体
 */
export interface DescribeMountTargetsResponse {
    /**
     * 挂载点详情
     */
    MountTargets?: Array<MountInfo>;
    /**
     * 挂载点数量
     */
    NumberOfMountTargets?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeSnapshotOperationLogs请求参数结构体
 */
export interface DescribeSnapshotOperationLogsRequest {
    /**
     * 快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
     */
    SnapshotId: string;
    /**
     * 起始时间，格式“YYYY-MM-DD hh:mm:ss”
     */
    StartTime: string;
    /**
     * 结束时间，格式“YYYY-MM-DD hh:mm:ss”
     */
    EndTime: string;
}
/**
 * CreateLifecyclePolicyDownloadTask请求参数结构体
 */
export interface CreateLifecyclePolicyDownloadTaskRequest {
    /**
     * 任务Id
     */
    TaskId?: string;
    /**
     * 下载文件的类型，包含 FileSuccessList，FileTotalList，FileFailedList
     */
    Type?: string;
}
/**
 * CFS数据迁移任务信息
 */
export interface MigrationTaskInfo {
    /**
     * <p>迁移任务名称</p>
     */
    TaskName?: string;
    /**
     * <p>迁移任务id</p>
     */
    TaskId?: string;
    /**
     * <p>迁移方式标志位，默认为0。0: 桶迁移；1: 清单迁移</p>
     */
    MigrationType?: number;
    /**
     * <p>迁移模式，默认为0。0: 全量迁移</p>
     */
    MigrationMode?: number;
    /**
     * <p>数据源桶名称</p>
     */
    BucketName?: string;
    /**
     * <p>数据源桶地域</p>
     */
    BucketRegion?: string;
    /**
     * <p>数据源桶地址</p>
     */
    BucketAddress?: string;
    /**
     * <p>清单地址</p>
     */
    ListAddress?: string;
    /**
     * <p>文件系统实例名称</p>
     */
    FsName?: string;
    /**
     * <p>文件系统实例Id</p>
     */
    FileSystemId?: string;
    /**
     * <p>文件系统路径</p>
     */
    FsPath?: string;
    /**
     * <p>同名文件迁移时覆盖策略，默认为0。0: 最后修改时间优先；1: 全覆盖；2: 不覆盖</p>
     */
    CoverType?: number;
    /**
     * <p>创建时间</p>
     */
    CreateTime?: number;
    /**
     * <p>完成/终止时间</p>
     */
    EndTime?: number;
    /**
     * <p>迁移状态。0: 已完成；1: 创建中；2: 运行中；3: 终止中；4: 已终止；5: 创建失败；6: 运行失败；7: 结束中；8: 删除中；9: 等待中</p>
     */
    Status?: number;
    /**
     * <p>文件数量</p>
     */
    FileTotalCount?: number;
    /**
     * <p>已迁移文件数量</p>
     */
    FileMigratedCount?: number;
    /**
     * <p>迁移失败文件数量</p>
     */
    FileFailedCount?: number;
    /**
     * <p>文件容量，单位Byte</p>
     */
    FileTotalSize?: number;
    /**
     * <p>已迁移文件容量，单位Byte</p>
     */
    FileMigratedSize?: number;
    /**
     * <p>迁移失败文件容量，单位Byte</p>
     */
    FileFailedSize?: number;
    /**
     * <p>全部清单</p>
     */
    FileTotalList?: string;
    /**
     * <p>已完成文件清单</p>
     */
    FileCompletedList?: string;
    /**
     * <p>失败文件清单</p>
     */
    FileFailedList?: string;
    /**
     * <p>源桶路径</p>
     */
    BucketPath?: string;
    /**
     * <p>迁移方向。0: 对象存储迁移至文件系统，1: 文件系统迁移至对象存储。默认 0</p>
     */
    Direction?: number;
    /**
     * <p>数据源服务商</p><p>枚举值：</p><ul><li>COS： 腾讯云COS</li><li>OSS： 阿里云OSS</li><li>OBS： 华为云OBS</li><li>BOS： 百度云BOS</li><li>TOS： 火山引擎TOS</li></ul>
     */
    SrcService?: string;
}
/**
 * StopLifecycleDataTask请求参数结构体
 */
export interface StopLifecycleDataTaskRequest {
    /**
     * 任务ID
     */
    TaskId: string;
}
/**
 * 文件系统客户端信息
 */
export interface FileSystemClient {
    /**
     * 文件系统IP地址
     */
    CfsVip?: string;
    /**
     * 客户端IP地址
     */
    ClientIp?: string;
    /**
     * 文件系统所属VPCID
     */
    VpcId?: string;
    /**
     * 可用区名称，例如ap-beijing-1，参考[简介](https://cloud.tencent.com/document/api/582/38144)文档中的地域与可用区列表
     */
    Zone?: string;
    /**
     * 可用区中文名称
     */
    ZoneName?: string;
    /**
     * 该文件系统被挂载到客户端上的路径信息
     */
    MountDirectory?: string;
}
/**
 * DescribeCfsFileSystems返回参数结构体
 */
export interface DescribeCfsFileSystemsResponse {
    /**
     * 文件系统信息
     */
    FileSystems?: Array<FileSystemInfo>;
    /**
     * 文件系统总数
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateLifecycleDataTask返回参数结构体
 */
export interface CreateLifecycleDataTaskResponse {
    /**
     * <p>任务 ID</p>
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ApplyPathLifecyclePolicy请求参数结构体
 */
export interface ApplyPathLifecyclePolicyRequest {
    /**
     * 生命周期管理策略ID
     */
    LifecyclePolicyID: string;
    /**
     * 生命周期管理策略关联目录的绝对路径列表
     */
    Paths?: Array<PathInfo>;
}
/**
 * BindAutoSnapshotPolicy请求参数结构体
 */
export interface BindAutoSnapshotPolicyRequest {
    /**
     * 需要解绑的文件系统ID列表，用"," 分割，文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
     */
    AutoSnapshotPolicyId: string;
    /**
     * 解绑的快照策略ID，可以通过[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208) 查询获取
     */
    FileSystemIds: string;
}
/**
 * ModifyFileSystemAutoScaleUpRule请求参数结构体
 */
export interface ModifyFileSystemAutoScaleUpRuleRequest {
    /**
     * 文件系统 ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
     */
    FileSystemId: string;
    /**
     * 扩容阈值，范围[10-90]
     */
    ScaleUpThreshold: number;
    /**
     * 扩容后目标阈值，范围[10-90]，该值要小于 ScaleUpThreshold
     */
    TargetThreshold: number;
    /**
     * 规则状态 0：关闭，1：开启；不传保留原状态
     */
    Status?: number;
}
/**
 * ScaleUpFileSystem请求参数结构体
 */
export interface ScaleUpFileSystemRequest {
    /**
     * 文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
     */
    FileSystemId: string;
    /**
     * 扩容的目标容量（单位GiB）
     */
    TargetCapacity: number;
}
/**
 * CreateCfsPGroup请求参数结构体
 */
export interface CreateCfsPGroupRequest {
    /**
     * 权限组名称，1-64个字符且只能为中文，字母，数字，下划线或横线
     */
    Name: string;
    /**
     * 权限组描述信息，1-255个字符
     */
    DescInfo?: string;
}
/**
 * DescribeMigrationTasks返回参数结构体
 */
export interface DescribeMigrationTasksResponse {
    /**
     * 迁移任务的总数量
     */
    TotalCount?: number;
    /**
     * 迁移任务详情
     */
    MigrationTasks?: Array<MigrationTaskInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAutoSnapshotPolicies请求参数结构体
 */
export interface DescribeAutoSnapshotPoliciesRequest {
    /**
     * 快照策略ID
     */
    AutoSnapshotPolicyId?: string;
    /**
     * 分页码
     */
    Offset?: number;
    /**
     * 页面长
     */
    Limit?: number;
    /**
     * 过滤条件
     */
    Filters?: Array<Filter>;
    /**
     * 升序，降序
     */
    Order?: string;
    /**
     * 排序字段
     */
    OrderField?: string;
}
/**
 * DescribeAvailableZoneInfo请求参数结构体
 */
export type DescribeAvailableZoneInfoRequest = null;
/**
 * ModifyDataRetrieval请求参数结构体
 */
export interface ModifyDataRetrievalRequest {
    /**
     * <p>数据检索ID示例值：dataretrieval-123456</p>
     */
    DataRetrievalId: string;
    /**
     * <p>数据检索名称示例值：DataDive</p>
     */
    DataRetrievalName?: string;
    /**
     * <p>聚合检索条件 示例值：from entries|where size &gt;4096</p>
     */
    CompoundCondition?: string;
    /**
     * <p>列表检索条件</p>
     */
    QueryCondition?: string;
    /**
     * <p>数据检索按月重复，每月1-31号，选择一天，每月将在这一天自动创建快照；例如1 代表1号；与DayOfWeek二选一</p>
     */
    DayOfMonth?: string;
    /**
     * <p>数据检索重复日期，星期一到星期日。 1代表星期一、7代表星期天，与DayOfMonth，二选一</p>
     */
    DayOfWeek?: string;
    /**
     * <p>重复时间点,0-23，小时</p>
     */
    Hour?: string;
}
/**
 * DescribeMountTargets请求参数结构体
 */
export interface DescribeMountTargetsRequest {
    /**
     * 文件系统 ID，[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)可以获得id
     */
    FileSystemId: string;
}
/**
 * CreateDataRetrieval返回参数结构体
 */
export interface CreateDataRetrievalResponse {
    /**
     * <p>数据检索ID示例值：dataretrieval-123456</p>
     */
    DataRetrievalId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateDataFlow返回参数结构体
 */
export interface CreateDataFlowResponse {
    /**
     * 数据流动管理 ID
     */
    DataFlowId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * SignUpCfsService请求参数结构体
 */
export type SignUpCfsServiceRequest = null;
/**
 * DeleteDataRetrieval请求参数结构体
 */
export interface DeleteDataRetrievalRequest {
    /**
     * <p>数据检索 ID。可通过 DescribeDataRetrieval 接口获取。</p>
     */
    DataRetrievalId: string;
}
/**
 * SignUpCfsService返回参数结构体
 */
export interface SignUpCfsServiceResponse {
    /**
     * 该用户当前 CFS 服务的状态，creating 是开通中，created 是已开通
     */
    CfsServiceStatus?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 快照策略信息
 */
export interface AutoSnapshotPolicyInfo {
    /**
     * 快照策略ID
     */
    AutoSnapshotPolicyId?: string;
    /**
     * 快照策略名称
     */
    PolicyName?: string;
    /**
     * 快照策略创建时间
     */
    CreationTime?: string;
    /**
     * 关联的文件系统个数
     */
    FileSystemNums?: number;
    /**
     * 快照定期备份在一星期哪一天，该参数与DayOfMonth,IntervalDays互斥
     */
    DayOfWeek?: string;
    /**
     * 快照定期备份在一天的哪一小时
     */
    Hour?: string;
    /**
     * 是否激活定期快照功能,1代表已激活，0代表未激活
     */
    IsActivated?: number;
    /**
     * 下一次触发快照时间
     */
    NextActiveTime?: string;
    /**
     * 快照策略状态，available代表快照策略状态正常。这里只有一种状态
     */
    Status?: string;
    /**
     * 账号ID
     */
    AppId?: number;
    /**
     * 保留时间
     */
    AliveDays?: number;
    /**
     * 地域
     */
    RegionName?: string;
    /**
     * 文件系统信息
     */
    FileSystems?: Array<FileSystemByPolicy>;
    /**
     * 快照定期备份在一个月的某个时间；该参数与DayOfWeek,IntervalDays互斥
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DayOfMonth?: string;
    /**
     * 快照定期间隔天数，1-365 天；该参数与DayOfMonth,DayOfWeek互斥
  注意：此字段可能返回 null，表示取不到有效值。
     */
    IntervalDays?: number;
    /**
     * 跨地域复制的快照保留时间，单位天
     */
    CrossRegionsAliveDays?: number;
    /**
     * 快照策略标签
     */
    Tags?: Array<TagInfo>;
}
/**
 * 入参权限组规则列表
 */
export interface InputPermissionGroupRules {
    /**
     * 允许访问的客户端IP
     */
    AuthClientIp: string;
    /**
     * 读写权限, ro为只读，rw为读写
     */
    RWPermission: string;
    /**
     * 用户权限。其中all_squash为所有访问用户都会被映射为匿名用户或用户组；no_all_squash为访问用户会先与本机用户匹配，匹配失败后再映射为匿名用户或用户组；root_squash为将来访的root用户映射为匿名用户或用户组；no_root_squash为来访的root用户保持root帐号权限。
     */
    UserPermission: string;
    /**
     * 规则优先级，1-100。 其中 1 为最高，100为最低
     */
    Priority: number;
}
/**
 * CreateLifecyclePolicyDownloadTask返回参数结构体
 */
export interface CreateLifecyclePolicyDownloadTaskResponse {
    /**
     * 下载路径
     */
    DownloadAddress?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCfsRules请求参数结构体
 */
export interface DescribeCfsRulesRequest {
    /**
     * 权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
     */
    PGroupId: string;
}
/**
 * UpdateCfsFileSystemName请求参数结构体
 */
export interface UpdateCfsFileSystemNameRequest {
    /**
     * 文件系统 ID,通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取
     */
    FileSystemId: string;
    /**
     * 用户自定义文件系统名称，64字节内的中文字母数字或者 _,-,与CreationToken 至少填一个
     */
    FsName?: string;
}
/**
 * DeleteCfsPGroup请求参数结构体
 */
export interface DeleteCfsPGroupRequest {
    /**
     * 权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
     */
    PGroupId: string;
}
/**
 * DescribeLifecycleDataTask返回参数结构体
 */
export interface DescribeLifecycleDataTaskResponse {
    /**
     * 任务数组
     */
    LifecycleDataTask?: Array<LifecycleDataTaskInfo>;
    /**
     * 查询结果总数
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateCfsPGroup返回参数结构体
 */
export interface UpdateCfsPGroupResponse {
    /**
     * 权限组ID
     */
    PGroupId?: string;
    /**
     * 权限组名称
     */
    Name?: string;
    /**
     * 描述信息
     */
    DescInfo?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateFileSystemBandwidthLimit返回参数结构体
 */
export interface UpdateFileSystemBandwidthLimitResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据检索信息
 */
export interface DataRetrievalInfo {
    /**
     * <p>数据检索策略名称</p>
     */
    DataRetrievalName?: string;
    /**
     * <p>迁移任务id<br>示例值：migrate-001</p>
     */
    DataRetrievalId?: string;
    /**
     * <p>文件系统实例 ID，通过查询文件系统 DescribeCfsFileSystems </p><p>获取示例值：cfs-xxxxxx</p>
     */
    FileSystemId?: string;
    /**
     * <p>聚合检索条件</p>
     */
    CompoundCondition?: string;
    /**
     * <p>创建时间<br>示例值：2023-01-09 15:03:57</p>
     */
    CreateTime?: string;
    /**
     * <p>数据检索重复日期，星期一到星期日。 1代表星期一、7代表星期天，与DayOfMonth，二选一</p>
     */
    DayOfWeek?: string;
    /**
     * <p>数据检索按月重复，每月1-31号，选择一天，每月将在这一天自动创建快照；例如1 代表1号；与DayOfWeek二选一</p>
     */
    DayOfMonth?: string;
    /**
     * <p>重复时间点,0-23，小时</p>
     */
    Hour?: string;
    /**
     * <p>列表检索条件</p>
     */
    QueryCondition?: string;
    /**
     * <p>修改时间</p><p>参数格式：2023-01-10 15:03:57</p>
     */
    UpdateTime?: string;
}
/**
 * DescribeLifecyclePolicies请求参数结构体
 */
export interface DescribeLifecyclePoliciesRequest {
    /**
     * 生命周期管理策略名称
     */
    LifecyclePolicyName?: string;
    /**
     * 每个分页包含的生命周期管理策略个数
     */
    PageSize?: number;
    /**
     * 列表的分页页码
     */
    PageNumber?: number;
    /**
     * 文件系统ID
     */
    FileSystemId?: string;
    /**
     * 生命周期管理策略ID
     */
    LifecyclePolicyID?: string;
}
/**
 * DeleteAutoSnapshotPolicy请求参数结构体
 */
export interface DeleteAutoSnapshotPolicyRequest {
    /**
     * 快照策略ID，查询快照策略接口获取,[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208)
     */
    AutoSnapshotPolicyId: string;
}
/**
 * CreateLifecyclePolicy返回参数结构体
 */
export interface CreateLifecyclePolicyResponse {
    /**
     * 生命周期管理策略ID
     */
    LifecyclePolicyID?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateCfsRule请求参数结构体
 */
export interface UpdateCfsRuleRequest {
    /**
     * 权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
     */
    PGroupId: string;
    /**
     * 规则 ID，可通过[DescribeCfsRules](https://cloud.tencent.com/document/api/582/38156)接口获取
     */
    RuleId: string;
    /**
     * 可以填写单个 IP 或者单个网段，例如 10.1.10.11 或者 10.10.1.0/24。默认来访地址为*表示允许所有。同时需要注意，此处需填写 CVM 的内网 IP。
     */
    AuthClientIp?: string;
    /**
     * 读写权限, 值为RO、RW；其中 RO 为只读，RW 为读写，不填默认为只读
     */
    RWPermission?: string;
    /**
     * 用户权限，值为all_squash、no_all_squash、root_squash、no_root_squash，默认值为root_squash
  all_squash：所有访问用户（含 root 用户）都会被映射为匿名用户或用户组。
  no_all_squash：所有访问用户（含 root 用户）均保持原有的 UID/GID 信息。
  root_squash：将来访的 root 用户映射为匿名用户或用户组，非 root 用户保持原有的 UID/GID 信息。
  no_root_squash：与 no_all_squash 效果一致，所有访问用户（含 root 用户）均保持原有的 UID/GID 信息
  
     */
    UserPermission?: string;
    /**
     * 规则优先级，参数范围1-100。 其中 1 为最高，100为最低，默认值为100
     */
    Priority?: number;
}
/**
 * DescribeDataRetrievalTask请求参数结构体
 */
export interface DescribeDataRetrievalTaskRequest {
    /**
     * <p>开始时间。须早于 EndTime ，仅支持查询最近3个月内的任务数据</p><p>参数格式：2024-11-19 10:15:37</p>
     */
    StartTime: string;
    /**
     * <p>结束时间。须晚于 StartTime ，仅支持查询最近3个月内的任务数据。</p><p>参数格式：2024-10-  19 10:15:37</p>
     */
    EndTime: string;
    /**
     * <p>数据检索ID示例值：dataretrieval-123456</p>
     */
    DataRetrievalId: string;
    /**
     * <p>分页的偏移量，默认值为0。 示例值：0</p>
     */
    Offset?: number;
    /**
     * <p>分页单页限制数目，默认值为20，最大值100。 示例值：20</p>
     */
    Limit?: number;
    /**
     * <p>DataRetrievalTaskID按照【数据检索任务id】进行过滤。类型：String</p>
     */
    Filters?: Array<Filter>;
}
/**
 * StopLifecycleDataTask返回参数结构体
 */
export interface StopLifecycleDataTaskResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteUserQuota请求参数结构体
 */
export interface DeleteUserQuotaRequest {
    /**
     * 文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
     */
    FileSystemId: string;
    /**
     * 指定配额类型，包括Uid（按用户ID限制）、Gid（按用户组ID限制）、Dir（按目录限制）
     */
    UserType: string;
    /**
     * UID/GID信息，和DirectoryPath参数，两者必须填写一个
     */
    UserId?: string;
    /**
     * 设置目录配额的目录的绝对路径，和UserId参数，两者必须填写一个
     */
    DirectoryPath?: string;
}
/**
 * DescribeAvailableZoneInfo返回参数结构体
 */
export interface DescribeAvailableZoneInfoResponse {
    /**
     * <p>各可用区的资源售卖情况以及支持的存储类型、存储协议等信息</p>
     */
    RegionZones?: Array<AvailableRegion>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteCfsSnapshot返回参数结构体
 */
export interface DeleteCfsSnapshotResponse {
    /**
     * 文件系统ID
     */
    SnapshotId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCfsFileSystemClients返回参数结构体
 */
export interface DescribeCfsFileSystemClientsResponse {
    /**
     * 客户端列表
     */
    ClientList?: Array<FileSystemClient>;
    /**
     * 文件系统总数
     */
    TotalCount?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DoDirectoryOperation返回参数结构体
 */
export interface DoDirectoryOperationResponse {
    /**
     * 1:成功 0:失败。创建目录的操作，1表示创建成功，0表示创建失败。  确认目录是否存在的操作，1表示目录存在，0表示目录不存在。此外，创建目录操作若目录已存在，也会返回创建成功。
     */
    Result?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyDataRetrieval返回参数结构体
 */
export interface ModifyDataRetrievalResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateCfsSnapshot请求参数结构体
 */
export interface CreateCfsSnapshotRequest {
    /**
     * 文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
     */
    FileSystemId: string;
    /**
     * 快照名称，支持不超过64字符长度，支持中文、数字、_、-
     */
    SnapshotName?: string;
    /**
     * 快照标签
     */
    ResourceTags?: Array<TagInfo>;
}
/**
 * DescribeBucketList请求参数结构体
 */
export interface DescribeBucketListRequest {
    /**
     * 数据源服务商。COS: 腾讯云COS，OSS: 阿里云OSS，OBS:华为云OBS
     */
    SrcService: string;
    /**
     * 数据源账号的SecretId
     */
    SrcSecretId: string;
    /**
     * 数据源账号的SecretKey
     */
    SrcSecretKey: string;
}
/**
 * DeleteCfsRule请求参数结构体
 */
export interface DeleteCfsRuleRequest {
    /**
     * 权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
     */
    PGroupId: string;
    /**
     * 规则 ID，可通过[DescribeCfsRules](https://cloud.tencent.com/document/api/582/38156)接口获取
     */
    RuleId: string;
}
/**
 * ApplyPathLifecyclePolicy返回参数结构体
 */
export interface ApplyPathLifecyclePolicyResponse {
    /**
     * 有规则冲突时返回的已有冲突规则信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CheckResults?: Array<CheckResult>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据检索任务信息
 */
export interface DataRetrievalTaskInfo {
    /**
     * <p>数据检索任务ID<br>示例值：dataretrievaltask-123456</p>
     */
    DataRetrievalTaskID?: string;
    /**
     * <p>迁移任务id<br>示例值：migrate-001</p>
     */
    DataRetrievalId?: string;
    /**
     * <p>文件系统实例 ID，通过查询文件系统 DescribeCfsFileSystems 获取示例值：cfs-xxxxxx</p>
     */
    FileSystemId?: string;
    /**
     * <p>聚合检索条件<br>示例值：from entries|where size &gt;4096</p>
     */
    CompoundCondition?: string;
    /**
     * <p>列表检索条件</p>
     */
    QueryCondition?: string;
    /**
     * <p>创建时间<br>示例值：2023-01-09 15:03:57</p>
     */
    CreateTime?: string;
    /**
     * <p>任务状态<br>已完成：completed<br>排队中：waiting<br>进行中：running<br>失败：failed</p>
     */
    State?: string;
    /**
     * <p>文件数量<br>示例：1000</p>
     */
    FileNum?: number;
    /**
     * <p>目录数量<br>示例：1000</p>
     */
    DirNum?: number;
    /**
     * <p>总文件大小，单位KiB<br>示例：1024</p>
     */
    Size?: number;
    /**
     * <p>文件清单下载地址<br>示例值：https://xx-12345.cos.ap-shanghai.myqcloud.com/list.csv</p>
     */
    FileList?: string;
    /**
     * <p>检索错误提示。默认：Null，当Status为failed时，将提示信息展示给用户。</p>
     */
    ErrorInfo?: string;
}
/**
 * UpdateCfsRule返回参数结构体
 */
export interface UpdateCfsRuleResponse {
    /**
     * 权限组 ID
     */
    PGroupId?: string;
    /**
     * 规则 ID
     */
    RuleId?: string;
    /**
     * 允许访问的客户端 IP 或者 IP 段
     */
    AuthClientIp?: string;
    /**
     * 读写权限
     */
    RWPermission?: string;
    /**
     * 用户权限
     */
    UserPermission?: string;
    /**
     * 优先级
     */
    Priority?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteMigrationTask返回参数结构体
 */
export interface DeleteMigrationTaskResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeLifecycleDataTask请求参数结构体
 */
export interface DescribeLifecycleDataTaskRequest {
    /**
     * 开始时间。须早于 EndTime ，仅支持查询最近3个月内的任务数据。
     */
    StartTime: string;
    /**
     * 结束时间。须晚于 StartTime ，仅支持查询最近3个月内的任务数据。
     */
    EndTime: string;
    /**
     * 任务ID
     */
    TaskId?: string;
    /**
     * Offset 分页码
     */
    Offset?: number;
    /**
     * Limit 页面大小
     */
    Limit?: number;
    /**
     * 过滤条件，TaskName，FileSystemId，Type
     */
    Filters?: Array<Filter>;
    /**
     * 文件系统版本；v3.1: pcfs/hifs v4.0:Turbo
     */
    CfsVersion?: string;
}
/**
 * DescribeSnapshotOperationLogs返回参数结构体
 */
export interface DescribeSnapshotOperationLogsResponse {
    /**
     * 快照ID
     */
    SnapshotId?: string;
    /**
     * 操作日志
     */
    SnapshotOperates?: Array<SnapshotOperateLog>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeDataRetrieval返回参数结构体
 */
export interface DescribeDataRetrievalResponse {
    /**
     * <p>数据检索总数。</p>
     */
    TotalCount?: number;
    /**
     * <p>数据检索策略的详细信息</p>
     */
    DataRetrievals?: Array<DataRetrievalInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteCfsFileSystem请求参数结构体
 */
export interface DeleteCfsFileSystemRequest {
    /**
     * 文件系统 ID，通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取。说明，进行删除文件系统操作前需要先调用 DeleteMountTarget 接口删除该文件系统的挂载点，否则会删除失败。
     */
    FileSystemId: string;
}
/**
 * UpdateFileSystemBandwidthLimit请求参数结构体
 */
export interface UpdateFileSystemBandwidthLimitRequest {
    /**
     * 文件系统 ID,可通过[DescribeCfsFileSystems](https://cloud.tencent.com/document/api/582/38170)接口获取
     */
    FileSystemId: string;
    /**
     * 文件系统带宽，仅吞吐型可填。单位MiB/s，最小为1GiB/s，最大200GiB/s。
     */
    BandwidthLimit: number;
}
/**
 * DeleteLifecyclePolicy返回参数结构体
 */
export interface DeleteLifecyclePolicyResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateCfsPGroup返回参数结构体
 */
export interface CreateCfsPGroupResponse {
    /**
     * 权限组 ID
     */
    PGroupId?: string;
    /**
     * 权限组名字
     */
    Name?: string;
    /**
     * 权限组描述信息
     */
    DescInfo?: string;
    /**
     * 已经与该权限组绑定的文件系统个数
     */
    BindCfsNum?: number;
    /**
     * 权限组创建时间
     */
    CDate?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCfsServiceStatus请求参数结构体
 */
export type DescribeCfsServiceStatusRequest = null;
/**
 * DescribeDataRetrieval请求参数结构体
 */
export interface DescribeDataRetrievalRequest {
    /**
     * <p>分页偏移量，默认值为 0。</p>
     */
    Offset?: number;
    /**
     * <p>分页单页限制数目，默认值为 20，最大值为 100。</p>
     */
    Limit?: number;
    /**
     * <p>过滤条件列表。支持的过滤字段：FileSystemId（文件系统 ID）、DataRetrievalId（数据检索 ID）、Name（数据检索名称，支持模糊搜索）。最多支持 10 个。</p>
     */
    Filters?: Array<Filter>;
}
/**
 * 有规则冲突时返回的已有冲突规则信息列表
 */
export interface CheckResult {
    /**
     * 生命周期管理策略ID
     */
    LifecyclePolicyID: string;
    /**
     * 文件系统ID
     */
    FileSystemId: string;
    /**
     * 目录绝对路径
     */
    Path: string;
    /**
     * 生命周期管理策略关联的管理规则列表
     */
    LifecycleRules: Array<LifecycleRule>;
    /**
     * 目标路径
     */
    TargetPath: string;
}
/**
 * DeleteUserQuota返回参数结构体
 */
export interface DeleteUserQuotaResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DeleteMigrationTask请求参数结构体
 */
export interface DeleteMigrationTaskRequest {
    /**
     * 迁移任务ID
     */
    TaskId: string;
}
/**
 * 文件系统绑定权限组信息
 */
export interface PGroup {
    /**
     * 权限组ID
     */
    PGroupId?: string;
    /**
     * 权限组名称
     */
    Name?: string;
}
/**
 * SetUserQuota请求参数结构体
 */
export interface SetUserQuotaRequest {
    /**
     * 文件系统 ID,通过[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)获取
     */
    FileSystemId: string;
    /**
     * 指定配额类型，包括Uid、Gid，Dir，分别代表用户配额，用户组配额，目录配额
     */
    UserType: string;
    /**
     * UID/GID信息
     */
    UserId?: string;
    /**
     * 容量硬限制，单位GiB。设置范围10-10000000。
     */
    CapacityHardLimit?: number;
    /**
     * 文件硬限制，单位个。设置范围1000-100000000
     */
    FileHardLimit?: number;
    /**
     * 需设置目录配额的目录绝对路径，不同目录不可存在包含关系
     */
    DirectoryPath?: string;
}
/**
 * CreateAutoSnapshotPolicy返回参数结构体
 */
export interface CreateAutoSnapshotPolicyResponse {
    /**
     * 快照策略ID
     */
    AutoSnapshotPolicyId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * ModifyFileSystemAutoScaleUpRule返回参数结构体
 */
export interface ModifyFileSystemAutoScaleUpRuleResponse {
    /**
     * 文件系统 ID
     */
    FileSystemId?: string;
    /**
     * 规则状态 0：关闭，1：开启
     */
    Status?: number;
    /**
     * 扩容阈值，范围[10-90]
     */
    ScaleUpThreshold?: number;
    /**
     * 扩容后达到阈值，范围[10-90]
     */
    TargetThreshold?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 数据流动信息
 */
export interface DataFlowInfo {
    /**
     * 数据流动管理 ID
     */
    DataFlowId?: string;
    /**
     * 数据流动名称
     */
    DataFlowName?: string;
    /**
     * 源端数据类型
     */
    SourceStorageType?: string;
    /**
     * 源端存储地址
     */
    SourceStorageAddress?: string;
    /**
     * 源端路径
     */
    SourcePath?: string;
    /**
     * 目录路径
     */
    TargetPath?: string;
    /**
     * available：已生效
  pending：配置中
  unavailable：失效
  deleting：删除中
     */
    Status?: string;
    /**
     * 创建时间
     */
    CreationTime?: string;
    /**
     * 文件系统 ID
     */
    FileSystemId?: string;
    /**
     * 0：不开启自动更新
  
  1：开启自动更新
     */
    AutoRefresh?: number;
    /**
     * KafkaConsumer 消费时使用的Topic参数
     */
    UserKafkaTopic?: string;
    /**
     * 服务地址
     */
    ServerAddr?: string;
    /**
     * Kafka消费用户名
     */
    UserName?: string;
    /**
     * 自动刷新的状态，available：已生效
  pending：配置中
  unavailable：失效
     */
    AutoRefreshStatus?: string;
    /**
     * 自动刷新开启时间
     */
    AutoRefreshTime?: string;
}
/**
 * 版本控制-类型数组
 */
export interface AvailableType {
    /**
     * <p>协议与售卖详情</p>
     */
    Protocols?: Array<AvailableProtoStatus>;
    /**
     * <p>存储类型。返回值中 SD 为通用标准型存储， HP为通用性能型存储， TB为Turbo标准型， TP 为Turbo性能型。</p>
     */
    Type?: string;
    /**
     * <p>是否支持预付费。返回值中 true 为支持、false 为不支持</p>
     */
    Prepayment?: boolean;
    /**
     * <p>文件系统版本</p><p>枚举值：</p><ul><li>v1.5： 通用系列</li><li>v3.1： 通用系列（增强型）</li><li>v4.0： Turbo系列</li></ul>
     */
    Version?: string;
}
/**
 * 生命周期管理策略信息
 */
export interface LifecyclePolicy {
    /**
     * <p>生命周期管理策略创建的时间</p>
     */
    CreateTime: string;
    /**
     * <p>生命周期管理策略ID</p>
     */
    LifecyclePolicyID: string;
    /**
     * <p>生命周期管理策略名称</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LifecyclePolicyName: string;
    /**
     * <p>生命周期管理策略关联的管理规则列表</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LifecycleRules: Array<LifecycleRule>;
    /**
     * <p>生命周期管理策略关联目录的绝对路径列表</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Paths: Array<PathInfo>;
}
/**
 * RunDataRetrievalTask返回参数结构体
 */
export interface RunDataRetrievalTaskResponse {
    /**
     * <p>数据检索任务 ID。</p>
     */
    DataRetrievalTaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateCfsSnapshot返回参数结构体
 */
export interface CreateCfsSnapshotResponse {
    /**
     * 文件系统快照id
     */
    SnapshotId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 生命周期管理策略关联的管理规则
 */
export interface LifecycleRule {
    /**
     * <p>数据转储后的存储类型。其中：InfrequentAccess：低频介质存储；ColdStorage：冷存储。</p>
     */
    StorageType: string;
    /**
     * <p>数据转储文件类型。其中，BIG_FILE：超大文件；STD_FILE：普通文件；SMALL_FILE：小文件；ALL：所有文件。</p>
     */
    FileType: string;
    /**
     * <p>数据转储行为。其中，Archive：沉降；Noarchive：不沉降。</p>
     */
    Action: string;
    /**
     * <p>数据转储触发时间。由“DEFAULT_ATIME_”与“数字”组成，单位为天。当 Action 为 Noarchive，请保持为空。</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Interval?: string;
    /**
     * <p>数据转储文件最大规格。其数值需使用“数字+单位”格式进行表示，单位支持K（KiB）、M（MiB）、G（GiB）。</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FileMaxSize?: string;
    /**
     * <p>数据转储文件最小规格。其数值需使用“数字+单位”格式进行表示，单位支持K（KiB）、M（MiB）、G（GiB）。</p>
  注意：此字段可能返回 null，表示取不到有效值。
     */
    FileMinSize?: string;
    /**
     * <p>策略类型</p>
     */
    PolicyType?: string;
    /**
     * <p>阈值范围[10-90]</p>
     */
    ExpireThreshold?: number;
    /**
     * <p>阈值范围[10-90]</p>
     */
    TargetThreshold?: number;
    /**
     * <p>当CFSTurbo内的文件和外置存储存在同名情况时，是否覆盖。</p><p>ture：覆盖</p><p>false：不覆盖（同时也不会释放热存数据）</p><p>为空时，默认为false</p>
     */
    IsOverwrite?: boolean;
    /**
     * <p>新建文件是否近实时同步至 S3。true：近实时同步（30 秒内）/ false：基于策略配置时间同步。默认 false。仅当 StorageType=ExternalStorage 时生效</p>
     */
    IsCreateRealTimeSync?: boolean;
    /**
     * <p>修改文件是否近实时同步至 S3。true：近实时同步（30 秒内）/ false：基于策略配置时间同步。默认 false。仅当 StorageType=ExternalStorage 时生效。与 IsOverwrite 独立</p>
     */
    IsModifyRealTimeSync?: boolean;
    /**
     * <p>删除文件是否同步至 S3。true：同步删除（30 秒内）/ false：不同步删除。默认 false。为 true 时要求目标 COS Bucket 已开启多版本。仅当 StorageType=ExternalStorage 时生效</p>
     */
    IsSyncDelete?: boolean;
}
/**
 * 文件系统配额信息
 */
export interface UserQuota {
    /**
     * 指定配额类型，包括Uid、Gid、Dir
     */
    UserType: string;
    /**
     * UID/GID信息
     */
    UserId: string;
    /**
     * 容量硬限制，单位GiB
     */
    CapacityHardLimit: number;
    /**
     * 文件硬限制，单位个
     */
    FileHardLimit: number;
    /**
     * 文件系统ID
     */
    FileSystemId: string;
    /**
     * 容量使用，单位GiB
     */
    CapacityUsed?: number;
    /**
     * 文件使用个数，单位个
     */
    FileUsed?: number;
    /**
     * 目录配额的目录绝对路径
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DirectoryPath?: string;
    /**
     * 配置规则状态，inavailable---配置中，available --已生效，deleting--删除中，deleted 已删除，failed--配置失败
     */
    Status?: string;
}
/**
 * CreateCfsRule请求参数结构体
 */
export interface CreateCfsRuleRequest {
    /**
     * 权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
     */
    PGroupId: string;
    /**
     * 可以填写单个 IP 或者单个网段，例如 10.1.10.11 或者 10.10.1.0/24。默认来访地址为*表示允许所有。同时需要注意，此处需填写 CVM 的内网 IP。
     */
    AuthClientIp: string;
    /**
     * 规则优先级，参数范围1-100。 其中 1 为最高，100为最低
     */
    Priority: number;
    /**
     * 读写权限, 值为 RO、RW；其中 RO 为只读，RW 为读写，不填默认为只读
     */
    RWPermission?: string;
    /**
     * 用户权限，值为 all_squash、no_all_squash、root_squash、no_root_squash。默认值为root_squash
  all_squash：所有访问用户（含 root 用户）都会被映射为匿名用户或用户组。
  no_all_squash：所有访问用户（含 root 用户）均保持原有的 UID/GID 信息。
  root_squash：将来访的 root 用户映射为匿名用户或用户组，非 root 用户保持原有的 UID/GID 信息。
  no_root_squash：与 no_all_squash 效果一致，所有访问用户（含 root 用户）均保持原有的 UID/GID 信息
  
     */
    UserPermission?: string;
}
/**
 * DeleteCfsFileSystem返回参数结构体
 */
export interface DeleteCfsFileSystemResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateCfsFileSystem返回参数结构体
 */
export interface CreateCfsFileSystemResponse {
    /**
     * <p>文件系统创建时间</p>
     */
    CreationTime?: string;
    /**
     * <p>用户自定义文件系统名称</p>
     */
    CreationToken?: string;
    /**
     * <p>文件系统 ID</p>
     */
    FileSystemId?: string;
    /**
     * <p>文件系统状态，可能出现状态包括：“creating”  创建中, “create_failed” 创建失败, “available” 可用, “unserviced” 不可用, “upgrading” 升级中， “deleting” 删除中。</p>
     */
    LifeCycleState?: string;
    /**
     * <p>文件系统已使用容量大小，单位为 Byte</p>
     */
    SizeByte?: number;
    /**
     * <p>可用区 ID</p>
     */
    ZoneId?: number;
    /**
     * <p>用户自定义文件系统名称</p>
     */
    FsName?: string;
    /**
     * <p>文件系统是否加密</p>
     */
    Encrypted?: boolean;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 对象存储桶
 */
export interface BucketInfo {
    /**
     * 桶名称
     */
    Name?: string;
    /**
     * 桶所在地域
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Region?: string;
}
/**
 * DeleteDataFlow返回参数结构体
 */
export interface DeleteDataFlowResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateAccessCert请求参数结构体
 */
export interface CreateAccessCertRequest {
    /**
     * 证书描述，不超过64字符
     */
    CertDesc: string;
}
/**
 * 生命周期任务
 */
export interface LifecycleDataTaskInfo {
    /**
     * <p>任务id</p>
     */
    TaskId?: string;
    /**
     * <p>任务状态</p><p>枚举值：</p><ul><li>init： 排队中</li><li>running： 执行中</li><li>finished： 已完成</li><li>failed： 失败</li><li>stopping： 停止中</li><li>stopped： 已停止</li></ul>
     */
    TaskStatus?: string;
    /**
     * <p>任务创建时间</p>
     */
    CreationTime?: string;
    /**
     * <p>任务结束时间</p>
     */
    FinishTime?: string;
    /**
     * <p>文件总数</p>
     */
    FileTotalCount?: number;
    /**
     * <p>处理成功文件数量</p>
     */
    FileSuccessedCount?: number;
    /**
     * <p>当前已经失败的文件数</p>
     */
    FileFailedCount?: number;
    /**
     * <p>文件容量，单位Byte</p>
     */
    FileTotalSize?: number;
    /**
     * <p>已处理完成的文件容量，单位Byte</p>
     */
    FileSuccessedSize?: number;
    /**
     * <p>已处理失败文件容量，单位Byte</p>
     */
    FileFailedSize?: number;
    /**
     * <p>总文件列表</p>
     */
    FileTotalList?: string;
    /**
     * <p>成功的文件列表</p>
     */
    FileSuccessedList?: string;
    /**
     * <p>失败文件的列表</p>
     */
    FileFailedList?: string;
    /**
     * <p>FileSystemId</p>
     */
    FileSystemId?: string;
    /**
     * <p>任务名称</p>
     */
    TaskName?: string;
    /**
     * <p>任务路径</p>
     */
    TaskPath?: string;
    /**
     * <p>任务类型,archive:表示沉降任务，restore：表示拉取任务</p>
     */
    Type?: string;
    /**
     * <p>数据流动Id</p>
     */
    DataFlowId?: string;
    /**
     * <p>当CFSTurbo内的文件和外置存储存在同名情况时，是否覆盖。</p><p>ture：覆盖</p><p>false：不覆盖（同时也不会释放热存数据）<br>为空时，默认为false</p>
     */
    IsOverwrite?: boolean;
    /**
     * <p>【新增】数据清单文件路径，清单文件内每行一条待处理文件的完整路径。与 TaskPath 二选一。路径必须以 /cfs 开头，且必须为 CFS 文件系统内已存在的文件。示例值：/cfs/lists/archive_list.txt</p>
     */
    ListPath?: string;
}
/**
 * DescribeLifecyclePolicies返回参数结构体
 */
export interface DescribeLifecyclePoliciesResponse {
    /**
     * 列表的分页页码
     */
    PageNumber?: number;
    /**
     * 每个分页包含的生命周期管理策略个数
     */
    PageSize?: number;
    /**
     * 生命周期管理策略总数
     */
    TotalCount?: number;
    /**
     * 生命周期管理策略列表
     */
    LifecyclePolicies?: Array<LifecyclePolicy>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeUserQuota请求参数结构体
 */
export interface DescribeUserQuotaRequest {
    /**
     * 文件系统 ID,通过[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)获取
     */
    FileSystemId: string;
    /**
     * 过滤条件。
  UserType - Array of String - 是否必填：否 -（过滤条件）按配额类型过滤。(Uid|Gid|Dir，分别对应用户，用户组，目录 )
  UserId- Array of String - 是否必填：否 -（过滤条件）按用户id过滤。
     */
    Filters?: Array<Filter>;
    /**
     * Offset 分页码，默认值0
     */
    Offset?: number;
    /**
     * Limit 页面大小，可填范围为大于0的整数，默认值是10
     */
    Limit?: number;
}
/**
 * OverrideCfsRules返回参数结构体
 */
export interface OverrideCfsRulesResponse {
    /**
     * 权限组规则列表
     */
    RuleList: Array<PGroupRuleInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 文件系统基本信息
 */
export interface FileSystemInfo {
    /**
     * 创建时间
     */
    CreationTime?: string;
    /**
     * 用户自定义名称
     */
    CreationToken?: string;
    /**
     * 文件系统 ID
     */
    FileSystemId?: string;
    /**
     * 文件系统状态。取值范围：
  - creating:创建中
  - mounting:挂载中
  - create_failed:创建失败
  - available:可使用
  - unserviced:停服中
  - upgrading:升级中
     */
    LifeCycleState?: string;
    /**
     * 文件系统已使用容量。单位：Byte
     */
    SizeByte?: number;
    /**
     * 文件系统空间限制。单位:GiB
     */
    SizeLimit?: number;
    /**
     * 区域 ID
     */
    ZoneId?: number;
    /**
     * 区域名称
     */
    Zone?: string;
    /**
     * 文件系统协议类型, 支持 NFS,CIFS,TURBO
     */
    Protocol?: string;
    /**
     * 存储类型，HP：通用性能型；SD：通用标准型；TP:turbo性能型；TB：turbo标准型；THP：吞吐型
     */
    StorageType?: string;
    /**
     * 文件系统绑定的预付费存储包
     */
    StorageResourcePkg?: string;
    /**
     * 文件系统绑定的预付费带宽包（暂未支持）
     */
    BandwidthResourcePkg?: string;
    /**
     * 文件系统绑定权限组信息
     */
    PGroup?: PGroup;
    /**
     * 用户自定义名称
     */
    FsName?: string;
    /**
     * 文件系统是否加密,true：代表加密，false：非加密
     */
    Encrypted?: boolean;
    /**
     * 加密所使用的密钥，可以为密钥的 ID 或者 ARN
     */
    KmsKeyId?: string;
    /**
     * 应用ID
     */
    AppId?: number;
    /**
     * 文件系统吞吐上限，吞吐上限是根据文件系统当前已使用存储量、绑定的存储资源包以及吞吐资源包一同确定. 单位MiB/s
     */
    BandwidthLimit?: number;
    /**
     * 文件系统关联的快照策略
     */
    AutoSnapshotPolicyId?: string;
    /**
     * 文件系统处理快照状态,snapping：快照中，normal：正常状态
     */
    SnapStatus?: string;
    /**
     * 文件系统容量规格上限
  单位:GiB
     */
    Capacity?: number;
    /**
     * 文件系统标签列表
     */
    Tags?: Array<TagInfo>;
    /**
     * 文件系统生命周期管理状态
  NotAvailable：不可用
  Available:可用
     */
    TieringState?: string;
    /**
     * 分层存储详情
     */
    TieringDetail?: TieringDetailInfo;
    /**
     * 文件系统自动扩容策略
     */
    AutoScaleUpRule?: AutoScaleUpRule;
    /**
     * 文件系统版本
     */
    Version?: string;
    /**
     * 额外性能信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ExstraPerformanceInfo?: Array<ExstraPerformanceInfo>;
    /**
     * basic：标准版元数据类型
  enhanced：增项版元数据类型
     */
    MetaType?: string;
}
/**
 * DescribeDataFlow请求参数结构体
 */
export interface DescribeDataFlowRequest {
    /**
     * 文件系统 ID ，通过查询文件系统 [DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170) 获取
     */
    FileSystemId?: string;
    /**
     * 数据流动 ID ，由创建数据流动返回
     */
    DataFlowId?: string;
    /**
     * 每次查询返回值个数，默认20；最大100
     */
    Limit?: number;
    /**
     * 偏移量，默认为0
     */
    Offset?: number;
    /**
     * 文件系统版本；版本号：v1.5，v3.0，v3.1，v4.0
     */
    CfsVersion?: string;
}
/**
 * DescribeBucketList返回参数结构体
 */
export interface DescribeBucketListResponse {
    /**
     * 桶的数量
     */
    TotalCount?: number;
    /**
     * 桶列表
     */
    BucketList?: Array<BucketInfo>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 挂载点信息
 */
export interface MountInfo {
    /**
     * 文件系统 ID
     */
    FileSystemId?: string;
    /**
     * 挂载点 ID
     */
    MountTargetId?: string;
    /**
     * 挂载点 IP
     */
    IpAddress?: string;
    /**
     * 挂载根目录
     */
    FSID?: string;
    /**
     * 挂载点状态，包括creating：创建中；available：运行中；
  deleting：删除中；
  create_failed： 创建失败
     */
    LifeCycleState?: string;
    /**
     * 网络类型，包括VPC,CCN
     */
    NetworkInterface?: string;
    /**
     * 私有网络 ID
     */
    VpcId?: string;
    /**
     * 私有网络名称
     */
    VpcName?: string;
    /**
     * 子网 Id
     */
    SubnetId?: string;
    /**
     * 子网名称
     */
    SubnetName?: string;
    /**
     * CFS Turbo使用的云联网ID
     */
    CcnID?: string;
    /**
     * 云联网中CFS Turbo使用的网段
     */
    CidrBlock?: string;
}
/**
 * UpdateCfsFileSystemName返回参数结构体
 */
export interface UpdateCfsFileSystemNameResponse {
    /**
     * 用户自定义文件系统名称
     */
    CreationToken?: string;
    /**
     * 文件系统ID
     */
    FileSystemId?: string;
    /**
     * 用户自定义文件系统名称
     */
    FsName?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCfsSnapshotOverview返回参数结构体
 */
export interface DescribeCfsSnapshotOverviewResponse {
    /**
     * 统计信息
     */
    StatisticsList?: Array<SnapshotStatistics>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 自动扩容规则
 */
export interface AutoScaleUpRule {
    /**
     * 自动扩容策略开启，关闭
     */
    Status?: string;
    /**
     * 集群用量占比，到达这个值后开始扩容,范围[10-90]
     */
    ScaleThreshold?: number;
    /**
     * 扩容后使用量跟集群总量比例,范围[10-90]
     */
    TargetThreshold?: number;
}
/**
 * DeleteCfsSnapshot请求参数结构体
 */
export interface DeleteCfsSnapshotRequest {
    /**
     * 快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
     */
    SnapshotId?: string;
    /**
     * 需要删除的文件系统快照ID 列表，快照ID，跟ID列表至少填一项
  快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
     */
    SnapshotIds?: Array<string>;
}
/**
 * DescribeCfsFileSystemClients请求参数结构体
 */
export interface DescribeCfsFileSystemClientsRequest {
    /**
     * 文件系统 ID，通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取
     */
    FileSystemId: string;
    /**
     * Offset 分页码，默认为0
     */
    Offset?: number;
    /**
     * Limit 页面大小，默认为10，最大值为100
     */
    Limit?: number;
}
/**
 * OverrideCfsRules请求参数结构体
 */
export interface OverrideCfsRulesRequest {
    /**
     * 权限组 ID
     */
    PermissionGroupId: string;
    /**
     * 权限组规则列表
     */
    RuleList: Array<InputPermissionGroupRules>;
}
/**
 * CreateDataRetrieval请求参数结构体
 */
export interface CreateDataRetrievalRequest {
    /**
     * <p>文件系统实例 ID，通过查询文件系统 DescribeCfsFileSystems 获取 示例值：cfs-xxxxxx</p>
     */
    FileSystemId: string;
    /**
     * <p>数据检索名称 示例值：DataDive</p>
     */
    DataRetrievalName: string;
    /**
     * <p>聚合检索条件 示例值：from entries|where size &gt;4096</p>
     */
    CompoundCondition?: string;
    /**
     * <p>列表检索条件</p>
     */
    QueryCondition?: string;
    /**
     * <p>数据检索按月重复，每月1-31号，选择一天，每月将在这一天自动创建快照；例如1 代表1号；与DayOfWeek二选一 示例值：1</p>
     */
    DayOfMonth?: string;
    /**
     * <p>数据检索重复日期，星期一到星期日。 1代表星期一、7代表星期天，与DayOfMonth，二选一 示例值：2,3</p>
     */
    DayOfWeek?: string;
    /**
     * <p>重复时间点,0-23，小时 示例值：1,3,5</p>
     */
    Hour?: string;
}
/**
 * DescribeCfsSnapshots返回参数结构体
 */
export interface DescribeCfsSnapshotsResponse {
    /**
     * 总个数
     */
    TotalCount?: number;
    /**
     * 快照信息描述
     */
    Snapshots?: Array<SnapshotInfo>;
    /**
     * 快照列表快照汇总
     */
    TotalSize?: number;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeCfsFileSystems请求参数结构体
 */
export interface DescribeCfsFileSystemsRequest {
    /**
     * 文件系统 ID
     */
    FileSystemId?: string;
    /**
     * 私有网络（VPC） ID
     */
    VpcId?: string;
    /**
     * 子网 ID
     */
    SubnetId?: string;
    /**
     * Offset 分页码,默认0
     */
    Offset?: number;
    /**
     * Limit 页面大小，默认10
     */
    Limit?: number;
    /**
     * 用户自定义名称
     */
    CreationToken?: string;
}
/**
 * 版本控制-区域数组
 */
export interface AvailableRegion {
    /**
     * 区域名称，如“ap-beijing”
     */
    Region?: string;
    /**
     * 区域名称，如“bj”
     */
    RegionName?: string;
    /**
     * 区域可用情况，当区域内至少有一个可用区处于可售状态时，取值为AVAILABLE，否则为UNAVAILABLE
     */
    RegionStatus?: string;
    /**
     * 可用区数组
     */
    Zones?: Array<AvailableZone>;
    /**
     * 区域中文名称，如“广州”
     */
    RegionCnName?: string;
}
/**
 * CreateCfsFileSystem请求参数结构体
 */
export interface CreateCfsFileSystemRequest {
    /**
     * <p>可用区名称，例如ap-beijing-1，请参考 <a href="https://cloud.tencent.com/document/product/582/13225">概览</a> 文档中的地域与可用区列表</p>
     */
    Zone: string;
    /**
     * <p>网络类型，可选值为 VPC，CCN；其中 VPC 为私有网络， CCN 为云联网。通用标准型/性能型请选择VPC，Turbo标准型/性能型请选择CCN。</p>
     */
    NetInterface: string;
    /**
     * <p>权限组 ID,pgroupbasic 是默认权限组，通过控制查询权限组列表接口获取<a href="https://cloud.tencent.com/document/product/582/38157">DescribeCfsPGroups</a></p>
     */
    PGroupId: string;
    /**
     * <p>文件系统协议类型， 值为 NFS、CIFS、TURBO ; 若留空则默认为 NFS协议，turbo系列必须选择TURBO，不支持NFS、CIFS</p>
     */
    Protocol?: string;
    /**
     * <p>文件系统存储类型，默认值为 SD ；其中 SD 为通用标准型存储， HP为通用性能型存储， TB为Turbo标准型， TP 为Turbo性能型。</p>
     */
    StorageType?: string;
    /**
     * <p>私有网络（VPC） ID，若网络类型选择的是VPC，该字段为必填.通过查询私有网络接口获取，<br><a href="https://cloud.tencent.com/document/product/215/15778">DescribeVpcs</a></p>
     */
    VpcId?: string;
    /**
     * <p>子网 ID，若网络类型选择的是VPC，该字段为必填。通过查询子网接口获取，<br><a href="https://cloud.tencent.com/document/product/215/15784">DescribeSubn