检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
状态码 状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,取得该流程对应的获取导航树接口中的query参数。否则接口返回是200,返回信息中会有报错信息。 父主题: 流程定义API
API管理 支持查询系统中所有API信息,支持定时从各模块中同步API信息。 前提条件 已登录MBM Space,且拥有该菜单栏目的操作权限。 查询API 在顶部导航栏中,选择“系统管理 > 应用配置 > API管理”,进入“API管理”页面。 在顶部搜索框输入API URL、Key或名称,选择是否为OpenAPI。
使用前必读 概述 欢迎使用硬件开发工具链平台云服务(CraftArts IPDCenter),您可以使用本文提供的API进行创建、查询等相关操作,API支持的全部操作请参见API概览。 在调用IPDCenter基础服务的API之前,请确保已经充分了解IPDCenter基础服务相关功能,详细信息请参见产品功能。
状态码 状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,在开始节点单击提交按钮,从接口中取得相应的入参。否则接口返回是200,返回信息中不会有真实模板的信息。 父主题: 流程定义API
查看API详情 进入应用运行态后,在左侧导航栏中,选择“数据服务管理 > 全量数据服务”,进入全量数据服务页面。 在分类栏中,选择需要查看的对象名称,进入该对象的API列表页面。 在API列表中,单击需要查看的API英文名称,即可查看该API详情。 图1 查看API详情 通过请求头参数控制是否自动进行数据鉴权
请求头 使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。 请求参数 无 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 msg String 接口响应信息 code Integer 接口返回码 data Array
状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,在某一个审批节点单击提交按钮,从接口中取得相应的入参。否则接口返回是200,但是返回信息中会有错误提示。 父主题: 流程定义API
请求头 使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。 请求参数 无 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 orderId String 请求跟踪流水号 msg String 接口响应信息 code Integer
状态码 状态码 描述 200 接口返参 错误码 请参见错误码。 使用说明 如果需要获得正常的反参,则需在页面上运行一个真实存在的流程,单击保存草稿按钮,从接口中取得相应的入参。否则接口返回是200,返回信息中不会有真实模板的信息。 父主题: 流程定义API
/pdmcore/ipdcworkflowservice/console/servicetask/api/localMethod/business_info/findBusinessSeqByBusinessKey 请求头 使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。
鉴权失败 接口鉴权失败 使用对应接口鉴权 500 IPDC.02010001 参数错误 检查接口入参未符合要求,应按照API文档中描述准确入参 检查接口入参是否符合要求 500 IPDC.02010033 系统内部错误 入参业务校验未通过,例如授权码已经失效,具体错误看接口返回错误信息
/pdmcore/ipdcworkflowservice/console/servicetask/api/localMethod/assessment_record/findAllRecord 请求头 使用机机认证调用接口时需传入header:Authorization,其值为机机鉴权token。 请求参数
orderId String 请求跟踪流水号 msg String 接口响应信息 code Integer 接口返回码 data Array of HistoricProcessInstanceVO objects 接口响应数据,JSON对象或数组 pageInfo PageVo object
ame(模板名称)需调用查询消息模板信息接口获取; fromUserAccountId(申请人账号ID)/receiver(接收用户)需要调用用户管理中心的查询用户信息接口获取。 URI POST /knowledge/public/api/v1/messages 请求参数 表1
获取账号ID 操作步骤 在调用接口的时候,部分请求中需要填入账号名(domain name)和账号ID(domain_id)。获取步骤如下: 注册并登录管理控制台。 鼠标移动至用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面的查看“账号名”和“账号ID”。 图1 获取账号ID
单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。 图1 查看项目ID 多项目时,展开“所属区域”,从项目ID列获取子项目ID。 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{
access_toke过期时,使用refresh_token获取access_token。 URI POST /basic/mgmt/public/api/v1/oauth2/refreshtoken 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 grant_type 是
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询云服务器列表,那么这个IAM用户被授予的策略中必须包含允许“ecs:ser
orderId String 请求跟踪流水号 msg String 接口响应信息 code Integer 接口返回码 data Array of HistoricProcessInstanceVO objects 接口响应数据,JSON对象或数组 pageInfo PageVo object