TestDataServiceApi
Tests a Data Service API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ApiId |
integer |
Yes |
The ID of the Data Service API on which the test is performed. |
12343 |
| QueryParam |
array<object> |
No |
The request parameters that are contained in the query. |
|
|
object |
No |
The object that is requested to query. |
||
| ParamKey |
string |
No |
The name of the parameter. |
name |
| ParamValue |
string |
No |
The value of the parameter. |
test |
| BodyParams |
array<object> |
No |
The request parameters that are contained in the request body. |
|
|
object |
No |
The object that is requested to query. |
||
| ParamKey |
string |
No |
The name of the parameter. |
name |
| ParamValue |
string |
No |
The value of the parameter. |
test |
| PathParams |
array<object> |
No |
The request parameters that are contained in the request path. |
|
|
object |
No |
The object that is requested to query. |
||
| ParamKey |
string |
No |
The name of the parameter. |
path1 |
| ParamValue |
string |
No |
The value of the parameter. |
api |
| HeadParams |
array<object> |
No |
The request parameters that are contained in the request header. |
|
|
object |
No |
The object that is requested to query. |
||
| ParamKey |
string |
No |
The name of the parameter. |
requestId |
| ParamValue |
string |
No |
The value of the parameter. |
abcd |
| BodyContent |
string |
No |
The data of the request body. |
{"name":"test"} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned result. |
||
| RequestId |
string |
The ID of the request. |
abdsfewe |
| Data |
object |
The information about the test. |
|
| TestId |
string |
The ID of the test. |
232432 |
Examples
Success response
JSON format
{
"RequestId": "abdsfewe",
"Data": {
"TestId": "232432"
}
}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.