ListDataServiceApiTest - DataWorks - Alibaba Cloud Documentation Center

Queries the test records of a DataService Studio API. This API operation allows you to query only the test records that are generated within the previous month.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ApiId	long	Yes	The ID of the DataService Studio API on which tests are performed.	12345
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100.	10

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	ESDAFWEA
Data	array<object>	The list of test records.
Data	object	The test record.
TestId	long	The ID of the test.	123
ApiId	long	The ID of the DataService Studio API on which the test is performed.	2343
ParamMap	string	The request parameters configured for the test.	{"name":"test"}
RetCode	long	The status code returned for the test. If the test is not complete, this parameter is not returned.	0
RetResult	string	The result returned for the test.	{"id":2}
CostTime	integer	The time that is consumed to complete the test.	10
Status	string	The status of the test. Valid values: RUNNING and FINISHED.	FINISHED
CreateTime	long	The time when the test was initiated.	1651824913000

Examples

Sample success responses

JSONformat

{
  "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
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.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-05-30	Add Operation	View Change Details