API标准及多语言预置SDK
本产品（PaiRecService/2022-12-13）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
实例管理
|
API |
标题 |
API概述 |
| ListInstances | 获取实例列表 | 获取PAIRec实例的列表。 |
| GetInstance | 获取实例详细信息 | 获取指定PAIRec实例的详细信息。 |
召回管理
|
API |
标题 |
API概述 |
| 召回管理配置 | 召回管理配置 | |
| CreateRecallManagementConfig | 创建召回管理配置 | 用于初始化召回管理的配置，包括实例ID、用户信息及网络设置。 |
| UpdateRecallManagementConfig | 更新召回管理配置 | 用于更新召回管理的初始化配置，包括实例ID、密码及网络配置等信息。 |
| GetRecallManagementConfig | 获取召回管理配置 | 获取召回管理配置。 |
| 召回管理表 | 召回管理表 | |
| CreateRecallManagementTable | 创建召回管理表 | 用于创建一个新的召回管理表，支持多种数据源和配置选项。 |
| ListRecallManagementTables | 获取召回管理表列表 | 查询指定实例下的召回管理表信息，支持分页和排序。 |
| UpdateRecallManagementTable | 更新召回管理数据表 | 用于更新指定ID的召回管理表的相关配置信息。 |
| GetRecallManagementTable | 获取召回管理数据表详情 | 查询指定召回管理表的详细信息，包括表结构和配置等。 |
| DeleteRecallManagementTable | 删除召回管理数据表 | 此API用于根据指定的数据表ID和实例ID删除召回管理数据表。 |
| PublishRecallManagementTable | 同步召回管理表 | 将MaxCompute表同步到召回引擎中，支持分区发布和模式选择。 |
| ListRecallManagementTableVersions | 获取召回管理表版本列表 | 此API用于查询指定召回管理表的所有版本信息。 |
| QueryRecallManagementTableRecords | 查询召回管理表数据 | 获取指定召回管理表中的记录列表。 |
| ExportRecallManagementTable | 导出召回管理数据表 | 将召回引擎中的指定表导出到MaxCompute项目中。 |
| 召回管理任务 | 召回管理任务 | |
| GetRecallManagementJob | 获取召回管理任务详情 | 查询特定召回管理任务的详细信息，包括状态、日志等。 |
| ListRecallManagementJobs | 获取召回管理任务列表 | 查询指定条件下的召回管理任务列表。 |
| 召回管理服务 | 召回管理服务 | |
| 召回服务 | 召回服务 | |
| CreateRecallManagementService | 创建召回管理服务 | 此API用于创建一个新的召回管理服务。 |
| ListRecallManagementServices | 获取召回管理服务列表 | 此API用于查询指定实例下的召回管理服务列表。 |
| UpdateRecallManagementService | 更新召回管理服务 | 用于更新指定召回管理服务的信息，包括实例ID和描述。 |
| GetRecallManagementService | 获取召回管理服务详情 | 查询指定召回管理服务的详细信息，包括状态、版本等。 |
| DeleteRecallManagementService | 删除召回管理服务 | 用于删除指定的召回管理服务。 |
| OnlineRecallManagementService | 上线召回管理服务 | 用于将指定的召回管理服务上线。 |
| OfflineRecallManagementService | 下线召回管理服务 | 用于将指定的召回管理服务设置为离线状态。 |
| ChangeRecallManagementServiceVersion | 更改召回管理服务版本 | 此API用于更新指定召回管理服务的版本。 |
| 召回服务版本 | 召回服务版本 | |
| CreateRecallManagementServiceVersion | 创建召回管理服务版本 | 用于创建一个新的召回管理服务版本，支持配置多种召回策略。 |
| ListRecallManagementServiceVersions | 召回管理服务版本列表 | 获取指定召回管理服务下的所有版本信息。 |
| GetRecallManagementServiceVersion | 获取召回管理服务版本详情 | 获取召回管理服务版本详情。 |
| DeleteRecallManagementServiceVersion | 删除召回管理服务版本 | 用于删除指定的召回管理服务版本。 |
| 召回服务版本配置 | 召回服务版本配置 | |
| CreateRecallManagementServiceVersionConfig | 创建召回管理服务版本配置 | 用于创建指定召回管理服务版本的配置，包括召回和归并设置。 |
| UpdateRecallManagementServiceVersionConfig | 更新召回管理服务版本配置 | 用于更新指定召回管理服务版本的配置信息。 |
| GetRecallManagementServiceVersionConfig | 获取召回管理服务版本配置 | 此API用于查询特定召回管理服务版本的配置详细信息。 |
| DeleteRecallManagementServiceVersionConfig | 删除召回管理服务版本配置 | 此API用于删除指定的召回管理服务版本配置。 |
数据资源管理
|
API |
标题 |
API概述 |
| ListInstanceResourceSchemas | 获取实例资源下的Schema | 此API用于查询指定实例和资源下的所有Schema信息。 |
| ListInstanceResourceTables | 获取实例资源下数据表列表 | 此API用于查询指定实例和数据源下的所有数据表。 |
| CheckInstanceResources | 检查资源状态 | 检测实例下配置的资源的连接状态。 |
| UpdateInstanceResource | 更新资源信息 | 更新指定实例下指定资源的信息。 |
| GetInstanceResourceTable | 获取资源下表信息 | 获取数据源下数据表的列表。 |
| ListInstanceResources | 获取资源列表 | 获取实例下配置的资源列表。 |
| GetInstanceResource | 获取资源详细信息 | 获取指定实例下指定资源的详细信息。 |
| DeleteInstanceResource | 删除资源配置 | 删除指定实例下的指定配置资源。 |
| CreateInstanceResource | 创建配置资源 | 为指定实例配置创建新的配置资源。 |
场景管理
|
API |
标题 |
API概述 |
| CreateScene | 创建场景 | 创建一个场景，在场景下可进行指标、实验分析。 |
| DeleteScene | 删除场景 | 删除指定场景。 |
| UpdateScene | 更新场景 | 更新场景信息，例如更新场景的名称、描述。 |
| ListScenes | 获取场景列表 | 获取场景列表。 |
| GetScene | 获取场景详细信息 | 获取指定场景的详细信息。 |
算法定制
|
API |
标题 |
API概述 |
| 数据诊断 | 数据诊断 | |
| CreateDataDiagnosis | 创建数据诊断任务 | 用于创建不同类型的数据诊断任务，支持多种分析类型。 |
| ListDataDiagnoses | 获取数据诊断列表 | 查询指定实例下的数据诊断任务列表。 |
| UpdateDataDiagnosis | 更新数据诊断信息 | 用于更新指定的数据诊断任务配置信息。 |
| GetDataDiagnosis | 获取数据诊断详情 | 通过数据诊断任务ID和实例ID获取详细的数据诊断信息。 |
| DeleteDataDiagnosis | 删除数据诊断 | 根据指定的数据诊断ID和实例ID删除数据诊断配置。 |
| CreateDataDiagnosisJobs | 创建数据诊断任务 | 用于创建指定时间段内的数据诊断（重跑）任务。 |
| ListDataDiagnosisJobs | 获取数据诊断任务列表 | 查询指定实例下的数据诊断任务及其状态。 |
| ListDataDiagnosisReports | 获取数据诊断报告 | 通过指定参数获取特定时间段内的数据诊断报告。 |
| QueryDataDiagnosisStatistics | 数据诊断统计查询 | 获取指定数据诊断在某时间范围内的统计信息。 |
| 算法定制 | 算法定制 | |
| GenerateAlgorithmCustomizationScript | 部署算法定制 | 生成算法定制脚本 |
实验室管理
|
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 | 上线实验 | 将指定实验发布上线。 |
参数管理
|
API |
标题 |
API概述 |
| CreateParam | 创建参数 | 创建一个参数。通过对参数进行管理，无需修改引擎配置、发布变更，即可对服务读取的变量进行修改，提高灵活性。 |
| DeleteParam | 删除参数 | 删除指定参数。 |
| UpdateParam | 更新参数 | 更新指定参数的信息，例如更新参数的值。 |
| ListParams | 获取参数列表 | 获取参数列表。 |
人群管理
|
API |
标题 |
API概述 |
| CreateCrowd | 创建人群 | 创建一个人群，用于表示用户群体。 |
| CreateSubCrowd | 创建子人群 | 在指定人群下创建子人群。 |
| DeleteCrowd | 删除人群 | 删除指定人群。 |
| DeleteSubCrowd | 删除子人群 | 删除指定子人群。 |
| UpdateCrowd | 更新人群 | 更新指定人群信息，例如更新人群的名称、描述。 |
| ListCrowds | 获取人群列表 | 获取人群列表。 |
| ListCrowdUsers | 获取人群下用户列表 | 获取指定人群所包含的所有用户，包括人群下的子人群内的用户。 |
| ListSubCrowds | 获取子人群列表 | 获取指定人群下的子人群列表。 |
| GetSubCrowd | 获取子人群详细信息 | 获取指定子人群的详细信息。 |
数据表管理
|
API |
标题 |
API概述 |
| UpdateTableMeta | 更新数据表 | 更新数据表。 |
| ListTableMetas | 获取数据表列表 | 获取数据表列表。 |
| GetTableMeta | 获取数据表 | 获取数据表详细信息。 |
| DeleteTableMeta | 删除数据表 | 删除数据表。 |
| CreateTableMeta | 创建数据表 | 创建数据表。 |
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 | 同步特征一致性检查任务重放日志 | 同步特征一致性检查任务重放日志。 |
引擎配置管理
|
API |
标题 |
API概述 |
| DeleteEngineConfig | 删除引擎配置 | 删除某个引擎配置。 |
| UpdateEngineConfig | 更新引擎配置 | 对某个引擎配置进行更新。 |
| ListEngineConfigs | 获取引擎配置列表 | 获取引擎配置列表。 |
| GetEngineConfig | 获取引擎配置详情 | 获取引擎配置详情。 |
| CreateEngineConfig | 创建引擎配置 | 创建引擎配置。 |
| CloneEngineConfig | 克隆引擎配置 | 克隆引擎配置。 |
| ApplyEngineConfig | 发布引擎配置 | 发布引擎配置。 |
服务管理
|
API |
标题 |
API概述 |
| GetService | 获取服务详情 | 获取服务详情。 |
流量调控
|
API |
标题 |
API概述 |
| 流量调控任务 | 流量调控任务 | |
| CreateTrafficControlTask | 创建流量调控任务 | 用于创建新的流量调控任务，支持多种条件设置和目标配置。 |
| ListTrafficControlTasks | 获取流量调控任务列表 | 查询指定条件下的流量调控任务信息。 |
| UpdateTrafficControlTask | 更新流量调控任务 | 用于更新指定的流量调控任务，包括其配置和目标。 |
| GetTrafficControlTask | 获取流量调控任务详情 | 查询指定ID的流量调控任务的具体信息。 |
| DeleteTrafficControlTask | 删除流量调控任务 | 用于删除指定的流量调控任务。 |
| CloneTrafficControlTask | 克隆流量调控任务 | 用于复制指定的流量调控任务到新的实例中。 |
| CheckTrafficControlTaskExpression | 检查流量调控任务表达式 | 验证给定的流量调控任务表达式是否有效。 |
| ReleaseTrafficControlTask | 发布流量调控任务 | 用于发布指定实例和环境下的流量调控任务。 |
| StartTrafficControlTask | 开启流量调控任务 | 用于启动指定ID的流量调控任务，适用于不同环境下的实例。 |
| StopTrafficControlTask | 停止流量调控任务 | 用于停止指定实例和环境下的流量调控任务。 |
| GenerateTrafficControlTaskCode | 生成流量调控任务代码 | 根据给定的流量调控任务ID和实例信息，生成相应的Flink代码。 |
| GetTrafficControlTaskTraffic | 获取流量调控任务详情 | 查询指定流量调控任务的流量分配情况。 |
| UpdateTrafficControlTaskTraffic | 更新流量调控任务流量 | 用于更新指定流量调控任务的流量参数，包括目标流量和实际流量等。 |
| DeployTrafficControlTaskCode | 部署流量调控任务代码 | 用于在指定环境中部署流量调控任务的Flink代码。 |
| QueryTrafficControlTaskDeployResult | 查询流量调控任务部署结果 | 获取指定流量调控任务在特定环境下的部署状态和相关信息。 |
| QueryTrafficControlTaskItemReport | 查询流量调控任务单品报表 | 用于获取指定流量调控任务下的单品调控详情报表。 |
| 流量调控目标 | 流量调控目标 | |
| CreateTrafficControlTarget | 创建流量调控目标 | 用于创建新的流量调控目标，支持设置调控条件、事件及目标值等参数。 |
| UpdateTrafficControlTarget | 更新流量调控目标 | 用于修改已有的流量调控目标配置，包括调控时间、条件及目标值等。 |
| GetTrafficControlTarget | 获取流量调控目标详情 | 查询指定ID的流量调控目标的具体信息。 |
| DeleteTrafficControlTarget | 删除流量调控目标 | 此API用于根据指定ID删除特定的流量调控目标。 |
| StartTrafficControlTarget | 开启流量调控任务 | 此API用于启动指定ID的流量调控任务。 |
| StopTrafficControlTarget | 停止流量调控目标 | 此API用于停止指定的流量调控目标。 |
| SplitTrafficControlTarget | 分隔流量调控的目标值 | 拆分流量调控各个时间段的目标值。 |
| ListTrafficControlTargetTrafficHistory | 获取流量调控任务历史 | 查询指定流量调控目标的历史流量变更记录。 |
| QueryTrafficControlTargetItemReportDetail | 查询流量调控目标单品详情 | 获取指定日期内特定环境下的流量调控目标单品调控详情。 |
其他
|
API |
标题 |
API概述 |
| ChatConversation | 发送对话消息 | 向智能体发送对话消息，支持SSE，可创建新会话或在已有会话中继续对话。 |
该文章对您有帮助吗？