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

腾讯云 API NODEJS SDK

import { AbstractClient } from "../../../common/abstract_client";
import { ClientConfig } from "../../../common/interface";
import { CreateMigrationTaskRequest, ScaleUpFileSystemResponse, CreateLifecycleDataTaskRequest, DescribeCfsPGroupsResponse, ModifyDataFlowResponse, DescribeMountTargetsResponse, DescribeSnapshotOperationLogsRequest, CreateLifecyclePolicyDownloadTaskRequest, StopLifecycleDataTaskRequest, DescribeCfsFileSystemsResponse, CreateLifecycleDataTaskResponse, ApplyPathLifecyclePolicyRequest, BindAutoSnapshotPolicyRequest, ModifyFileSystemAutoScaleUpRuleRequest, ScaleUpFileSystemRequest, CreateCfsPGroupRequest, DescribeMigrationTasksResponse, DescribeAutoSnapshotPoliciesRequest, DescribeAvailableZoneInfoRequest, ModifyDataRetrievalRequest, DescribeMountTargetsRequest, CreateDataRetrievalResponse, CreateDataFlowResponse, SignUpCfsServiceRequest, DeleteDataRetrievalRequest, SignUpCfsServiceResponse, CreateLifecyclePolicyDownloadTaskResponse, DescribeCfsRulesRequest, UpdateCfsFileSystemNameRequest, DeleteCfsPGroupRequest, DescribeLifecycleDataTaskResponse, UpdateCfsPGroupResponse, UpdateFileSystemBandwidthLimitResponse, DescribeLifecyclePoliciesRequest, DeleteAutoSnapshotPolicyRequest, CreateLifecyclePolicyResponse, UpdateCfsRuleRequest, DescribeDataRetrievalTaskRequest, StopLifecycleDataTaskResponse, DeleteUserQuotaRequest, DescribeAvailableZoneInfoResponse, DeleteCfsSnapshotResponse, DescribeCfsFileSystemClientsResponse, DoDirectoryOperationResponse, ModifyDataRetrievalResponse, CreateCfsSnapshotRequest, DescribeBucketListRequest, DeleteCfsRuleRequest, ApplyPathLifecyclePolicyResponse, UpdateCfsRuleResponse, DeleteMigrationTaskResponse, DescribeLifecycleDataTaskRequest, DescribeSnapshotOperationLogsResponse, DescribeDataRetrievalResponse, DeleteCfsFileSystemRequest, UpdateFileSystemBandwidthLimitRequest, DeleteLifecyclePolicyResponse, CreateCfsPGroupResponse, DescribeCfsServiceStatusRequest, DescribeDataRetrievalRequest, DeleteUserQuotaResponse, DeleteMigrationTaskRequest, SetUserQuotaRequest, CreateAutoSnapshotPolicyResponse, ModifyFileSystemAutoScaleUpRuleResponse, RunDataRetrievalTaskResponse, CreateCfsSnapshotResponse, CreateCfsRuleRequest, DeleteCfsFileSystemResponse, CreateCfsFileSystemResponse, DeleteDataFlowResponse, CreateAccessCertRequest, DescribeLifecyclePoliciesResponse, DescribeUserQuotaRequest, OverrideCfsRulesResponse, DescribeDataFlowRequest, DescribeBucketListResponse, UpdateCfsFileSystemNameResponse, DescribeCfsSnapshotOverviewResponse, DeleteCfsSnapshotRequest, DescribeCfsFileSystemClientsRequest, OverrideCfsRulesRequest, CreateDataRetrievalRequest, DescribeCfsSnapshotsResponse, DescribeCfsFileSystemsRequest, CreateCfsFileSystemRequest, RunDataRetrievalTaskRequest, DescribeMigrationTasksRequest, UnbindAutoSnapshotPolicyRequest, DescribeDataRetrievalTaskResponse, DescribeCfsServiceStatusResponse, BindAutoSnapshotPolicyResponse, DescribeCfsSnapshotsRequest, UpdateCfsFileSystemSizeLimitResponse, UpdateAutoSnapshotPolicyRequest, UpdateCfsFileSystemSizeLimitRequest, DeleteDataRetrievalResponse, DescribeCfsRulesResponse, UpdateCfsFileSystemPGroupResponse, UpdateAutoSnapshotPolicyResponse, UpdateCfsFileSystemPGroupRequest, CreateMigrationTaskResponse, DeleteAutoSnapshotPolicyResponse, DeleteCfsRuleResponse, UpdateCfsSnapshotAttributeResponse, UpdateCfsPGroupRequest, DeleteDataFlowRequest, ModifyLifecyclePolicyResponse, SetUserQuotaResponse, DescribeCfsPGroupsRequest, DeleteCfsPGroupResponse, UpdateCfsSnapshotAttributeRequest, DescribeUserQuotaResponse, ModifyLifecyclePolicyRequest, DeleteLifecyclePolicyRequest, CreateLifecyclePolicyRequest, CreateCfsRuleResponse, StopMigrationTaskResponse, CreateAccessCertResponse, StopMigrationTaskRequest, DescribeAutoSnapshotPoliciesResponse, ModifyDataFlowRequest, DescribeCfsSnapshotOverviewRequest, UnbindAutoSnapshotPolicyResponse, CreateAutoSnapshotPolicyRequest, CreateDataFlowRequest, DescribeDataFlowResponse, DoDirectoryOperationRequest } from "./cfs_models";
/**
 * cfs client
 * @class
 */
export declare class Client extends AbstractClient {
    constructor(clientConfig: ClientConfig);
    /**
     * 文件系统目录操作接口。当前仅 Turbo 系列文件系统支持调用此接口进行目录操作，通用系列文件系统（含增强型）不支持调用。
     */
    DoDirectoryOperation(req: DoDirectoryOperationRequest, cb?: (error: string, rep: DoDirectoryOperationResponse) => void): Promise<DoDirectoryOperationResponse>;
    /**
     * 本接口（DescribeCfsRules）用于查询权限组规则列表。
     */
    DescribeCfsRules(req: DescribeCfsRulesRequest, cb?: (error: string, rep: DescribeCfsRulesResponse) => void): Promise<DescribeCfsRulesResponse>;
    /**
     * 本接口（UpdateCfsFileSystemPGroup）用于更新文件系统所使用的权限组
     */
    UpdateCfsFileSystemPGroup(req: UpdateCfsFileSystemPGroupRequest, cb?: (error: string, rep: UpdateCfsFileSystemPGroupResponse) => void): Promise<UpdateCfsFileSystemPGroupResponse>;
    /**
     * 查询生命周期任务的接口。仅支持查询最近三个月内的任务数据。
     */
    DescribeLifecycleDataTask(req: DescribeLifecycleDataTaskRequest, cb?: (error: string, rep: DescribeLifecycleDataTaskResponse) => void): Promise<DescribeLifecycleDataTaskResponse>;
    /**
     * 删除文件系统快照
     */
    DeleteCfsSnapshot(req: DeleteCfsSnapshotRequest, cb?: (error: string, rep: DeleteCfsSnapshotResponse) => void): Promise<DeleteCfsSnapshotResponse>;
    /**
     * 用于删除文件系统
     */
    DeleteCfsFileSystem(req: DeleteCfsFileSystemRequest, cb?: (error: string, rep: DeleteCfsFileSystemResponse) => void): Promise<DeleteCfsFileSystemResponse>;
    /**
     * 更新文件系统快照名称及保留时长
     */
    UpdateCfsSnapshotAttribute(req: UpdateCfsSnapshotAttributeRequest, cb?: (error: string, rep: UpdateCfsSnapshotAttributeResponse) => void): Promise<UpdateCfsSnapshotAttributeResponse>;
    /**
     * 用于获取迁移任务列表。
此接口需提交工单，开启白名单之后才能使用。
     */
    DescribeMigrationTasks(req: DescribeMigrationTasksRequest, cb?: (error: string, rep: DescribeMigrationTasksResponse) => void): Promise<DescribeMigrationTasksResponse>;
    /**
     * 更新文件系统吞吐
仅吞吐型支持此接口
     */
    UpdateFileSystemBandwidthLimit(req: UpdateFileSystemBandwidthLimitRequest, cb?: (error: string, rep: UpdateFileSystemBandwidthLimitResponse) => void): Promise<UpdateFileSystemBandwidthLimitResponse>;
    /**
     * 设置文件系统配额，提供UID/GID的配额设置的接口（仅部分Turbo实例能使用，若需要调用请提交工单与我们联系）
     */
    SetUserQuota(req: SetUserQuotaRequest, cb?: (error: string, rep: SetUserQuotaResponse) => void): Promise<SetUserQuotaResponse>;
    /**
     * 删除数据检索。

删除指定的数据检索配置，不允许在存在关联任务时删除。调用接口后，若通过 DescribeDataRetrieval 接口查询不到对应的数据检索，则表示删除成功。
     */
    DeleteDataRetrieval(req: DeleteDataRetrievalRequest, cb?: (error: string, rep: DeleteDataRetrievalResponse) => void): Promise<DeleteDataRetrievalResponse>;
    /**
     * 本接口（DescribeMountTargets）用于查询文件系统挂载点信息
     */
    DescribeMountTargets(req: DescribeMountTargetsRequest, cb?: (error: string, rep: DescribeMountTargetsResponse) => void): Promise<DescribeMountTargetsResponse>;
    /**
     * 创建数据流动接口
     */
    CreateDataFlow(req: CreateDataFlowRequest, cb?: (error: string, rep: CreateDataFlowResponse) => void): Promise<CreateDataFlowResponse>;
    /**
     * 本接口（DeleteCfsPGroup）用于删除权限组，只有未绑定文件系统的权限组才能够被此接口删除。
     */
    DeleteCfsPGroup(req: DeleteCfsPGroupRequest, cb?: (error: string, rep: DeleteCfsPGroupResponse) => void): Promise<DeleteCfsPGroupResponse>;
    /**
     * 删除生命周期管理策略
     */
    DeleteLifecyclePolicy(req: DeleteLifecyclePolicyRequest, cb?: (error: string, rep: DeleteLifecyclePolicyResponse) => void): Promise<DeleteLifecyclePolicyResponse>;
    /**
     * 查询文件系统快照定期策略列表信息
     */
    DescribeAutoSnapshotPolicies(req: DescribeAutoSnapshotPoliciesRequest, cb?: (error: string, rep: DescribeAutoSnapshotPoliciesResponse) => void): Promise<DescribeAutoSnapshotPoliciesResponse>;
    /**
     * 解除文件系统绑定的快照策略
     */
    UnbindAutoSnapshotPolicy(req: UnbindAutoSnapshotPolicyRequest, cb?: (error: string, rep: UnbindAutoSnapshotPolicyResponse) => void): Promise<UnbindAutoSnapshotPolicyResponse>;
    /**
     * 下载生命周期任务中文件列表
     */
    CreateLifecyclePolicyDownloadTask(req: CreateLifecyclePolicyDownloadTaskRequest, cb?: (error: string, rep: CreateLifecyclePolicyDownloadTaskResponse) => void): Promise<CreateLifecyclePolicyDownloadTaskResponse>;
    /**
     * 查询挂载该文件系统的客户端。此功能需要客户端安装CFS监控插件。
     */
    DescribeCfsFileSystemClients(req: DescribeCfsFileSystemClientsRequest, cb?: (error: string, rep: DescribeCfsFileSystemClientsResponse) => void): Promise<DescribeCfsFileSystemClientsResponse>;
    /**
     * 本接口（DescribeCfsServiceStatus）用于查询用户使用CFS的服务状态。
     */
    DescribeCfsServiceStatus(req?: DescribeCfsServiceStatusRequest, cb?: (error: string, rep: DescribeCfsServiceStatusResponse) => void): Promise<DescribeCfsServiceStatusResponse>;
    /**
     * 查询数据检索。

查询数据检索列表，支持按文件系统 ID、数据检索 ID、名称等条件筛选。
     */
    DescribeDataRetrieval(req: DescribeDataRetrievalRequest, cb?: (error: string, rep: DescribeDataRetrievalResponse) => void): Promise<DescribeDataRetrievalResponse>;
    /**
     * 用于终止迁移任务，可以终止等待中、运行中状态的任务。
     */
    StopMigrationTask(req: StopMigrationTaskRequest, cb?: (error: string, rep: StopMigrationTaskResponse) => void): Promise<StopMigrationTaskResponse>;
    /**
     * 创建数据检索
     */
    CreateDataRetrieval(req: CreateDataRetrievalRequest, cb?: (error: string, rep: CreateDataRetrievalResponse) => void): Promise<CreateDataRetrievalResponse>;
    /**
     * 本接口（DescribeAvailableZoneInfo）用于查询区域的可用情况。
     */
    DescribeAvailableZoneInfo(req?: DescribeAvailableZoneInfoRequest, cb?: (error: string, rep: DescribeAvailableZoneInfoResponse) => void): Promise<DescribeAvailableZoneInfoResponse>;
    /**
     * 支持主动沉降/预热接口
     */
    CreateLifecycleDataTask(req: CreateLifecycleDataTaskRequest, cb?: (error: string, rep: CreateLifecycleDataTaskResponse) => void): Promise<CreateLifecycleDataTaskResponse>;
    /**
     * 本接口（OverrideCfsRules）用于批量覆盖式创建权限组规则。
     */
    OverrideCfsRules(req: OverrideCfsRulesRequest, cb?: (error: string, rep: OverrideCfsRulesResponse) => void): Promise<OverrideCfsRulesResponse>;
    /**
     * 本接口（SignUpCfsService）用于开通CFS服务。
     */
    SignUpCfsService(req?: SignUpCfsServiceRequest, cb?: (error: string, rep: SignUpCfsServiceResponse) => void): Promise<SignUpCfsServiceResponse>;
    /**
     * 用于删除迁移任务。不支持删除等待中、创建中、运行中、取消中、终止中状态的任务。
     */
    DeleteMigrationTask(req: DeleteMigrationTaskRequest, cb?: (error: string, rep: DeleteMigrationTaskResponse) => void): Promise<DeleteMigrationTaskResponse>;
    /**
     * 该接口用于对turbo 文件系统扩容使用,该接口只支持扩容不支持缩容。turbo标准型扩容步长是10240GIB，turbo性能型扩容步长是5120GIB
     */
    ScaleUpFileSystem(req: ScaleUpFileSystemRequest, cb?: (error: string, rep: ScaleUpFileSystemResponse) => void): Promise<ScaleUpFileSystemResponse>;
    /**
     * 本接口（UpdateCfsFileSystemSizeLimit）用于更新文件系统存储容量限制。
     */
    UpdateCfsFileSystemSizeLimit(req: UpdateCfsFileSystemSizeLimitRequest, cb?: (error: string, rep: UpdateCfsFileSystemSizeLimitResponse) => void): Promise<UpdateCfsFileSystemSizeLimitResponse>;
    /**
     * 创建文件存储生命周期策略
     */
    CreateLifecyclePolicy(req: CreateLifecyclePolicyRequest, cb?: (error: string, rep: CreateLifecyclePolicyResponse) => void): Promise<CreateLifecyclePolicyResponse>;
    /**
     * 用于添加新文件系统
     */
    CreateCfsFileSystem(req: CreateCfsFileSystemRequest, cb?: (error: string, rep: CreateCfsFileSystemResponse) => void): Promise<CreateCfsFileSystemResponse>;
    /**
     * 用于获取数据源桶列表。
     */
    DescribeBucketList(req: DescribeBucketListRequest, cb?: (error: string, rep: DescribeBucketListResponse) => void): Promise<DescribeBucketListResponse>;
    /**
     * 本接口（DescribeCfsPGroups）用于查询权限组列表。
     */
    DescribeCfsPGroups(req?: DescribeCfsPGroupsRequest, cb?: (error: string, rep: DescribeCfsPGroupsResponse) => void): Promise<DescribeCfsPGroupsResponse>;
    /**
     * 修改数据检索
     */
    ModifyDataRetrieval(req: ModifyDataRetrievalRequest, cb?: (error: string, rep: ModifyDataRetrievalResponse) => void): Promise<ModifyDataRetrievalResponse>;
    /**
     * 文件系统快照概览
     */
    DescribeCfsSnapshotOverview(req?: DescribeCfsSnapshotOverviewRequest, cb?: (error: string, rep: DescribeCfsSnapshotOverviewResponse) => void): Promise<DescribeCfsSnapshotOverviewResponse>;
    /**
     * 查询生命周期管理策略
     */
    DescribeLifecyclePolicies(req: DescribeLifecyclePoliciesRequest, cb?: (error: string, rep: DescribeLifecyclePoliciesResponse) => void): Promise<DescribeLifecyclePoliciesResponse>;
    /**
     * 查询文件系统配额（仅部分Turbo实例能使用，若需要调用请提交工单与我们联系）
     */
    DescribeUserQuota(req: DescribeUserQuotaRequest, cb?: (error: string, rep: DescribeUserQuotaResponse) => void): Promise<DescribeUserQuotaResponse>;
    /**
     * 配置生命周期策略关联到的目录列表
     */
    ApplyPathLifecyclePolicy(req: ApplyPathLifecyclePolicyRequest, cb?: (error: string, rep: ApplyPathLifecyclePolicyResponse) => void): Promise<ApplyPathLifecyclePolicyResponse>;
    /**
     * 指定条件删除文件系统配额（仅部分Turbo实例能使用，若需要调用请提交工单与我们联系）
     */
    DeleteUserQuota(req: DeleteUserQuotaRequest, cb?: (error: string, rep: DeleteUserQuotaResponse) => void): Promise<DeleteUserQuotaResponse>;
    /**
     * 修改数据流动相关参数
     */
    ModifyDataFlow(req: ModifyDataFlowRequest, cb?: (error: string, rep: ModifyDataFlowResponse) => void): Promise<ModifyDataFlowResponse>;
    /**
     * 本接口（UpdateCfsRule）用于更新权限规则。
     */
    UpdateCfsRule(req: UpdateCfsRuleRequest, cb?: (error: string, rep: UpdateCfsRuleResponse) => void): Promise<UpdateCfsRuleResponse>;
    /**
     * 本接口（DescribeCfsFileSystems）用于查询文件系统
     */
    DescribeCfsFileSystems(req: DescribeCfsFileSystemsRequest, cb?: (error: string, rep: DescribeCfsFileSystemsResponse) => void): Promise<DescribeCfsFileSystemsResponse>;
    /**
     * 用来设置文件系统扩容策略，该接口只支持turbo文件系统
     */
    ModifyFileSystemAutoScaleUpRule(req: ModifyFileSystemAutoScaleUpRuleRequest, cb?: (error: string, rep: ModifyFileSystemAutoScaleUpRuleResponse) => void): Promise<ModifyFileSystemAutoScaleUpRuleResponse>;
    /**
     * 查询文件系统快照列表
     */
    DescribeCfsSnapshots(req: DescribeCfsSnapshotsRequest, cb?: (error: string, rep: DescribeCfsSnapshotsResponse) => void): Promise<DescribeCfsSnapshotsResponse>;
    /**
     * 文件系统绑定快照策略，可以同时绑定多个fs，一个fs 只能跟一个策略绑定
     */
    BindAutoSnapshotPolicy(req: BindAutoSnapshotPolicyRequest, cb?: (error: string, rep: BindAutoSnapshotPolicyResponse) => void): Promise<BindAutoSnapshotPolicyResponse>;
    /**
     * 更新文件存储生命周期策略
     */
    ModifyLifecyclePolicy(req: ModifyLifecyclePolicyRequest, cb?: (error: string, rep: ModifyLifecyclePolicyResponse) => void): Promise<ModifyLifecyclePolicyResponse>;
    /**
     * 本接口（DeleteCfsRule）用于删除权限组规则。
     */
    DeleteCfsRule(req: DeleteCfsRuleRequest, cb?: (error: string, rep: DeleteCfsRuleResponse) => void): Promise<DeleteCfsRuleResponse>;
    /**
     * 删除数据流动
     */
    DeleteDataFlow(req: DeleteDataFlowRequest, cb?: (error: string, rep: DeleteDataFlowResponse) => void): Promise<DeleteDataFlowResponse>;
    /**
     * 用于创建迁移任务。
     */
    CreateMigrationTask(req: CreateMigrationTaskRequest, cb?: (error: string, rep: CreateMigrationTaskResponse) => void): Promise<CreateMigrationTaskResponse>;
    /**
     * 创建定期快照策略
     */
    CreateAutoSnapshotPolicy(req: CreateAutoSnapshotPolicyRequest, cb?: (error: string, rep: CreateAutoSnapshotPolicyResponse) => void): Promise<CreateAutoSnapshotPolicyResponse>;
    /**
     * 本接口（CreateCfsPGroup）用于创建权限组
     */
    CreateCfsPGroup(req: CreateCfsPGroupRequest, cb?: (error: string, rep: CreateCfsPGroupResponse) => void): Promise<CreateCfsPGroupResponse>;
    /**
     * 删除快照定期策略
     */
    DeleteAutoSnapshotPolicy(req: DeleteAutoSnapshotPolicyRequest, cb?: (error: string, rep: DeleteAutoSnapshotPolicyResponse) => void): Promise<DeleteAutoSnapshotPolicyResponse>;
    /**
     * 终止生命周期任务的接口
     */
    StopLifecycleDataTask(req: StopLifecycleDataTaskRequest, cb?: (error: string, rep: StopLifecycleDataTaskResponse) => void): Promise<StopLifecycleDataTaskResponse>;
    /**
     * 创建文件系统快照
     */
    CreateCfsSnapshot(req: CreateCfsSnapshotRequest, cb?: (error: string, rep: CreateCfsSnapshotResponse) => void): Promise<CreateCfsSnapshotResponse>;
    /**
     * 更新定期自动快照策略
     */
    UpdateAutoSnapshotPolicy(req: UpdateAutoSnapshotPolicyRequest, cb?: (error: string, rep: UpdateAutoSnapshotPolicyResponse) => void): Promise<UpdateAutoSnapshotPolicyResponse>;
    /**
     * RunDataRetrievalTask 执行数据检索任务。
手动触发指定数据检索的执行，创建一个新的数据检索任务。单个文件系统同时执行的任务数不超过 20 个。
仅Turbo系列文件系统支持。
     */
    RunDataRetrievalTask(req: RunDataRetrievalTaskRequest, cb?: (error: string, rep: RunDataRetrievalTaskResponse) => void): Promise<RunDataRetrievalTaskResponse>;
    /**
     * 查询数据检索任务
     */
    DescribeDataRetrievalTask(req: DescribeDataRetrievalTaskRequest, cb?: (error: string, rep: DescribeDataRetrievalTaskResponse) => void): Promise<DescribeDataRetrievalTaskResponse>;
    /**
     * 查询快照操作日志
     */
    DescribeSnapshotOperationLogs(req: DescribeSnapshotOperationLogsRequest, cb?: (error: string, rep: DescribeSnapshotOperationLogsResponse) => void): Promise<DescribeSnapshotOperationLogsResponse>;
    /**
     * 本接口（UpdateCfsFileSystemName）用于更新文件系统名
     */
    UpdateCfsFileSystemName(req: UpdateCfsFileSystemNameRequest, cb?: (error: string, rep: UpdateCfsFileSystemNameResponse) => void): Promise<UpdateCfsFileSystemNameResponse>;
    /**
     * 查询数据流动信息接口
     */
    DescribeDataFlow(req: DescribeDataFlowRequest, cb?: (error: string, rep: DescribeDataFlowResponse) => void): Promise<DescribeDataFlowResponse>;
    /**
     * 本接口（CreateCfsRule）用于创建权限组规则。
     */
    CreateCfsRule(req: CreateCfsRuleRequest, cb?: (error: string, rep: CreateCfsRuleResponse) => void): Promise<CreateCfsRuleResponse>;
    /**
     * 创建用于访问文件系统的凭证
     */
    CreateAccessCert(req: CreateAccessCertRequest, cb?: (error: string, rep: CreateAccessCertResponse) => void): Promise<CreateAccessCertResponse>;
    /**
     * 本接口（UpdateCfsPGroup）更新权限组信息。
     */
    UpdateCfsPGroup(req: UpdateCfsPGroupRequest, cb?: (error: string, rep: UpdateCfsPGroupResponse) => void): Promise<UpdateCfsPGroupResponse>;
}