调试API

操作场景

API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。

• 后端路径中含有环境变量的API，不支持调试。
• API绑定签名密钥时，不支持调试。
• 如果API已绑定流控策略，在调试API时，流控策略无效。

前提条件

已创建待调试的API。

操作步骤

1. 在DataArts Studio控制台首页，选择对应工作空间的“数据服务”模块，进入数据服务页面。

2. 在左侧导航栏选择服务版本（例如：专享版），进入总览页。
3. 单击“开发API > API管理”，进入到API管理信息页面。
4. 通过以下任意一种方法，进入API调试页面。
   • 在待调试的API所在行，单击“更多 > 调试”。
   • 单击“API名称”，进入API详情页面，单击“调试”。
     左侧为API请求参数配置区域，参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。

     表1 调试API

     参数名称	说明
     API版本	仅专享版支持指定API版本调试。 当未指定API版本时，默认调试的是未发布的API。
     参数配置	Query的参数与参数值。
     集群配置	仅专享版支持，选择调试API所依托的实例。

     

     不同类型的请求，调试界面展现的信息项有差异。

5. 添加请求参数后，单击“开始测试”。

   右侧返回结果回显区域打印API调用的Response信息。

   • 调用成功时，返回HTTP状态码为“200”和Response信息。
   • 调用超过默认60秒无结果时，会报超时错误。
   • 调试失败时，返回HTTP状态码为4xx或5xx。
6. 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。
   

   如果需要修改API参数，请在右上角单击“编辑”，进入API编辑页面。

相关操作

• 批量调试API：您可以在专享版的“开发API > API管理”页面，勾选需要调试的API后，依次单击API列表上方的“批量操作 > 批量调试”，然后在批量调试页面，导入修改后的API调试参数Excel，实现多个API的统一调试。
  图1 批量操作
  
• 发布API：API调试成功后，为方便API调用者调用，您可以将API发布，具体操作请参见发布API。