华为云用户手册

  • 响应示例 状态码: 200 successful operation { "msg": null, "success": [ { "entity_type": "Metamodel3-SubjectArea", "entity_urn": "urn:abm:Metamodel3-SubjectArea:b2570da68c011fbf7bf8e784e9cd2c", "entity_name": "q8" } ], "failure": [] }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 entities 是 Array of 表3 objects 实体请求列表,最大个数不超过200个。 表3 MetadataEntityRequest 参数 是否必选 参数类型 描述 package_id 是 String 模型包ID。 最小长度:1 最大长度:50 entity_name 是 String 实体名称。 最小长度:1 最大长度:200 entity_type 是 String 实体类型。 最小长度:1 最大长度:150 subtype 否 String 实体子类型。 最大长度:50 entity_attributes 否 Array of 表5 objects 实体属性。 signatures 否 Array of 表4 objects 特征。 表4 MetadataSignature 参数 是否必选 参数类型 描述 signature_type 是 String 特征类型。 signature_name 否 String 特征名称。 signature_attributes 否 Array of 表5 objects 特征属性。 表5 MetadataAttributeRequest 参数 是否必选 参数类型 描述 attribute_id 否 String 属性ID。 最大长度:200 attribute_value 否 String 属性值。
  • 修订记录 表1 修订记录 发布日期 修订记录 2024-04-24 第六次正式发布。 优化如下章节: 概述 终端节点 API概览 构造请求 认证鉴权 返回结果 运行流并查看运行记录 查询流历史活动记录 查询单个流历史活动记录 获取流运行详细信息 2024-03-11 第五次正式发布。 新增如下章节: 应用模型 修改如下章节: API概览,增加应用模型概览。 错误码,增加应用模型错误码。 2022-11-28 第四次正式发布。 优化如下章节: API概览 权限及授权项说明 错误码 2022-11-01 第三次正式发布。 优化如下章节: 查询流历史活动记录 查询单个流历史活动记录 获取流运行详细信息 2022-09-29 第二次正式发布。 新增如下章节: 终端节点 约束与限制 基本概念 应用示例 历史API 修改如下章节: 废除webhook触发流程调用(废弃)API。 提交运行流,修改请求和响应参数。 错误码,修改部分错误码说明。 2022-04-15 第一次正式发布。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Long 历史记录总数。 histories Array of histories objects 所有历史记录的信息。 表4 histories 参数 参数类型 描述 id String 流运行记录ID。 flow_id String 流ID。 flow_name String 流名称。 flow_version_id String 流运行版本ID。 run_model String 流运行模式,通常有手动、自动、测试三种。 手动:需要用户在页面单击运行流。 自动:会按照触发器的类型自动运行流。 测试:用户在创建流的时候可以测试流的功能。 status String 最后一次运行,流程运行状态。 success:流运行成功 fail:流运行失败 icon String 流图标。 start_time String 开始时间。 end_time String 结束时间。 exec_time Long 执行时间,单位:毫秒。 running_times Long 运行次数。 last_time String 最后一次运行时间。 message String 最后一次运行,输出的错误信息。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • URI GET /v1/{project_id}/flows/{flow_id}/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,用于资源隔离。获取方式请参考获取项目ID。 flow_id 是 String 流程ID。 表2 Query参数 参数 是否必选 参数类型 描述 time_range 否 String 时间筛选范围,UTC时间。格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'toyyyy-MM-dd'T'HH:mm:ss.SSS'Z' 例如:2020-11-10T00:00:00Zto2020-11-12T00:00:00 status 否 String 流的状态。 枚举值: success fail offset 否 Integer 当前页,起始页数应大于等于0。 limit 否 Integer 每页记录数,每页记录数应大于等于1。
  • URI GET /v1/{project_id}/flows/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,用于资源隔离。获取方式请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 time_range 否 String 时间筛选范围,UTC时间。格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'toyyyy-MM-dd'T'HH:mm:ss.SSS'Z' 例如:2020-11-10T00:00:00Zto2020-11-12T00:00:00 name 否 String 请求名称。 status 否 String 流的状态。 枚举值: success fail offset 否 Integer 当前页,起始页数应大于等于0。 limit 否 Integer 每页记录数,每页记录数应大于等于1。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Long 历史记录总数。 histories Array of histories objects 所有历史记录的信息。 表4 histories 参数 参数类型 描述 id String 流运行记录ID。 flow_id String 流ID。 flow_name String 流名称。 flow_version_id String 流运行版本ID。 run_model String 流运行模式,通常有手动、自动、测试三种。 手动:需要用户在页面单击运行流。 自动:会按照触发器的类型自动运行流。 测试:用户在创建流的时候可以测试流的功能。 status String 最后一次运行,流运行状态。 success:流运行成功 fail:流运行失败 icon String 流图标。 start_time String 流运行的开始时间。 end_time String 流运行的结束时间。 exec_time Long 执行时间,单位:毫秒。 running_times Long 运行次数。 last_time String 最后一次运行时间。 message String 最后一次运行,输出的错误信息。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 状态码 状态码如表1所示。 表1 状态码 状态码 编码 说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 200 OK 接口调用成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 429 Too Many Requests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 Internal Server Error 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 父主题: 附录
  • 流管理权限 表1 流管理的细化权限说明 权限 对应API接口 授权项 依赖的授权项 IAM 项目 企业项目 运行流程 POST /v1/{project_id}/flows/{flow_id}/run mssi:flow:start - √ × 开启流程 POST /v1/{project_id}/flows/{flow_id}/enable mssi:flow:enable - √ × 关闭流程 POST /v1/{project_id}/flows/{flow_id}/disable mssi:flow:disable - √ × 查询流程运行记录 GET /v2/{project_id}/flows/running-history mssi:flow:listRunHistory - √ × 查询单个流程运行记录 GET /v2/{project_id}/flows/{flow_id}/running-history mssi:flow:listFlowRunHistory - √ × 查询流程运行详细记录 GET /v2/{project_id}/flows/{flow_id}/running-history/{running_id} mssi:flow:getRunHistory - √ × 父主题: 权限策略和授权项
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝在特定条件下对指定资源进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目,“√”表示支持,“×”表示暂不支持。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 开天 集成工作台 的支持自定义策略授权项如下所示: 流管理,包括流接口对应的授权项,如提交运行流、启用流程、禁用流程、webhook触发流程调用等接口。
  • 操作步骤 提交一个流并查看响应信息。 运行流。 接口相关信息 URI格式:POST /v1/{project_id}/flows/{flow_id}/run 参数说明请参见提交运行流。 请求示例 POST http://{endpoint}/v1/f00ca7a36e************6d6c5f8da8/flows/cfdcacae-a44f-4827-8ad9-db47ad2a8b41/run { "run_mode": "manual", "input": {}, "trigger_timing": "editFlow" } {endpoint}为“mssi.cn-north-4.myhuaweicloud.com”。 响应示例 { "running_id": "d96ba061-3caf-49cb-8950-4dac97a8f082", "flow_id": "cfdcacae-a44f-4827-8ad9-db47ad2a8b41", "success": true, "flow_name": "遍历集合元素测试", "message": "" } 从上述响应数据中,记录流运行的running_id。 查看流运行记录。 查询流某次运行记录。 接口相关信息 URI格式:GET /v2/{project_id}/flows/{flow_id}/running-history/{running_id} 参数说明请参见查询单个流运行历史记录。 请求示例 GET http://{endpoint}/v2/f00ca7a36e***********6d6c5f8da8/flows/cfdcacae-a44f-4827-8ad9-db47ad2a8b41/running-history/d96ba061-3caf-49cb-8950-4dac97a8f082 {endpoint}为“mssi.cn-north-4.myhuaweicloud.com”。 响应示例 { "id":"d96ba061-3caf-49cb-8950-4dac97a8f082", "flow_id":"cfdcacae-a44f-4827-8ad9-db47ad2a8b41", "flow_name":"遍历集合元素测试", "run_model":"manual", "status":"success", "icon":"https://connector-icon.obs.cn-north-7.ulanqab.huawei.com/icon/c9710579264845c6a5339fd738e66fd6/155e6930bdb24d9d95b5d3c636e133eb.png", "start_time":1655881122470, "end_time":1655881126839, "exec_time":4369, "message":null, "steps":[ { "stepId":"05778538-83a6-467b-bb92-738d9049bb3c", "actionName":"手动触发器触发事件", "actionType":null, "call":{ "connectorRef":"ManualTrigger", "triggerRef":{ "refName":"手动触发器触发事件", "refId":"ManualTrigger", "type":"instant", "authentication":{ "connectionId":null, "schema":null }, "input":{ "body":{ } }, "config":null, "customFunctionMap":null }, "actionRef":null, "connectorVersion":"1" }, "transmit":[ "bc744b98-007f-496e-bd10-ed460548f7de" ], "icon":"https://connector-icon.obs.cn-north-7.ulanqab.huawei.com/icon/c9710579264845c6a5339fd738e66fd6/155e6930bdb24d9d95b5d3c636e133eb.png", "name":"手动触发流", "lastRunningStatus":"success", "cost":354 } ] }
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • Token认证 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 获取Token 后,再调用其他接口时,需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 GET https://mssi.cn-north-4.myhuaweicloud.com/v1/{project_id}/flows/running-history Content-Type: application/json X-Auth-Token: ABCDEFG.... 还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 还可以参考华为云IAM认证服务了解如何获取IAM用户Token。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。如果请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxx为project的名称,如cn-north-1,您可以从地区和终端节点中获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type:application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 需要添加到请求中的公共消息头如表3所示。 表3 公共请求消息头 参数名 说明 是否必选 示例 Content-type 消息体的类型(格式),默认取值为“application/json”。 是 application/json X-Auth-Token 用户Token,也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 否,使用Token认证时该字段必选。 - X-Sdk-Date 请求的发生时间,格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 否,如果使用AK/SK做接口认证的时候,那么此字段必须设置;如果使用PKI token的时候,不必设置。 20190307T101459Z Authorization 签名认证信息。 该值来源于请求签名结果,使用AK/SK进行加密签名的时候需要。 类型:字符串 默认值:无 否,使用AK/SK认证时必选。 SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994 Host 请求的服务器信息,从服务API的URL中获取。 值为hostname[:port]。 端口缺省时使用默认的端口,https的默认端口为443。 否,使用AK/SK认证时必选。 code.test.com 或者 code.test.com:443 API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。AK/SK认证的详细说明请参见API签名指南。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://mssi.cn-north-4.myhuaweicloud.com/v1/{project_id}/flows/{flow_id}/run Content-Type: application/json
  • 请求URI 请求URI由如下部分组成: {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 请求URI 参数 说明 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议不要直接使用账号进行日常管理工作,而是创建并使用用户进行日常管理工作。 IAM用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区 可用区是同一服务区内,电力和网络互相独立的地理区域,一般是一个独立的物理机房,这样可以保证可用区的独立性。 一个区域内有多个可用区,一个可用区发生故障后不会影响同一区域内下的其它可用区。 可用区间通过内网访问。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问账号中该区域的所有资源。如果希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 同样在我的凭证下,可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 概述 欢迎使用开天集成工作台(MacroVerse SmartStage for Integrators,MSSI),开天集成工作台是一个助力企业应用创新的开放的集成平台。基于元数据、可配置的集成框架,汇聚丰富的集成资产以及开发工具,帮助企业实现业务流程的自动化,连通企业内的应用孤岛,以及创新应用的高效(低代码)开发。 您可以使用本文档提供的API对MSSI服务进行相关操作,如查询、提交、启用流。MSSI服务支持的全部操作请参见API概览。 在调用开天集成工作台API之前,请确保已经充分了解开天集成工作台相关概念,详细信息请参见《产品介绍》。 父主题: 使用前必读
  • 响应示例 状态码: 200 请求成功。 { "count" : 1438, "histories" : [ { "id" : "df00b54a-7765-4ed9-98fe-1504119841e4", "flow_id" : "55e42ede-25dd-4f79-9aa4-842e1ba435a1", "flow_name" : "业务对象测试", "flow_version_id" : "55e42ede-25dd-4f79-9aa4-842e1ba435a1", "run_model" : "auto", "status" : "fail", "icon" : null, "start_time" : "2022-02-28T06:24:04.022Z", "end_time" : "2022-02-28T06:24:04.022Z", "exec_time" : 0, "running_times" : null, "last_time" : null, "message" : "trigger action running fail." } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Long 历史记录总数。 histories Array of histories objects 所有历史记录的信息。 表4 histories 参数 参数类型 描述 id String 流运行记录ID。 flow_id String 流ID。 flow_name String 流名称。 flow_version_id String 流运行版本ID。 run_model String 流运行模式,通常有手动、自动、测试这几种。手动方式需要用户在页面点击运行流,自动方式会按照触发器的类型自动运行流,测试方式用户在创建流的时候可以测试流的功能。 status String 最后一次运行,流运行状态。 success: 流运行成功 fail: 流运行失败 icon String 流图标。 start_time String 开始时间。 end_time String 结束时间。 exec_time Long 执行时间,单位毫秒。 running_times Long 运行次数。 last_time String 最后一次运行时间。 message String 最后一次运行,输出的错误信息。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • URI GET /v2/{project_id}/flows/{flow_id}/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,用于资源隔离。获取方法请参考获取项目ID。 flow_id 是 String 流id。 表2 Query参数 参数 是否必选 参数类型 描述 time_range 否 String 时间筛选范围,查询该范围内的流运行记录。UTC时间格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'toyyyy-MM-dd'T'HH:mm:ss.SSS'Z'如:2020-11-10T00:00:00Zto2020-11-12T00:00:00。 status 否 String 流运行状态,枚举值。 success: 流运行成功 fail: 流运行失败 offset 否 Integer 当前页,起始页数应大于等于0。 最小值:1 limit 否 Integer 每页记录数,每页记录数应大于等于1。 最小值:1
  • 响应示例 状态码: 200 请求成功。 { "id" : "d96ba061-3caf-49cb-8950-4dac97a8f082", "flow_id" : "cfdcacae-a44f-4827-8ad9-db47ad2a8b41", "flow_name" : "遍历集合元素测试", "run_model" : "manual", "status" : "success", "icon" : "https://connector-icon.obs.cn-north-7.ulanqab.huawei.com/icon/c9710579264845c6a5339fd738e66fd6/155e6930bdb24d9d95b5d3c636e133eb.png", "start_time" : 1655881122470, "end_time" : 1655881126839, "exec_time" : 4369, "message" : null, "steps" : [ { "stepId" : "05778538-83a6-467b-bb92-738d9049bb3c", "actionName" : "手动触发器触发事件", "actionType" : null, "call" : { "connectorRef" : "ManualTrigger", "triggerRef" : { "refName" : "手动触发器触发事件", "refId" : "ManualTrigger", "type" : "instant", "authentication" : { "connectionId" : null, "schema" : null }, "input" : { "body" : { } }, "config" : null, "customFunctionMap" : null }, "actionRef" : null, "connectorVersion" : "1" }, "transmit" : [ "bc744b98-007f-496e-bd10-ed460548f7de" ], "icon" : "https://connector-icon.obs.cn-north-7.ulanqab.huawei.com/icon/c9710579264845c6a5339fd738e66fd6/155e6930bdb24d9d95b5d3c636e133eb.png", "name" : "手动触发流", "lastRunningStatus" : "success", "cost" : 354 } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Long 历史记录总数。 histories Array of histories objects 所有历史记录的信息。 表4 histories 参数 参数类型 描述 id String 流运行记录ID。 flow_id String 流ID。 flow_name String 流名称。 flow_version_id String 流运行版本ID。 run_model String 流运行模式,通常有手动、自动、测试这几种。手动方式需要用户在页面点击运行流,自动方式会按照触发器的类型自动运行流,测试方式用户在创建流的时候可以测试流的功能。 status String 最后一次运行,流运行状态。 success: 流运行成功 fail: 流运行失败 icon String 流图标。 start_time String 开始时间。 end_time String 结束时间。 exec_time Long 执行时间,单位毫秒。 running_times Long 运行次数。 last_time String 最后一次运行时间。 message String 最后一次运行,输出的错误信息。 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • URI GET /v2/{project_id}/flows/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,用于资源隔离。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 time_range 否 String 时间筛选范围,查询该范围内的流运行记录。UTC时间格式:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'toyyyy-MM-dd'T'HH:mm:ss.SSS'Z'如:2020-11-10T00:00:00Zto2020-11-12T00:00:00。 name 否 String 流的名称。 status 否 String 流运行状态,枚举值。 success: 流运行成功 fail: 流运行失败 offset 否 Integer 当前页,起始页数应大于等于0。 最小值:1 limit 否 Integer 每页记录数,每页记录数应大于等于1。 最小值:1
  • 响应示例 状态码: 200 请求成功。 { "count" : 5, "histories" : [ { "id" : "f4ce35fd-5e33-4d9e-b7e1-63f3a07d74ce", "flow_id" : "55e42ede-25dd-4f79-9aa4-842e1ba435a1", "flow_name" : "业务对象测试", "flow_version_id" : null, "run_model" : null, "status" : "fail", "icon" : "data:image/png;base64,iVBORw0KGgoAAA...", "start_time" : "2022-02-28T03:34:04.025Z", "end_time" : null, "exec_time" : 0, "running_times" : 1438, "last_time" : "2022-02-28T03:34:04.025Z", "message" : "trigger action running fail." }, "..." ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 success Boolean 响应是否成功,默认为true。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 running_id String 流记录id。 flow_id String 流id。 success Boolean 流运行状态 success: 流运行成功 fail: 流运行失败 flow_name String 流名称。 message String 返回信息。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:8 最大长度:36 error_msg String 错误描述。 最小长度:2 最大长度:512
  • 错误码 状态码 错误码 错误信息 描述 处理措施 400 MSSI.00010001 connector is not found 连接器不存在 请检查填写的连接器。 400 MSSI.00010002 icon not found 图片资源不存在 请检查填写的图片资源。 400 MSSI.00010003 swagger data not found swagger资源不存在 请检查填写的swagger资源。 400 MSSI.00010004 connector can not delete 内置连接器无法删除 请正确选择要删除的连接器,内置连接器无法删除。 400 MSSI.00010005 connector was used in flow or template can not delete 该连接器已在流中使用,请删除流后再进行此操作 请先删除使用该连接器的流。 400 MSSI.00010006 connector name can not be null 创建连接器,名称不可为空字符串 请填写连接器名称。 400 MSSI.00011001 flow not found 流不存在 请检查填写的流。 400 MSSI.00011002 flowConnector not found 流对应的连接器找不到 请选择其他连接器。 400 MSSI.00011003 flowRepository not found 流对应的仓库找不到 请选择其他仓库。 400 MSSI.00011004 duplicate flowName 流名称重复 请重命名重复的流名称。 400 MSSI.00012001 template not found 模板不存在 请检查填写的模板。 400 MSSI.00012002 cooperation not found 模板供应商不存在 请选择其他模板供应商。 400 MSSI.00013001 gateway not found 网关不存在 请选择其他网关。 400 MSSI.00014001 share not found 共享数据不存在 请选择其他共享数据。 400 MSSI.00015001 connect not found 连接不存在 请检查填写的连接。 400 MSSI.00015002 connectionName repeat 连接名称重复 请更换重复的名称。 400 MSSI.00016001 function not found 函数找不到 请检查填写的函数。 400 MSSI.00017001 data format is incorrect 数据格式不正确 请检查填写的数据格式。 400 MSSI.00017002 no permission 无权限操作该资源 请添加操作该资源的权限。 400 MSSI.00017003 no certification 无认证方式 请添加认证方式。 400 MSSI.00017004 batch operate apic failed 批量操作APIC失败 请稍后重试,或者联系技术支持人员。 400 MSSI.00017005 operate swagger failed 批量操作SWAGGER失败 请稍后重试,或者联系技术支持人员。 400 MSSI.00017006 to bean failed JsonUtils 请检查JSON格式的合法性。 400 MSSI.00017007 is not a pic 导入不是图片文件 请导入图片文件。 400 MSSI.00017008 is not a swagger 导入文件不符合Swagger标准 请检查导入的文件是否符合Swagger标准。 400 MSSI.00017010 param is invalid 连接正在使用,无法删除 请先停止正在使用的流程,再删除。 400 MSSI.00017011 flow is enable 流正在使用,无法删除 请先停止正在使用的流,再删除。 400 MSSI.00020001 flow is not exist 流程不存在 请检查填写的流程。 400 MSSI.00020002 connector is not exist 连接器不存在 请检查填写的连接器。 400 MSSI.00020003 connect is not exist 连接不存在(认证连接) 请核对鉴权信息。 400 MSSI.00020005 time_range is invalid, example:2020-11-10T00:00:00.000Zto2022-23-10T00:00:00.000Z 无效的时间范围格式 请更改时间格式为统一UTC时区。 400 MSSI.00020006 decrypt database password error 数据库密码错误 请检查填写的数据库密码。 400 MSSI.00020007 trigger type is invalid. 无效的触发器类型 请检查触发器类型是否符合规范。 400 MSSI.00020008 flow has no trigger step. Please check flow step config. 不存在FLowStep 请检查FLowStep配置信息。 400 MSSI.00020009 connector is not exist or deploy_url is empty. 连接器不存在或部署地址为空 请检查填写的连接器是否规范,或者是否填写部署地址。 400 MSSI.00020011 param is invalid. 参数无效 请检查填写的参数。 400 MSSI.00020012 running history is not exist. 流运行历史不存在 请检查填写的流。 400 MSSI.00020015 time_range exceeds 30 days. 时间范围超过30天 请检查选择的时间区间 400 MSSI.00020016 connector release version not exits. 连接器发布版本不存在 请检查连接器版本 400 MSSI.00020017 connector invoke record not exits. 连接器调用记录不存在 请检查填写的连接器 400 MSSI.00020018 flow status is disable 流被禁用 请检查流的状态 400 MSSI.00020019 action in not exist 连接器执行动作不存在 请检查执行动作 400 MSSI.00020020 action is not belong to connector 执行动作不属于连接器 请检查执行动作 403 MSSI.00020004 forbidden operation. concat the project owner 操作越权,禁止操作。 操作了其他租户的资源 请检查权限信息。 500 MSSI.00029999 unknown error 未知的异常,一般来说是系统内部超出预期的异常 系统错误,请联系技术支持人员。 500 MSSI.00050001 Internal Server Error 未知的异常,一般来说是系统内部超出预期的异常 系统错误,请联系技术支持人员 500 MSSI.00050002 Failed to connection DataSource 连接数据源失败 请检查数据源连接信息 500 MSSI.00050004 Unsupported datasource type 不支持的数据源类型 请检查数据源类型 500 MSSI.00050005 MetaModel adapter is not found 元模型适配器未找到 请检查元模型适配器 500 MSSI.00050013 Task not found 采集任务未找到 请检查采集任务 500 MSSI.00050015 MetaData adapter failed 元数据采集适配器失败 请检查元模型适配器 400 MSSI.00050018 Some params are invalid 参数不合法 请检查参数 400 MSSI.00050019 Resource count over limit 资源超限 请检查资源配额 404 MSSI.00050021 Resource not exist 资源不存在 请检查资源是否存在 403 MSSI.00050022 No permission 没有权限访问 请检查权限 500 MSSI.00050024 Schedule log aspect record schedule log failed 审计日志记录失败 系统错误,请联系技术支持人员 400 MSSI.00050025 Unsupported adapter type 不支持的适配器类型 请检查适配器类型 403 MSSI.00050027 Taskcollector's parameter has modify failed, task maybe in the status of starting, executing and stopfailed. 任务采集失败 请检查采集任务 父主题: 附录
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全