Help Center/ ROMA Connect/ API Reference/ Out-of-Date APIs/ APIC APIs (V1)/ Custom Backend Management (V1)/ Querying the Backend API Test Result
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying the Backend API Test Result

Function

This API is used to query the test results of a backend API in an instance.

URI

GET /v1/{project_id}/apic/instances/{instance_id}/livedata-apis/{ld_api_id}/test

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

ld_api_id

Yes

String

Backend API ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

his

Array of LdApiTestHistoryInfo objects

Test result objects.
Table 4 LdApiTestHistoryInfo

Parameter

Type

Description

testStatusCode

String

Returned status code.

testRequest

String

Request method.

testUsedtime

Integer

Test duration.

testOperator

String

Project ID of the tester.

testResponse

String

Test response content.

testMethod

String

Request method.

testID

Integer

Test ID.

testDate

String

Test time.

apiUUID

String

Backend API ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "size" : 1,
  "his" : [ {
    "apiUUID" : "bd42841c20184da6bbf457c6d8a06e37",
    "testDate" : "2020-09-19T06:40:52Z",
    "testID" : 2524356,
    "testMethod" : "GET",
    "testOperator" : "73d69ae0cfcf460190522d06b60f05ad",
    "testRequest" : "{\"apiUUID\":\"bd42841c20184da6bbf457c6d8a06e37\",\"method\":\"GET\",\"params\":[{\"paramDesc\":\"\",\"paramName\":\"header\",\"paramRequired\":\"0\",\"paramType\":\"Headers\",\"paramValue\":\"test\"}],\"testUrl\":\"/test/function\"}",
    "test_response" : "Hello world!",
    "testStatusCode" : "200",
    "testUsedtime" : 29
  } ]
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status code: 403

Forbidden

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

Status code: 404

Not Found

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

Status code: 500

Internal Server Error

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.