File Storage vePFS
File Storage vePFS
Document
- Documentation
File Storage vePFSAPI ReferenceData Insights V2.1DescribeLensTasks - Query Data Insight Tasks
Copy page
Download PDFData Insights V2.1
DescribeLensTasks - Query Data Insight Tasks
Copy pageDownload PDFDescribeLensTasks - Query Data Insight Tasks
Call the DescribeLensTasks API to query data insight task information.
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Below are the request parameters specific to this API and some common parameters. For more information, see Common Parameters.
Action string requiredExample: DescribeLensTasks
Action to perform: DescribeLensTasks.
Version string requiredExample: 2022-01-01
API version: 2022-01-01.
PageSize integer Optional Example: 10
Number of tasks per page when using pagination. Enter an integer between 1 and 100. The default value is 10.
PageNumber integer Optional Example: 1
The page number for paginating the task list. The value cannot exceed the maximum value of the Integer data type, and it starts from 1.
LensTaskId string Optional Example: lenstask-cnbj********
Data Insight task ID to query. Use the task ID to search for the target task.
LensTaskName string Optional Example: test
Name of the Data Insight task to query.
LensPolicyId string Optional Example: lenspolicy-cnbj********
Data Insight policy ID associated with the task; use the policy ID to query related tasks.
FileSystemId string Optional Example: vepfs-cnbj********
File system ID associated with the task. Use the file system ID to query related tasks.
Status string[] Optional Example: Completed
Data Insight task status. Query tasks by specified status. Value descriptions are as follows:
- Creating: In creation.
- Pending: In queue.
- Starting: Starting.
- Running: Running.
- Canceling: Canceling.
- Completed: Completed.
- Cancelled: Cancelled.
- Abnormal: Abnormal.
- Conflicted: Conflict terminated.
- Failed: Failed.
MasterTaskId string Optional Example: lenstask-cnbj********
Data Insight main task ID.
ScheduleType string Optional Example: Once
Data Insight task schedule type. Query tasks by the specified schedule type. The value descriptions are as follows:
- Timed: Recurring task.
- Once: One-time task.
Response parameters
Below are the response parameters specific to this API. For more information, see Response Structure.
TotalCount integer Example: 1
Number of data insight tasks queried.
LensTasks object[] Example: See sample code
Details about the Data Insight task.
LensTaskId string Example: lenstask-cnbj********
Data Insight task ID.
LensTaskName string Example: lenstask
Data Insight task name.
FileSystemId string Example: vepfs-cnbj*********
File system ID.
LensPolicyId string Example: lenspolicy-cnbj********
Data Insight policy ID.
Status string Example: Running
Status of the data insight task. The parameter options are described below:
- Creating: Creating.
- Pending: Queuing
- Starting: Starting
- Running: Running
- Canceling: Canceling
- Completed: Completed
- Cancelled: Cancelled
- Abnormal: Abnormal
- Conflicted: Conflict terminated
- Failed: Failed
Schedule object Example: See sample code for details
Execution plan for the Data Insight task.
ScheduleType string Example: Timed
Data Insight task plan types. The values are explained as follows:
- Timed: Recurring tasks.
- Once: One-time tasks.
OnceRunTiming string Example: Now
Execution time of the one-time Data Insight task. Value explanations:
- Now: Execute immediately.
- Later: Execute on schedule.
Period integer Example: 1
Recurring execution period for a Data Insight task.
PeriodUnit string Example: Day
Data Insight task cycle unit for periodic tasks. The value options are as follows:
- Hour: Hour.
- Day: Day.
- Week: Week.
- Month: Month.
RunTime long Example: 1765265717
Start time of the data insight task.
ConflictPolicy string Example: Enqueue
Data Insight task conflict policy. Value description:
- Enqueue: Add to queue.
- Conflict: Terminate on conflict.
TargetInfos object[] For details, see sample code
Target directory information.
FilesetId string Example: fset-*****
fileset ID.
RelativePath string Example: /test/
Subdirectory.
LensTaskContent string[] Example: MetadataExport
Data Insight task content. Note:
- MetadataExport: Export task. Tasks aiming to obtain execution result files are export tasks.
- MetadataAnalyze: Analysis task. A task aimed at obtaining analysis information based on task execution results is referred to as an analysis task.
- CapacityStat: Capacity statistics task. A task aimed at obtaining capacity information based on task execution results is referred to as a capacity statistics task.
LensExportInfo object Example: See sample code for details
Export task information.
ExportAttrs string[] Example: Path
Data Insight task export metrics are explained as follows:
- Inode：Inode.
- Mode: File access permissions.
- NLink: Number of links.
- Size: File size.
- CreationTime: Creation time.
- AccessTime: Last accessed time.
- ChangeTime: Last metadata change time.
- ModifyTime: Last data modification time.
- Type: File type.
- Extension: file extension.
- Name: file name.
- Path: file path.
ExportPath string Example: /test/
Export directory.
TosBucket string Example: tosbucket
TOS bucket.
TosPrefix string Example: /test/
TOS path prefix.
EnableDownload boolean Example: -
Enable download.
ResultDownloadUrl string Example: -
Export result download link. This parameter only appears in the return parameters.
LensAnalysisInfo object Example: See sample code for details
Analysis task information.
EnableLensAnalysis boolean Example: true
Enable result analysis for tasks as described below:
- true: Enabled.
- false: Disabled.
tip
When the LensTaskContent parameter contains MetadataAnalyze, set the value to true; otherwise, set it to false.
AnalysisAttrs string[] Example: Inode
Data Insight task analysis metrics are described as follows:
- Inode：Inode.
- Mode: File access permissions.
- NLink: Number of links.
- Size: File size.
- CreationTime: Creation time.
- AccessTime: Last access time.
- ChangeTime: Last metadata change time.
- ModifyTime: Last data modification time.
- Type: File type.
- Extension: File extension.
- Name: File name.
- Path: File path.
TlsTopicId string Example: 29fecf9e-878e-4ae3-9990-90785b2d****
Log Service Topic ID.
TlsProjectId string Example: 5c7a0de3-6fd3-4a0f-8503-233a7729****
Log Service project ID.
ExpirationTime string Example: 2025-12-30T14:15:28+08:00
Expiration time for Log Service.
LensCapacityStatInfo object Example: See sample code for details
Capacity statistics task information.
FirstLevelSubDir boolean Exampleount the capacity of the top-level directory.
SecondLevelSubDir boolean Example: -
Count the capacity of secondary directories.
EnableDownload boolean Example: -
Is download supported for capacity statistics results.
FirstLevelSubDirDownloadUrl string Example: -
Download link for the first-level directory capacity statistics result. This parameter appears only in the response parameters.
SecondLevelSubDirDownloadUrl string Example: -
Second-level directory capacity statistics download link. This parameter only appears in the return parameters.
ExportPath string Example: /test/
Export directory for capacity statistics results on the file system side.
TosBucket string Example: tosbucket
TOS bucket for exporting capacity statistics.
TosPrefix string Example: /test/
TOS bucket prefix for exporting capacity statistics results.
Progress object Example: See sample code for details
Task progress.
TotalEntriesQueued long Example: 10
Total number of entries queued (including files, directories, etc.).
DirectoriesQueued long Example: 1
Number of directories in the queue.
EntriesProcessed long Example: 4
Number of entries processed.
RunTimes integer Example: 1
Run count, indicates the number of times a recurring task has executed.
Stage string Example: Scanning
Data Insight task stages are explained as follows:
- Pending: Waiting to run.
- Scanning: Scanning.
- Processing: Processing.
- Generating: Generating results.
- Generated: The result has been generated.
MasterTaskId string Example: lenstask-cnbj********
Main task ID for Data Insight tasks.
ConflictTaskId string Example: lenstask-cnbj********
Conflict task ID.
LensPolicySnapshot object Example: See the sample code for details
Snapshot of the data insight policy at task creation (saves the complete policy content at that time).
LensPolicyId string Example: lenspolicy-cnbj*********
Data Insight policy ID.
LensPolicyName string Example: test
Data insight policy name.
LogicOperator string Example: Or
Logical relationships among Data Insight rule groups are described as follows:
- Or: Or. Files that meet any indicator rule.
- And: And. Files that must meet all indicator rules.
- AndNot: Not. Files that do not meet all indicator rules.
RuleGroups object[] Example: See sample code for details
Data Insight policy rule group.
Rules object[] Example: -
Data Insight rules.
Dimension string Example: Size
Data insight rule metrics, explained as follows:
- Size: File size.
- CreationTime: Creation time.
- AccessTime: Last access time.
- ChangeTime: Last metadata change time.
- ModifyTime: Last data modification time.
- Type: File type.
- Extension: File extension.
- Name: File name.
- Path: File path.
Conditions object[] Example: -
Data Insight rule conditions.
ValueType string Example: StorageUnit
Data insight condition value type. The value description is as follows:
- StorageUnit: Storage size.
- Timestamp: Timestamp.
- RelativeTime: Relative time size.
- Text: Text.
ConstraintType string Example: Greater
Constraint conditions for data insight rules. See below for details:
- Before: Earlier, greater than now.
- UntilNow: Later, less than now.
- Between: Between.
- Greater: greater than.
- GreaterEqual: greater than or equal to.
- Less: less than.
- LessEqual: less than or equal to.
- Equal: equal to.
- NotEqual: not equal to.
- Contain: contains.
- NotContain: does not contain.
- Prefix: prefix equals.
- NotPrefix: prefix does not equal.
NumberValue object Example: -
Numeric value.
StringValue object Example: -
Text value.
RangeValue object Example: -
Number range.
LogicOperator string Example: Or
Logical relationship within the Data Insight rule group, explained as follows:
- Or: or. Files that meet any metric rule.
- And: and. Files must meet all metric rules at the same time.
Description string Example: for-test
Data Insight policy description.
CreateTime string Example: 2025-12-14T14:15:37+08:00
Creation time of the Data Insight policy.
ModifyTime string Example: 2025-12-14T14:15:37+08:00
Last modification time of the Data Insight policy.
Description string Example: test
Description.
CreateTime string Example: 2025-12-14T14:15:28+08:00
Data Insight task creation time.
ModifyTime string Example: 2025-12-14T14:15:37+08:00
Last modified time of the Data Insight task.
StartTime string Example: 2025-12-14T14:15:37+08:00
Start time of the Data Insight task runtime.
CompleteTime string Example: 2025-12-14T14:15:37+08:00
Completion time of the Data Insight task.
PageSize integer Example: 10
The number of tasks per page when performing paginated queries. Enter an integer between 1 and 100. The default is 10.
PageNumber integer Example: 1
Page number for the queried task list. The value must not exceed the maximum value for the Integer data type. The starting value is 1.
Sample request
POST /?Action=DescribeLensTasks&Version=2022-01-01 HTTP/1.1
Host: vepfs.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260514T080742Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260514/cn-beijing/vepfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"PageSize": 10,
"PageNumber": 1,
"LensTaskId": "lenstask-cnbj********",
"LensTaskName": "test",
"LensPolicyId": "lenspolicy-cnbj********",
"FileSystemId": "vepfs-cnbj********",
"Status": [
"Completed"
],
"MasterTaskId": "lenstask-cnbj********",
"ScheduleType": "Once"
}
Return example
{
"ResponseMetadata": {
"RequestId": "2026051416075922013703508965****",
"Action": "DescribeLensTasks",
"Version": "2022-01-01",
"Service": "vepfs",
"Region": "cn-beijing"
},
"Result": {
"TotalCount": 1,
"LensTasks": [
{
"LensTaskId": "lenstask-cnbj********",
"LensTaskName": "lenstask",
"FileSystemId": "vepfs-cnbj*********",
"LensPolicyId": "lenspolicy-cnbj********",
"Status": "Running",
"Schedule": {
"ScheduleType": "Timed",
"OnceRunTiming": "Now",
"Period": 1,
"PeriodUnit": "Day",
"RunTime": 1765265717,
"ConflictPolicy": "Enqueue"
},
"TargetInfos": [
{
"FilesetId": "fset-*****",
"RelativePath": "/test/"
}
],
"LensTaskContent": [
"MetadataExport"
],
"LensExportInfo": {
"ExportAttrs": [
"Path"
],
"ExportPath": "/test/",
"TosBucket": "tosbucket",
"TosPrefix": "/test/",
"EnableDownload": true,
"ResultDownloadUrl": "-"
},
"LensAnalysisInfo": {
"EnableLensAnalysis": true,
"AnalysisAttrs": [
"Inode"
],
"TlsTopicId": "29fecf9e-878e-4ae3-9990-90785b2d****",
"TlsProjectId": "5c7a0de3-6fd3-4a0f-8503-233a7729****",
"ExpirationTime": "2025-12-30T14:15:28+08:00"
},
"LensCapacityStatInfo": {
"FirstLevelSubDir": true,
"SecondLevelSubDir": true,
"EnableDownload": true,
"FirstLevelSubDirDownloadUrl": "-",
"SecondLevelSubDirDownloadUrl": "-",
"ExportPath": "/test/",
"TosBucket": "tosbucket",
"TosPrefix": "/test/"
},
"Progress": {
"TotalEntriesQueued": 10,
"DirectoriesQueued": 1,
"EntriesProcessed": 4,
"RunTimes": 1,
"Stage": "Scanning"
},
"MasterTaskId": "lenstask-cnbj********",
"ConflictTaskId": "lenstask-cnbj********",
"LensPolicySnapshot": {
"LensPolicyId": "lenspolicy-cnbj*********",
"LensPolicyName": "test",
"LogicOperator": "Or",
"RuleGroups": [
{
"Rules": [
{
"Dimension": "Size",
"Conditions": [
{
"ValueType": "StorageUnit",
"ConstraintType": "Greater",
"NumberValue": {
"Value": 0,
"Unit": "TiB"
},
"StringValue": {
"Value": "test"
},
"RangeValue": {
"MinValue": 1,
"MaxValue": 2,
"MinValueUnit": "TiB",
"MaxValueUnit": "TiB"
}
}
]
}
],
"LogicOperator": "Or"
}
],
"Description": "for-test",
"CreateTime": "2025-12-14T14:15:37+08:00",
"ModifyTime": "2025-12-14T14:15:37+08:00"
},
"Description": "test",
"CreateTime": "2025-12-14T14:15:28+08:00",
"ModifyTime": "2025-12-14T14:15:37+08:00",
"StartTime": "2025-12-14T14:15:37+08:00",
"CompleteTime": "2025-12-14T14:15:37+08:00"
}
],
"PageSize": 10,
"PageNumber": 1
}
}
Error codes
The table below lists the error codes for this interface related to business logic. For public error codes, refer to the Public Error Codes documentation.
Status Code | Error codes | Error message | Note |
400 | InvalidParameter | The specified parameter format is invalid. | Incorrect parameter format. |
500 | InternalError | Service has some internal Error. Pls Contact With Admin. | Internal error. |
Last updated: 2026.05.15 11:26:13
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
