华为云用户手册

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 version_id 是 String 训练作业的版本ID。version_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.version_id”。或可通过查询训练作业列表的响应获取。 表2 get_job_log_file_list返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 log_file_list List 训练作业的日志文件名。单机作业日志仅有一个文件，分布式作业日志有多个文件。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id和version_id获取 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, job_id="182626", version_id="278813") job_log_list = estimator.get_job_log_file_list() 方式二：根据创建训练作业生成的训练作业对象获取 1 job_log_list = job_instance.get_job_log_file_list() 方式三：根据查询训练作业版本列表返回的指定训练作业版本对象获取 1 job_log_list = job_version_instance_list[0].get_job_log_file_list()

参数说明 表1 get_visualization_job_list请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 status 否 String 可视化作业的运行状态，详细作业状态列表请查看作业状态参考。 per_page 否 Integer 指定每一页展示作业的总量，默认为“10”，“per_page”可选的范围为[1，100]。 page 否 Integer 指定要查询页的索引，默认为“1”。 sortBy/sort_by 否 String 当使用AK/SK认证方式时，参数名为sortBy；当使用用户名密码认证方式时，参数名为sort_by。指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”以及创建时间 “create_time”，日志存储目录“log_dir”。 order 否 String 可选值。 “asc”为递增排序，默认为“asc”。 “desc”为递减排序。 search_content 否 String 指定要查询的文字信息，例如可视化作业名字，默认为空，字符串的长度为[0，100]。 表2 get_visualization_job_list返回参数说明 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 job_total_count Integer 查询的可视化作业总数。 job_count_limit Integer 用户还可以创建可视化作业的数量。 jobs JSON Array 可视化作业的属性列表，具体请参见表3。 表3 jobs属性列表 参数 参数类型 描述 job_id Integer 可视化作业ID。 job_name String 可视化作业的名称。 status Integer 可视化作业的运行状态，详细作业状态列表请参见作业状态参考。 create_time Long 可视化作业的创建时间。 duration Long 可视化作业的运行时长，单位为毫秒。 job_desc String 可视化作业的具体描述。 service_url String 可视化作业的endpoint。 train_url String 可视化作业的日志存储路径。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job_list = VisualizationJob.get_visualization_job_list(modelarts_session=session, status=8, per_page=10, page=1, sort_by="create_time", order="asc", search_content="job") print(job_list)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() algo_info = Estimator.get_train_instance_types(modelarts_session=session) print(algo_info)

响应提取 响应提取是提取接口响应结果的某一部分，命名为参数，供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义，后续测试步骤使用。 在前序测试步骤中，在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数，请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配，提取出与给定正则表达式匹配的返回值。 在后续测试步骤中，通过“${参数名}”方式引用前序测试步骤创建的响应提取。后续步骤的URL、请求头、请求体中均可以引用此参数。如果在JSON格式的请求体中引用此参数，请在参数外使用英文引号，如： { id: "用例ID" name:"${name}" } 响应提取支持根据给定的“key:value”获取字符串，详细配置可参考示例：根据给定的key:value从响应体中获取字符串。 字段 说明 出参名称 用于之后使用${出参名称}来引用此参数，名称使用字母数字下划线。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码。 属性 若来源是响应码，属性为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体（JSON），属性有两种填写方法： 普通提取表达式（非“$”开头），例如“item.name”。 取字段中的值，支持嵌套取值。详细介绍请参见响应体（JSON）检查。 从响应体中提取数组时，下标可以是数字，也可以是“key:value”表达式，详细介绍请参见示例：根据给定的key:value从响应体中获取字符串。 JsonPath表达式(“$.”或“$[”开头)，例如“$.store.book[0].title”。 详细介绍请参见示例：根据JsonPath从响应体中获取数据。 高级提取类型 可选项，使用高级提取类型，辅助提取响应结果信息，若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式： 字符串提取，也就是字符串的截取。 正则表达式，即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能，若不能满足需求可考虑使用正则表达式。 赋值给环境动态参数 将响应提取后的值赋值给动态变量，用于后续测试引用。请参考新建变量，如何设置动态变量。 父主题： 测试用例管理

API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框，选择“生成接口请求代码”，弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码，单击右上角，可一键复制并直接粘贴，支持编辑修改和代码格式化。 生成业务代码 单击“生成代码”下拉框，选择“生成业务代码”，弹出“生成业务代码”对话框。 根据需要选择语言、生成范围（包括“仅当前接口及关联模型”和“整个项目”），单击“生成”将生成的代码存储到本地，开发者可以将代码复制到本地的研发工具（如IntelliJ IDEA）。

pm pm:Object pm对象，含有接口运行关联信息。可利用它获取或设置环境变量和全局变量，且访问请求信息和返回结果信息。 pm:info:Object pm.info对象，含有接口运行关联信息。 pm.info.eventName:String：获取当前执行的脚本类型：前置脚本（prerequest），后置脚本（test）。 pm.info.iterationCount:Number：返回执行循环的总次数，仅集合测试有效。 pm.info.iteration:Number：获取当前执行循环（iteration）次序，仅集合测试有效。 pm.info.requestId:String：获取运行中接口用例的唯一ID。 pm.info.requestName:String：获取运行中接口用例名称。

对于响应的处理 pm.response 在后置脚本中pm.response接口请求完成后返回响应信息，Response SDK 参考。 response包含了以下结构： pm.response.code:Number：获取响应码。 pm.response.status:String：获取响应状态。 pm.response.headers:HeaderList：获取响应头。 pm.response.responseSize:Number：获取响应大小。 pm.response.text():Function：以文本形式输出响应体。 pm.response.json():Function：以json形式输出响应体。 pm.response.setBody('')：设置响应体。 pm.response.headers.get：从响应头中获取指定参数的值，Response SDK 参考。 后置脚本中使用“pm.response.headers.get”命令可以获取响应头中指定参数的值。例如想要获取响应Header中date参数的值，那么可以在后置操作中输入如下自定义脚本： var test = pm.response.headers.get("date"); console.log(test);

对于发送请求的处理 pm.sendRequest pm.sendRequest:Function用于脚本异步发送HTTP/HTTPS的请求。 更多参数信息请查阅Collection SDK 文档 。 在前置脚本和后置脚本都可以使用。 更多参考: Request JSON 结构 Response 结构 // 使用字符串URL示例 pm.sendRequest("https://postman-echo.com/get", function(err, resq) { if (err) { console.log(err); } else { pm.variables.set("variable_name", "new_value"); } }); // 完整请求示例 const echoPostRequest = { url: "https://postman-echo.com/post", method: "POST", header: { header_name1: "value1", header_name2: "value2", }, // body 为 x-www-form-urlencoded 格式 body: { mode: "urlencoded", // 此处为 urlencoded // 此处为 urlencoded urlencoded: [ { key: "account", value: "codeartsapi" }, { key: "password", value: "123456" }, ], }, /* // body 为 form-data 格式 body: { mode: 'formdata', // 此处为 formdata // 此处为 formdata formdata: [ { key: 'account', value: 'codeartsapi' }, { key: 'password', value: '123456' } ] } // body 为 json 格式 header: { "Content-Type": "application/json", // 提醒：header中需要添加Content-Type }, body: { mode: 'raw', raw: JSON.stringify({ account: 'codeartsapi', password:'123456' }) } // body 为 raw 或 json 格式 body: { mode: 'raw', raw: 'body内容' } */ }; pm.sendRequest(echoPostRequest, function(err, resq) { console.log(err ? err : resq.json()); }); // 对返回结果进行断言 pm.sendRequest("https://postman-echo.com/get", function(err, resq) { if (err) { console.log(err); } pm.test("response should be OK to process", function() { pm.expect(err).to.equal(null); pm.expect(resq).to.have.property("code", 200); pm.expect(resq).to.have.property("status", "OK"); }); });

对于请求的处理 pm.request pm.request对象可以在脚本中对请求数据进行访问，Request SDK 参考。在前置脚本中表示即将运行的请求，在后置脚本中，表示已经运行的请求。 pm.request包含了以下结构： pm.request.url:Url：获取当前请求的URL。 pm.request.getBaseUrl()：获取运行中环境选择的前置URL。 pm.request.method:String：获取当前请求的方法，如GET、POST等。 pm.request.headers:HeaderList：获取当前请求的headers列表。 pm.request.body:RequestBody：获取当前请求的body体。 pm.request.headers.add({ key: headerName:String, value: headerValue:String}):function：为当前请求添加指定键和值的header。 pm.request.headers.remove(headerName:String):function：删除当前请求里指定键的header。 pm.request.headers.get(headerName:String):function：获取请求里指定名称的header。 pm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function：插入指定键和值的header（如果header不存在则新增，如果header已存在则修改）。 pm.request.auth：获取请求的身份验证信息。

配置请求规则 请求Mock服务时，系统会根据规则中配置的参数匹配，只有规则下所有参数满足匹配条件时，才可匹配到整个规则。 请求参数，支持Query、Path、Header、Body。 Path参数只有在当前选择的接口的url中存在path变量时才可以显示配置。 Body支持json和xml格式。当请求体为json格式时，匹配规则会同时匹配json中的key和value。 无法保存重复规则。如果同一个接口下的不同规则配置内容一致，会提示无法保存规则。

导入快捷调试 CodeArts API支持Postman的Collection数据文件的导入，也支持Collections和Environments数据集ZIP包的全量导入，方便用户迁移调试数据。 进入“快捷调试”页面，单击，选择“导入Postman文件”。 弹出“导入Postman文件”对话框，选择需要导入的Postman文件。 Collection数据文件的导入 弹出“导入”对话框，选择需要导入的接口，单击“导入”完成数据迁移。 Collections和Environments数据集ZIP包的导入 弹出“导入”对话框，选择需要导入的接口和环境变量，单击“导入”完成数据迁移。 导入通过Postman导出的文件时，接口示例会被同时导入为快捷调试接口，名称和Postman中接口示例名称相同。 父主题： 导入与导出

响应体（JSON）检查 检查响应体（JSON）中对象字段的值。例如： 响应体结构如下： 检查响应体对象中字段名为“status”的值，检查点配置如下： 检查响应体（JSON）中某个数组的对象的字段值（数组条件采用下标确定对象，下标从0开始）。例如： 响应体结构如下： 检查响应体“result”数组的第1个元素对象字段名为“userId”的值，检查点配置如下： 检查响应体（JSON）中某个数组的对象的字段值（数组条件采用模糊匹配功能确定对象）。例如： 响应体结构如下： a.检查响应体“result”数组下“name”是“啤酒”的所有对象取第1个之后获取id的值，检查点配置如下： 当获取的数组下的对象只有一个，“[0]”可以省略，示例中的表达式可以写为“result[name==啤酒].id”。 b.检查响应体“result”数组下“name”是“啤酒”的并且“obj”对象下属性“a”的值是“2”的对象的id值，检查点配置如下：

比较符说明 支持以下比较类型： 比较类型 比较符 是否需要填入值 举例 数字比较 等于(数字) 不等于(数字) 大于等于(数字) 小于等于(数字) 大于(数字) 小于(数字) 是 响应码 等于 200 响应码 不等于 200 响应码 大于等于 200 响应码 小于等于 200 响应码 大于 200 响应码 小于 200 字符串比较 等于(字符串、区分大小写) 不等于(字符串、区分大小写) 等于(字符串、不区分大小写) 包含(字符串) 不包含(字符串) 是 响应体中的属性param1 等于 test 响应体中的属性param2 不等于 test 响应体中的属性param3 等于 TEST 响应体中的属性param4包含 tri 响应体中的属性param5不包含 tri 正则比较 正则表达式 是 响应体中的属性param1 正则表达式 ^[A-Za-z0-9]{1,32}$ 通用比较 是空（该字段是否为空，即是否没有该字段） 不是空（该字段是否不为空，即是否有该字段） 否 响应体中的属性param1 是空 响应体中的属性param2 不是空 Json数组比较 JSON数组为空数组（json数组是否为空数组） JSON数组为非空数组（json数组是否为非空数组） 否 响应体中的属性param1 JSON数组为空数组 响应体中的属性param2 JSON数组为非空数组 JSON数组的大小（json数组的大小是否为...） 是 响应体中的属性param1 JSON数组的大小 类型比较 是JSON类型（是否是json对象类型） 是JSON数组类型（是否是json数组类型） 否 响应体中的属性param1 是JSON类型 响应体中的属性param2 是JSON数组类型 Json对象比较 JSON等于（json等于） 是 响应体中的属性param1 JSON等于 {"name":"zhangsan"}

检查点说明 测试检查点即请求结果的断言，通过检查接口响应是否符合预期，判定系统是否满足预期。 在接口自动化用例中，测试步骤的“检查点”页签中可以定义测试检查点。 检查点内容包括属性、比较符和目标值定义。 字段 说明 重试次数 如果检查点失败，重新执行该测试步骤的次数，重试次数范围：0~5的正整数。 重试间隔 如果检查点失败，每次重试的间隔时长，单位为ms，重试间隔范围：0~10,000的正整数。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码、变量。 属性 若来源是响应码，属性可为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体（JSON），属性有两种填写方法： 普通提取表达式（非“$”开头），例如“item.name”。 取字段中的值，支持嵌套取值。详细介绍请参见响应体（JSON）检查。 从响应体中提取数组时，下标可以是数字，也可以是“key:value”表达式，详细介绍请参见示例：根据给定的key:value从响应体中获取字符串。 JsonPath表达式(“$.”或“$[”开头)，例如“$.store.book[0].title”。 详细介绍请参见示例：根据JsonPath从响应体中获取数据。 若来源是变量，属性为全局变量，局部变量，响应提取后的变量。详细介绍请参见变量检查。 高级提取类型 可选项，使用高级提取类型，辅助提取检查点信息，若选择不涉及，则视为不使用额外的方式匹配。 目前有两种方式： 字符串提取，也就是字符串的截取。 正则表达式，即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能，若不能满足需求可考虑使用正则表达式。 类型值 高级提取类型中所需的参数。 比较符 支持数字、字符串、JSON对象比较、类型比较等多种比较符，详细介绍请参见比较符说明。 目标值 检查点期望值。目标值支持使用内置参数，请参考内置参数了解如何使用内置参数。 例如，检查响应体（JSON格式）中“item.name”字段的第零位（首位）到第四位之间是不是petty，参数配置如下： 字段 值 来源 响应体（JSON） 属性 item.name 高级提取类型 字符串提取 类型值 0、5 比较符 等于(字符串) 目标值 petty

YApi项目导入 导出数据 打开YApi对应项目，单击“数据管理”，进入“数据管理”页面。 在导出数据模块中，选择“json”数据方式，单击导出，完成导出。 导入数据 打开CodeArts API首页，单击“导入项目”。 弹出“导入项目”对话框，选择导入文件格式为“YApi”，选择需要导入的YApi文件。 在“导入项目”对话框输入项目名称，单击“确定”。 弹出“导入预览”对话框，可预览所有导入数据，然后单击“导入”。 弹出导入进度对话框，可查看导入进度。 导入完成后，可进入导入项目，查看导入的接口。 当导入请求体和响应体结构为Json格式时，支持JsonSchema和Json标准（双斜杠类型字段注释将被识别为字段描述）格式导入。

断言 可以利用后置脚本验证API响应返回结果的正确性。 // 示例1：pm.response.to.have pm.test('Response status is 200', function() { pm.response.to.have.status(200); }); // 示例2：pm.expect() pm.test('this is production', function() { pm.expect(pm.environment.get('env')).to.equal('production'); }); // 示例3：response assertions pm.test('no error', function() { pm.response.to.not.be.error; pm.response.to.have.jsonBody(''); pm.response.to.not.have.jsonBody('error'); }); // 示例4：pm.response.to.be* pm.test('no error', function() { // 断言结果：info, success, redirection, clientError, serverError, are other variants pm.response.to.be.ok; // 断言有body，并且是json格式 pm.response.to.be.withBody; pm.response.to.be.json; });

全局代理设置 使用系统代理 进入网络代理设置页面后，默认使用系统代理。 可根据需要选择是否优先使用系统环境变量HTTP_PROXY、HTTPS_PROXY、NO_PROXY，勾选后，CodeArts API会优先调用系统环境变量。 身份认证：请查看身份认证。 不使用代理 选择不使用代理时，此时CodeArts API不使用任何代理（包含系统代理）连接服务器。 自定义 选择自定义代理时，需配置“接口类型”、“代理服务器”、“身份认证”、“Proxy Bypass”。 接口类型：接口类型默认HTTP和HTTPS全选，支持两种协议类型的代理。 代理服务器：需输入代理服务器地址和端口。 身份认证：请查看身份认证。 Proxy Bypass：无需进行代理转发的IP或 域名 ，可填入多个，以英文逗号进行分隔。

响应提取 响应提取是提取接口响应结果的某一部分，命名为参数，供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义，后续测试步骤使用。 在前序测试步骤中，在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数，请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配，提取出与给定正则表达式匹配的返回值。 在后续测试步骤中，通过“${参数名}”方式引用前序测试步骤创建的响应提取。后续步骤的URL、请求头、请求体中均可以引用此参数。如果在JSON格式的请求体中引用此参数，请在参数外使用英文引号，如： { id: "用例ID" name:"${name}" } 响应提取支持根据给定的“key:value”获取字符串，详细配置可参考示例：根据给定的key:value从响应体中获取字符串。 字段 说明 出参名称 用于之后使用${出参名称}来引用此参数，名称使用字母数字下划线。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码。 属性 若来源是响应码，属性为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体（JSON），属性有两种填写方法： 普通提取表达式（非“$”开头），例如“item.name”。 取字段中的值，支持嵌套取值。详细介绍请参见响应体（JSON）检查。 从响应体中提取数组时，下标可以是数字，也可以是“key:value”表达式，详细介绍请参见示例：根据给定的key:value从响应体中获取字符串。 JsonPath表达式(“$.”或“$[”开头)，例如“$.store.book[0].title”。 详细介绍请参见示例：根据JsonPath从响应体中获取数据。 高级提取类型 可选项，使用高级提取类型，辅助提取响应结果信息，若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式： 字符串提取，也就是字符串的截取。 正则表达式，即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能，若不能满足需求可考虑使用正则表达式。 赋值给环境动态参数 将响应提取后的值赋值给动态变量，用于后续测试引用。请参考新建变量，如何设置动态变量。 父主题： 测试用例管理

响应体（JSON）检查 检查响应体（JSON）中对象字段的值。例如： 响应体结构如下： 检查响应体对象中字段名为“status”的值，检查点配置如下： 检查响应体（JSON）中某个数组的对象的字段值（数组条件采用下标确定对象，下标从0开始）。例如： 响应体结构如下： 检查响应体“result”数组的第1个元素对象字段名为“userId”的值，检查点配置如下： 检查响应体（JSON）中某个数组的对象的字段值（数组条件采用模糊匹配功能确定对象）。例如： 响应体结构如下： a.检查响应体“result”数组下“name”是“啤酒”的所有对象取第1个之后获取id的值，检查点配置如下： 当获取的数组下的对象只有一个，“[0]”可以省略，示例中的表达式可以写为“result[name==啤酒].id”。 b.检查响应体“result”数组下“name”是“啤酒”的并且“obj”对象下属性“a”的值是“2”的对象的id值，检查点配置如下：

比较符说明 支持以下比较类型： 比较类型 比较符 是否需要填入值 举例 数字比较 等于(数字) 不等于(数字) 大于等于(数字) 小于等于(数字) 大于(数字) 小于(数字) 是 响应码 等于 200 响应码 不等于 200 响应码 大于等于 200 响应码 小于等于 200 响应码 大于 200 响应码 小于 200 字符串比较 等于(字符串、区分大小写) 不等于(字符串、区分大小写) 等于(字符串、不区分大小写) 包含(字符串) 不包含(字符串) 是 响应体中的属性param1 等于 test 响应体中的属性param2 不等于 test 响应体中的属性param3 等于 TEST 响应体中的属性param4包含 tri 响应体中的属性param5不包含 tri 正则比较 正则表达式 是 响应体中的属性param1 正则表达式 ^[A-Za-z0-9]{1,32}$ 通用比较 是空（该字段是否为空，即是否没有该字段） 不是空（该字段是否不为空，即是否有该字段） 否 响应体中的属性param1 是空 响应体中的属性param2 不是空 Json数组比较 JSON数组为空数组（json数组是否为空数组） JSON数组为非空数组（json数组是否为非空数组） 否 响应体中的属性param1 JSON数组为空数组 响应体中的属性param2 JSON数组为非空数组 JSON数组的大小（json数组的大小是否为...） 是 响应体中的属性param1 JSON数组的大小 类型比较 是JSON类型（是否是json对象类型） 是JSON数组类型（是否是json数组类型） 否 响应体中的属性param1 是JSON类型 响应体中的属性param2 是JSON数组类型 Json对象比较 JSON等于（json等于） 是 响应体中的属性param1 JSON等于 {"name":"zhangsan"}

检查点说明 测试检查点即请求结果的断言，通过检查接口响应是否符合预期，判定系统是否满足预期。 在接口自动化用例中，测试步骤的“检查点”页签中可以定义测试检查点。 检查点内容包括属性、比较符和目标值定义。 字段 说明 重试次数 如果检查点失败，重新执行该测试步骤的次数，重试次数范围：0~5的正整数。 重试间隔 如果检查点失败，每次重试的间隔时长，单位为ms，重试间隔范围：0~10,000的正整数。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码、变量。 属性 若来源是响应码，属性可为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体（JSON），属性有两种填写方法： 普通提取表达式（非“$”开头），例如“item.name”。 取字段中的值，支持嵌套取值。详细介绍请参见响应体（JSON）检查。 从响应体中提取数组时，下标可以是数字，也可以是“key:value”表达式，详细介绍请参见示例：根据给定的key:value从响应体中获取字符串。 JsonPath表达式(“$.”或“$[”开头)，例如“$.store.book[0].title”。 详细介绍请参见示例：根据JsonPath从响应体中获取数据。 若来源是变量，属性为全局变量，局部变量，响应提取后的变量。详细介绍请参见变量检查。 高级提取类型 可选项，使用高级提取类型，辅助提取检查点信息，若选择不涉及，则视为不使用额外的方式匹配。 目前有两种方式： 字符串提取，也就是字符串的截取。 正则表达式，即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能，若不能满足需求可考虑使用正则表达式。 类型值 高级提取类型中所需的参数。 比较符 支持数字、字符串、JSON对象比较、类型比较等多种比较符，详细介绍请参见比较符说明。 目标值 检查点期望值。目标值支持使用内置参数，请参考内置参数了解如何使用内置参数。 例如，检查响应体（JSON格式）中“item.name”字段的第零位（首位）到第四位之间是不是petty，参数配置如下： 字段 值 来源 响应体（JSON） 属性 item.name 高级提取类型 字符串提取 类型值 0、5 比较符 等于(字符串) 目标值 petty

响应示例 状态码： 200 删除服务组成员返回信息 { "data": { "id": "26f562c4-fe11-43d0-9654-f54298d5b12e" "name": "0-65535|0-65535" } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }

请求示例 示例为更新一个IPv4类型的外到内的规则，名称为测试规则，源类型为IP地址，地址为1.1.1.1，目的类型为IP地址，目的地址类型为2.2.2.2，服务类型为服务，协议类型为TCP，源端口为0，目的端口为0，不支持长连接，动作为放行，启用状态为启用 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 { "name" : "测试规则", "status" : 1, "action_type" : 0, "description" : "", "source" : { "type" : 0, "address" : "1.1.1.1" }, "destination" : { "type" : 0, "address" : "2.2.2.2" }, "service" : { "type" : 0, "protocol" : 6, "source_port" : "0", "dest_port" : "0" }, "type" : 0, "address_type" : 0, "tag" : { "tag_key" : "", "tag_value" : "" }, "long_connect_enable" : 0, "direction" : 0 }

云服务器常见问题 如何选择云服务器的个数？ 您可以根据您的应用软件所占用的计算资源（CPU、内存等）进行整体汇总，并根据每个云服务器可提供的计算资源进行估算，得出需要的云服务器的个数。 云服务器的资源是独占的吗？ 是独占的。 对公有云提供的计算资源，您享有完全使用权。这些计算资源与其他用户使用的完全隔离。 是否支持共享池的E CS 加入到DCC集群中? DCC集群不支持共享池的ECS加入到集群中。 可以使用设备节点上的硬盘吗？ 仅支持使用设备节点上的计算资源，不能直接使用设备节点上的硬盘。

启动数据集成任务 数据集成任务创建后，“任务状态”为“停止”状态，此时任务不会执行，需先启动任务。 实时任务启动后，ROMA Connect会不断检测源端数据变更。首次执行时，会把所有符合条件的源端数据集成到目标端，后续若检测到新增数据，则将其集成到目标端。 定时任务启动后，ROMA Connect按照任务计划进行数据集成。首次执行时，会把所有符合条件的源端数据集成到目标端，后续根据任务配置，集成符合条件的全量数据或只集成增量数据。 启动数据集成任务。 在数据集成任务左侧勾选上要启动的任务，单击任务列表上方的“启动”，启动任务。任务启动成功后，“任务状态”变为“启动”。 任务启动后，任务状态为“执行中”，待任务状态为“执行成功”，则表示该数据集成任务执行完成。 执行完成后，可在目标端数据库的数据表中查看集成同步过来的数据。

前提条件 确保业务系统所在网络与ROMA Connect的网络互通。 若通过公网互通，ROMA Connect实例需绑定弹性IP。 确保业务系统的数据库为ROMA Connect支持的数据源类型。 数据API支持的数据源请参见服务集成支持的数据源。 准备一个可用的独立域名，用于作为API的访问域名。 确保已完成独立域名到“服务集成APIC连接地址”的域名解析配置，具体请参考增加A类型记录集。 若还没有独立域名，您可以通过 域名注册服务 申请域名，并通过备案中心完成域名备案。 如果数据API使用HTTPS请求协议，您还需要为独立域名申请SSL证书，并获取pem格式的SSL证书内容和密钥。

在中台实例创建API 在中台实例创建并开放API，使用子公司实例中的API作为后端服务。各子公司或合作伙伴通过调用中台实例开放的API，实现对各子公司能力的调用。 创建API的过程请参考创建API，仅后端配置有如下区别。 表7 API后端服务配置 参数 配置说明 后端服务类型 选择后端服务的类型。使用子公司实例的API作为后端服务时，需选择“HTTP/HTTPS”。 负载通道 是否使用负载通道访问后端服务。使用子公司实例的API作为后端服务时，需选择“使用”。 URL 配置后端服务的URL。 请求方法：选择后端服务的请求方法，根据子公司实例中API的请求方法选择。 请求协议：选择后端服务使用的请求协议，根据子公司实例中API的请求协议选择。 负载通道：选择访问后端服务所使用的负载通道，选择配置级联实例间的负载通道所创建的负载通道。 路径：填写后端服务的请求路径，格式如：/getUserInfo/{userId}。请求路径中可包含Path参数，以{参数名}形式表示。 如果请求路径中需要携带环境变量，则使用“#变量名#”的形式将环境变量添加到请求路径中，如/#path#。环境变量名严格区分大小写，支持添加多个环境变量，如/#path##request#。 级联标识 是否使用级联方式访问后端服务，选择开启。 自定义host头域 自定义后端服务请求中的Host头域。若配置级联实例间的负载通道中创建负载通道时，“后端服务器地址”填写了IP地址，则此处需要填写子公司实例API的域名。 后端超时 (ms) 后端服务请求的超时时间，默认为5000ms。 重试次数 ROMA Connect调用后端服务失败后的重试次数。 值为-1时，表示不开启重试功能。 值为0-10时，表示开启重试功能，并根据设置的值执行重试。重试次数不能大于负载通道中已启用的后端服务器个数。 TLS双向认证 仅当“协议”选择“HTTPS”时可配置。 选择是否在ROMA Connect和后端服务间启用双向认证。使用子公司实例的API作为后端服务时，不启用双向认证。 后端认证 选择是否启用后端认证。使用子公司实例的API作为后端服务时，不启用后端认证。

配置实例间的级联关系 配置中台实例到各子公司实例的级联关系，使中台实例可使用各子公司实例的开放API作为后端服务。 在子公司实例配置级联功能。 登录子公司实例A所在的ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在“实例信息”页面选择“配置参数”页签，并找到级联功能开关参数“cascade”。 单击参数右侧的“编辑”，把参数运行值设置为“on”，然后单击“保存”，打开级联功能开关。 单击参数左侧的“”，展开并配置级联相关配置参数。 表1 子公司实例配置 参数 配置说明 cascade_auth_key 级联认证的加密密钥，用于级联API之间的调用认证。子公司实例和中台实例的cascade_auth_key值必须配置一致。 cascade_instance_ids 填写中台实例的实例ID。 重复1.a-1.d，配置在子公司B的ROMA Connect实例上配置级联功能。 在中台实例配置级联功能。 登录中台实例所在的ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在“实例信息”页面选择“配置参数”页签，并找到级联功能开关参数“cascade”。 单击参数右侧的“编辑”，把参数运行值设置为“on”，然后单击“保存”，打开级联功能开关。 单击参数左侧的“”，展开并配置级联相关配置参数。 表2 中台实例配置 参数 配置说明 cascade_auth_key 级联认证的加密密钥，用于级联API之间的调用认证。公司实例和中台实例的cascade_auth_key值必须配置一致。 cascade_instance_ids 中台实例中无需配置该参数。