本产品（Airec/2020-11-26）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
实例
|
API |
标题 |
API概述 |
| CreateInstance | 创建一个预付费实例 | 创建一个智能推荐实例。 |
| ModifyInstance | 修改实例 | 修改指定实例配置。 |
| DescribeInstance | 查询实例信息 | 通过指定的实例ID查看实例详情。 |
| ListInstance | 查询实例列表 | 查询一个或多个实例的详细信息。 |
| RunInstance | 运行实例 | 启动实例开始全量数据导入任务。 |
| UpgradeInstance | 更新实例配额信息 | 更新指定实例配额（Quota）信息。 |
| ValidateInstance | 校验指定实例有效性 | 校验指定实例信息的有效性。 |
| DowngradeInstance | 降低指定实例配额 (Quota)信息 | 降低指定实例配额 （Quota）信息。 |
外部数据源
|
API |
标题 |
API概述 |
| CreateExtraDataSource | 创建数据源 | 创建一个数据源。 |
| DeleteExtraDataSource | 删除数据源 | 删除数据源。 |
| ListExtraDataSources | 获取数据源 | 获取特征、样本数据源列表。 |
数据集
|
API |
标题 |
API概述 |
| DeleteDataSet | 删除指定实例的指定数据集版本 | 删除指定实例的指定数据集版本。 |
| AttachDataset | 开启数据训练 | 指定实例的指定数据集版本提供在线服务。 |
| DescribeDataSetMessage | DescribeDataSetMessage | 获取指定实例的指定数据集版本数据错误详情。 |
| ListDataSet | 获取数据集列表 | 获取指定实例的数据集列表。 |
实验
|
API |
标题 |
API概述 |
| DeleteExperiment | 删除实验 | 删除一个实验。 |
| EnableExperiment | 启用实验 | 启用实验功能。 |
| UpdateExperimentBasicInfo | 更新实验基本信息 | 更新实验基本信息。 |
| UpdateExperimentConfig | 更新实验配置 | 更新一个实验配置信息。 |
| UpdateExperimentStatus | 更新实验状态 | 更新实验状态。 |
| DescribeBaseExperiment | 获取基础实验 | 获取基础实验。 |
| DescribeExperiment | DescribeExperiment | 查看一个实验详情。 |
| DescribeExperimentEnv | 获取实验环境 | 查看实验场景信息。 |
| DescribeExperimentEnvProgress | 获取实验环境进度 | 查看实验场景开通状态。 |
| ListExperiments | ListExperiments | 列出实验清单，说明：只展示实验基本信息，不展示算法配置，暂不提供分页功能。 |
| CloneExperiment | 克隆实验 | 克隆实验。 |
流量调控
|
API |
标题 |
API概述 |
| ListFlowControlTaskReports | 流量调控任务曝光分析 | 流量调控任务曝光分析。 |
| ListFlowControlTaskInvalidItems | 查询失效物品清单 | 查询当前流量调控任务中失效物品清单，返回物品ID(ItemId)与物品类型(ItemType)。 |
| ListFlowControlTaskItems | 流量调控预览 | 流量调控预览。 |
| CreateFlowControlTask | 创建流量调控任务 | 创建流控任务。 |
| GetFlowControlTask | 获取流量调控任务详情 | 获取流量调控任务详情。 |
| DeleteFlowControlTask | 删除流量调控任务 | 删除流量调控任务。 |
| ListFlowControlTask | 获取流量调控任务列表，按照创建时间倒序返回 | 查询流控任务列表。 |
| ListFlowControlTaskItemReports | 流量调控曝光排名物品/失效物品查询 | 流量调控曝光排名物品/失效物品查询。 |
| ListFlowControlTaskReference | 流量调控参考数据 | 流量调控参考数据。 |
| ModifyFlowControlTask | 修改流量控制任务，目前只支持草稿态和发布失败状态的任务修改配置信息 | 流调任务修改接口。 |
| StopFlowControlTask | 结束流量调控任务 | 结束流量调控任务。 |
| PublishFlowControlTask | 发布流量调控任务 | 发布流量调控任务。 |
召回表
|
API |
标题 |
API概述 |
| CreateFilteringAlgorithm | 创建召回表 | 创建召回表，目前召回表由PAI训练完成导出到odps中，在AIRec中指定ODPS表信息。 |
| DeleteFilteringAlgorithm | 删除召回表 | 删除指定的召回配置及相关索引表信息。 |
| ModifyFilteringAlgorithmMeta | ModifyFilteringAlgorithmMeta | 修改召回表的配置。 |
| DescribeFilteringAlgorithm | 获取召回表 | 根据指定召回表ID 获取某个召回配置信息。 |
| ListFilteringAlgorithms | 获取召回表列表 | 列表显示所有的召回表信息。 |
| OfflineFilteringAlgorithm | 下线召回表 | 下线召回表。 |
排序系统
|
API |
标题 |
API概述 |
| CreateRankingSystem | 创建排序服务 | 创建排序服务。 |
| DeleteRankingSystem | 删除排序服务 | 删除排序服务 |
| ModifyRankingSystem | 修改排序服务 | 修改排序服务。 |
| GetRankingSystem | 获取排序服务详情 | 获取排序服务详情。 |
| GetRankingSystemHistory | 查询排序服务操作记录 | 查询排序服务操作记录。 |
| ListRankingSystems | 获取排序服务列表 | 获取排序服务列表。 |
| ListRankingSystemHistories | 查询服务操作记录列表 | 查询服务操作记录列表。 |
| DeployRankingSystem | 部署排序服务 | 部署/重启部署排序服务，已经部署过的服务，修改配置后必须重启部署，注：若未修改任何参数，则可以不传body。 |
| VerifyRankingSystem | 调试排序服务 | 调试排序服务。 |
| RollbackRankingSystem | 回滚排序服务 | 回滚排序服务。 |
排序模型模版
|
API |
标题 |
API概述 |
| CreateRankingModelTemplate | 创建排序模型模板 | 创建排序模型模板。 |
| DeleteRankingModelTemplate | 删除模型 | 删除模型。 |
| ModifyRankingModelTemplate | 修改排序模型模板 | 修改排序模型模板。 |
| GetRankingModelTemplate | 查看排序模型配置详情 | 查看排序模型配置详情 |
| RunRankingModelTemplate | 启动训练 | 运行排序模型模板 |
排序模型
|
API |
标题 |
API概述 |
| CreateRankingModel | 创建排名模型 | 创建模型。 |
| DeleteRankingModel | 删除排名模型 | 删除排序模型。 |
| DeleteRankingModelVersion | 删除模型版本 | 删除某个模型版本。 |
| ModifyRankingModel | 修改排名模型 | 修改模型信息。 |
| ListRankingModels | 获取排名模型列表 | 查询模型列表。 |
| ListRankingModelTemplates | 查看排序模型模板列表 | 查看排序模型模板列表，按创建时间倒序。 |
| GetRankingModelVersion | 查看排序模型版本详情 | 查看排序模型版本详情，包括评估结果和训练结果 |
| ListRankingModelVersions | 获取排序模型版本 | 获取排序模型版本。 |
| DecribeRankingModel | 获取排序模型 | 获取排序模型。 |
| CheckRankingModelReachable | 测试模型网络联通性 | 测试模型网络联通性。 |
规则
|
API |
标题 |
API概述 |
| CreateRule | 创建规则 | 创建推荐策略运营规则。 |
| ModifyRule | ModifyRule | 修改规则。 |
| ListRules | 获取规则列表 | 查询规则列表。 |
| DescribeRule | 获取规则信息 | 查询一个规则的详细信息。 |
| PublishRule | 发布规则 | 发布一个规则。 |
场景
|
API |
标题 |
API概述 |
| CreateScene | 创建场景 | 校验创建场景的信息。 |
| DeleteScene | 删除场景 | 删除场景。 |
| ModifyScene | 修改场景信息 | 修改场景信息。 |
| DescribeScene | 查询场景详情 | 查询场景详情。 |
| ListScenes | 查询场景列表 | 查询场景列表。 |
样本
|
API |
标题 |
API概述 |
| CreateCustomSample | 创建自定义样本 | 创建自定义样本。 |
| CreateSampleFormatConfig | 创建样本格式化配置 | 创建样本格式化配置。 |
| DeleteSample | 删除样本 | 删除样本。 |
| ModifySample | 修改样本配置 | 修改样本配置。 |
| ListSamples | 获取样本列表 | 获取样本列表。 |
| GetSample | 获取样本详情 | 获取样本详情 |
| CloneSample | 复制创建样本 | 复制创建样本。 |
| GenerateSample | 生成样本 | 生成样本，只针对复制创建的样本。 |
其他
|
API |
标题 |
API概述 |
| CreateCustomAnalysisTask | 创建自定义分析任务 | 创建自定义分析任务。 |
| AttachIndexVersion | AttachIndexVersion | 把指定版本的索引切换到线上。 |
| ModifyDataSource | 修改指定实例的指定数据源信息 | 修改指定表的数据源信息。 |
| ModifyFeatureTable | 修改特征表 | 修改特征表，只支表级别持特征列表的全量修改。 |
| ModifyItems | 修改项目 | 批量操作物品池。 |
| ModifyOfflineStorages | 修改实例的离线存储配置 | 修改实例的离线存储配置。（只支持三张表同时修改）。 |
| StopDataSet | 停止数据集 | 停止指定实例的指定数据集版本。 |
| DescribeCustomAnalysisTask | 查询指定实例的仪表盘自定义分析任务结果 | 查询指定实例的仪表盘自定义分析任务结果 |
| DescribeDefaultAlgorithms | 获取默认算法信息 | 获取默认算法信息。 |
| DescribeLatestTask | 获取最新任务 | 获取最近一次构建的任务。 |
| DescribeQuota | 获取指定实例的配额信息 | 通过指定的实例ID查看实例的配额信息。 |
| DescribeRegions | 查询区域 | 查询可以使用的阿里云区域。 |
| DescribeSceneBucket | DescribeSceneBucket | 查看场景下实验桶分布情况。 |
| DescribeSceneThroughput | 获取场景流量 | 获取场景流量。 |
| DescribeSyncReportDetail | 获取实时数据小时级别报告细节信息 | 获取实时数据小时级别报告细节信息。 |
| DescribeSyncReportOutliers | 获取实时数据报告异常明细 | 获取实时数据报告异常明细。 |
| DescribeUserMetrics | 获取用户指标（转化率信息） | 获取用户指标（转化率信息）。 |
| GetExtraDataSource | 查看其他数据源详情 | 查看其他数据源详情。 |
| ListDashboardDetails | ListDashboardDetails | 通过指定条件查询指定实例的细分指标。 |
| ListDashboardDetailsFlows | 通过指定条件查询实例的细分流量指标 | 通过指定条件查询指定实例的细分流量指标。 |
| ListDashboardMetrics | ListDashboardMetrics | 查询指定实例的整理仪表盘数据。 |
| ListDashboardMetricsFlows | 查询指定实例的整理仪表盘流量数据 | 查询指定实例的整理仪表盘流量数据。 |
| ListFeatureTables | 获取特征表列表 | 获取特征表列表。 |
| ListIndexVersions | 获取索引版本列表 | 根据指定的实例ID，召回表ID获取索引版本列表。目前仅支持显示10条数据（包含3条可以切换的），所以不用翻页，不用过滤。 |
| ListInstanceTask | 查询指定实例的任务列表 | 查询指定实例的任务列表。 |
| ListItems | 获取列表项 | 查询实例物品池。 |
| ListLogs | 获取日志列表 | 该接口用于获取指定实例的日志信息（近七日内）。 |
| ListMixCategories | ListMixCategories | 查询类目列表。 |
| ListOfflineStorages | 查询离线存储 | 查询离线存储。 |
| ListRuleConditions | 查询实例具体的选品规则 | 查询实例具体的选品规则.。 |
| ListRuleTasks | 查询规则的任务状态 | 查询规则的任务状态。 |
| ListSampleFormatConfigs | 获取样本格式化配置列表 | 获取样本格式化配置列表。 |
| ListSceneItems | 获取预览结果 | 获取预览结果。 |
| ListSceneParameters | 获取指定实例全量的渠道和场景信息列表 | 获取指定实例全量的渠道和场景信息列表。 |
| ListUmengAppkeys | 获取友盟 appkey 列表信息 | 获取友盟appkey列表信息。 |
| ListUserClusters | 获取用户集群列表 | 列表显示当前的实例用户cluster。 |
| QueryDataMessage | 查询用户数据表中的更新消息 | 用户数据表中的更新消息查询。 |
| QueryDataMessageStatistics | 查询用户数据表中的更新消息统计数据 | 用户数据表中的更新消息统计数据查询。 |
| QueryExceptionHistory | 异常数据历史分段查询 | 异常数据历史分段查询。 |
| QueryRawData | 用户数据表中的原始数据查询 | 用户数据表中的原始数据查询。 |
| QuerySingleAggregationReport | 单表聚合查询 | 单表聚合查询（数据可能有修改）。 |
| QuerySingleReport | QuerySingleReport | 单表维度分析查询（类型可能会增加）。 |
| QuerySyncReportAggregation | 查询整体数据概览 | 查询整体数据概览。 |
| ListDataSource | 获取指定实例的数据源列表 | 获取指定实例的数据源列表信息。 |
| InitComputingResource | 初始化计算资源 | 初始化计算资源。 |
| PushDocument | 推送文档 | 向指定实例指定表推送文档。 |
| PushIntervention | PushIntervention | 该接口用于向指定实例推送干预数据。 |
| RebuildIndex | 重建索引 | 重建索引。 |
| Recommend | 智能推荐 | 该接口用于获取指定实例的推荐结果。 |
| RefreshFeatureTable | 刷新特征表 | 刷新特征表，根据特征表源更新特征表，刷新策略为以用户源表为准。 |
| RunSampleFormatConfig | 触发样本格式化 | 触发样本格式化。 |
| UnLockIndexVersion | 解锁索引版本 | 解锁召回表的索引版本。 |
| CreateDataDiagnoseTask | 创建数据诊断任务 | 创建数据诊断任务。 |
| GetLatestDataDiagnoseTaskStatus | 获取最新诊断任务状态 | 获取最新诊断任务状态。 |
| ListDataDiagnoseReports | 获取数据诊断报告 | 获取数据诊断报告 （包括用户手动触发的诊断、每天产出的周期报告、数据启动时诊断的报告）。 |
| ListDataDiagnoseSampleDetails | 获取数据诊断报告抽样明细 | 获取数据诊断报告抽样明细。 |
该文章对您有帮助吗？