ListProjects-阿里云帮助中心

Lists projects in a Feature Store instance, filterable by name, workspace, and owner.

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

list

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call the ListInstances operation to obtain the ID.	fs-cn-********

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	No	The ID of the workspace. Call the ListWorkspaces operation to get this ID.	234
Name	string	No	The project name to filter by.	fs1
Owner	string	No	The Alibaba Cloud account ID of the project owner.	134324352****
PageNumber	integer	No	The page number. Starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
Order	string	No	The sort order. Valid values: `Asc`: ascending order. `Desc`: descending order.	Asc
SortBy	string	No	The field to sort the results by.	GmtModifiedTime
ProjectIds	array	No	An array of project IDs to filter by.
	string	No	The ID of the project. To get project IDs, call this operation without this parameter.	3

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	44933189-493B-5C43-A5C6-11EEC2A43520
TotalCount	integer	The total number of projects.	10
Projects	array<object>	The list of projects.
	object	A project.
ProjectId	string	The project ID.	3
Name	string	The project name.	project1
Description	string	The project description.	This is a test.
OfflineDatasourceType	string	The offline data source type.	MaxCompute
OfflineDatasourceId	string	The offline data source ID.	4
OfflineDatasourceName	string	The offline data source name.	datasource1
OnlineDatasourceType	string	The online data source type.	Hologres
OnlineDatasourceId	string	The online data source ID.	5
OnlineDatasourceName	string	The online data source name.	datasource2
OfflineLifecycle	integer	The offline data lifecycle, in days.	10
FeatureEntityCount	integer	The number of feature entities.	10
FeatureViewCount	integer	The number of feature views.	10
ModelCount	integer	The number of models.	5
Owner	string	The project owner.	1232132543543****
GmtCreateTime	string	The creation time.	2021-12-15T23:24:33.132+08:00
GmtModifiedTime	string	The modification time.	2021-12-15T23:24:33.132+08:00
WorkspaceId	string	The workspace ID.	35523

Examples

Success response

JSON format

{
  "RequestId": "44933189-493B-5C43-A5C6-11EEC2A43520",
  "TotalCount": 10,
  "Projects": [
    {
      "ProjectId": "3",
      "Name": "project1",
      "Description": "This is a test.",
      "OfflineDatasourceType": "MaxCompute",
      "OfflineDatasourceId": "4",
      "OfflineDatasourceName": "datasource1",
      "OnlineDatasourceType": "Hologres",
      "OnlineDatasourceId": "5",
      "OnlineDatasourceName": "datasource2",
      "OfflineLifecycle": 10,
      "FeatureEntityCount": 10,
      "FeatureViewCount": 10,
      "ModelCount": 5,
      "Owner": "1232132543543****",
      "GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
      "GmtModifiedTime": "2021-12-15T23:24:33.132+08:00",
      "WorkspaceId": "35523"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.