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

查询后端API测试结果

功能介绍

在某个实例中查询后端API的测试结果。

URI

GET /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 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量

最小值：1

最大值：500

缺省值：20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

histories

Array of LdApiTestHistoryInfoV2 objects

本次查询到的测试结果对象列表
表5 LdApiTestHistoryInfoV2

参数

参数类型

描述

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编号

状态码： 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

错误描述

请求示例

无

响应示例

状态码： 200

OK

{
  "total" : 1,
  "size" : 1,
  "histories" : [ {
    "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
  } ]
}

状态码： 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

错误码

请参见错误码。

父主题： 自定义后端服务