天翼云数据治理中心 DataArts Studio 节点参考 - Rest Client
文档简介：
本章节主要介绍节点参考的 Rest Client。
功能：
通过Rest Client节点执行一个内的RESTful请求，目前只支持IAM Token认证鉴权方式的RESTful请求。
咨询热线：400-826-7010，为您提供专业的售前咨询，让您快速了解云产品，助您轻松上云！
微信咨询
免费试用、价格特惠
功能
通过Rest Client节点执行一个内的RESTful请求，目前只支持IAM Token认证鉴权方式的RESTful请求。
说明
当由于网络限制，Rest Client某些API无法调通时，可以尝试使用Shell脚本进行API调用。您需要拥有ECS弹性云主机，并确保ECS主机和待调用的API之间网络可通，然后在DataArts Studio创建主机连接，通过Shell脚本使用CURL命令进行API调用。
参数
用户可参考下表中配置Rest Client节点的参数。
属性参数
| 参数 | 是否必选 | 说明 |
|---|---|---|
| 节点名称 | 是 | 节点名称，可以包含中文、英文字母、数字、“_”、“-”、“/”、“<”、“>”等各类特殊字符，长度为1～128个字符。 |
| 代理集群名称 | 是 | 选择CDM集群名称，CDM集群提供代理连接的功能。如果选择选择的CDM集群与第三方服务处于同一个VPC下，那么Rest Client可以调用租户面的API。 |
| URL地址 | 是 | 填写请求主机的IP或域名地址，以及端口号。例如：https://192.160.10.10:8080 |
| HTTP方法 | 是 |
选择请求的类型： GET POST PUT DELETE |
| 请求头 | 否 |
单击  ，添加请求消息头，参数说明如下：参数名称 选择参数的名称，选项为“Content-Type”、“Accept-Language”。 参数值 填写参数的值。 |
| URL参数 | 否 |
填写URL参数，格式为“参数=值”形式的字符串，字符串间以换行符分隔。当“HTTP方法”为“GET”时，显示该配置项。参数说明如下： 参数 只支持英文字母、数字、“-”、“*”，*最大长度为32字符。 值 只支持英文字母、数字、“-”、“”、“$”、“{”和“}”，最大长度为64字符。 |
| 请求消息体 | 是 | 填写Json格式的请求消息体。当“HTTP方法”为“POST”、“PUT”时，显示该配置项。 |
| 是否需要判断返回值 | 否 |
设置是否判断返回消息的值和预期的一致。当“HTTP方法”为“GET”时，显示该配置项。 YES：检查返回消息中的值是否和预期的一致。 NO：不检查，请求返回200响应码（表示节点执行成功）。 |
| 返回值字段路径 | 是 |
填写Json响应消息中某个属性的路径（下称：Json属性路径），每个Rest Client节点都只能配置一个属性的路径。当“是否需要判断返回值”为“YES”时，显示该配置项。 例如，返回结果为： { "param1": "aaaa", "inner": { "inner": { "param4": 2014247437 }, "param3": "cccc" }, "status": 200, "param2": "bbbb" } 其中“param4”属性的路径为“inner.inner.param4”。 |
| 请求成功标志位 | 是 | 填写请求成功标志位，如果响应消息的返回值与请求成功标志位中的某一个匹配，表示节点执行成功。当“是否需要判断返回值”为“YES”时，显示该配置项。请求成功标志位只支持英文字母、数字、“-”、“_”、“$”、“{”、“}”，多个值使用“;”分隔。 |
| 请求失败标志位 | 否 | 填写请求失败标志位，如果响应消息的返回值与请求失败标志位中的某一个匹配，表示节点执行失败。当“是否需要判断返回值”为“YES”时，显示该配置项。请求失败标志位只支持英文字母、数字、“-”、“_”、“$”、“{”、“}”，多个值使用“;”分隔。 |
| 请求间隔时间（秒） | 是 | 如果响应消息的返回值与请求成功标志位不匹配，将每隔一段时间查询一次，直到响应消息的返回值与请求成功标志位一致。节点执行的超时时间默认为1小时，如果1小时内查询的结果始终为不匹配，那么节点的状态将置为失败。当“是否需要判断返回值”为“YES”时，显示该配置项。 |
| 响应消息体解析为传递参数定义 | 否 | 设置作业变量与Json属性路径的对应关系，参数间以换行符分隔。例如：var4=inner.inner.param4其中，“var4”为作业变量，作业变量只支持英文字母、数字，最大长度为64字符；“inner.inner.param4”为Json属性路径。仅该节点的后续节点引用该参数才会生效，引用该参数时，格式为：${var4}。 |
高级参数
| 参数 | 是否必选 | 说明 |
|---|---|---|
| 节点执行的最长时间 | 是 | 设置节点执行的超时时间，如果节点配置了重试，在超时时间内未执行完成，该节点将不会再重试，直接置为失败状态。 |
| 失败重试 | 是 |
节点执行失败后，是否重新执行节点。 是：重新执行节点，请配置以下参数。 − 最大重试次数 − 重试间隔时间（秒） 否：默认值，不重新执行节点。 说明 如果作业节点配置了重试，并且配置了超时时间，该节点执行超时后将不会再重试，直接置为失败状态。 |
| 失败策略 | 是 |
节点执行失败后的操作： 终止当前作业执行计划：停止当前作业运行，当前作业实例状态显示为“失败”。 继续执行下一节点：忽略当前节点失败，当前作业实例状态显示为“忽略失败成功”。 挂起当前作业执行计划：暂停当前作业运行，当前作业实例状态显示为“等待运行”。 终止后续节点执行计划：停止后续节点的运行，当前作业实例状态显示为“失败”。 |
| 空跑 | 否 | 如果勾选了空跑，该节点不会实际执行，将直接返回成功。 |
血缘关系
| 参数 | 说明 |
|---|---|
| 输入 | |
| 新建 |
单击“新建”，在“类型”的下拉选项中选择要新建的类型。可以选择DWS，OBS，CSS，HIVE，CUSTOM和DLI类型。 DWS − 连接名称（必选）：单击   ，在弹出的“连接名称”窗口选择DWS的数据连接。− 数据库（必选）：单击   ，在弹出的“数据库”窗口选择DWS的数据库。−schema（必选）：单击   ，在弹出的“schema”窗口选择DWS的数据库模式。− 表名（必选）：单击   ，在弹出的“表名”窗口选择DWS的数据表。OBS − 路径（必选）：单击   ，在弹出的“OBS文件浏览”窗口选择OBS路径。CSS − 集群名称（必选）：单击   ，在弹出的“CloudSearch集群”窗口选择CloudSearch集群。− 索引名称（必选）：输入CSS类型的索引名称。 HIVE − 连接名称（必选）：单击   ，在弹出的“连接名称”窗口选择HIVE的数据连接。− 数据库（必选）：单击   ，在弹出的“数据库”窗口选择HIVE的数据库。− 表名（必选）：单击   ，在弹出的“表名”窗口选择HIVE的数据表。CUSTOM − 名称（必选）：输入CUSTOM类型的名称。 − 属性（必选）：输入CUSTOM类型的属性，可新增不止一条。 DLI − 连接名称（必选）：单击   ，在弹出的“连接名称”窗口选择DLI的数据连接。− 数据库（必选）：单击   ，在弹出的“数据库”窗口选择DLI的数据库。− 表名（必选）：单击  ，在弹出的“表名”窗口选择DLI的数据表。
|
| 确定 | 单击“确认”，保存节点输入功能的参数配置。 |
| 取消 | 单击“取消”，取消节点输入功能的参数配置。 |
| 编辑 |
单击  ，修改节点输入功能的参数配置，修改完成后，请保存。
|
| 删除 |
单击  ，删除节点输入功能的参数配置。
|
| 查看表详情 |
单击  ，查看节点输入血缘关系创建数据表的详细信息。
|
| 输出 | |
| 新建 |
单击“新建”，在“类型”的下拉选项中选择要新建的类型。可以选择DWS，OBS，CSS，HIVE，CUSTOM和DLI类型。 DWS − 连接名称（必选）：单击   ，在弹出的“连接名称”窗口选择DWS的数据连接。− 数据库（必选）：单击   ，在弹出的“数据库”窗口选择DWS的数据库。− schema（必选）：单击   ，在弹出的“schema”窗口选择DWS的数据库模式。− 表名（必选）：单击   ，在弹出的“表名”窗口选择DWS的数据表。OBS − 路径（必选）：单击   ，在弹出的“OBS文件浏览”窗口选择OBS路径。CSS − 集群名称（必选）：单击   ，在弹出的“CloudSearch集群”窗口选择CloudSearch集群。− 索引名称（必选）：输入CSS类型的索引名称。 HIVE − 连接名称（必选）：单击   ，在弹出的“连接名称”窗口选择HIVE的数据连接。− 数据库（必选）：单击   ，在弹出的“数据库”窗口选择HIVE的数据库。− 表名（必选）：单击   ，在弹出的“表名”窗口选择HIVE的数据表。CUSTOM − 名称（必选）：输入CUSTOM类型的名称。 − 属性（必选）：输入CUSTOM类型的属性，可新增不止一条。 DLI − 连接名称（必选）：单击   ，在弹出的“连接名称”窗口选择DLI的数据连接。− 数据库（必选）：单击   ，在弹出的“数据库”窗口选择DLI的数据库。− 表名（必选）：单击   ，在弹出的“表名”窗口选择DLI的数据表。
|
| 确定 | 单击“确认”，保存节点输出功能的参数配置。 |
| 取消 | 单击“取消”，取消节点输出功能的参数配置。 |
| 编辑 |
单击  ，修改节点输出功能的参数配置，修改完成后，请保存。
|
| 删除 |
单击  ，删除节点输出功能的参数配置。
|
| 查看表详情 |
单击  ，查看节点输出血缘关系创建数据表的详细信息。
|
