检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 类型 API 说明 工作空间 查询企业项目列表 查询用户在当前项目id下的企业项目列表。 创建工作空间 用于在推荐系统下面创建独立的工作空间,用于资源的隔离 查询工作空间列表 用于查询当前用户具有操作权限的工作空间列表。 查询工作空间详情 查询指定工作空间的具体信息。
响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
API 在线服务 场景 工作空间 数据源 查询规格 训练作业 调度
URI POST /v1/{project_id}/apig 参数说明请参见表1-URI参数说明。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
作业相关API 提交组合作业 提交召回作业 提交过滤作业 提交特征工程作业 提交排序作业 提交实时流近线作业 提交流式训练作业 提交数据质量作业 策略参数说明 停止算子作业 查询作业列表 查询作业详情 重新执行作业 删除作业 提交效果评估任务 查询效果指标 编辑修改作业 更新索引结构
开启公共终端节点 推荐系统在需要使用CloudTable集群进行数据存储,CloudTable集群创建后默认没有打开APIG,需开启之后推荐才能正常使用CloudTable集群。 前提条件 已开通CloudTable服务,创建集群并完成资源绑定。 公共终端节点默认不开启。
全局配置API 计算资源配置 新增场景 查询场景 删除场景 全局指标配置 获取全局配置指标 查询配额信息 父主题: API(V1不推荐)
平台资源API 绑定依赖资源 获取资源列表 解绑依赖资源 创建跨源连接 获取跨源连接 删除跨源连接 开启公共终端节点 父主题: API(V1不推荐)
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RES.1001 Basic Error 请求参数({0})的值无效 请检查是否有非法的参数值输入。
如何调用API 构造请求 认证鉴权 返回结果
API版本选择建议 当前RES服务对外API开放存在2种: RES新版本的API接口,推荐使用。 RES旧版本的API接口,现仅为存量用户提供,即将下线。 父主题: 使用前必读
通过调用API查询作业详情 功能介绍 该接口用于查询作业详情。 URI GET/v1/{project_id}/jobs/{job_id} 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目
对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。
API(V1不推荐) 平台资源API 作业相关API 全局配置API 在线服务API
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
image", "infer_type": "real-time", "is_shared": false, "access_address": "https://8f7abc92ae1347e99d5f90d170ea2799.apigw.southchina.huaweicloud.com
提交排序任务API 功能介绍 用于提交排序训练作业。 URI POST /v1/{project_id}/rank-job 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目
在线服务API 获取规格列表 部署服务 预测接口 预测接口(排序) 预测接口(文本标签) 更新服务 查询服务列表 查询服务详情 订阅服务 停止/启动服务 删除服务 查询镜像列表 父主题: API(V1不推荐)
通过调用API重新执行作业 功能介绍 该接口用于重新执行作业。 URI POST /v1/{project_id}/rerun-job 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目
提交数据质量作业API 功能介绍 该接口用于提交数据质量作业并进行离线计算。 URI POST /v1/{project_id}/data-quality 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离