ListDataServiceApiTest
Lists the test records of a DataService API. Only data from the last month can be queried.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ApiId |
integer |
Yes |
The ID of the API to test. |
12345 |
| PageSize |
integer |
No |
The page size. Maximum value: 100. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response message. |
||
| RequestId |
string |
The request ID. |
ESDAFWEA |
| Data |
array<object> |
The data list. |
|
|
object |
The data object. |
||
| TestId |
integer |
The test ID. |
123 |
| ApiId |
integer |
The ID of the API to test. |
2343 |
| ParamMap |
string |
The request parameters of the test API. |
{"name":"test"} |
| RetCode |
integer |
The return code of the test API. This field is empty if the test is not completed. |
0 |
| RetResult |
string |
The returned data. |
{"id":2} |
| CostTime |
integer |
The time consumed by the API request. |
10 |
| Status |
string |
Indicates whether the task is completed. Valid values:
|
FINISHED |
| CreateTime |
integer |
The time when the task was created. The value is a 13-digit number, such as |
1651824913000 |
Examples
Success response
JSON format
{
"RequestId": "ESDAFWEA",
"Data": [
{
"TestId": 123,
"ApiId": 2343,
"ParamMap": "{\"name\":\"test\"}",
"RetCode": 0,
"RetResult": "{\"id\":2}",
"CostTime": 10,
"Status": "FINISHED",
"CreateTime": 1651824913000
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.