ListDatasourceFeatureViews
Retrieves all feature view information under a datasource.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
featurestore:ListDatasourceFeatureViews |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v1/instances/{InstanceId}/datasources/{DatasourceId}/featureviews HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. You can call ListInstances to obtain the instance ID. |
fs-cn-******** |
| DatasourceId |
string |
Yes |
The datasource ID. You can call ListDatasources to obtain the datasource ID. |
3 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageSize |
integer |
No |
The number of entries to return on each page. |
10 |
| PageNumber |
integer |
No |
The page number. |
1 |
| SortBy |
string |
No |
The field used to sort the results. |
GmtCreateTime |
| Order |
string |
No |
The sort order. |
Desc |
| ProjectId |
string |
No |
The project ID. You can call ListProjects to obtain the project ID. |
3 |
| Name |
string |
No |
Filters feature views by name using a fuzzy match. |
fv |
| Type |
string |
No |
The feature view type. Valid values:
|
Stream |
| All |
boolean |
No |
Specifies whether to return all data without pagination. |
false |
| ProjectName |
string |
No |
Filters results by project name. |
fs_project |
| StartDate |
string |
No |
The start date for querying read and write volume, in yyyy-mm-dd format. |
2025-03-14 |
| EndDate |
string |
No |
The end date for querying read and write volume, in yyyy-mm-dd format. |
2025-03-19 |
| Verbose |
boolean |
No |
Specifies whether to show detailed information. If set to false, UsageStatistics for each feature view is not displayed and only the total is shown. Default value: true. |
true |
| ShowStorageUsage |
boolean |
No |
Specifies whether to show storage usage. Default value: true. |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| TotalCount |
integer |
The total number of entries. |
10 |
| requestId |
string |
Id of the request |
514F82AF-3C04-5C3D-8F38-A11261BF37B0 |
| TotalUsageStatistics |
object |
The aggregated usage statistics. Displayed only for feature views that use FeatureDB. |
|
| TotalDiskUsage |
number |
The total disk storage usage. |
12.3 |
| TotalMemoryUsage |
number |
The total memory storage usage. |
1.23 |
| TotalReadWriteCount |
array<object> |
The total read and write count statistics. |
|
|
object |
|||
| Date |
string |
The date and time of the total read/write count statistics, in ISO 8601 format with time zone offset, for example, 2025-03-18T00:00:00+08:00. |
2025-03-18T00:00:00+08:00 |
| TotalWriteCount |
integer |
The total number of write operations. |
123 |
| TotalReadCount |
integer |
The total number of read operations. |
456 |
| FeatureViews |
array<object> |
The list of feature views. |
|
|
array<object> |
|||
| FeatureViewId |
string |
The feature view ID. |
3 |
| Name |
string |
The feature view name. |
fv1 |
| ProjectName |
string |
The project name. |
p1 |
| Type |
string |
The feature view type. Valid values:
|
Batch |
| FeatureEntityName |
string |
The feature entity name. |
user |
| TTL |
integer |
The time to live (TTL). Unit: seconds. |
86400 |
| Config |
string |
The feature view configuration. This field has a value only for feature views that use FeatureDB, and displays the number of shards and replicas. |
{"shard_count":5,"replication_count":1} |
| UsageStatistics |
object |
The usage statistics. Displayed only for feature views that use FeatureDB. |
|
| RowCount |
integer |
The number of rows. |
10000 |
| DiskUsage |
number |
The disk storage usage. |
1.23 |
| MemoryUsage |
number |
The memory storage usage. |
0.12 |
| ReadWriteCount |
array<object> |
The read and write count statistics. |
|
|
object |
|||
| Date |
string |
The date and time of the read/write count statistics, in ISO 8601 format with time zone offset, for example, 2025-03-18T00:00:00+08:00. |
2025-03-18T00:00:00+08:00 |
| WriteCount |
integer |
The number of write operations. |
100 |
| ReadCount |
integer |
The number of read operations. |
200 |
Examples
Success response
JSON format
{
"TotalCount": 10,
"requestId": "514F82AF-3C04-5C3D-8F38-A11261BF37B0",
"TotalUsageStatistics": {
"TotalDiskUsage": 12.3,
"TotalMemoryUsage": 1.23,
"TotalReadWriteCount": [
{
"Date": "2025-03-18T00:00:00+08:00",
"TotalWriteCount": 123,
"TotalReadCount": 456
}
]
},
"FeatureViews": [
{
"FeatureViewId": "3",
"Name": "fv1",
"ProjectName": "p1",
"Type": "Batch",
"FeatureEntityName": "user",
"TTL": 86400,
"Config": "{\"shard_count\":5,\"replication_count\":1}",
"UsageStatistics": {
"RowCount": 10000,
"DiskUsage": 1.23,
"MemoryUsage": 0.12,
"ReadWriteCount": [
{
"Date": "2025-03-18T00:00:00+08:00",
"WriteCount": 100,
"ReadCount": 200
}
]
}
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.