如何调试调用GridDB Web API的R代码及排查查询失败问题

背景说明 #

已通过R的httr包成功调用GridDB Web API完成以下操作：

1. 创建容器：通过POST请求调用/:cluster/dbs/:database/containers接口

   container_url = "https://cloud1.griddb.com/trial1234/griddb/v2/my_Cluster1234/dbs/test_DB/containers/"
   r <- POST(container_url, 
             add_headers("Content-Type" = "application/json; charset=UTF-8"),      
             config = authenticate("myUser", "myPass"), 
             encode = "json", 
             body= my_data_obj) 
   

2. 插入数据：通过PUT请求调用/:cluster/dbs/:database/containers/:container/rows接口，成功插入89090行61列数据

   insert_url = "https://cloud1.griddb.com/trial1234/griddb/v2/my_Cluster1234/dbs/test_DB/containers/my_DB_Table/rows"  
   r <- PUT(insert_url, 
            add_headers("Content-Type" = "application/json; charset=UTF-8"),      
            config = authenticate("myUser", "myPass"), 
            body = myn_data_JSON, 
            encode = "json" ) 
   
   # 验证插入行数
   print(paste(jsonlite::fromJSON(r.text)$count, ' rows have been registered in the container my_DB_Table.'))
   

但调用SQL查询接口/:cluster/dbs/:database/sql时，返回400错误且无数据，直接在数据库执行该SQL语句可正常返回结果，查询代码如下：

query_request_body = '[ {"type" : "sql-select", "stmt" : "SELECT country_name, country_code, score_2015 FROM   my_DB_Table where indicator_code=\'NY.GNP.PCAP.CD\' 

ORDER BY score_2015 " , "limit":"10" }]'  
# 调用GridDB WebAPI
qr1 <- POST ( my_query_url, 
              add_headers("Content-Type" = "application/json"),      
              config = authenticate("myUser", "myPass"), 
              body = query_request_body 
)                            
print(qr1)

问题解答 #

1. 调试R代码、查看请求详情的方法 #

• 启用请求日志：在POST请求的config参数中加入verbose()，可打印完整的请求头、请求体、响应头信息，快速定位格式问题：

  qr1 <- POST ( my_query_url, 
                add_headers("Content-Type" = "application/json; charset=UTF-8"),      
                config = c(authenticate("myUser", "myPass"), verbose()), 
                body = query_request_body 
  )
  

• 查看响应原始错误信息：即使返回400错误，也可通过content(qr1, "text")获取API返回的具体错误提示，大部分Web API会明确说明问题原因：

  cat(content(qr1, "text"))
  

• 用R对象生成标准JSON：避免手动拼接JSON字符串，改用jsonlite包将R列表转为规范JSON，方便调试时检查生成的内容：

  query_body_list <- list(
    list(
      type = "sql-select",
      stmt = "SELECT country_name, country_code, score_2015 FROM my_DB_Table where indicator_code='NY.GNP.PCAP.CD' ORDER BY score_2015",
      limit = 10
    )
  )
  # 打印生成的JSON
  cat(jsonlite::toJSON(query_body_list, auto_unbox = TRUE))
  

2. SQL查询调用失败的可能原因及修复建议 #

• JSON格式不规范：手动构造的query_request_body存在换行、引号转义问题，导致API无法解析。建议用R列表配合encode="json"参数生成请求体（和创建/插入请求保持一致）：

  query_body_list <- list(
    list(
      type = "sql-select",
      stmt = "SELECT country_name, country_code, score_2015 FROM my_DB_Table WHERE indicator_code='NY.GNP.PCAP.CD' ORDER BY score_2015",
      limit = 10
    )
  )
  
  qr1 <- POST ( my_query_url, 
                add_headers("Content-Type" = "application/json; charset=UTF-8"),      
                config = authenticate("myUser", "myPass"), 
                body = query_body_list,
                encode = "json"
  )
  

• limit参数类型错误：GridDB Web API要求limit为数字类型，手动构造的JSON中"limit":"10"是字符串，改为数字10即可（用R列表生成时直接写limit=10）。
• 请求头不一致：创建和插入请求使用application/json; charset=UTF-8，查询请求仅用application/json，保持请求头一致可避免编码相关问题。
• SQL语句格式问题：手动编写的SQL存在多余换行和空格，API可能对格式更严格，建议将SQL压缩为单行，避免不必要的换行。
• URL路径检查：确认my_query_url严格符合/:cluster/dbs/:database/sql格式，检查是否遗漏griddb/v2前缀，或集群、数据库名称拼写错误。

参考GridDB v4.3 Web API官方参考文档

内容的提问来源于stack exchange，提问作者Pratik Dwivedi