检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Tok
API概览 类型 API 说明 工作空间 查询企业项目列表 查询用户在当前项目id下的企业项目列表。 创建工作空间 用于在推荐系统下面创建独立的工作空间,用于资源的隔离 查询工作空间列表 用于查询当前用户具有操作权限的工作空间列表。 查询工作空间详情 查询指定工作空间的具体信息。
获取资源列表 功能介绍 该接口用于获取资源列表。 URI GET /v1/{project_id}/resources 参数说明请参见表1-URI参数说明。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
如何调用API 构造请求 认证鉴权 返回结果
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
获取跨源连接 功能介绍 该接口用于获取跨源连接。 URI GET /v1/{project_id}/datasource-connection 参数说明请参见表1-URI参数说明。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号
作业相关API 提交组合作业 提交召回作业 提交过滤作业 提交特征工程作业 提交排序作业 提交实时流近线作业 提交流式训练作业 提交数据质量作业 策略参数说明 停止算子作业 查询作业列表 查询作业详情 重新执行作业 删除作业 提交效果评估任务 查询效果指标 编辑修改作业 更新索引结构
获取全局配置指标 功能介绍 该接口用于获取全局配置指标。 URI GET /v1/{project_id}/global-setting?scene-id={scene_id} 参数说明请参见表1-URI参数说明。 表1 URI参数说明 名称 是否必选 类型 说明 project_id
API 在线服务 场景 工作空间 数据源 查询规格 训练作业 调度
通过调用API重新执行作业 功能介绍 该接口用于重新执行作业。 URI POST /v1/{project_id}/rerun-job 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
在线服务API 获取规格列表 部署服务 预测接口 预测接口(排序) 预测接口(文本标签) 更新服务 查询服务列表 查询服务详情 订阅服务 停止/启动服务 删除服务 查询镜像列表 父主题: API(V1不推荐)
平台资源API 绑定依赖资源 获取资源列表 解绑依赖资源 创建跨源连接 获取跨源连接 删除跨源连接 开启公共终端节点 父主题: API(V1不推荐)
ken。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。
获取规格列表 功能介绍 该接口用于获取节点规格列表。 URI GET /v1/{project_id}/specifications 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
API版本选择建议 当前RES服务对外API开放存在2种: RES新版本的API接口,推荐使用。 RES旧版本的API接口,现仅为存量用户提供,即将下线。 父主题: 使用前必读
全局配置API 计算资源配置 新增场景 查询场景 删除场景 全局指标配置 获取全局配置指标 查询配额信息 父主题: API(V1不推荐)
提交排序任务API 功能介绍 用于提交排序训练作业。 URI POST /v1/{project_id}/rank-job 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用于资源隔离。获取方法请参见获取项目ID。
提交数据质量作业API 功能介绍 该接口用于提交数据质量作业并进行离线计算。 URI POST /v1/{project_id}/data-quality 参数说明请参见表1。 表1 URI参数说明 名称 是否必选 类型 说明 project_id 是 String 项目编号,用