文件存储 vePFS
文件存储 vePFS
文档指南
请输入
- 文档首页
文件存储 vePFSAPI 参考数据洞察 V2.1DescribeLensTasks - 查询数据洞察任务
复制全文
下载 pdfDescribeLensTasks - 查询数据洞察任务
文档反馈
问问助手调用 DescribeLensTasks 接口，查询数据洞察任务信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeLensTasks
要执行的操作，取值：DescribeLensTasks。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
PageSize integer 可选 示例值：10
分页查询时，设置的每个分页上记录的任务数量。取值为 1~100 之间的整数，默认值为 10。
PageNumber integer 可选 示例值：1
查询的任务列表分页的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
LensTaskId string 可选 示例值：lenstask-cnbj********
需要查询的数据洞察任务 ID，根据任务 ID 查询目标任务。
LensTaskName string 可选 示例值：test
查询的数据洞察任务名称。
LensPolicyId string 可选 示例值：lenspolicy-cnbj********
任务关联的数据洞察策略 ID，通过策略 ID，查询相关任务。
FileSystemId string 可选 示例值：vepfs-cnbj********
任务关联的文件系统 ID，通过文件系统 ID，查询相关任务。
Status string[] 可选 示例值：Completed
数据洞察任务状态，查询指定状态的任务，取值说明如下：
- Creating：创建中。
- Pending：排队中。
- Starting：启动中。
- Running：运行中。
- Canceling：取消中。
- Completed：已完成。
- Cancelled：已取消。
- Abnormal：异常。
- Conflicted：冲突终止。
- Failed：失败。
MasterTaskId string 可选 示例值：lenstask-cnbj********
数据洞察任务主任务 ID。
ScheduleType string 可选 示例值：Once
数据洞察任务计划类型，查询指定计划类型的任务，取值说明如下：
- Timed：周期性任务。
- Once：一次性任务。
返回参数
TotalCount integer 示例值：1
查询到的数据洞察任务数量。
LensTasks object[] 示例值：详情请参见示例代码
数据洞察任务详情。
LensTaskId string 示例值：lenstask-cnbj********
数据洞察任务 ID。
LensTaskName string 示例值：lenstask
数据洞察任务名称。
FileSystemId string 示例值：vepfs-cnbj*********
文件系统 ID。
LensPolicyId string 示例值：lenspolicy-cnbj********
数据洞察策略 ID。
Status string 示例值：Running
数据洞察任务状态，取值说明如下：
- Creating：创建中。
- Pending：排队中。
- Starting：启动中。
- Running：运行中。
- Canceling：取消中。
- Completed：已完成。
- Cancelled：已取消。
- Abnormal：异常。
- Conflicted：冲突终止。
- Failed：失败。
Schedule object 示例值：详情请参见示例代码
数据洞察任务执行计划。
ScheduleType string 示例值：Timed
数据洞察任务计划类型，取值说明如下：
- Timed：周期性任务。
- Once：一次性任务。
OnceRunTiming string 示例值：Now
数据洞察一次性任务执行时间，取值说明如下：
- Now：立即执行。
- Later：定时执行。
Period integer 示例值：1
数据洞察任务周期性任务执行周期。
PeriodUnit string 示例值：Day
数据洞察任务周期性任务执行周期单位，取值说明如下：
- Hour：小时。
- Day：天。
- Week：周。
- Month：月。
RunTime long 示例值：1765265717
数据洞察任务开始时间。
ConflictPolicy string 示例值：Enqueue
数据洞察任务冲突策略，取值说明如下：
- Enqueue：加入排队。
- Conflict：冲突终止。
TargetInfos object[] 示例值：详情请参见示例代码
目标目录信息。
FilesetId string 示例值：fset-*****
fileset ID。
RelativePath string 示例值：/test/
子目录。
LensTaskContent string[] 示例值：MetadataExport
数据洞察任务内容，取值说明如下：
- MetadataExport：导出任务。以获取任务执行结果文件为目标的任务为导出任务。
- MetadataAnalyze：分析任务。以根据任务执行结果获取分析信息为目标的任务为分析任务。
- CapacityStat：容量统计任务。以根据任务执行结果获取容量信息为目标的任务为容量统计任务。
LensExportInfo object 示例值：详情请参见示例代码
导出任务信息。
ExportAttrs string[] 示例值：Path
数据洞察任务导出指标，取值说明如下：
- Inode：Inode。
- Mode：文件访问权限。
- NLink：链接数。
- Size：文件大小。
- CreationTime：创建时间。
- AccessTime：最后访问时间。
- ChangeTime：最后元数据变更时间。
- ModifyTime：最后数据修改时间。
- Type：文件类型。
- Extension：文件扩展名。
- Name：文件名称。
- Path：文件路径。
ExportPath string 示例值：/test/
导出目录。
TosBucket string 示例值：tosbucket
TOS 桶。
TosPrefix string 示例值：/test/
TOS 路径前缀。
EnableDownload boolean 示例值：-
是否开启下载。
ResultDownloadUrl string 示例值：-
导出结果下载链接，该参数仅出现在返回参数。
LensAnalysisInfo object 示例值：详情请参见示例代码
分析任务信息。
EnableLensAnalysis boolean 示例值：true
是否开启任务执行结果分析功能，取值说明如下：
- true：开启。
- false：不开启。
说明
LensTaskContent 参数取值中包含 MetadataAnalyze 时，取值为 ture，否则取值为 false。
AnalysisAttrs string[] 示例值：Inode
数据洞察任务分析指标，取值说明如下：
- Inode：Inode。
- Mode：文件访问权限。
- NLink：链接数。
- Size：文件大小。
- CreationTime：创建时间。
- AccessTime：最后访问时间。
- ChangeTime：最后元数据变更时间。
- ModifyTime：最后数据修改时间。
- Type：文件类型。
- Extension：文件扩展名。
- Name：文件名称。
- Path：文件路径。
TlsTopicId string 示例值：29fecf9e-878e-4ae3-9990-90785b2d****
日志服务主题 ID。
TlsProjectId string 示例值：5c7a0de3-6fd3-4a0f-8503-233a7729****
日志服务项目 ID。
ExpirationTime string 示例值：2025-12-30T14:15:28+08:00
日志服务过期时间。
LensCapacityStatInfo object 示例值：详情请参见示例代码
容量统计任务信息。
FirstLevelSubDir boolean 示例值：-
是否统计一级目录容量。
SecondLevelSubDir boolean 示例值：-
是否统计二级目录容量。
EnableDownload boolean 示例值：-
容量统计结果是否支持下载。
FirstLevelSubDirDownloadUrl string 示例值：-
一级目录容量统计结果下载链接，该参数仅出现在返回参数。
SecondLevelSubDirDownloadUrl string 示例值：-
二级目录容量统计结果下载链接，该参数仅出现在返回参数。
ExportPath string 示例值：/test/
容量统计结果在文件系统侧的导出目录。
TosBucket string 示例值：tosbucket
容量统计结果导出的 TOS 桶。
TosPrefix string 示例值：/test/
容量统计结果导出的 TOS 桶前缀。
Progress object 示例值：详情请参见示例代码
任务进度。
TotalEntriesQueued long 示例值：10
已加入队列的条目总数（含文件、目录等）。
DirectoriesQueued long 示例值：1
队列中的目录个数。
EntriesProcessed long 示例值：4
已处理的条目数。
RunTimes integer 示例值：1
运行次数，用于表示周期性任务的已运行次数。
Stage string 示例值：Scanning
数据洞察任务阶段，取值说明如下：
- Pending：待运行。
- Scanning：扫描中。
- Processing：处理中。
- Generating：生成结果中。
- Generated：结果已生成。
MasterTaskId string 示例值：lenstask-cnbj********
数据洞察任务主任务 ID。
ConflictTaskId string 示例值：lenstask-cnbj********
冲突任务 ID。
LensPolicySnapshot object 示例值：详情请参见示例代码
任务创建时的数据洞察策略快照（保存当时的完整策略内容）。
LensPolicyId string 示例值：lenspolicy-cnbj*********
数据洞察策略 ID。
LensPolicyName string 示例值：test
数据洞察策略名称。
LogicOperator string 示例值：Or
数据洞察规则组间逻辑关系，取值说明如下：
- Or：或。满足任意指标规则的文件。
- And：且。需同时满足所有指标规则的文件。
- AndNot：非。不满足所有指标规则的文件。
RuleGroups object[] 示例值：详情请参见示例代码
数据洞察策略规则组。
Rules object[] 示例值：-
数据洞察规则。
Dimension string 示例值：Size
数据洞察规则指标，取值说明如下：
- Size：文件大小。
- CreationTime：创建时间。
- AccessTime：最后访问时间。
- ChangeTime：最后元数据变更时间。
- ModifyTime：最后数据修改时间。
- Type：文件类型。
- Extension：文件扩展名。
- Name：文件名称。
- Path：文件路径。
Conditions object[] 示例值：-
数据洞察规则条件。
ValueType string 示例值：StorageUnit
数据洞察条件值类型，取值说明如下：
- StorageUnit：存储大小。
- Timestamp：时间戳。
- RelativeTime：相对时间大小。
- Text：文本。
ConstraintType string 示例值：Greater
数据洞察规则条件约束，取值说明如下：
- Before：早于，距今大于。
- UntilNow：晚于，距今小于。
- Between：介于。
- Greater：大于。
- GreaterEqual：大于等于。
- Less：小于。
- LessEqual：小于等于。
- Equal：等于。
- NotEqual：不等于。
- Contain：包含。
- NotContain：不包含。
- Prefix：前缀等于。
- NotPrefix：前缀不等于。
NumberValue object 示例值：-
数字值。
StringValue object 示例值：-
文本值。
RangeValue object 示例值：-
数值区间。
LogicOperator string 示例值：Or
数据洞察规则组内逻辑关系，取值说明如下：
- Or：或。满足任意指标规则的文件。
- And：且。需同时满足所有指标规则的文件。
Description string 示例值：for-test
数据洞察策略描述。
CreateTime string 示例值：2025-12-14T14:15:37+08:00
数据洞察策略创建时间。
ModifyTime string 示例值：2025-12-14T14:15:37+08:00
数据洞察策略最后修改时间。
Description string 示例值：test
描述。
CreateTime string 示例值：2025-12-14T14:15:28+08:00
数据洞察任务创建时间。
ModifyTime string 示例值：2025-12-14T14:15:37+08:00
数据洞察任务最后修改时间。
StartTime string 示例值：2025-12-14T14:15:37+08:00
数据洞察任务运行开始时间。
CompleteTime string 示例值：2025-12-14T14:15:37+08:00
数据洞察任务完成时间。
PageSize integer 示例值：10
分页查询时，设置的每个分页上记录的任务数量。取值为 1~100 之间的整数，默认值为 10。
PageNumber integer 示例值：1
查询的任务列表分页的页码。取值为不超过 Integer 数据类型的最大值，起始值为 1。
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter | The specified parameter format is invalid. | 参数格式错误。 |
500 | InternalError | Service has some internal Error. Pls Contact With Admin. | 内部错误。 |
最近更新时间：2026.05.14 17:38:22
这个页面对您有帮助吗？
有用
有用
无用
无用