API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

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

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

自定义签名场景

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

账号与安全准备

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

API目录

API

标题

API概述

RecallRuleAudit 撤回审核 撤回审核。
DescribeAuditDetails 审核详情 审批详情。
ModifyRulePriority 修改策略优先级 策略修改优先级。
UpdateRule 修改策略 更新策略。
UpdateAudit 策略审批 审批。
ModifyRuleStatus 修改策略状态 策略版本申请状态变更。
DescribeRulePageList 策略分页列表 查询策略列表。
DescribeAuditPageList 审核列表 审核列表展示、查询。
DescribeRuleVersionList 策略版本列表 查询策略版本列表。
DescribeAuditConfig 审核配置 审批开关。
UpdateRuleBase 修改策略基础信息 更新策略基础信息。
DescribeRuleDetailByRuleId 查询策略详情 查询策略/版本详情。
ExpressionTest 自定义变量测试 自定义变量测试。
DescribeAllRootVariable 自定义表达式测试时,展示所有的根变量 自定义表达式测试时,展示所有的根变量。
DescribeDetailStart 详细统计 详细统计。
DescribeServiceAppKey service、AppKey下拉值 ServiceAppkey下拉。
DescribeBasicStart 基础统计 基础统计。
DeleteQueryVariable 删除自定义查询变量 查询变量删除。
DescribeQueryVariableDetail 自定义查询变量详情查询 查询变量详情查询。
DescribeAllDataSource 数据源列表查询 数据源列表。
DescribeDataSourceFields 根据数据源编码获取数据源字段 获取数据源所有字段。
SwitchQueryVariable 查询变量启用/禁用 查询变量启用/禁用。
DescribeQueryVariablePageList 自定义查询变量分页列表查询 查询变量列表查询。
UpdateQueryVariable 编辑自定义查询变量 自定义查询变量修改。
DescribeDataSourcePageList 外部数据源列表查询 数据源列表接口。
CreateQueryVariable 创建自定义查询变量 自定义查询变量新增。
DescribeDataSourceDataDownloadUrl 根据文件名下载文件 获取数据源数据下载链接。
DescribeOssPolicy 查询oss上传凭证 获取OSS Policy。
CreateAnalysisConditionFavorite 保存查询条件 新增查询条件。
CreateAnalysisExportTask 新建导出任务 新建导出任务。
DeleteAnalysisConditionFavorite 删除收藏查询条件 删除查询条件。
DescribeAdvanceSearchPageList 事件分析高级查询 高级查询。
DescribeAnalysisColumnFieldList 事件分析查询所有字段 展示所有字段。
DescribeAnalysisColumnList 事件分析查询自定义列 查询自定义列。
DescribeAnalysisConditionFavoriteList 条件查询列表 查询条件列表。
DescribeAnalysisExportTaskDownloadUrl 下载查询结果 下载查询结果。
DescribeBasicSearchPageList 事件分析基础查询 基础查询。
DescribeEventDetailByRequestId 根据requestId查事件详情 根据requestId查询事件详情。
DescribeEventVariableList 事件下的变量列表 查询事件变量。
DescribeRuleListByEventCodesList 通过eventCode 根据事件编码查询策略列表 查询策略列表。
SaveAnalysisColumn 保存自定义列 保存自定义列。
UpdateAnalysisConditionFavorite 修改查询条件 修改查询条件。
DescribeAdvanceSearchLeftVariableList 高级查询获取左变量 高级查询获取左变量接口。
DescribeOperatorListByType 根据场景查询查询操作符映射列表 查询操作符映射列表。
DescribeAuthRulePageList 策略列表 策略列表。
DescribeAuthSceneList 场景下拉列表 场景列表。
DescribeAuthScenePageList 场景列表 场景列表。
QueryAuthRuleDetailByRuleId 白盒化策略详情查询 白盒化策略详情查询。
UpdateAuthRule 修改授权策略 修改授权策略。
DescribeHitRuleTrend 策略命中趋势 策略命中趋势。
DescribeDecisionResultTrend 决策结果波动趋势 决策结果波动趋势。
DescribeHighRiskPieChart 风险地图高风险饼图+地图 风险地图概览图表(饼图)。
DescribeDecisionResultFluctuation 决策结果波动检测 决策结果波动检测。
DescribeHitRuleFluctuation 策略命中波动检测 策略命中波动检测。
DescribeTagsFluctuation 标签波动检测 标签波动检测
DescribeResultCount 下钻分析列表 下钻分析
DescribeRequestPeakReport 请求峰值 请求峰值
DescribeEventTotalCountReport 调用事件次数 调用事件次数
DescribeEventResultBarChart 风险大盘 风险大盘
DescribeEventResultList 事件概览列表 事件概览列表
DescribeRuleBarChart 策略概览列表 策略概览列表
DescribeAvgExecuteCostReport 平均执行耗时 平均执行耗时
DescribeTagsTrend 标签波动趋势 标签命中趋势
DescribeRiskLineChart 风险地图折线图 风险地图概览图表(折线图)
DescribeTagsBarChart 标签概览列表 标签概览列表
DeleteByPassShuntEvent 删除旁路事件 删除旁路事件
DescribeByPassShuntEvent 查看旁路事件 查看旁路事件
DescribeHitRuleList 主事件/旁路/分流策略命中TOP 20 主事件/旁路/分流策略命中TOP20
DescribeScoreSectionNumLineChart 旁路/分流 - 分值区间数量分析 分值区间数量分析
DescribeScoreSectionPieChart 主事件/旁路事件/分流事件分值区间占比饼图 主事件/旁路事件/分流事件分值区间占比
DescribeScoreSectionRatioLineChart 旁路/分流 - 分值区间占比分析 分值区间占比分析
DescribeTagsNumLineChart 旁路/分流 - 标签命中数量分析 标签命中数量分析
DescribeTagsRatioLineChart 旁路/分流 - 标签命中占比分析 标签命中占比分析
SaveByPassOrShuntEvent 配置旁路/分流 旁路/分流配置
StartOrStopByPassShuntEvent 开启/停止旁路事件 开启/停止旁路事件
SwitchToOnline 旁路事件切换上线 一键切换上线
UpdateByPassShuntEvent 编辑旁路事件 编辑旁路事件。
UpdateSampleBatch 批量修改样本 批量修改样本。
CreateSample 添加样本 添加样本。
DescribeOssAuthStatus 查看是否授权Oss 查看是否授权Oss。
DescribeApi 得到api详情 得到api详情。
DescribeGroupPage 社群列表 社群列表。
DescribeSampleList 查询样本列表 查询样本列表。
ModifyAppKey 更新备注 更新备注。
DescribeExcuteNum 自助调用列表 自助调用列表。
DescribeGroupConditionList 社群列表查询条件 社群列表查询条件。
DescribeApis 得到api列表包括用户购买的以及自定义的 得到api列表包括用户购买的以及自定义的。
DeleteSampleBatch 批量删除样本 批量删除样本。
DescribeSafConsole 查询saf权限 查询saf权限。
DescribeOssToken 获取文件上传凭证 获取文件上传凭证。
DescribeApiVariable 查询变量详情 查询变量详情。
DescribeSampleInfo 查询样本详情 查询样本详情。
DescribeSampleTagList 获取标签列表 获取标签列表。
DescribeMarkPage 打标列表 打标列表。
DescribeGroupTrend 风险社群的近期趋势 风险社群的近期趋势。
DescribeGroupStatisticsByToday 当日发现的风险社群 当日发现的风险社群。
DescribeGroupAccountPage 社群账户列表 社群账户列表。
DescribeApiGroups 得到api分组包括用户购买的以及自定义的 得到api分组包括用户购买的以及自定义的。
DescribeTemplateDownload 模版下载 模版下载。
DescribeExistScene 场景是否存在 场景是否存在。
DescribeSampleDataList 样本列表分页查询 样本列表分页查询。
ImportTemplateEvent 导入模板事件 导入模板事件
DescribeRecommendVariablesVelocity 查询变量下的指标信息 查询变量下的指标信息。
StopSimulationTask 停止任务 停止任务。
DescribeSimulationPreditInfo 预估调用信息 预估调用信息。
DescribeSampleSceneList 查询场景列表 查询场景列表。
DeleteSampleData 删除样本数据 删除样本数据。
DescribeSampleDemoDownloadUrl 查询样本示例授权 查询样本示例授权。
DescribeTaskLogList 任务日志列表 任务日志列表。
DescribeSampleDownloadUrl 查询样本下载授权信息 查询样本下载授权信息。
DescribeRecommendSceneVariables 查询样本&场景下的变量列表 查询样本&场景下的变量列表。
DescribeSupportRuleList 查询支持仿真的策略列表 查询支持仿真的策略列表。
StartSimulationTask 开始执行任务 开始执行任务。
DescribeSimulationTaskList 任务列表 任务列表。
DescribeEventTaskHistory 查询策略下载列表 查询策略下载列表。
CreateRecommendEventRule 创建推荐事件策略 创建推荐事件策略。
DescribeRecommendVelocities 查询支持的指标列表 查询支持的指标列表。
CreateSimulationTask 创建任务 创建任务。
DescribeRecommendTaskDetail 变量推荐详情查询接口 变量推荐详情查询接口.
DescribeOperationLogPageList 查询操作日志 根据事件名称查询事件列表
DescribeTemplatePageList 根据事件名称查询事件列表 根据事件名称查询事件列表。
CreateRecommendTask 创建推荐任务 创建推荐任务。
DescribeSimulationTaskCount 查询任务记录数 查询任务记录数。
DescribeRecommendTaskPageList 变量推荐列表查询接口 变量推荐列表查询接口。
DescribeEventLogDetail 查询事件历史详情 查询事件历史详情
DescribeMenuPermission 查询是否有权限 查询是否有权限
ModifyEventStatus 修改事件状态 修改事件状态
OpenConsoleSls 开通服务 开通服务
DescribeLoanTaskList 获取贷中监控任务列表 获取贷中监控任务列表。
DescribeSelectItem 查询任务ID列表 查询任务ID列表。
DescribeSlsUrlConfig 获取project配置 获取project配置。
DescribeMonitorTaskLimit 查询任务的限制 查询任务的限制。
DescribeSDKDownloadList sdk下载列表 sdk下载列表。
CheckFieldLimit 校验字段数目是否操过限定值 校验字段数目是否操过限定值。
DescribeLoanExecList 获取监控对象列表 获取监控对象列表。
DescribeSafTagList 获取风险标签列表 获取风险标签列表
DescribeAppKeyPage 查询appKey列表 查询appKey列表。
DescribeEventUploadPolicy 批量导入策略 批量导入策略。
DescribeSafStartSteps 查询接入步骤详细信息 查询接入配置
ModifyEvent 修改事件 编辑事件
DescribeApiNameList 获取api服务名称 获取api服务名称。
DescribeAuthStatus 查看是否授权 查看是否授权
DescribeSampleUploadPolicy 查询样本上传授权信息 查询样本上传授权信息。
DescribeSafOrder 查询订单信息 查询订单信息。
DescribeApiLimit 查询创建api任务的limit信息 查询创建api任务的limit信息
DescribeEventLogPage 查询事件历史列表 查询事件历史列表。
RemoveEvent 删除事件 删除事件
DescribeDownloadUrl 下载 下载。
DescribeRuleHit DescribeRuleHit 查询策略命中详情
DescribeUsedService 获取用户使用过服务列表 获取用户使用过服务列表。
DescribeAuthEventNameList 查询当前用户的事件名列表 查询当前用户的事件名列表
CreateAppKey 创建appKey 创建appKey。
DescribeRequestHit 查询请求命中详情 查询请求命中详情。
DescribeAllEventNameAndCode 事件名称code映射列表 事件列表查询。
CreateEvent 创建事件 创建事件。
DescribeSafDeOrder 查询saf_de订单信息 查询saf_de订单。
DescribeRuleSnapshot DescribeRuleSnapshot 根据ruleId+version查询历史快照。
DescribeServiceList 获取服务列表 获取服务列表。
DescribePocTaskList 获取poc任务列表 获取poc任务列表。
DescribeSafStartConfig 查询接入配置 查询接入配置。
DescribeEventCount 查询事件总数量 查询事件总数量。
DescribeEventPageList 事件列表分页查询 事件分页查询。
DescribeFieldById 字段详情查询 获取字段详情
SwitchExpressionVariable 修改自定义变量状态 自定义变量开关。
DescribeFieldPage 字段分页列表 查询字段分页列表。
CheckUsageVariable 校验变量引用 校验变量引用。
DeleteNameList 删除名单 删除名单。
DescribeExistName 查询字段名是否重复 校验字段名是否重复(基于用户单位)。
DescribeCustVariablePage 累计变量分页列表查询 查询自定义累计变量列表
BindVariable 变量绑定 变量绑定操作。
DeleteField 删除字段 删除字段。
DescribeNameListLimit 查询名单限制数 查询名单限制数。
OperateFavoriteVariable 收藏变量 操作收藏。
ModifyField 修改字段 修改字段。
DescribeEventVariableTemplateBind 查询事件模板 查询事件模版。
DeleteNameListData 删除名单数据 删除(伪)名单变量数据。
CreateExpressionVariable 创建自定义变量 创建自定义变量。
DescribeVariableList 查询变量列表 查询变量详情。
DescribeHasRuleNameByEventCode 查询事件名下的策略名是否存在 查询事件名下的策略名是否存在。
DescribeFieldList 字段列表 查询字段列表。
SwitchField 上下线字段 字段开关。
SwitchVariable 上下线累计变量 累计变量开关。
CheckCustVariableLimit 校验累计变量数目是否操过限定值 校验累计变量数目是否超过限定值。
CheckExpressionVariableLimit 校验创建自定义变量是否超过上限 校验创建变量是否超过上限。
CreateCustVariable 创建累计变量 创建累计变量。
CreateField 新建字段 新增字段。
DeleteCustVariable 删除累计变量 删除累计变量。
DeleteExpressionVariable 删除自定义变量 删除自定义变量。
DescribeCustVariableConfigList 累计变量配置查询 查询自定义累计变量的类型配置。
DescribeCustVariableDetail 累计变量详情查询 累计变量详情。
DescribeEventBaseInfoByEventCode 查询事件详情 查询事件详情。
DescribeEventsVariableList 查询事件变量 查询事件变量
DescribeExpressionVariableDetail 自定义变量详情 自定义变量详情
DescribeExpressionVariableFunctionList 函数列表 函数列表。
DescribeExpressionVariablePage 自定义变量分页查询 自定义变量分页查询。
DescribeNameList 查询名单分页 查询名单分页。
DescribeOperatorList 查询操作符映射列表 根据客户ID查询操作符映射列表。
DescribeParamByEventCodes 查询事件属性列表 查询事件属性列表。
DescribeRuleCountByUserId 根据用户id查询策略数 根据用户Id查询策略数。
DescribeVariableBindDetail 查询变量绑定信息 查询变量绑定信息。
DescribeVariableDetail 变量详情查询 查询变量详情。
DescribeVariableFee 查询变量收费信息 查询变量收费信息。
DescribeVariableMarketList 变量定义列表查询 查询变量定义。
DescribeVariableSceneList 查询配置信息 查询配置信息。
ImportNameList 创建或者导入名单 创建或导入名单。
ModifyCustVariable 修改累计变量 编辑累计变量。
ModifyExpressionVariable 修改自定义变量 编辑自定义变量。
CreatePocEv 创建POC 创建poc。
DescribeListPoc POC任务列表 任务列表。
DescribeTagList 标签列表 标签列表。
FileUpload 文件上传 文件上传。
PermissionCheck 前置条件判断 前置条件判断。
SampleFileDownload 模板下载 模板下载。
TaskNameByUserId 任务名是否重复 判断任务名是否重复。
DescribeNameListVariablePageList 名单列表查询 名单列表。
DescribeNameListPageList 分页查询名单 名单内容查询。
DescribeNameListTypeList 名单类型列表 名单类型列表。
DescribeNameListDownloadUrl 下载名单内容 下载名单列表。
DescribePrivateStack 判断该用户是否开通privateStack模式 判断是否开通Stack私域模式。
DescribeSceneEventPageList 场景化事件风控事件列表 场景化事件风控事件列表查询。
DescribeSceneAllEventNameCodeList 场景化风控事件下拉 场景化风控事件下拉列表。
DescribeSceneRulePageList 场景化风控事件策略列表 场景化风控事件策略列表。

其他

API

标题

API概述

CreateSampleApi 通过API上传样本的接口 用户级别单API创建样本批
DescribeOperatorListByScene Query Operator Mapping List by Scene Query Operator Mapping List
DescribeEventVariableTemplateList 查询事件模板 查询事件模版
DescribeInputFeildCountByEventCode 查询事件总数量 查询事件总数量
AddSampleDataByCsv 样本批通过csv增加数据 样本批通过csv增加数据
AddSampleDataByText 样本批通过TEXT增加数据 样本通过文本框新增名单数据
BatchDeleteSampleData 批量删除样本名单数据 批量删除样本名单数据。
CancelSubTask 取消任务 创建任务组
CheckCopyRuleVariable 检查是否复制过 策略复制血缘关系检查
CheckSampleName 样本名称唯一性校验 样本名称唯一性校验
CheckTaskGroupName 任务组名称唯一性校验 任务组名称唯一性校验
CompareCopyRuleVariable 策略复制对比 策略对比。
CompareRule 策略版本对比 策略版本内容对比。
CreateDataSource 创建查询变量数据源 新增数据源。
CreateForeignPocSample 样本库创建 创建样本记录对客
CreateModel 创建模型 创建模型。
CreatePocSample 创建样本 创建样本记录
CreateRule 创建规则 创建策略&版本。
CreateSampleBatch 新建样本批 新建样本批。
CreateSampleData 创建样本数据 创建样本数据。
CreateTaskGroup 创建任务组 取消子任务
DeepCopyRule 策略复制 策略复制
DeleteDataSource 删除数据源 删除数据源。
DeleteEventField 事件字段删除 事件字段删除。
DeleteRule 删除规则 删除策略版本。
DeleteSample 删除样本 删除样本
DeleteSampleBatchMeta 样本删除 样本删除。
DeleteSelfBindVariable 删除自定义系统变量 删除自定义系统变量。
DescribeExpressionVariableVersionDetail 自定义变量版本详情查询 自定义变量版本详情信息查询。
DescribeInitDig POC弹框提示信息 POC新增初始化弹框提示信息
DescribeListModel 模型任务列表 模型任务列表。
DescribeModelDetailsById 查看详情 查看结果。
DescribeModelOssPolicy 模型OSS信息 获取文件上传凭证。
DescribeOperationLogMonitoring 查询操作日志监控统计信息 查询操作日志监控统计信息。
DescribePocOssToken 获取文件上传凭证 获取文件上传凭证。
DescribeRegions 查询ApiGateway支持的region列表 查询ApiGateway支持的region列表。
DescribeRiskTagsLineChart 标签命中率 标签命中维度 标签命中率 标签命中维度
DescribeSampleBatchOssPolicy 获取文件上传凭证 获取文件上传凭证。
DescribeSamplebatchPage 样本批次列表 样本批次列表。
DescribeSampleDataByBatchUUidPage 样本名单列表 样本名单列表。
DescribeSampleDataPage 样本名单列表 样本名单列表。
DescribeScoreList 评分分布 评分分布。
DescribeServiceCodeName 所有服务 查询所有服务。
DescribeTagsList 获取标签列表 获取标签列表
DescribeTaskList 任务列表 任务列表。
DescribeTemplateCount 查询事件总数量 查询事件总数量。
DescribeUserInfo 获取当前登录用户信息 获取当前登录用户信息。
DescribeVariableVersionDetail 累计变量版本详情 累计变量版本详情查询。
DescribeVersionPageList 变量版本列表查询 变量版本列表查询。
DownloadSampleFile 下载样本文件 下载样本文件
DownloadSmapleBatch 样本名单数据下载 样本名单数据下载。
DownloadSubTaskResult 下载子任务结果 下载子任务结果
GetSampleDetail 获取样本详情 创建样本记录
GetSubTaskResult 获取子任务结果 查看子任务结果
ImportField 批量导入字段 批量导入
ListSample 样本列表 样本列表查询
ListTaskGroup 任务组列表 任务组列表查询
ListVariableDefine 查询变量定义 查询变量定义
MergeDownload 合并下载 合并下载
ModelDelete 删除模型 删除模型。
ModelFileUpload 文件上传校验 文件上传校验。
ModelIsUsing 启用/禁用 启用、停用。
ModelNameIsDuplication 模型名是否重复 模型名是否重复。
ModelSampleDownload 模板下载 模板下载
PocCreateTask 创建POC任务 创建POC任务。
PocGetDownloadUrl 获取下载地址 获取下载URL。
PocGetToken 申请令牌 申请令牌。
PocSendData 批次上传 批次上传。
SearchSample 样本查询 样本搜索
UpdateDataSource 外部数据源修改 修改数据源。
UploadFileCheck 样本检验 样本检验。
UploadForeignSampleFile 上传样本文件 上传并校验样本文件对客
UploadSampleFile 上传文件 上传并校验样本文件