检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取。调用本服务API需要
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 从控制台获取项目ID(推荐使用) 调用API获取项目ID 从控制台获取项目ID 在调用接口的时候,部分URL中需要填入项目编号,所以需要获取到项目编号。编号获取步骤如下:
对外API规范 API规范示例 为了对外API在调用时有用户信息,API调用时需要在header中传递Modifier、Creator字段。 值格式为:用户名+空格+用户id,如图1所示。 图1 示例 具有AccessControlled功能的实体,其API做了权限管控,权限管理
工作流程 在第三方应用作为被调用方时,需要检验请求中的认证凭据的合法性: 获取请求头中的认证凭据-Token。 获取请求头中名为Authorization的认证凭据。 校验认证凭据。 调用SDK中的检验方法,将token传递给检验方法,如果token合法,可返回调用者的信息。 父主题: IPDCenter外部集成开发
生命周期数据模型API 操作场景 当您在应用设计态完成数据模型的构建和发布,并将应用部署至生命周期数据模型后,系统会将应用下所有对外可调用的API展示在应用运行态的“数据服务管理 > 全量数据服务”中。 进入应用运行态 以系统管理员用户进入运行态: 进入IPDCenter基础服务
向用户消息中心发送消息。 入参中的messageTemplateName(模板名称)需调用查询消息模板信息接口获取; fromUserAccountId(申请人账号ID)/receiver(接收用户)需要调用用户管理中心的查询用户信息接口获取。 URI POST /knowledge/p
编码发生器API 功能介绍 调用编码生成器,生成编码。 URI POST /unidata/public/api/v1/geninfo/createExternalGen 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 genCode 是 String 生成器代码
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 common.authenticate.fail 没有操作权限错误 用户没有操作权限错误 切换用户或申请权限 400 common.param
IPDCenter提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询服务的终端节点。 CraftArts
按工单获取工单相关信息 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
获取工单产品信息 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
导入工单 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
批量取消工单 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
分页查询工单 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
批量生成工单方案 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
批量删除工单 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4
批量实例化工单 操作场景 本章节指导用户通过调用API导入工单。 前提条件 已开通数字化制造云平台(MBM Space),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 假设数字化制造云平台的访问网址为https://ipdcenter.cn-north-4