文档首页> 应用与数据集成平台 ROMA Connect> API参考> 服务集成API> 自定义后端服务> 测试后端API
更新时间：2023-07-10 GMT+08:00
在线调试
CLI示例
查看PDF

测试后端API

功能介绍

测试后端API是否可用。

URI

POST /v2/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id}/test

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID

ld_api_id

是

String

后端API的编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

parameters

否

Array of LdApiParameter objects

后端API请求参数
表4 LdApiParameter

参数

是否必选

参数类型

描述

name

是

String

参数名称：

  • 参数位于Headers、 Parameters时，用户自行定义，支持英文、数字、点、中划线、下划线，且需要英文开头，不区分大小写。

  • 参数位于Body时候，参数以application/json、application/xml、application/text为名，但实际是以请求body里的键值对作为参数名和参数值，比如请求消息样例，参数名为application/json，参数值为{"table":"apic01","id":"1"}，后端取table：apic01，id：1这两个键值对作为入参。

  • 注意：定义参数不要重名，否则会覆盖掉，当Headers、Parameters重复时候，Parameters会被覆盖，当Parameters和Body里的键值对重复时候，Parameters会被覆盖。

最小长度：1

最大长度：32

in

是

String

该参数在调用API时候所放的位置：

  • Headers ：放于请求头

  • Parameters ：放于请求参数

  • Body：放于请求体

default

否

String

参数默认值

最大长度：4000

description

否

String

参数描述

不支持<，>字符

最小长度：0

最大长度：255

required

否

Boolean

参数是否必须。true：必须，false：不必须

缺省值：false

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

test_status_code

String

测试返回的状态码

test_request

String

测试的请求内容

test_used_time

Integer

测试耗时

test_operator

String

测试者的项目编号

test_response

String

测试的响应内容

test_method

String

测试的请求方法

test_id

Integer

测试编号

test_date

String

测试时间

ld_api_id

String

后端API编号

debug_log

Array of strings

本次测试日志列表

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

测试指定的自定义后端，测试时添加一个Header参数

{
  "parameters" : [ {
    "name" : "header",
    "in" : "Headers",
    "required" : false,
    "default" : "test"
  } ]
}

响应示例

状态码： 200

OK

{
  "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37",
  "test_date" : "2020-09-19T06:40:52Z",
  "test_id" : 2524356,
  "test_method" : "GET",
  "test_operator" : "73d69ae0cfcf460190522d06b60f05ad",
  "test_request" : "{\"apiUUID\":\"bd42841c20184da6bbf457c6d8a06e37\",\"method\":\"GET\",\"params\":[{\"paramDesc\":\"\",\"paramName\":\"header\",\"paramRequired\":\"0\",\"paramType\":\"Headers\",\"paramValue\":\"test\"}],\"testUrl\":\"/test/function\"}",
  "test_response" : "Hello world!",
  "test_status_code" : "200",
  "test_used_time" : 29,
  "debug_log" : [ "2021-04-20 16:52:47 | 226e613ca72f4997b87def5445dac75c | 111", "2021-04-20 16:52:47 | 226e613ca72f4997b87def5445dac75c | message:bbb" ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3084",
  "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 自定义后端服务