{
  "name": "goosefs",
  "display_name": "数据加速器 GooseFS",
  "description": "介绍如何使用API创建、删除、查询、管理数据加速器GooseFS，为GooseFS服务分发配置，管理存储在GooseFS服务中的文件等。",
  "domain": "other",
  "api_version": "2022-05-19",
  "endpoint": "goosefs.tencentcloudapi.com",
  "actions": [
    {
      "name": "AddCrossVpcSubnetSupportForClientNode",
      "description": "为客户端节点添加跨vpc或子网访问能力",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x-c60-a1b2c3d4"
        },
        {
          "name": "SubnetInfo",
          "type": "object",
          "required": true,
          "description": "子网信息",
          "example": "null",
          "children": [
            {
              "name": "VpcId",
              "type": "string",
              "required": true,
              "description": "vpc id",
              "example": "vpc-a1b2c3d4"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "子网ID",
              "example": "subnet-a1b2c3d4"
            },
            {
              "name": "UsedCluster",
              "type": "string",
              "required": false,
              "description": "应用的集群；可以是集群id,也可以是All",
              "example": "All"
            },
            {
              "name": "CIDR",
              "type": "string",
              "required": false,
              "description": "cidr，只有当IsDirectConnect为true时才生效",
              "example": "172.21.160.0/20"
            },
            {
              "name": "IsDirectConnect",
              "type": "boolean",
              "required": false,
              "description": "是否为专线接入场景",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "FileSystemId",
        "SubnetInfo"
      ]
    },
    {
      "name": "AttachFileSystemBucket",
      "description": "为文件系统关联Bucket",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "无",
          "example": "x_c60_r3c4fa1f"
        },
        {
          "name": "Bucket",
          "type": "object",
          "required": true,
          "description": "关联新Bucket",
          "example": "无",
          "children": [
            {
              "name": "BucketName",
              "type": "string",
              "required": true,
              "description": "对象存储Bucket名",
              "example": "mybucket-1250000"
            },
            {
              "name": "FileSystemPath",
              "type": "string",
              "required": true,
              "description": "映射到的文件系统路径, 默认为/",
              "example": "/goosefs_data"
            },
            {
              "name": "DataRepositoryTaskAutoStrategy",
              "type": "array",
              "required": false,
              "description": "数据流动的自动策略, 包含加载与沉降。策略可以是多种的组合 按需加载(OnDemandImport) 自动加载元数据(AutoImportMeta) 自动加载数据(AutoImportData) 周期加载(PeriodImport) 周期沉降(PeriodExport) 立即沉降(ImmediateExport)",
              "example": "[\"AutoImportData\",\"AutoImportMeta\"]",
              "item_type": "string"
            },
            {
              "name": "RuleId",
              "type": "string",
              "required": false,
              "description": "绑定bucket的数据流动策略ID",
              "example": "x-rule-1"
            },
            {
              "name": "RuleDescription",
              "type": "string",
              "required": false,
              "description": "规则备注与描述",
              "example": "this rule is for picture bucket"
            },
            {
              "name": "Status",
              "type": "integer",
              "required": false,
              "description": "桶关联状态 0：关联中 1：关联完成",
              "example": "0"
            },
            {
              "name": "AccelerateFlag",
              "type": "boolean",
              "required": false,
              "description": "是否使用全球加速域名",
              "example": "false"
            },
            {
              "name": "BucketRegion",
              "type": "string",
              "required": false,
              "description": "桶所在的园区",
              "example": "ap-shanghai"
            },
            {
              "name": "Endpoint",
              "type": "string",
              "required": false,
              "description": "自定义Endpoint",
              "example": "172.0.1.16"
            }
          ]
        }
      ],
      "required": [
        "FileSystemId",
        "Bucket"
      ]
    },
    {
      "name": "BatchAddClientNodes",
      "description": "批量添加客户端节点",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x-c60-80k2ly5b"
        },
        {
          "name": "ClientNodes",
          "type": "array",
          "required": true,
          "description": "添加客户端节点列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "InstanceId",
              "type": "string",
              "required": false,
              "description": "cvmId",
              "example": "ins-m1r9uwdp"
            },
            {
              "name": "VpcId",
              "type": "string",
              "required": false,
              "description": "节点所属vpcid",
              "example": "vpc-5ke3uoww"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "节点所属子网id",
              "example": "subnet-ihijdp5h"
            },
            {
              "name": "LinuxClientNodeIp",
              "type": "string",
              "required": false,
              "description": "linux客户端节点地址",
              "example": "10.0.1.2"
            },
            {
              "name": "MountPoint",
              "type": "string",
              "required": false,
              "description": "自定义挂载点",
              "example": "/test"
            }
          ]
        },
        {
          "name": "SingleClusterFlag",
          "type": "boolean",
          "required": false,
          "description": "是否单集群默认是false",
          "example": "false"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "客户端集群id",
          "example": "x-c60-80k2ly5b-1"
        }
      ],
      "required": [
        "FileSystemId",
        "ClientNodes"
      ]
    },
    {
      "name": "BatchDeleteClientNodes",
      "description": "批量删除客户端节点",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-80k2ly5b"
        },
        {
          "name": "ClientNodes",
          "type": "array",
          "required": true,
          "description": "删除的客户端节点列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "InstanceId",
              "type": "string",
              "required": false,
              "description": "cvmId",
              "example": "ins-m1r9uwdp"
            },
            {
              "name": "VpcId",
              "type": "string",
              "required": false,
              "description": "节点所属vpcid",
              "example": "vpc-5ke3uoww"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "节点所属子网id",
              "example": "subnet-ihijdp5h"
            },
            {
              "name": "LinuxClientNodeIp",
              "type": "string",
              "required": false,
              "description": "linux客户端节点地址",
              "example": "10.0.1.2"
            },
            {
              "name": "MountPoint",
              "type": "string",
              "required": false,
              "description": "自定义挂载点",
              "example": "/test"
            }
          ]
        },
        {
          "name": "SingleClusterFlag",
          "type": "boolean",
          "required": false,
          "description": "是否单集群，默认是false",
          "example": "false"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "客户端集群id",
          "example": "x-c60-80k2ly5b-1"
        }
      ],
      "required": [
        "FileSystemId",
        "ClientNodes"
      ]
    },
    {
      "name": "BuildClientNodeMountCommand",
      "description": "生成客户端的挂载命令",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x-c60-80k2ly5b"
        },
        {
          "name": "CustomMountDir",
          "type": "string",
          "required": false,
          "description": "自定义挂载目录的绝对路径, 如果未指定, 则会使用默认值, 格式/goosefsx/${fs_id}-proxy. 比如/goosefsx/x-c60-a2b3d4-proxy",
          "example": "/Goosefsx"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "客户端集群ID",
          "example": "x-c60-80k2ly5b-1"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "BuildCustomerCluster",
      "description": "构建客户端集群",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": false,
          "description": "文件系统id",
          "example": "x-c60-1f2yq7b5"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": false,
          "description": "vpc网络ID",
          "example": "vpc-5owubpl0"
        },
        {
          "name": "SubnetId",
          "type": "string",
          "required": false,
          "description": "子网id",
          "example": "vpc-5owubpl0"
        },
        {
          "name": "ClusterName",
          "type": "string",
          "required": false,
          "description": "集群名称",
          "example": "CustomerCluster-2"
        }
      ],
      "required": []
    },
    {
      "name": "CancelLoadTask",
      "description": "取消单个预热任务，仅任务在 waiting、running 状态时可以调用此接口。注意，该接口需要 GooseFS 集群版本 ≥ 1.5.1。",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群 ID",
          "example": "g_cvm_**g97c61"
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "预热任务 ID",
          "example": "00453915-1c85-4e3c-8e14-237416beb76b"
        }
      ],
      "required": [
        "ClusterId",
        "TaskId"
      ]
    },
    {
      "name": "CreateDataRepositoryTask",
      "description": "创建数据流通任务,包括从将文件系统的数据上传到存储桶下, 以及从存储桶下载到文件系统里。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskType",
          "type": "string",
          "required": true,
          "description": "数据流通任务类型, FS_TO_COS(文件系统到COS Bucket),或者COS_TO_FS(COS Bucket到文件系统)",
          "example": "FS_TO_BUCKET"
        },
        {
          "name": "Bucket",
          "type": "string",
          "required": true,
          "description": "COS存储桶名",
          "example": "mybucket-1250000"
        },
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        },
        {
          "name": "TaskPath",
          "type": "string",
          "required": true,
          "description": "对于FS_TO_COS, TaskPath是Bucket映射目录的相对路径, 对于COS_TO_FS是COS上的路径。如果置为空, 则表示全部数据",
          "example": "aaa/bbb"
        },
        {
          "name": "TaskName",
          "type": "string",
          "required": true,
          "description": "任务名称",
          "example": "DOWNLOAD"
        },
        {
          "name": "RepositoryType",
          "type": "string",
          "required": false,
          "description": "数据流通方式 MSP_AFM 手动加载 RAW_AFM 按需加载",
          "example": "MSP_AFM"
        },
        {
          "name": "TextLocation",
          "type": "string",
          "required": false,
          "description": "文件列表下载地址，以http开头",
          "example": "https://location.com/list.txt"
        },
        {
          "name": "EnableDataFlowSubPath",
          "type": "boolean",
          "required": false,
          "description": "是否开启自定义路径(暂时仅供预热使用)",
          "example": "false"
        },
        {
          "name": "DataFlowSubPath",
          "type": "string",
          "required": false,
          "description": "自定义路径(暂时仅供预热使用)",
          "example": "dst/"
        }
      ],
      "required": [
        "TaskType",
        "Bucket",
        "FileSystemId",
        "TaskPath",
        "TaskName"
      ]
    },
    {
      "name": "CreateFileSystem",
      "description": "创建文件系统",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "文件系统名",
          "example": "ai_fs"
        },
        {
          "name": "Description",
          "type": "string",
          "required": true,
          "description": "文件系统备注描述",
          "example": "our test fs"
        },
        {
          "name": "VpcId",
          "type": "string",
          "required": true,
          "description": "vpc网络ID",
          "example": "vpc-a1b2c3d4"
        },
        {
          "name": "SubnetId",
          "type": "string",
          "required": true,
          "description": "子网ID",
          "example": "subnet-m1n1g1h1"
        },
        {
          "name": "Zone",
          "type": "string",
          "required": true,
          "description": "子网所在的可用区",
          "example": "ap-guangzhou-3"
        },
        {
          "name": "Tag",
          "type": "array",
          "required": false,
          "description": "文件系统关联的tag",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "标签键",
              "example": "usage"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "标签值",
              "example": "production"
            }
          ]
        },
        {
          "name": "GooseFSxBuildElements",
          "type": "object",
          "required": false,
          "description": "GooseFSx构建时要传递的参数",
          "example": "无",
          "children": [
            {
              "name": "Model",
              "type": "string",
              "required": true,
              "description": "GooseFSx的型号",
              "example": "C60"
            },
            {
              "name": "Capacity",
              "type": "integer",
              "required": true,
              "description": "容量单位是GB, 例如4608(4.5TB)",
              "example": "4608"
            }
          ]
        },
        {
          "name": "SecurityGroupId",
          "type": "string",
          "required": false,
          "description": "客户端集群所属的安全组",
          "example": "sg-k3j3utox"
        },
        {
          "name": "ClusterPort",
          "type": "integer",
          "required": false,
          "description": "集群ssh通信端口，默认是22",
          "example": "22"
        }
      ],
      "required": [
        "Name",
        "Description",
        "VpcId",
        "SubnetId",
        "Zone"
      ]
    },
    {
      "name": "CreateFileset",
      "description": "创建Fileset",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-683u5pct"
        },
        {
          "name": "FsetName",
          "type": "string",
          "required": true,
          "description": "Fileset名称",
          "example": "fset_001"
        },
        {
          "name": "FsetDir",
          "type": "string",
          "required": true,
          "description": "Fileset目录",
          "example": "/myfset/fset_001/"
        },
        {
          "name": "QuotaSizeLimit",
          "type": "string",
          "required": false,
          "description": "Fileset容量配额（需带单位G）",
          "example": "100G"
        },
        {
          "name": "QuotaFilesLimit",
          "type": "string",
          "required": false,
          "description": "Fileset文件数配额",
          "example": "1000000"
        },
        {
          "name": "AuditState",
          "type": "string",
          "required": false,
          "description": "Fileset文件删除操作审计",
          "example": "enable/disable"
        }
      ],
      "required": [
        "FileSystemId",
        "FsetName",
        "FsetDir"
      ]
    },
    {
      "name": "CreateLoadTask",
      "description": "GooseFS 预热相关接口，用于下发，列出，查询，修改预热任务。用于元数据预热、数据预热场景。 注意，该接口需要 GooseFS 集群版本 ≥ 1.5.1。",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群 ID",
          "example": "g_cvm_********"
        },
        {
          "name": "LoadTaskCreationAttrs",
          "type": "object",
          "required": true,
          "description": "创建预热任务参数",
          "example": "无",
          "children": [
            {
              "name": "TaskType",
              "type": "string",
              "required": true,
              "description": "预热任务类型，枚举值，MetadataLoad｜DistributedLoad。",
              "example": "DistributedLoad"
            },
            {
              "name": "Priority",
              "type": "integer",
              "required": false,
              "description": "任务优先级，数值越高代表优先级越高，边界值 1-9999，默认值为 1",
              "example": "666"
            },
            {
              "name": "Description",
              "type": "string",
              "required": false,
              "description": "任务描述，支持中文",
              "example": "hello"
            },
            {
              "name": "MetadataLoadAttrs",
              "type": "object",
              "required": false,
              "description": "元数据预热任务参数，用于仅预热元数据时入参。入参数TaskType为MetadataLoad时，该参数不应为空。",
              "example": "无",
              "children": [
                {
                  "name": "LoadType",
                  "type": "string",
                  "required": true,
                  "description": "预热类型，枚举值 LoadByPath｜LoadByList",
                  "example": "LoadByList"
                },
                {
                  "name": "SkipIfExists",
                  "type": "boolean",
                  "required": false,
                  "description": "是否跳过相同文件，默认为 true",
                  "example": "true"
                },
                {
                  "name": "LoadByPath",
                  "type": "string",
                  "required": false,
                  "description": "预热路径，入参单条挂载路径，长度不能超过255个字符。入参数LoadType为LoadByPath，该参数不应为空",
                  "example": "/goosefs_path/"
                },
                {
                  "name": "LoadByList",
                  "type": "string",
                  "required": false,
                  "description": "通过文件列表批量预热，入参为 cos://bucket-appid/ 开头的 COS 路径，且仅支持 txt 格式文件，长度不能超过255个字符。入参数LoadType为LoadByList，该参数不应为空",
                  "example": "cos://goosefs-beijing-**********/api_test/temp/test_metadata_args_loadbylist_is_file_csv/*************"
                }
              ]
            },
            {
              "name": "DistributedLoadAttrs",
              "type": "object",
              "required": false,
              "description": "数据预热任务参数。入参数TaskType为DistributedLoad时，该参数不应为空。",
              "example": "无",
              "children": [
                {
                  "name": "LoadType",
                  "type": "string",
                  "required": true,
                  "description": "预热类型，枚举值 LoadByPath｜LoadByList",
                  "example": "LoadByList"
                },
                {
                  "name": "SkipIfExists",
                  "type": "boolean",
                  "required": false,
                  "description": "是否跳过相同文件，默认为 true",
                  "example": "true"
                },
                {
                  "name": "LoadByPath",
                  "type": "string",
                  "required": false,
                  "description": "预热路径，入参单条挂载路径。入参数LoadType为LoadByPath，该参数不应为空",
                  "example": "/goosefs_path/"
                },
                {
                  "name": "LoadByList",
                  "type": "string",
                  "required": false,
                  "description": "通过文件列表批量预热，入参为 cos://bucket-appid/ 开头的 COS 路径，且仅支持 txt 格式文件，长度不能超过255个字符。入参数LoadType为LoadByList，该参数不应为空",
                  "example": "cos://goosefs-beijing-**********/api_test/temp/test_distributedload_args_loadbylist_is_file_txt/load_list.txt"
                },
                {
                  "name": "Replica",
                  "type": "string",
                  "required": false,
                  "description": "副本数配置，枚举值，可选值 SingleReplica（单副本，默认）｜MaxReplica（最大副本）",
                  "example": "SingleReplica"
                },
                {
                  "name": "MetadataSync",
                  "type": "boolean",
                  "required": false,
                  "description": "同步执行元数据预热，并基于预热后的元数据执行 DistributedLoad。默认为 false",
                  "example": "true"
                }
              ]
            },
            {
              "name": "ReportPath",
              "type": "string",
              "required": false,
              "description": "将任务执行报告写入 COS 的路径，如果不需要报告则入参空",
              "example": "cos://**********-nj-**********/test.txt"
            }
          ]
        }
      ],
      "required": [
        "ClusterId",
        "LoadTaskCreationAttrs"
      ]
    },
    {
      "name": "DeleteCrossVpcSubnetSupportForClientNode",
      "description": "为客户端节点删除跨vpc子网访问能力",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x-c60-a1b2c3d4"
        },
        {
          "name": "SubnetInfo",
          "type": "object",
          "required": true,
          "description": "子网信息",
          "example": "无",
          "children": [
            {
              "name": "VpcId",
              "type": "string",
              "required": true,
              "description": "vpc id",
              "example": "vpc-a1b2c3d4"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "子网ID",
              "example": "subnet-a1b2c3d4"
            },
            {
              "name": "UsedCluster",
              "type": "string",
              "required": false,
              "description": "应用的集群；可以是集群id,也可以是All",
              "example": "All"
            },
            {
              "name": "CIDR",
              "type": "string",
              "required": false,
              "description": "cidr，只有当IsDirectConnect为true时才生效",
              "example": "172.21.160.0/20"
            },
            {
              "name": "IsDirectConnect",
              "type": "boolean",
              "required": false,
              "description": "是否为专线接入场景",
              "example": "false"
            }
          ]
        }
      ],
      "required": [
        "FileSystemId",
        "SubnetInfo"
      ]
    },
    {
      "name": "DeleteCustomerCluster",
      "description": "删除客户端集群",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": false,
          "description": "文件系统id",
          "example": "x-c60-w953d0pt"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "客户端集群ID",
          "example": "x-c60-w953d0pt-1"
        }
      ],
      "required": []
    },
    {
      "name": "DeleteFileSystem",
      "description": "删除文件系统",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "DeleteFileset",
      "description": "删除Fileset",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-683u5pct"
        },
        {
          "name": "FsetId",
          "type": "string",
          "required": true,
          "description": "Fileset id",
          "example": "fset_123000"
        }
      ],
      "required": [
        "FileSystemId",
        "FsetId"
      ]
    },
    {
      "name": "DescribeClientNodes",
      "description": "列出集群中所有的客户端节点",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统Id",
          "example": "x_c60_r3c4fa1f"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "DescribeClusterClientToken",
      "description": "查询GooseFS集群客户端凭证",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "g_cvm_h8kz3o02"
        }
      ],
      "required": [
        "ClusterId"
      ]
    },
    {
      "name": "DescribeClusterRoleToken",
      "description": "查询GooseFS集群角色凭证",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "g_cvm_x419f8qc"
        },
        {
          "name": "RoleName",
          "type": "string",
          "required": true,
          "description": "角色名",
          "example": "test"
        }
      ],
      "required": [
        "ClusterId",
        "RoleName"
      ]
    },
    {
      "name": "DescribeCustomerCluster",
      "description": "查询客户端集群",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": false,
          "description": "文件系统id",
          "example": "x-c60-412s8jlp"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeDataRepositoryTaskStatus",
      "description": "获取数据流通任务实时状态，用作客户端控制",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "task id",
          "example": "x_task_r3c4fa1f"
        },
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "file system id",
          "example": "x_c60_r3c4fa1f"
        }
      ],
      "required": [
        "TaskId",
        "FileSystemId"
      ]
    },
    {
      "name": "DescribeFileSystemBuckets",
      "description": "罗列文件系统关联的Bucket映射",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "DescribeFileSystems",
      "description": "列出所有的文件系统",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "每页的数量",
          "example": "20"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeFilesetGeneralConfig",
      "description": "查询Fileset通用配置",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-683u5pct"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "DescribeFilesets",
      "description": "查询Fileset列表",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-683u5pct"
        },
        {
          "name": "FilesetIds",
          "type": "array",
          "required": false,
          "description": "FsetId列表",
          "example": "fset_1743578359192",
          "item_type": "string"
        },
        {
          "name": "FilesetDirs",
          "type": "array",
          "required": false,
          "description": "FsetDir列表",
          "example": "/fset_test_001/",
          "item_type": "string"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "DescribeLoadTask",
      "description": "查询单个预热任务执行情况。注意，该接口需要 GooseFS 集群版本 ≥ 1.5.1。",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群 ID",
          "example": "g_cvm_7kg3li69"
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "预热任务 ID",
          "example": "7f22ba8e-ca92-40e4-a277-18461e481808"
        }
      ],
      "required": [
        "ClusterId",
        "TaskId"
      ]
    },
    {
      "name": "DetachFileSystemBucket",
      "description": "解绑文件系统与Bucket的映射",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        },
        {
          "name": "BucketName",
          "type": "string",
          "required": true,
          "description": "要解绑的Bucket名",
          "example": "mybucket-1250000"
        }
      ],
      "required": [
        "FileSystemId",
        "BucketName"
      ]
    },
    {
      "name": "ExpandCapacity",
      "description": "扩展文件系统容量",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        },
        {
          "name": "ExpandedCapacity",
          "type": "integer",
          "required": true,
          "description": "新增扩容的系统容量",
          "example": "4680"
        },
        {
          "name": "ModifyType",
          "type": "string",
          "required": false,
          "description": "容量修改类型：add/sub",
          "example": "add"
        }
      ],
      "required": [
        "FileSystemId",
        "ExpandedCapacity"
      ]
    },
    {
      "name": "ListLoadTasks",
      "description": "列出该集群下所有预热任务。注意，该接口需要 GooseFS 集群版本 ≥ 1.5.1。",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群 ID",
          "example": "g_cvm_hlg97c61"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "偏移量",
          "example": "1"
        },
        {
          "name": "StartTimestamp",
          "type": "integer",
          "required": false,
          "description": "任务创建起始时间戳，默认为3天前：当前时间戳-86400*3",
          "example": "1767859318"
        },
        {
          "name": "EndTimestamp",
          "type": "integer",
          "required": false,
          "description": "任务变更时间戳",
          "example": "1767859328"
        },
        {
          "name": "State",
          "type": "string",
          "required": false,
          "description": "筛选任务状态，枚举Waiting,Running,Canceled,Completed。默认返回所有任务",
          "example": "Completed"
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": false,
          "description": "筛选优先级任务，默认返回所有任务",
          "example": "1"
        }
      ],
      "required": [
        "ClusterId",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "ModifyDataRepositoryBandwidth",
      "description": "修改数据流动带宽",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        },
        {
          "name": "Bandwidth",
          "type": "integer",
          "required": true,
          "description": "带宽, 单位MB/S",
          "example": "600"
        }
      ],
      "required": [
        "FileSystemId",
        "Bandwidth"
      ]
    },
    {
      "name": "MountMultipleStorageFileSystem",
      "description": "客户端集群挂载存储集群",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": false,
          "description": "客户端集群所属的文件系统id",
          "example": "x-c60-a112q1lj"
        },
        {
          "name": "CustomerClusterId",
          "type": "string",
          "required": false,
          "description": "客户端集群Id",
          "example": "x-c60-a112q1lj-client-cluster-1"
        },
        {
          "name": "StorageFileSystemId",
          "type": "string",
          "required": false,
          "description": "挂载的存储集群的id",
          "example": "x-c60-mrn3a677"
        }
      ],
      "required": []
    },
    {
      "name": "QueryClientNodeMountCommand",
      "description": "生成客户端的挂载命令",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "客户端集群ID",
          "example": "x-c60-a112q1lj-client-cluster-default"
        },
        {
          "name": "ClusterMountInfo",
          "type": "array",
          "required": false,
          "description": "集群挂载信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "StorageFileSystemId",
              "type": "string",
              "required": false,
              "description": "挂载的文件系统Id",
              "example": "x-c60-who39x58"
            },
            {
              "name": "MountPoint",
              "type": "string",
              "required": false,
              "description": "客户端集群挂载点。入参是节点的自定义挂载点，出参是集群的默认挂载点 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "/mountDir"
            }
          ]
        },
        {
          "name": "FileSystemId",
          "type": "string",
          "required": false,
          "description": "文件系统id",
          "example": "x-c60-a112q1lj"
        }
      ],
      "required": []
    },
    {
      "name": "QueryCrossVpcSubnetSupportForClientNode",
      "description": "查询客户端节点跨vpc子网访问能力",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x-c60-a1b2c3d4"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "QueryDataRepositoryBandwidth",
      "description": "查询数据流动带宽",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统ID",
          "example": "x_c60_r3c4fa1f"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "UpdateFileset",
      "description": "修改FIleset",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-683u5pct"
        },
        {
          "name": "FsetId",
          "type": "string",
          "required": true,
          "description": "Fileset id",
          "example": "fset_123000"
        },
        {
          "name": "QuotaSizeLimit",
          "type": "string",
          "required": false,
          "description": "容量配额限定值",
          "example": "100G"
        },
        {
          "name": "QuotaFilesLimit",
          "type": "string",
          "required": false,
          "description": "文件数配额限定值",
          "example": "1000000"
        },
        {
          "name": "AuditState",
          "type": "string",
          "required": false,
          "description": "Fileset文件删除操作审计",
          "example": "enable/disable"
        }
      ],
      "required": [
        "FileSystemId",
        "FsetId"
      ]
    },
    {
      "name": "UpdateFilesetGeneralConfig",
      "description": "修改Fileset通用配置",
      "status": "online",
      "parameters": [
        {
          "name": "FileSystemId",
          "type": "string",
          "required": true,
          "description": "文件系统id",
          "example": "x-c60-683u5pct"
        },
        {
          "name": "EnforceQuotaOnRoot",
          "type": "string",
          "required": false,
          "description": "配额对root用户生效",
          "example": "yes/no"
        }
      ],
      "required": [
        "FileSystemId"
      ]
    },
    {
      "name": "UpdateLoadTaskPriority",
      "description": "变更已有 GooseFS 预热任务配置，仅任务状态为 waiting 时可调用该接口。注意，该接口需要 GooseFS 集群版本 ≥ 1.5.1。",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群 ID",
          "example": "g_cvm_36brs5g2"
        },
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "预热任务 ID",
          "example": "2c4a3356-28d5-4f87-98c3-78745b5d6bbf"
        },
        {
          "name": "Priority",
          "type": "integer",
          "required": true,
          "description": "任务优先级，数值越高代表优先级越高，边界值 1-9999，默认值为 1",
          "example": "666"
        }
      ],
      "required": [
        "ClusterId",
        "TaskId",
        "Priority"
      ]
    }
  ]
}