Lists all features in a project. This operation supports filtering by name, alias, and feature view, as well as sorting and pagination. The response includes the data type, parent feature view, and the number of model features that reference each feature.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
featurestore:ListProjectFeatures |
list |
*All Resource
|
None | None |
Request syntax
GET /api/v1/instances/{InstanceId}/projects/{ProjectId}/features HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the instance. |
fs-cn-******** |
| ProjectId |
string |
Yes |
The ID of the project. |
3 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
No |
The feature name. Fuzzy search is supported. |
f1 |
| AliasName |
string |
No |
The feature alias. Fuzzy search is supported. |
ff1 |
| Filter |
string |
No |
Additional filter conditions in a JSON object. Conditions are combined by using the AND operator. |
{"feature_view_name":"fv1"} |
| PageNumber |
integer |
No |
The page number. Starts from 1. |
1 |
| PageSize |
integer |
No |
The number of features to return per page. |
10 |
| SortBy |
string |
No |
The field used to sort the returned features. |
ModelFeatureCount |
| Order |
string |
No |
Specifies the sort order. Valid values: |
Desc |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| TotalCount |
integer |
The total number of features that match the query criteria. |
10 |
| requestId |
string |
The request ID. |
7D497816-607C-5B67-97B1-61354B6ACB2B |
| Features |
array<object> |
The list of returned features. |
|
|
object |
An object that represents a feature. |
||
| Name |
string |
The name of the feature. |
f1 |
| Type |
string |
The data type of the feature. |
STRING |
| FeatureViewId |
string |
The ID of the parent feature view. |
1 |
| FeatureViewName |
string |
The name of the parent feature view. |
fv1 |
| Owner |
string |
The owner of the feature. |
123456 |
| ModelFeatureCount |
integer |
The number of model features that reference this feature. |
10 |
| AliasNames |
string |
A comma-separated list of aliases for the feature. |
age1,age2 |
| GmtCreateTime |
string |
The time the feature was created, in ISO 8601 format. |
2021-12-15T23:24:33.132+08:00 |
Examples
Success response
JSON format
{
"TotalCount": 10,
"requestId": "7D497816-607C-5B67-97B1-61354B6ACB2B",
"Features": [
{
"Name": "f1",
"Type": "STRING",
"FeatureViewId": "1",
"FeatureViewName": "fv1",
"Owner": "123456",
"ModelFeatureCount": 10,
"AliasNames": "age1,age2",
"GmtCreateTime": "2021-12-15T23:24:33.132+08:00"
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.