本产品（
人工智能平台PAI-推荐全链路深度定制开发平台/2022-12-13）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
引擎管理
| API | 标题 | API概述 |
|---|---|---|
| DeleteEngineConfig | 删除引擎配置 | 删除某个引擎配置。 |
| UpdateEngineConfig | 更新引擎配置 | 对某个引擎配置进行更新。 |
| ListEngineConfigs | 获取引擎配置列表 | 获取引擎配置列表。 |
| GetEngineConfig | 获取引擎配置详情 | 获取引擎配置详情。 |
| CreateEngineConfig | 创建引擎配置 | 创建引擎配置。 |
| CloneEngineConfig | 克隆引擎配置 | 克隆引擎配置。 |
| ApplyEngineConfig | 发布引擎配置 | 发布引擎配置。 |
实例管理
| API | 标题 | API概述 |
|---|---|---|
| ListInstances | 获取实例列表 | 获取PAIRec实例的列表。 |
| GetInstance | 获取实例详细信息 | 获取指定PAIRec实例的详细信息。 |
数据资源管理
| API | 标题 | API概述 |
|---|---|---|
| CheckInstanceResources | 检查资源状态 | 检测实例下配置的资源的连接状态。 |
| UpdateInstanceResource | 更新资源信息 | 更新指定实例下指定资源的信息。 |
| GetInstanceResourceTable | 获取资源下表信息 | 获取数据源下数据表的列表。 |
| ListInstanceResources | 获取资源列表 | 获取实例下配置的资源列表。 |
| GetInstanceResource | 获取资源详细信息 | 获取指定实例下指定资源的详细信息。 |
| DeleteInstanceResource | 删除资源配置 | 删除指定实例下的指定配置资源。 |
| CreateInstanceResource | 创建配置资源 | 为指定实例配置创建新的配置资源。 |
数据表管理
| API | 标题 | API概述 |
|---|---|---|
| UpdateTableMeta | 更新数据表 | 更新数据表。 |
| ListTableMetas | 获取数据表列表 | 获取数据表列表。 |
| GetTableMeta | 获取数据表 | 获取数据表详细信息。 |
| DeleteTableMeta | 删除数据表 | 删除数据表。 |
| CreateTableMeta | 创建数据表 | 创建数据表。 |
场景管理
| API | 标题 | API概述 |
|---|---|---|
| CreateScene | 创建场景 | 创建一个场景，在场景下可进行指标、实验分析。 |
| DeleteScene | 删除场景 | 删除指定场景。 |
| UpdateScene | 更新场景 | 更新场景信息，例如更新场景的名称、描述。 |
| ListScenes | 获取场景列表 | 获取场景列表。 |
| GetScene | 获取场景详细信息 | 获取指定场景的详细信息。 |
参数管理
| API | 标题 | API概述 |
|---|---|---|
| CreateParam | 创建参数 | 创建一个参数。通过对参数进行管理，无需修改引擎配置、发布变更，即可对服务读取的变量进行修改，提高灵活性。 |
| DeleteParam | 删除参数 | 删除指定参数。 |
| UpdateParam | 更新参数 | 更新指定参数的信息，例如更新参数的值。 |
| ListParams | 获取参数列表 | 获取参数列表。 |
人群管理
| API | 标题 | API概述 |
|---|---|---|
| CreateCrowd | 创建人群 | 创建一个人群，用于表示用户群体。 |
| CreateSubCrowd | 创建子人群 | 在指定人群下创建子人群。 |
| DeleteCrowd | 删除人群 | 删除指定人群。 |
| DeleteSubCrowd | 删除子人群 | 删除指定子人群。 |
| UpdateCrowd | 更新人群 | 更新指定人群信息，例如更新人群的名称、描述。 |
| ListCrowds | 获取人群列表 | 获取人群列表。 |
| ListCrowdUsers | 获取人群下用户列表 | 获取指定人群所包含的所有用户，包括人群下的子人群内的用户。 |
| ListSubCrowds | 获取子人群列表 | 获取指定人群下的子人群列表。 |
| GetSubCrowd | 获取子人群详细信息 | 获取指定子人群的详细信息。 |
实验室管理
| API | 标题 | API概述 |
|---|---|---|
| CreateLaboratory | 创建实验室 | 创建一个实验室，实验室是一组流量的集合，在实验室下可开展实验。 |
| DeleteLaboratory | 删除实验室 | 删除指定实验室。 |
| UpdateLaboratory | 更新实验室 | 更新实验室信息，例如更新实验室的名称。 |
| ListLaboratories | 获取实验室列表 | 获取某个场景下的实验室列表。 |
| GetLaboratory | 获取实验室详细信息 | 获取指定实验室的详细信息。 |
| OnlineLaboratory | 上线实验室 | 将指定实验室进行发布上线，以开展实验分析。 |
| OfflineLaboratory | 下线实验室 | 将指定实验室下线。 |
| CloneLaboratory | 克隆实验室 | 将指定实验室克隆到指定环境，克隆时需指定是否克隆实验室下的实验组。 |
层管理
| API | 标题 | API概述 |
|---|---|---|
| CreateLayer | 创建层 | 在指定实验室下创建一个层，用于分层实验。层与层之间正交，可独立开展实验，避免流量饥饿问题。 |
| DeleteLayer | 删除层 | 删除指定层。 |
| UpdateLayer | 更新层 | 更新指定层的信息，例如更新层的名称、描述。 |
| ListLayers | 获取层列表 | 获取某个实验室下的层列表。 |
| GetLayer | 获取层详细信息 | 获取指定层的详细信息。 |
实验组管理
| API | 标题 | API概述 |
|---|---|---|
| CreateExperimentGroup | 创建实验组 | 在指定层下，创建一个实验组。可按照实验类型划分实验组，从而按照实验组观测实验整体效果表现。 |
| DeleteExperimentGroup | 删除实验组 | 删除指定实验组。 |
| UpdateExperimentGroup | 更新实验组 | 更新指定实验组的信息，例如更新实验组的名称、描述。 |
| ListExperimentGroups | 获取实验组列表 | 获取实验组列表。 |
| GetExperimentGroup | 获取实验组详细信息 | 获取指定实验组的详细信息。 |
| CloneExperimentGroup | 克隆实验组 | 向指定环境克隆一个实验组。 |
| OnlineExperimentGroup | 上线实验组 | 上线指定实验组。 |
| OfflineExperimentGroup | 下线实验组 | 下线指定实验组。 |
实验管理
| API | 标题 | API概述 |
|---|---|---|
| CreateExperiment | 创建实验 | 在指定实验组下创建一个实验。 |
| DeleteExperiment | 删除实验 | 删除指定实验。 |
| UpdateExperiment | 更新实验 | 更新指定实验的信息，例如更新实验的名称。 |
| GetExperiment | 获取实验详细信息 | 获取指定实验的详细信息。 |
| ListExperiments | 获取实验列表 | 获取指定实验组下的实验列表。 |
| CloneExperiment | 克隆实验 | 对指定实验进行克隆。 |
| OfflineExperiment | 下线实验 | 将指定实验下线。 |
| PushAllExperiment | 推全实验 | 对于效果较优且稳定的实验，可对该实验进行推全。对某个实验推全后，该实验所属的实验组将结束生命周期，不再支持继续实验。平台会生成一个新的实验组，被推全的实验将在该实验组下占有全额的流量。 |
| OnlineExperiment | 上线实验 | 将指定实验发布上线。 |
AB指标管理
| API | 标题 | API概述 |
|---|---|---|
| UpdateABMetric | 更新AB指标 | 更新AB实验指标。 |
| CreateABMetric | 创建AB指标 | 创建AB实验指标。 |
| ListABMetrics | 获取AB指标列表 | 获取AB实验指标列表。 |
| GetABMetric | 获取AB指标详细信息 | 获取AB实验指标详细信息。 |
| DeleteABMetric | 删除AB指标 | 删除指定AB实验指标。 |
AB指标组管理
| API | 标题 | API概述 |
|---|---|---|
| ReportABMetricGroup | 查询指标组报表 | 查询指标组的报表。 |
| UpdateABMetricGroup | 更新指标组 | 更新AB实验指标组。 |
| CreateABMetricGroup | 创建指标组 | 创建AB实验指标组。 |
| ListABMetricGroups | 获取指标组列表 | 获取AB实验指标组列表。 |
| GetABMetricGroup | 获取指标组详细信息 | 获取AB实验指标组详细信息。 |
| DeleteABMetricGroup | 删除指标组 | 删除AB实验指标组。 |
计算任务管理
| API | 标题 | API概述 |
|---|---|---|
| ListCalculationJobs | 获取计算任务列表 | 获取计算任务列表。 |
| GetCalculationJob | 获取计算任务 | 获取指定计算任务详细信息。 |
| CreateCalculationJobs | 创建计算任务 | 批量创建计算任务。 |
特征一致性检查任务管理
| API | 标题 | API概述 |
|---|---|---|
| CreateFeatureConsistencyCheckJobConfig | 创建特征一致性检查任务配置 | 创建特征一致性检查任务配置。 |
| CreateFeatureConsistencyCheckJob | 创建特征一致性检查任务 | 创建特征一致性检查任务。 |
| UpdateFeatureConsistencyCheckJobConfig | 更新特征一致性检查任务配置 | 更新特征一致性检查任务配置详细信息，例如更新名称。 |
| ListFeatureConsistencyCheckJobConfigs | 获取特征一致性检查任务配置列表 | 获取特征一致性检查任务配置列表。 |
| GetFeatureConsistencyCheckJobConfig | 获取特征一致性检查任务配置详情 | 获取特征一致性检查任务配置详情。 |
| ListFeatureConsistencyCheckJobs | 获取特征一致性检查任务列表 | 获取特征一致性检查任务列表。 |
| GetFeatureConsistencyCheckJob | 获取特征一致性检查任务详情 | 获取特征一致性检查任务详情。 |
| ListFeatureConsistencyCheckJobFeatureReports | 获取特征一致性检查任务的特征报表 | 获取特征一致性检查任务的特征报表。 |
| ListFeatureConsistencyCheckJobScoreReports | 获取特征一致性检查任务分数报表 | 获取特征一致性检查任务分数报表。 |
| CloneFeatureConsistencyCheckJobConfig | 克隆特征一致性检查任务配置 | 克隆特征一致性检查任务配置。 |
| TerminateFeatureConsistencyCheckJob | 取消指定特征一致性检查正在运行中的任务 | 取消指定特征一致性检查正在运行中的任务。 |
| BackflowFeatureConsistencyCheckJobData | 特征一致性检查数据回流 | 对指定特征一致性检查任务配置下，最近一次创建的任务进行数据回流。 |
| SyncFeatureConsistencyCheckJobReplayLog | 同步特征一致性检查任务重放日志 | 同步特征一致性检查任务重放日志。 |