ListDatasourceFeatureViews-阿里云帮助中心

Retrieve all feature view information from the data source.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

featurestore:ListDatasourceFeatureViews

list

*All Resource

*

None

Request syntax

GET /api/v1/instances/{InstanceId}/datasources/{DatasourceId}/featureviews HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID. Get this ID using the ListInstances API.	fs-cn-********
DatasourceId	string	Yes	Data source ID. Get this ID using the ListDatasources API.	3

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	Page size.	10
PageNumber	integer	No	Page number.	1
SortBy	string	No	Sort by.	GmtCreateTime
Order	string	No	Sort order.	Desc
ProjectId	string	No	Project ID. Get this ID using the ListProjects API.	3
Name	string	No	Fuzzy filter for feature view names.	fv
Type	string	No	Feature view type. Batch - offline feature Stream - real-time feature Sequence - sequence feature	Stream
All	boolean	No	Return all data (no paging).	false
ProjectName	string	No	Filter by project name.	fs_project
StartDate	string	No	Start time for query read/write volume. Format: yyyy-mm-dd.	2025-03-14
EndDate	string	No	End time for query read/write volume. Format: yyyy-mm-dd.	2025-03-19
Verbose	boolean	No	Show detailed information. If set to false, do not show UsageStatistics for each view; show only the total. Default is true.	true
ShowStorageUsage	boolean	No	Show storage usage. Default is true.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	Total count.	10
requestId	string	Id of the request	514F82AF-3C04-5C3D-8F38-A11261BF37B0
TotalUsageStatistics	object	Overall usage statistics. Only displayed for feature views using FeatureDB.
TotalDiskUsage	number	Total disk usage.	12.3
TotalMemoryUsage	number	Total memory usage.	1.23
TotalReadWriteCount	array<object>	Total read/write count statistics.
	object
Date	string	Date.	2025-03-18T00:00:00+08:00
TotalWriteCount	integer	Total write count.	123
TotalReadCount	integer	Total read count.	456
FeatureViews	array<object>	Feature view list.
	array<object>
FeatureViewId	string	Feature view ID.	3
Name	string	Feature view name.	fv1
ProjectName	string	Project name.	p1
Type	string	Feature view type. Batch - offline feature Stream - real-time feature Sequence - sequence feature	Batch
FeatureEntityName	string	Feature entity name.	user
TTL	integer	Lifecycle. Unit: seconds.	86400
Config	string	Feature view configuration. Only feature views using FeatureDB have values, showing number of shards and number of replicas.	{"shard_count":5,"replication_count":1}
UsageStatistics	object	Usage statistics. Only displayed for feature views using FeatureDB.
RowCount	integer	Row count.	10000
DiskUsage	number	Disk usage.	1.23
MemoryUsage	number	Memory usage.	0.12
ReadWriteCount	array<object>	Read/write count statistics.
	object
Date	string	Date.	2025-03-18T00:00:00+08:00
WriteCount	integer	Write count.	100
ReadCount	integer	Read count.	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.