检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
数据源 创建数据源 查询数据源列表 查询数据源详情 修改数据源内容 修改数据源特征 删除数据源 查询数据源任务结果 父主题: API
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
创建工作空间 功能介绍 用于在推荐系统下面创建独立的工作空间,用于资源的隔离,用户可以在工作空间下面继续创建数据源、场景以及推荐任务等。是否有工作空间的操作权限取决于用户是否属于当前工作空间绑定的企业项目。 调试 您可以在API Explorer中调试该接口。 URI POST /v2
Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
修订记录 发布日期 修订记录 2021-11-17 第二次正式发布。 下线北京一局点 2020-06-04 第一次正式发布。
"access_address": "https://8f7abc92ae1347e99d5f90d170ea2799.apigw.southchina.huaweicloud.com/v1/infers/84746641-9af3-4fa6-b6ed-850e1f63416c"
更新智能场景内容 功能介绍 更新智能场景的内容信息。 调试 您可以在API Explorer中调试该接口。 URI PUT /v2.0/{project_id}/workspaces/{workspace_id}/intelligent-scenes/{scene_id} 表1 路径参数
调用说明 推荐系统提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
删除场景 功能介绍 该接口用于删除场景,删除之后不能恢复,请您谨慎操作。 调试 您可以在API Explorer中调试该接口。 URI DELETE /v2.0/{project_id}/workspaces/{workspace_id}/scenes/{scene_id} 表1
查询训练规格 功能介绍 查询当前推荐系统所提供的离线计算规格,实时计算规格和排序模型训练规格。在创建数据源和场景时,需要提供此信息。 调试 您可以在API Explorer中调试该接口。 URI GET /v2.0/{project_id}/resource-specs 表1 路径参数
查询工作空间详情 功能介绍 查询指定工作空间的具体信息。 调试 您可以在API Explorer中调试该接口。 URI GET /v2.0/{project_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建智能场景 功能介绍 在指定工作空间下面创建智能场景。 调试 您可以在API Explorer中调试该接口。 URI POST /v2.0/{project_id}/workspaces/{workspace_id}/intelligent-scenes 表1 路径参数 参数 是否必选
查询场景详情 功能介绍 查询指定场景的详情。 调试 您可以在API Explorer中调试该接口。 URI GET /v2.0/{project_id}/workspaces/{workspace_id}/scenes/{scene_id} 表1 路径参数 参数 是否必选 参数类型
执行作业 功能介绍 执行独立的作业。 调试 您可以在API Explorer中调试该接口。 URI POST /v2.0/{project_id}/workspaces/{workspace_id}/resources/{resource_id}/jobs/{job_id}/schedule-job
API(V1不推荐) 平台资源API 作业相关API 全局配置API 在线服务API
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
全局配置API 计算资源配置 新增场景 查询场景 删除场景 全局指标配置 获取全局配置指标 查询配额信息 父主题: API(V1不推荐)
API版本选择建议 当前RES服务对外API开放存在2种: RES新版本的API接口,推荐使用。 RES旧版本的API接口,现仅为存量用户提供,即将下线。 父主题: 使用前必读