云服务器内容精选

  • URI POST 华为云Astro轻应用 域名 /u-route/baas/v1.0/flow/{action}/{name_or_id} 表1 参数说明 参数 是否必选 参数类型 描述 action 是 String 参数解释: 需要对服务编排执行的操作。 约束限制: 不涉及。 取值范围: 各个操作取值及其含义如下: start:启动服务编排,系统标准启动操作。 run:开始执行服务编排,自定义启动操作。 next:执行服务编排的下一步。 back:执行服务编排的上一步。 finish:结束运行的服务编排,即正常完成服务编排。 terminate:终止运行的服务编排实例和相关资源。 del:删除服务编排实例和相关资源。 默认取值: 不涉及。 name_or_id 是 String 参数解释: 当action取值为start或run时,设置为服务编排的名称。其他操作设置为服务编排的运行实例ID,可通过调用查看服务编排运行实例接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 result result object 参数解释: 成功请求时,会返回interviewId和outputs两个字段。 表3 result字段说明 参数 参数类型 描述 interviewId String 参数解释: 服务编排的运行实例ID。流程启动成功后,可以从返回结果中获取到运行实例ID。 取值范围: 不涉及。 outputs Any 参数解释: 服务编排的执行结果,由服务编排输出决定,可为任意取值。
  • 请求示例 开始运行服务编排,例如调用start命令执行了服务编排“testFlowXyz”,传入参数为自定义的参数。 POST https://华为云Astro轻应用域名/u-route/baas/v1.0/flow/start/testFlowXyz { "paramA": "valueA", "paramB": { "subParamBA": [ "A", "B" ], "subParamBB": "BB" } }
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "createdBy": "10gd000000QwWjXspAOW", "createdBy.__objectType": "User", "createdBy.name": "bingo", "createdDate": "2021-05-19 11:41:30", "curElement": "isMasterAccountByIdentityId", "description": "", "endTime": "", "id": "002N000000jrOCerKZBQ", "label": "isMasterAccount 2021-05-19 11:41:30", "lastHandler": null, "lastModifiedBy": "10gd000000QwWjXspAOW", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "bingo", "lastModifiedDate": "2021-05-19 11:41:30", "name": "CP_DS__isMasterAccountForOperator", "owner": "10gd000000QwWjXspAOW", "owner.__objectType": "User", "owner.name": "bingo", "rootID": "", "runMode": 2, "startTime": "2021-05-19 11:41:30", "state": "Broken", "suspended": false, "type": "Flow", "type.name": "Flow", "version": "1.0.1" } }
  • URI GET 华为云Astro轻应用域名/u-route/baas/v1.0/flow/{action}{?owner&creater&fields&orderField&orderType&limit&offset} 表1 参数说明 参数 是否必选 参数类型 描述 action 是 String 参数解释: 需要查询的服务编排状态或者根据id查询服务编排信息。 约束限制: 不涉及。 取值范围: 各个状态取值及其含义如下: activeFlow:正在执行的服务编排。 suspendedFlow:延时的服务编排。 terminatedFlow:被终止的服务编排。 completedFlow:正常完成的服务编排。 instanceId:根据id查询服务编排信息,请求时该参数需替换为具体的服务编排运行实例ID。 默认取值: 不涉及。 owner 否 String 参数解释: 所属账号ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creater 否 String 参数解释: 创建者ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 fields 否 Array 参数解释: 字符串数组,为需要查询的字段,不传则默认。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 orderField 否 String 参数解释: 用于排序的字段,需要在fields中。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 orderType 否 String 参数解释: 排序方式。 约束限制: 不涉及。 取值范围: 0:代表Asc升序。 1:代表Desc降序。 默认取值: 不涉及。 limit 否 Integer 参数解释: 数据条数限制。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 offset 否 Integer 参数解释: 数据起始位置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 result Object 参数解释: 成功请求时会有内容返回,内容包含请求中传入的fields中的字段或默认字段。
  • 调用服务 聚合服务发布成功后,您可根据业务需要调用已发布的API接口。调用方在目标服务的“服务发布”页签中获取相应的API调用信息后,可通过API方式调用服务编排。 图1 获取API调用信息(纯脚本服务示例) API调用信息:包括生产环境API调用链接和测试环境API调用链接。其中测试环境API需在测试环境发布后才支持调用。 请求头参数说明:包括tenantId和Iam-X-Auth-Token。 表1 请求头参数获取方法 名称 获取方法 tenantId 登录LinkX-F系统后,在浏览器地址栏复制对应tenantId值。 Iam-X-Auth-Token Token获取的具体方法可参考认证鉴权。 请求体参数说明:来源于“服务定义”页签中设置的入参。
  • 创建私有结构体 服务编排中如果涉及复杂的结构体参数,可以先创建全局或私有结构体,并用作参数类型。创建全局结构体和私有结构体后,再参考创建对象变量/结构体变量/事件变量中操作,创建全局结构体变量和私有结构体变量,作为服务编排的参数类型。 在服务编排设计器右侧,选择,在私有结构体页面单击“新增”。 该“私有结构体”页面有两个“新增”按钮,单击上面的“新增”按钮,是通过设置页面参数新建私有结构体。单击下面的“新增”按钮,是通过输入JSON Schema类型的数据源码定义私有结构体。 图12 添加私有结构体类型 (如果上一步单击“私有结构体”页面上方的“新增”按钮,请执行该步骤)设置页面参数。 在“基本信息”中,输入结构体名字、描述信息。 在“结构体成员”中,设置自定义成员变量,包括设置成员变量的名称、数据类型、是否必填、是否是集合和描述信息等。单击“新增”,可增加成员变量,支持设置全局结构体或私有结构体成员变量。当私有结构体的成员变量包含结构体类型时,您需要提前定义成员结构体。例如,下图中成员变量“hobby”为私有结构体类型,需要提前创建“create”私有结构体。 图13 配置私有结构体 (如果上一步单击“私有结构体”页面下方的“新增”按钮,请执行该步骤)在“创建JSON Schema”页面中,定义结构体名称,在“JSON源码”中输入数据源码,单击,系统会进行校验,转换成服务编排中的结构体类型,单击“保存”。 图14 创建JSON Schema 数据源码示例如下: { "name": "xiaoming", "age": 18, "father": { "name": "daliu", "gender":"male" }, "brother": { "name": "xiaolei", "gender":"male" } } 创建成功后,页面显示如下。 图15 创建成功 该方式创建的结构体中,包含成员结构体时,成员结构体具体定义不会在界面显示,且其他结构体不可引用。 JSON结构体支持嵌套,例如上述创建的“family”结构体,在“JSON Schema结构体”区域再次单击“新增”,新增“company”结构体,里面“ceo”嵌套引用“family”结构体,如下图所示,在定义结构体输入值时,您可以输入“$”符号,选择当前服务编排中的其它结构体进行嵌套引用。 图16 引用其他结构体
  • 创建服务编排 参考登录华为云Astro轻应用应用设计器中操作,登录应用设计器。 在左侧导航栏中,选择“逻辑”。 (可选)单击编排后的,为服务编排添加目录。 服务编排默认存放在根目录下,在创建服务编排前,您可以先创建服务编排存放的目录,也可以在服务编排创建后将其拖拽到指定目录。 将鼠标放在已创建的服务编排目录上,单击,进入“添加服务编排”页面。 如果未创建服务编排目录,请直接单击编排后的,进入添加服务编排页面。 设置参数,单击“添加”。 图1 创建服务编排 表1 添加服务编排参数说明 参数 说明 标签 新建服务编排的标签名,用于在界面展示,创建后可修改。 取值范围:1~64个字符。 名称 服务编排在系统中的唯一标识,创建后不支持修改。系统会自动在名称前添加“{命名空间}__”,当其他功能调用服务编排时,调用的是服务编排的名称,而不是标签。 命名要求如下: 长度不能超过64个字符,包括前缀命名空间的长度。 名称前的内容为命名空间,在华为云Astro轻应用中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。 名称必须以英文字母开头,只能由英文字母、数字或单下划线组成,且不能以下划线结尾。 类型 在下拉框中,选择服务编排的类型。 Autolaunched Flow:自启动Flow,在接口调用后会立即执行服务编排模型定义的逻辑。 Event Trigger:事件触发的服务编排,在事件触发时才会开始执行服务编排模型定义的逻辑。当选择该类型时,您需要配置具体的事件以及条件规则。 默认值:Autolaunched Flow。 描述 请根据实际需求,输入服务编排的描述信息,建议设置为服务编排的功能介绍。 取值范围:1~255个字符。 创建变量。 在服务编排设计器中,单击,进入全局上下文页面。 单击“变量”后的,创建表2中的变量。 图2 创建变量 表2 变量说明 变量名 类型 变量说明 userName 文本 传入的用户名 message 文本 欢迎信息 在全局上下文中,除了创建基本类型的变量,还可以创建常量、创建公式变量、创建私有结构体和创建对象变量/结构体变量/事件变量。 单击,配置服务编排的输入输出参数。 图3 配置输入输出参数 将“逻辑”中的“赋值”图元,拖拽到画布中。 赋值图元可以实现对全局上下文中变量等参数进行赋值,其他图元的详细介绍,请参见为华为云Astro轻应用服务编排设置图元。 图4 拖拽赋值图元到画布 配置图元。 选择赋值图元,单击。 在“赋值”页面中,单击“新增行”,参照下图将创建的变量拖拽到相应的位置。 将“"Hello,"”赋值给message变量,并将userName变量拼接到message变量中,赋值语句将从上往下依次执行。 图5 配置赋值图元 连接图元指定逻辑关系,即从开始图元连向赋值图元,表示服务编排开始执行后,执行赋值图元的赋值语句。 图6 连接图元 单击页面上方的,保存服务编排。 单击,进入服务编排调试页面。 在输入参数中,输入如下内容,并单击“运行”。 { "userName": "Flow" } 运行结果如下,输出“Hello,Flow”。 图7 运行结果 单击页面上方的,启用服务编排。 服务编排启用后,才可以在脚本、工作流等操作中引用。 调试已创建的服务编排。 在应用设计器左侧导航栏中,选择“集成”。 单击开放接口后的“+”,新建一个helloFlow开放接口,单击“保存”。 图8 新建开放接口helloFlow 接口创建后,在开放接口中,将鼠标放在已创建的接口上,单击,选择“查看”。 在预览页面,单击接口后的。 单击“测试一下”,输入示例模型,单击“执行”。 图9 测试接口 执行成功后,可查看到API的测试结果。 [ "resCode": "0", "resMsg": "成功", "result": [{ "message": "Hello, Flow" }] ]
  • 创建常量 编排服务流程或交互时,不会改变的值或参数,通常定义为常量,例如服务标识、访问地址和错误码等。 在服务编排设计器右侧,选择。 在全局上下文页面,单击“常量”后的。 单击新增常量后的“...”,选择“设置”。 设置页面参数,单击“保存”。 图10 配置常量 表3 常量参数说明 参数 说明 名称 新建常量的名称,名称是变量在流程中引用的唯一标识。修改变量名不会改变图元中的引用,但是会导致流程不可用。 数据类型 常量的数据类型,直接在下拉框中选择即可,默认为“文本”类型。 值 新建常量的取值,字符串常量输入需要用双引号括起来,例如“"abc"”。 描述 根据实际需求,输入变量的描述信息。 外部使用 如果勾选该选项,表示该变量为外部使用变量,编译时不校验其是否被使用。 默认为不勾选。
  • 创建对象变量/结构体变量/事件变量 对象变量用于在服务编排中引用或操作特定的对象实例,用于较简单的业务流程中。结构体变量允许将多个不同类型的数据项进行组合,通常用于较复杂的业务流程中。事件变量用于表示系统或业务流程中发生的事件,事件可以是系统内部产生的,也可以是外部触发的。 在服务编排设计器右侧,选择。 在全局上下文页面,单击“对象变量”后的。 设置页面参数,以创建对象变量为例进行介绍。 图17 配置对象变量 表5 对象变量参数说明 参数 说明 名称 输入新建对象变量的名称,名称是变量在流程中引用的唯一标识。修改变量名不会改变图元中的引用,但是会导致流程不可用。 对象 请直接在下拉框中,选择具体的对象。选择“对象”类型时,该参数才会显示。 全局结构体 请直接在下拉框中,选择具体的全局结构体。选择“全局结构体”类型时,该参数才会显示。 私有结构体 请直接在下拉框中,选择具体的私有结构体。选择“私有结构体”类型时,该参数才会显示。 事件 请直接在下拉框中,选择具体的事件。选择“事件”类型时,成员变量为事件的自定义字段,不包括系统预置的标准字段。选择“事件”类型时,该参数才会显示。 默认值 请直接输入变量的默认值或从下拉框中选择。 描述 请根据实际需求,输入变量的描述信息。 取值范围:1~255个字符。 是否为数组 是否为数组变量,即集合变量。 默认为不勾选。 外部使用 勾选该选项,表示该变量为外部使用变量,编译时不校验其是否被使用。 默认为不勾选。
  • 创建公式变量 在服务编排中,公式变量主要用于变量赋值、表达式计算、参数传递等。 在服务编排设计器右侧,选择。 在全局上下文页面,单击“公式”后的。 设置页面参数,单击“保存”。 图11 配置公式变量 表4 公式变量参数说明 参数 说明 名称 输入新建公式变量的名称。 数据类型 公式变量的数据类型,直接在下拉框中选择即可,默认为“文本”类型。 描述 根据实际需求,输入公式变量的描述信息。 外部使用 勾选该选项,表示该变量为外部使用变量,编译时不校验其是否被使用。 默认为不勾选。 表达式 设置新增变量的表达式。如果表达式中需要运用公式,可根据需要双击“公式”区域中系统预置的公式,该公式会显示在右侧“表达式”区域中。当表达式中需要有变量参数时,可从变量区域中直接选择变量拖入到表达式中。
  • 如何使用记录创建图元 在基本中,拖拽“记录创建”图元至画布中。 选中记录创建图元,单击,设置基本信息。 表1 基本信息参数说明 参数 说明 标签 设置图元的标签,用于在服务编排设计页面展示。系统会自动填入该值,格式为RecordCreate序号,序号从“0”开始,表示同类型图元序号。 名称 设置图元的名称,名称为图元在服务编排中的标识,请确保在当前服务编排中唯一。命名要求如下: 长度范围为1~80个字符。 必须以英文字母开头,由英文字母,数字或单下划线组成,且不能以下划线结尾。 描述 请根据实际需求,在输入框中输入图元的描述信息。 取值范围:1~255个字符。 使用快速创建模式 是否启用快速创建模式。 如果勾选该参数,表示为快速模式。该模式可以创建一条或者多条记录,仅需要配置对象的对象变量(与对象关联的变量)或对象变量数组。该图元负责将对象变量或对象变量数组的值写入数据库。当对象变量为数组时,则实现创建多条记录。创建成功后,返回的记录ID自动保存在对象变量中。创建记录的各个字段的值为对象变量中的值,因此一般需要在创建记录之前先给对象变量进行赋值。 不勾选,表示为普通模式。该模式下每次执行到该图元仅创建一条记录,需要配置要创建记录的对象名,对象中字段的值,返回的记录ID保存到变量名中。 默认为不勾选。 单击,在“记录创建”页面进行配置。 如果上一步勾选“使用快速创建模式”,则需要指定一个预先定义的对象变量或者对象变量数组,并将该对象变量或对象变量数组拖拽到“变量”输入框中,使用该对象变量或对象变量数组的值创建新记录。如下图所示,使用“accountCreate”对象变量的值创建新记录。 图1 快速创建模式 表2 快速创建模式参数说明 参数 说明 变量 预先定义的对象变量或对象变量数组,使用该对象变量或者对象变量数组的值创建新记录。 从全局上下文拖拽或直接输入对象变量/对象变量数组。 当前流程出现错误时回滚 勾选表示在服务编排中,当后续图元失败的情况下,就可以回滚到上一个流程。 不勾选,在服务编排中,当出现后边图元失败的情况下,对象记录操作的图元就不回滚。 默认为勾选。无特殊要求,请不要更改设置。 如果上一步未勾选“使用快速创建模式”,则需要指定对象并为对象的字段赋值来创建记录。如图2所示,为“Account”对象新增“name”为“Lily”的数据记录,在变量“var_record_id”中保存新建的记录ID。 图2 普通创建模式 表3 普通创建模式参数说明 参数 说明 对象 请在下拉框中,选择具体的对象。这里只能使用当前项目中的,依赖BO中公开的以及全局的对象。 当前流程出现错误时回滚 当前服务编排出现错误时,回滚到上一个流程。 默认为勾选。无特殊要求,请不要更改设置。 赋值 选中对象后,该赋值区域“目标”列会出现该对象的字段。如果需要给多个字段赋值,则单击“新增行”,定义其他字段的值。 在“目标”中选择需要赋值的对象字段,“源”则可从全局上下文拖拽变量或者直接输入“{!变量名}”。 变量 将创建的记录ID分配到该变量中,以便在服务编排中引用。 从全局上下文拖拽或直接输入文本类型变量。
  • 如何使用BO图元 在BO中,拖拽所需的BO图元至画布中。 选中BO图元,单击,设置基本信息。 表1 基本信息参数说明 参数 说明 标签 设置图元的标签,用于在服务编排设计页面展示。系统会自动填入该值,格式为BO名序号,序号从“0”开始,表示同类型图元序号。 名称 设置图元的名称,名称为图元在服务编排中的标识,请确保在当前服务编排中唯一。命名要求如下: 长度范围为1~80个字符。 必须以英文字母开头,由英文字母,数字或单下划线组成,且不能以下划线结尾。 描述 根据实际需求,输入图元的描述信息。 取值范围:1~255个字符。 单击,在“BO”页面进行配置。 图1 配置BO图元 表2 BO图元配置参数说明 参数 说明 服务版本 BO中自定义API的版本号。 API类型 根据实际需求,选择REST或SDK。 操作方法 BO中已自定义好的API接口,该API接口类型必须是“服务编排”,才可在服务编排中调用。 入参/目标 当选择具体操作方法(API)后,API的输入参数将会显示在入参的目标列。 入参/源 服务编排中的变量,需要和目标的参数类型保持一致。该源会将服务编排中的变量,赋值给调用API的输入参数。 出参/源 当选择具体操作方法(API)后,API的输入参数将会显示在出参的源列。 出参/目标 服务编排中的变量,需要和输出参数的类型保持一致。API中的输出参数赋值给服务编排中的变量,供服务编排使用。
  • 在已有服务编排基础上新建服务编排 需要开发的新服务编排与已有的某个服务编排类似,此时可以基于原有服务编排修改,再保存为新的服务编排。在此场景下,原有服务编排仍然有效。新服务编排和老服务编排也没有关联关系,各自独立。 参考登录华为云Astro轻应用应用设计器中操作,登录应用设计器。 在左侧导航栏中,选择“逻辑”。 将鼠标放在对应的服务编排上,单击,选择“编辑”,进入服务编排设计页面。 在服务编排设计页面上方,单击,进入另存为页面。 “类型”选择“新服务编排”,设置服务编排标签,单击“保存”。 图3 另存为新服务编排 表2 另存为新服务编排参数说明 参数 说明 标签 服务编排的标签,用于在页面展示,创建后可修改。 取值范围:1~64个字符。 名称 服务编排在系统中的唯一标识,创建后不支持修改。系统会自动在名称前添加“{命名空间}__”,当其他功能调用服务编排时,调用的是服务编排的名称,而不是标签。 命名要求如下: 长度不能超过64个字符,包括前缀命名空间的长度。 名称前的内容为命名空间,在华为云Astro轻应用中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。 名称必须以英文字母开头,只能由英文字母、数字或单下划线组成,且不能以下划线结尾。 类型 在下拉框中,选择服务编排另存的类型。 新版本:基于原有服务编排创建一个新版本的服务编排,创建后原有服务编排作为老版本自动失效。 新服务编排:基于原有服务编排创建一个新的服务编排。创建后原有服务编排仍然有效。新服务编排和老服务编排也没有关联关系,各自独立。 默认值:新版本,此处请选择“新服务编排”。 服务编排类型 继承创建基础服务编排时配置的类型,不可更改。 展示标签 服务编排实例的展示标签,系统自动填充为“标签值{!$Flow.CurrentDateTime}”。设置后,单击服务编排设计页面的空白处,再单击,在“基本信息”中可查看到设置的标签。 描述 根据实际需求,输入服务编排的描述信息。 取值范围:1~255个字符。 在服务编排设计页面,进行定制修改。 在服务编排设计页面,可查看到新建的服务编排,且版本为1.0.1。 图4 编辑新服务编排的内容 服务编排定制完成后,单击页面上方的,保存服务编排。 保存成功后,单击,运行服务编排,检查服务编排运行结果是否符合预期。 符合预期后,单击页面上方的,启用服务编排。