大数据开发治理平台 DataWorks：注册外部API服务

注册API

如果您没有API，则需要使用生成API功能。详情请参见通过向导模式生成API。

1. 在服务开发页面，单击图标，选择新建API > 注册API。

   您也可以打开相应的业务流程，右键单击API，选择新建API > 注册API。

2. 在注册API对话框中，配置各项参数后，完成配置。

   

   参数	描述
   目标文件夹	存放API的目录，请单击文字进行选择。 重要 建议优先选定目标文件夹，若选不中，请先创建业务流程。
   API名称	自定义API名称。网关分组下唯一且工作空间下唯一。
   API Path	API存放的路径，例如/user。
   协议	支持HTTP、HTTPS协议。 如果您需要通过HTTPS协议调用API，请您发布API至网关后，在API网关控制台绑定独立域名，并上传SSL证书。详情请参见支持HTTPS。
   请求方式	支持GET、POST、PUT和DELETE。
   返回类型	支持JSON和XML。
   可见范围	包括工作空间和私有： 工作空间：该API对本工作空间内的所有成员可见。 私有：该API仅对API的负责人可见，且暂不支持授权。 说明 如果设置可见范围为私有，在目录树中，仅自己可见，工作空间内的其他成员不可见。
   标签	从标签列表中选择相应的标签。
   描述	对API进行简要描述，不得超过2000个字符。

配置API

1. 双击打开注册API的编辑页面，在后端服务定义区域，配置各项参数。

   

   参数	描述
   后台服务Host	待注册API服务的Host，以http://或https://开头，并且不包含Path。 说明 示例：假设您接口服务地址为http://xxx-cn-xxx.alicloudapi.com/user/info，可取http://xxx-cn-xxx.alicloudapi.com设为后台服务Host。具体的可根据您接口服务地址实际路径进行配置。
   后台服务Path	待注册API服务的Path，Path中支持参数，参数要放在[]中，如/user/[userid]。 配置Path中的参数后，在注册API向导的第二步API参数配置环节，系统会自动在请求参数列表添加Path位置的参数。 说明 示例：假设您接口服务地址为http://xxx-cn-xxx.alicloudapi.com/user/info，可将/user/info设为后台服务Path。具体的可根据您接口服务地址实际路径进行配置。
   后端超时	设置后端超时时间。

2. 在请求参数定义区域，配置各项参数。

   

   参数	描述
   请求参数	单击新增参数，根据页面配置API的请求参数。 其中参数位置支持QUERY、HEAD、PATH和BODY。不同的请求方式支持不同的参数位置，请根据页面提供的可选项按需选择。
   常量参数	参数值为固定的参数，对调用者不可见。调用API时无需传入常量参数，但后台服务始终接收您在此处配置的常量参数及参数值。 适用于固定某个参数的取值并对调用者隐藏参数的场景。
   请求Body定义	仅请求方式为POST和PUT时，会出现该参数。 请求Body定义支持输入JSON和XML类型的Body描述，相当于一个请求Body的示例，以供API调用者参考格式。

3. 在返回内容定义区域，输入正常返回结果示例和异常返回结果示例，以便API调用者参考和编写API返回结果解析代码。

4. 在错误码定义区域，填写调用API时出现的错误码、错误信息和解决方案，以便API调用者参考并自行查找错误原因。

5. 单击上方工具栏中的图标，保存API。