ListFeatureViews-阿里云帮助中心

Lists feature views, filterable by project, name, type, tag, and feature name.

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:ListFeatureViews

list

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the PAI-FeatureStore instance. Call the ListInstances API to obtain it.	fs-cn-********

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of feature views to return on each page.	10
PageNumber	integer	No	The page number of the results to return.	1
ProjectId	string	No	The project ID. You can obtain this ID by calling the `ListProjects` operation.	3
Owner	string	No	Filters the results by owner.	1232143243242****
Tag	string	No	Filters the results by tag.	tag1
FeatureName	string	No	Filters the results by feature name.	feature1
SortBy	string	No	The field by which to sort the results.	GmtCreateTime
Order	string	No	The sort order. Valid values: `Desc` (descending) and `Asc` (ascending).	Desc
FeatureViewIds	array	No	The feature view IDs by which to filter the results.
	string	No	A feature view ID.	3
Type	string	No	Filters the results by type. Valid values: ● `Batch`: batch feature ● `Stream`: stream feature	Batch
Name	string	No	Filters the results by feature view name.	fv1

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	C03B2680-AC9C-59CD-93C5-8142B92537FA
TotalCount	integer	The total count of feature views.	10
FeatureViews	array<object>	The feature view list.
	object
FeatureViewId	string	The feature view ID.	3
ProjectId	string	The project ID.	3
ProjectName	string	The project name.	project1
FeatureEntityName	string	The feature entity name.	featureEntity1
Name	string	The feature view name.	featureView1
Owner	string	The ID of the Alibaba Cloud account that created the feature view.	12321421412****
Type	string	The type of the feature view. Valid values: ● Batch feature ● Stream feature	Batch
WriteToFeatureDB	boolean	Indicates whether data is written to the online feature store.	false
GmtCreateTime	string	The creation time.	2021-12-15T23:24:33.132+08:00
GmtModifiedTime	string	The update time.	2021-12-15T23:24:33.132+08:00
RegisterTable	string	The registered table name.	table1
RegisterDatasourceName	string	The name of the data source for the registered table.	datasource1
TTL	integer	The TTL (Time to Live) of features in the feature view, in seconds.	90
RegisterDatasourceId	string	The ID of the data source for the registered table.	4

Examples

Success response

JSON format

{
  "RequestId": "C03B2680-AC9C-59CD-93C5-8142B92537FA",
  "TotalCount": 10,
  "FeatureViews": [
    {
      "FeatureViewId": "3",
      "ProjectId": "3",
      "ProjectName": "project1",
      "FeatureEntityName": "featureEntity1",
      "Name": "featureView1",
      "Owner": "12321421412****",
      "Type": "Batch",
      "WriteToFeatureDB": false,
      "GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
      "GmtModifiedTime": "2021-12-15T23:24:33.132+08:00",
      "RegisterTable": "table1",
      "RegisterDatasourceName": "datasource1",
      "TTL": 90,
      "RegisterDatasourceId": "4"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.