ChargeAttribute
付费信息详情
被如下接口引用：DescribeFileSystems。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CurDeadline | String | 否 | 到期时间 示例值：2024-01-01 00:00:00 |
| PayMode | String | 否 | 付费方式 示例值：prePay |
| AutoRenewFlag | Integer | 否 | 自动付费标识：0:默认未设置 1:自动续费 2 不自动续费 示例值：0 |
| ResourceId | String | 否 | 资源ID 示例值：100026787145_sp_cdls_goosefs_1716879810 |
ClientClusterManagerNodeInfo
客户侧集群管理节点信息
被如下接口引用：DescribeFileSystems。
| 名称 | 类型 | 描述 |
|---|---|---|
| NodeIp | String | 客户端节点IP 示例值：10.0.1.2 |
| NodeInstanceId | String | 节点Instance Id 示例值：ins-a1b2c3d4 |
| InitialPassword | String | 初始密码 示例值：* |
| ClusterId | String | 所属集群id 示例值：x-c60-rz400po1-client-cluster-1 |
ClientNodeAttribute
客户端节点属性
被如下接口引用：DescribeClientNodes。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientNodeIp | String | 客户端节点IP 示例值：10.0.1.2 |
| Status | String | 客户端节点服务状态, Active(运行中), Adding(添加中), Destroying(销毁中), Down(已停止) 示例值：active |
| ClientType | String | 客户端节点类型，extend(扩展节点)，manager(管理节点) 示例值：extend |
| VpcId | String | 节点所属vpcid 示例值：vpc-5ke3uoww |
| SubnetId | String | 节点所属子网id 示例值：subnet-ihijdp5h |
| InstanceId | String | cvmId 示例值：ins-m1r9uwdp |
| MountPoint | String | 自定义挂载点 示例值：/test |
ClientToken
查询Client Token
被如下接口引用：DescribeClusterClientToken。
| 名称 | 类型 | 描述 |
|---|---|---|
| NodeIp | String | 节点 IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.2.3.4 |
| LocalDirectory | String | 挂载点 注意：此字段可能返回 null，表示取不到有效值。 示例值：/goosefs |
| GooseFSDirectory | String | 可以访问的 GooseFS 目录 注意：此字段可能返回 null，表示取不到有效值。 示例值：/goosefs |
| Token | String | token 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx-yyy |
DistributedLoadAttrs
数据预热任务参数
被如下接口引用：CreateLoadTask, DescribeLoadTask, ListLoadTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LoadType | String | 是 | 预热类型，枚举值 LoadByPath｜LoadByList 示例值：LoadByList |
| SkipIfExists | Boolean | 否 | 是否跳过相同文件，默认为 true 示例值：true |
| LoadByPath | String | 否 | 预热路径，入参单条挂载路径。入参数LoadType为LoadByPath，该参数不应为空 示例值：/goosefs_path/ |
| LoadByList | String | 否 | 通过文件列表批量预热，入参为 cos://bucket-appid/ 开头的 COS 路径，且仅支持 txt 格式文件，长度不能超过255个字符。入参数LoadType为LoadByList，该参数不应为空 示例值：cos://goosefs-beijing-**/api_test/temp/test_distributedload_args_loadbylist_is_file_txt/load_list.txt |
| Replica | String | 否 | 副本数配置，枚举值，可选值 SingleReplica（单副本，默认）｜MaxReplica（最大副本） 示例值：SingleReplica |
| MetadataSync | Boolean | 否 | 同步执行元数据预热，并基于预热后的元数据执行 DistributedLoad。默认为 false 示例值：true |
FSAttribute
文件系统属性
被如下接口引用：DescribeFileSystems。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 文件系统类型, 可填goosefs和goosefsx 示例值：goosefsx |
| FileSystemId | String | 文件系统ID 示例值：x_c60_r3c4fa1f |
| CreateTime | Timestamp ISO8601 | 创建时间 示例值：2022-01-01T12:00:00+08:00 |
| GooseFSxAttribute | GooseFSxAttribute | GooseFSx文件系统属性 |
| Status | String | 文件系统状态 ACTIVE(运行中), CREATING(创建中), DESTROYING(销毁中), FAIL(创建失败),EXPANDING(扩容中),PROBING(容灾中) 示例值：Active |
| Name | String | 文件系统名 示例值：ai_fs |
| Description | String | 文件系统备注描述 示例值：our test fs |
| VpcId | String | vpc ID 示例值：vpc-a1b2c3d4 |
| SubnetId | String | 子网ID 示例值：subnet-m1n1g1h1 |
| Zone | String | 子网所在的可用区 示例值：ap-guangzhou-3 |
| Tag | Array of Tag | Tag数组 |
| ModifyTime | Timestamp ISO8601 | 更新属性时间 示例值：2022-01-01T12:00:00+08:00 |
| ChargeAttribute | ChargeAttribute | 文件系统付费信息 |
FilesetInfo
Fileset信息
被如下接口引用：DescribeFilesets。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FsetId | String | 否 | Fileset id 示例值：fset_123000 |
| FsetName | String | 否 | Fileset名称 示例值：myfset |
| FsetDir | String | 否 | Fileset目录 示例值：myfset/fset_001 |
| QuotaSizeLimit | String | 否 | Fileset容量配额限定值 示例值：100G |
| QuotaSizeUsed | String | 否 | 已使用容量配额 示例值：1024K |
| QuotaSizeUsedPercent | String | 否 | 容量配额使用占比 示例值：10% |
| QuotaFilesLimit | String | 否 | Fileset文件数配额限定值 示例值：1000000 |
| QuotaFilesUsed | String | 否 | 已使用文件数配额 示例值：1000 |
| QuotaFilesUsedPercent | String | 否 | 文件数配额使用占比 示例值：5% |
| AuditState | String | 否 | Fileset审计 示例值：enable/disable |
| CreateTime | Timestamp ISO8601 | 否 | 创建时间 示例值：2025-04-08T19:38:54+08:00 |
| ModifyTime | Timestamp ISO8601 | 否 | 修改时间 示例值：2025-04-29T15:20:23+08:00 |
| Status | String | 否 | Fileset状态：creating 配置中 active 已生效 modify 修改中 示例值：active |
GooseFSxAttribute
GooseFSx文件系统的属性
被如下接口引用：DescribeFileSystems。
| 名称 | 类型 | 描述 |
|---|---|---|
| Model | String | GooseFSx的型号 示例值：C60 |
| Capacity | Integer | 容量单位是GB, 例如4608(4.5TB) 示例值：4608 |
| MappedBucketList | Array of MappedBucket | 要关联映射的bucket列表 |
| ClientManagerNodeList | Array of ClientClusterManagerNodeInfo | 客户侧管理节点信息 |
GooseFSxBuildElement
GooseFSx创建时候的属性
被如下接口引用：CreateFileSystem。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Model | String | 是 | GooseFSx的型号 示例值：C60 |
| Capacity | Integer | 是 | 容量单位是GB, 例如4608(4.5TB) 示例值：4608 |
LinuxNodeAttribute
添加删除客户端节点列表
被如下接口引用：BatchAddClientNodes, BatchDeleteClientNodes。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InstanceId | String | 否 | cvmId 示例值：ins-m1r9uwdp |
| VpcId | String | 否 | 节点所属vpcid 示例值：vpc-5ke3uoww |
| SubnetId | String | 否 | 节点所属子网id 示例值：subnet-ihijdp5h |
| LinuxClientNodeIp | String | 否 | linux客户端节点地址 示例值：10.0.1.2 |
| MountPoint | String | 否 | 自定义挂载点 示例值：/test |
LoadTaskAttrs
预热任务参数
被如下接口引用：DescribeLoadTask, ListLoadTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 预热任务 ID 示例值：dd4bf5c2-24dd-45ea-b4c7-01539edd0227 |
| TaskType | String | 预热任务类型，枚举值，MetadataLoad｜DistributedLoad 示例值：DistributedLoad |
| Description | String | 任务描述，支持中文 示例值：priority为0（小于最小值）测试 |
| Priority | Integer | 任务优先级，数值越高代表优先级越高，边界值 1-9999，默认值为 1 示例值：666 |
| MetadataLoadAttrs | MetadataLoadAttrs | 元数据预热任务参数，用于仅预热元数据时入参。入参数TaskType为MetadataLoad时，该参数不应为空。 |
| DistributedLoadAttrs | DistributedLoadAttrs | 数据预热任务参数。入参数TaskType为DistributedLoad时，该参数不应为空。 |
| ReportPath | String | 将任务执行报告写入 COS 的路径，如果不需要报告则入参空 示例值：cos://**-bj-**/report/ |
| State | String | 枚举，Completed，Running，Waiting，Cancelled 示例值：Running |
| TaskMessage | String | 任务执行信息，打印预热文件成功个数，失败个数，预热耗时信息 示例值：{"SuccessfulPaths":1,"FailedPaths":0,"LoadingTime":1,"LoadingTraffic":0} |
| CreateTime | Timestamp ISO8601 | 预热任务创建时间 示例值：2026-01-12T10:20:57+08:00 |
| ModifyTime | Timestamp ISO8601 | 预热任务变更时间 示例值：2026-01-12T10:27:56+08:00 |
| Requester | String | 任务提交账号，子账号或服务角色 ID 示例值：10001*** |
LoadTaskCreationAttrs
创建预热任务
被如下接口引用：CreateLoadTask。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TaskType | String | 是 | 预热任务类型，枚举值，MetadataLoad｜DistributedLoad。 示例值：DistributedLoad |
| Priority | Integer | 否 | 任务优先级，数值越高代表优先级越高，边界值 1-9999，默认值为 1 示例值：666 |
| Description | String | 否 | 任务描述，支持中文 示例值：hello |
| MetadataLoadAttrs | MetadataLoadAttrs | 否 | 元数据预热任务参数，用于仅预热元数据时入参。入参数TaskType为MetadataLoad时，该参数不应为空。 |
| DistributedLoadAttrs | DistributedLoadAttrs | 否 | 数据预热任务参数。入参数TaskType为DistributedLoad时，该参数不应为空。 |
| ReportPath | String | 否 | 将任务执行报告写入 COS 的路径，如果不需要报告则入参空 示例值：cos://**-nj-**/test.txt |
MappedBucket
关联的对象Bucket, 并将其映射到文件系统某个路径上
被如下接口引用：AttachFileSystemBucket, DescribeFileSystemBuckets, DescribeFileSystems。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BucketName | String | 是 | 对象存储Bucket名 示例值：mybucket-1250000 |
| FileSystemPath | String | 是 | 映射到的文件系统路径, 默认为/ 示例值：/goosefs_data |
| DataRepositoryTaskAutoStrategy | Array of String | 否 | 数据流动的自动策略, 包含加载与沉降。策略可以是多种的组合 按需加载(OnDemandImport) 自动加载元数据(AutoImportMeta) 自动加载数据(AutoImportData) 周期加载(PeriodImport) 周期沉降(PeriodExport) 立即沉降(ImmediateExport) 示例值：["AutoImportData","AutoImportMeta"] |
| RuleId | String | 否 | 绑定bucket的数据流动策略ID 示例值：x-rule-1 |
| RuleDescription | String | 否 | 规则备注与描述 示例值：this rule is for picture bucket |
| Status | Integer | 否 | 桶关联状态 0：关联中 1：关联完成 示例值：0 |
| AccelerateFlag | Boolean | 否 | 是否使用全球加速域名 示例值：false |
| BucketRegion | String | 否 | 桶所在的园区 示例值：ap-shanghai |
| Endpoint | String | 否 | 自定义Endpoint 示例值：172.0.1.16 |
MetadataLoadAttrs
元数据预热参数
被如下接口引用：CreateLoadTask, DescribeLoadTask, ListLoadTasks。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LoadType | String | 是 | 预热类型，枚举值 LoadByPath｜LoadByList 示例值：LoadByList |
| SkipIfExists | Boolean | 否 | 是否跳过相同文件，默认为 true 示例值：true |
| LoadByPath | String | 否 | 预热路径，入参单条挂载路径，长度不能超过255个字符。入参数LoadType为LoadByPath，该参数不应为空 示例值：/goosefs_path/ |
| LoadByList | String | 否 | 通过文件列表批量预热，入参为 cos://bucket-appid/ 开头的 COS 路径，且仅支持 txt 格式文件，长度不能超过255个字符。入参数LoadType为LoadByList，该参数不应为空 示例值：cos://goosefs-beijing-**/api_test/temp/test_metadata_args_loadbylist_is_file_csv/* |
RoleToken
角色凭证
被如下接口引用：DescribeClusterRoleToken。
| 名称 | 类型 | 描述 |
|---|---|---|
| RoleName | String | 角色名 示例值：test |
| Token | String | 用于goosefs client/sdk等 示例值：MTY4ODQ2NTA1NF84MzM2X2E3ZWFmMDVmLWI0MzMtNGE2Yi1iOWU2LTZiZDY5OTYwXXXXXX== |
SubnetInfo
vpc子网信息
被如下接口引用：AddCrossVpcSubnetSupportForClientNode, DeleteCrossVpcSubnetSupportForClientNode, QueryCrossVpcSubnetSupportForClientNode。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | vpc id 示例值：vpc-a1b2c3d4 |
| SubnetId | String | 否 | 子网ID 示例值：subnet-a1b2c3d4 |
| UsedCluster | String | 否 | 应用的集群；可以是集群id,也可以是All 示例值：All |
| CIDR | String | 否 | cidr，只有当IsDirectConnect为true时才生效 示例值：172.21.160.0/20 |
| IsDirectConnect | Boolean | 否 | 是否为专线接入场景 示例值：false |
Tag
文件系统关联的标签
被如下接口引用：CreateFileSystem, DescribeFileSystems。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 标签键 示例值：usage |
| Value | String | 是 | 标签值 示例值：production |
