You need to enable JavaScript to run this app.
文档中心
文件存储 vePFS

文件存储 vePFS

复制全文
下载 pdf
数据洞察 V2.1
DescribeLensPolicies - 列举数据洞察策略
复制全文
下载 pdf
DescribeLensPolicies - 列举数据洞察策略
调用 DescribeLensPolicies 接口,查询数据洞察策略。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeLensPolicies​
要执行的操作,取值:DescribeLensPolicies。​
​
Version string 必选 示例值:2022-01-01​
API的版本,取值:2022-01-01。​
​
PageSize integer 可选 示例值:10​
分页查询时,设置的每个分页上记录的策略数量。取值为 1~100 之间的整数,默认值为 10。​
​
PageNumber integer 可选 示例值:1​
查询的数据洞察策略列表分页的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。​
​
LensPolicyId string 可选 示例值:lenspolicy-cnbj********​
查询的数据洞察策略 ID。​
​
LensPolicyName string 可选 示例值:test​
查询的数据洞察策略名称。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TotalCount integer 示例值:1​
查询到的数据洞察策略数量。​
​
LensPolicies 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 示例值:-​
数字值。​
Value long 示例值:Equal​
数据洞察规则条件类型参数ValueType取值为StorageUnit、Timestamp或RelativeTime时,其具体可取值说明如下:​
  • 当参数ValueType取值为StorageUnit时,可取值为:​
  • Equal:等于​
  • Greater:大于​
  • GreaterEqual:大于等于​
  • Less:小于​
  • LessEqual:小于等于​
  • 当参数ValueType取值为Timestamp或RelativeTime时,可取值为:​
  • Before:之前,不包含边界值​
  • UntilNow:至今,包含边界值​
​
Unit string 示例值:TiB​
数据洞察规则条件值单位,取值说明如下:​
  • 当参数ValueType取值为StorageUnit时,可取值为:​
  • Byte:byte。​
  • KiB:Kibibyte。​
  • MiB:Mebibyte。​
  • GiB:Gibibyte。​
  • TiB:Tebibyte。​
  • PiB:Pebibyte。​
  • 当参数ValueType取值为RelativeTime时,可取值为:Day,表示天。​
  • 当参数ValueType取值为Timestamp时,可取值为:Second,表示秒。​
​
​
StringValue object 示例值:-​
文本值。​
Value string 示例值:test​
数据洞察规则条件类型参数ValueType取值为Text时,填写具体的文件信息,例如文件名称等。​
​
​
RangeValue object 示例值:-​
数值区间。​
MinValue long 示例值:1​
数据洞察规则条件类型参数ValueType取值为StorageUnit、Timestamp或RelativeTime时,包含该数值的区间最小值。​
​
MaxValue long 示例值:2​
数据洞察规则条件类型参数ValueType取值为StorageUnit、Timestamp或RelativeTime时,不包含该数值的区间最大值。​
​
MinValueUnit string 示例值:TiB​
数据洞察规则条件区间最小值单位,取值说明如下:​
  • 当参数ValueType取值为StorageUnit时,可取值为:​
  • Byte:byte。​
  • KiB:Kibibyte。​
  • MiB:Mebibyte。​
  • GiB:Gibibyte。​
  • TiB:Tebibyte。​
  • PiB:Pebibyte。​
  • 当参数ValueType取值为RelativeTime时,可取值为:Day,表示天。​
  • 当参数ValueType取值为Timestamp时,可取值为:Second,表示秒。​
​
MaxValueUnit string 示例值:TiB​
数据洞察规则条件区间最大值单位,取值说明如下:​
  • 当参数ValueType取值为StorageUnit时,可取值为:​
  • Byte:byte。​
  • KiB:Kibibyte。​
  • MiB:Mebibyte。​
  • GiB:Gibibyte。​
  • TiB:Tebibyte。​
  • PiB:Pebibyte。​
  • 当参数ValueType取值为RelativeTime时,可取值为:Day,表示天。​
  • 当参数ValueType取值为Timestamp时,可取值为:Second,表示秒。​
​
​
​
​
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​
数据洞察策略最后修改时间。​
​
​
PageSize integer 示例值:10​
数据洞察策略列表页面每个分页上记录的策略数量。取值为 1~100 之间的整数,默认值为 10。​
​
PageNumber integer 示例值:1​
数据洞察策略列表分页的页码,取值为不超过 Integer 数据类型的最大值,起始值为 1。​
​
​
​
请求示例​
​
POST /?Action=DescribeLensPolicies&Version=2022-01-01 HTTP/1.1​
Host: https://api.volcengine.com/api-explorer/?action=CreateLensPolicy&groupName=Lens_Public&serviceCode=vepfs&version=2022-01-01​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251215T095349Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251215/cn-beijing/vepfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251215175352179168109255714FE8",​
"Action": "DescribeLensPolicies",​
"Version": "2022-01-01",​
"Service": "vepfs",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 1,​
"LensPolicies": [​
{​
"LensPolicyId": "lenspolicy-cnbj*********",​
"LensPolicyName": "test",​
"CreateTime": "2025-12-14T14:15:37+08:00",​
"ModifyTime": "2025-12-14T14:15:37+08:00"​
}​
],​
"PageSize": 10,​
"PageNumber": 1​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter format is invalid.​
参数格式错误。​
500​
InternalError​
Service has some internal Error. Pls Contact With Admin.​
内部错误。​
​
​
最近更新时间:2025.12.18 14:02:41
这个页面对您有帮助吗?
有用
有用
无用
无用