全量资源管理API接口参考-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

API标准及多语言预置SDK

本产品（PaiFeatureStore/2023-06-21）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

实例管理

API	标题	API概述
CreateInstance	创建实例	创建 FeatureStore 实例。同一账号下已存在运行中或初始化中的实例时，返回已有实例 ID（幂等）。
ListInstances	获取实例列表	列出当前账号下的 FeatureStore 实例，支持按状态过滤。
GetInstance	获取实例详细信息	获取 FeatureStore 实例详细信息。
CheckInstanceDatasource	检查数据源连通性	检查数据源连通性。

数据源管理

API	标题	API概述
CreateDatasource	创建数据源	在 FeatureStore 实例下注册数据源。数据源为项目提供离线或在线存储。
ListDatasources	获取数据源列表	列出 FeatureStore 实例下的数据源，支持按工作空间、类型和名称过滤。
GetDatasource	获取数据源详细信息	获取数据源详细信息，包括类型、连接信息和配置。
UpdateDatasource	更新数据源	更新数据源信息。数据源类型和工作空间不可更改。
DeleteDatasource	删除数据源	从 FeatureStore 实例中删除数据源。
ListDatasourceFeatureViews	获取数据源下所有特征视图信息	获取数据源下所有特征视图信息。
ListDatasourceTables	获取数据源下的数据表列表	列出数据源中的表。仅支持 MaxCompute 类型数据源。
GetDatasourceTable	获取数据源下指定表的详细信息	获取数据源中指定表的字段信息。仅支持 MaxCompute 类型数据源。

大模型配置信息管理

API	标题	API概述
CreateLLMConfig	创建大模型配置信息	创建 LLM 调用配置，配置 Embedding 模型的调用参数和密钥。创建时会验证 ApiKey 和 Model 是否可用，DashScope 模型的 EmbeddingDimension 需符合模型固定的合法维度。
ListLLMConfigs	列举大模型配置信息	查询 LLM 调用配置列表。
GetLLMConfig	获取大模型配置信息	查询 LLM 调用配置详情。
UpdateLLMConfig	更新大模型配置信息	更新 LLM 调用配置。ApiKey 不传则保留原有密钥，更新时会重新验证模型可用性和参数合法性。
DeleteLLMConfig	删除大模型配置信息	删除 LLM 调用配置。被特征视图引用的配置无法删除，需先删除关联的特征视图。

项目管理

API	标题	API概述
CreateProject	创建项目	创建 FeatureStore 项目。项目是特征实体、特征视图、模型特征的容器。
UpdateProject	更新项目信息	更新项目的描述。
ListProjects	获取项目列表	列出 FeatureStore 实例下的项目，支持按名称、工作空间和所有者过滤。
GetProject	获取项目详细信息	获取项目详细信息，包括数据源绑定和资源计数。
DeleteProject	删除项目	删除 FeatureStore 项目。
ListProjectFeatures	获取项目下所有特征信息	检索项目下所有特征字段，支持按名称、别名和特征视图过滤，支持排序和分页。返回结果包含每个特征的类型、所属特征视图和被模型特征引用的次数。
ListProjectFeatureViews	获取特征视图与特征列表	列出项目下所有特征视图及其可选的特征字段，用于为 CreateModelFeature 和 UpdateModelFeature 选取特征视图和字段。
GetProjectFeatureEntity	获取项目下指定特征实体详细信息	根据名称，获取项目下指定特征实体的详细信息。

特征实体

API	标题	API概述
CreateFeatureEntity	创建特征实体	创建特征实体。特征实体定义关联键，多个特征视图通过关联键关联到同一特征实体，实现特征拼接。
ListFeatureEntities	获取特征实体列表	列出 FeatureStore 实例下的特征实体，支持按项目、名称、所有者和父特征实体过滤。
GetFeatureEntity	获取特征实体详细信息	获取特征实体详细信息。
DeleteFeatureEntity	删除特征实体	删除特征实体。

特征视图

API	标题	API概述
CreateFeatureView	创建特征视图	创建特征视图，支持创建离线、实时、行为序列三种类型的特征视图。特征视图通过字段定义特征结构，并关联到特征实体。
ListFeatureViews	获取特征视图列表	列出特征视图，支持按项目、名称、类型、标签和特征名过滤。
GetFeatureView	获取特征视图详细信息	获取特征视图详细信息，包括字段定义、数据源绑定和同步状态。
UpdateFeatureView	更新特征视图	更新特征视图。
DeleteFeatureView	删除特征视图	删除特征视图。被模型特征引用的特征视图无法删除，需先删除关联的模型特征。
PublishFeatureViewTable	发布特征视图下表数据	创建特征视图的数据同步任务，把离线表数据同步到对应的在线存储。
WriteFeatureViewTable	向指定特征视图写表	从 URL 导入数据到特征视图的离线表，异步执行。
ListFeatureViewOnlineFeatures	获取特征视图下的在线特征数据	根据 Join ID 查询特征视图的在线特征数据，返回每个 Join ID 对应的特征字段键值对。
ListFeatureViewRelationships	获取特征视图血缘关系	查询特征视图的血缘关系，返回引用该特征视图的模型特征列表。
ListFeatureViewFieldRelationships	获取特征字段血缘关系	查询特征视图指定字段的血缘关系，返回引用该字段的模型特征列表及在线/离线表名。

Label表

API	标题	API概述
CreateLabelTable	创建label表	创建 Label 表。Label 表定义标签数据的表结构，供模型特征引用。
ListLabelTables	获取label表列表	列出 Label 表，支持按项目、名称、所有者和 ID 过滤。
GetLabelTable	获取label表详细信息	获取 Label 表详细信息，包括字段定义和关联模型。
UpdateLabelTable	更新label表	更新 Label 表字段属性。只能修改已有字段的属性，不能新增、删除字段或修改字段名和类型。
DeleteLabelTable	删除label表	删除 Label 表。被模型特征引用的 Label 表无法删除，需先删除关联的模型特征。

模型特征

API	标题	API概述
CreateModelFeature	创建模型特征	创建模型特征。模型特征关联一张 Label 表和一组特征视图字段，用于生成模型训练所需的训练集表和指定模型推理使用的特征集合。
ListModelFeatures	获取模型特征列表	列出模型特征，支持按项目、名称、创建人和 ID 过滤，支持排序和分页。
GetModelFeature	获取模型特征详细信息	获取模型特征详细信息，包括所选特征列表、血缘关系和训练集导出脚本。
UpdateModelFeature	更新模型特征	更新模型特征的信息，包括关联的 Label 表、所选特征字段和冲突优先级策略。更新为全量替换，传入的 Features 会覆盖已有值。
DeleteModelFeature	删除模型特征	删除模型特征，同时删除关联的训练集表。
ExportModelFeatureTrainingSetTable	导出模型特征的训练集表	导出模型特征的训练集表。配置 Label 表输入、各特征视图的数据源分区和训练集输出分区，创建导出任务。
ListModelFeatureAvailableFeatures	获取注册FG特征时模型特征下可选的所有特征	获取注册FG特征时模型特征下可选的所有特征。
UpdateModelFeatureFGFeature	更新模型特征的FG特征配置信息	更新模型特征的FG特征配置信息。
GetModelFeatureFGFeature	获取模型特征的FG特征配置信息	获取模型特征的FG特征配置信息。
GetModelFeatureFGInfo	获取模型特征的fg.json文件配置信息	获取模型特征的fg.json文件配置信息。
CheckModelFeatureFGFeature	检查模型特征FG配置内容是否正确	检查FG配置内容是否正确，是否满足所有规则。

任务管理

API	标题	API概述
ListTasks	获取任务列表	列出实例下的异步任务，支持按项目、对象类型、状态等条件过滤，支持分页。
GetTask	获取任务详细信息	获取异步任务详情。
StopTask	停止任务	停止异步任务。仅 Initializing 或 Running 状态的任务可以停止。
ListTaskLogs	获取任务日志	获取异步任务的执行日志，支持分页。