Queries the information about APIs in the development state in DataService Studio.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListDataServiceApis |
The operation that you want to perform. |
PageNumber | Integer | Yes | 1 |
The number of the page. Pages start from 1. Default value: 1. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
ProjectId | Long | Yes | 10000 |
The ID of the DataWorks workspace. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where your project resides. |
TenantId | Long | Yes | 10001 |
The ID of the tenant. |
ApiNameKeyword | String | No | My API name |
The API name of the keyword, and filtered to obtain the API name contains the keyword of the APIs |
ApiPathKeyword | String | No | /test/ |
The keyword of the API path. APIs whose API paths contain the keyword are obtained. |
CreatorId | String | No | 12345 |
The Alibaba Cloud ID of the API creator. The API created by the user is obtained. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
The information about the APIs that are being developed. |
|
Apis | Array of Api |
The development state information of the API. |
|
ApiId | Long | 10002 |
The ID of the API to query. |
ApiMode | Integer | 0 |
The type of the API. Valid values: 0 (Wizard API), 1 (Script API), and 2 (registration API). |
ApiName | String | My API name |
The operation that you want to perform. |
ApiPath | String | /test/1 |
The path to the API. |
CreatedTime | String | 2020-06-23T00:21:01+0800 |
The time when the configuration group was created. |
CreatorId | String | 1234567 |
The Alibaba Cloud ID of the project creator. |
Description | String | Test API description |
The description of the API operation. |
FolderId | Long | 0 |
The ID of the folder. |
GroupId | String | abcde123456789 |
The ID of the group. |
ModifiedTime | String | 2020-06-23T00:21:01+0800 |
The time when the node instance was last modified. |
OperatorId | String | 2345678 |
The Alibaba Cloud ID of the latest editor. |
ProjectId | Long | 10000 |
The ID of the DataWorks workspace. |
Protocols | List | 0 |
The protocol used by the API. It is a list of multiple values. You can select 0(HTTP) and 1(HTTPS). |
RegistrationDetails | Struct |
The details of the registered API. Only the registered API is returned. |
|
FailedResultSample | String | {"success": false} |
Error return example. |
RegistrationErrorCodes | Array of RegistrationErrorCode |
Registers a list of API error codes. |
|
ErrorCode | String | 1001 |
The error code. |
ErrorMessage | String | fail to call |
The error message. |
ErrorSolution | String | retry |
Solution to the error. |
RegistrationRequestParameters | Array of RegistrationRequestParameter |
The request parameters of the registered API. |
|
ColumnName | String | column1 |
The table field name to be associated with the RDS instance. This parameter is only supported by codeless UI. |
DefaultValue | String | default1 |
Auto is the default value for License Type. |
ExampleValue | String | example1 |
Example. |
IsRequiredParameter | Boolean | true |
Indicates whether the service is required. |
ParameterDataType | Integer | 0 |
The data type. Valid values: 0(STRING), 1(INT), 2(LONG), 3(FLOAT), 4(DOUBLE), and 5(BOOLEAN). |
ParameterDescription | String | description1 |
The information of the description. |
ParameterName | String | name1 |
The key of parameter N. |
ParameterOperator | Integer | 0 |
OPERATOR. Optional enumeration values include 0(Equal), 1(Like), 2(Const), and 3(In). The codeless UI API supports Equal, Like, and In. The script-based API supports Equal. The registration API supports Equal and Const. |
ParameterPosition | Integer | 0 |
The location of the parameter. You can select 0(Path), 1(Query), 2(Head), or 3(Body). The Wizard and script APIs only support Query. The GET and DELETE methods in the registration API support Query and Head, while the PUT and POST methods support Query, Head, and Body. |
ServiceContentType | Integer | 0 |
The type of the data to be returned for the API. Valid values: 0(JSON) and 1(XML). JSON is supported for Wizard and script APIs, and JSON and XML are supported for registration APIs. |
ServiceHost | String | http://www.abc.com |
The backend service address |
ServicePath | String | /index |
The path of the backend service. |
ServiceRequestBodyDescription | String | {"abc":1} |
The description of the backend request body. |
SuccessfulResultSample | String | {"success": true} |
Sample success responses. |
RequestMethod | Integer | 0 |
The API request method. You can select 0(GET), 1(POST), 2(PUT), or 3(DELTE). The Wizard and script APIs support GET and POST. The registration API supports GET, POST, PUT, and DELETE. |
ResponseContentType | Integer | 0 |
The type of the data to be returned for the API. Valid values: 0(JSON) and 1(XML). JSON is supported for Wizard and script APIs, and JSON and XML are supported for registration APIs. |
ScriptDetails | Struct |
The details of the script API. Only script APIs are returned. |
|
IsPagedResponse | Boolean | true |
Specifies whether to enable pagination. |
Script | String | select a from t |
SQL script. |
ScriptConnection | Struct |
The data source information about the script API. |
|
ConnectionId | Long | 123 |
The ID of the data source. |
TableName | String | t |
The name of the source table. |
ScriptRequestParameters | Array of ScriptRequestParameter |
The request parameters of the script API. |
|
ColumnName | String | column1 |
The table field name to be associated with the RDS instance. This parameter is only supported by codeless UI. |
DefaultValue | String | default1 |
Default value |
ExampleValue | String | example1 |
Example |
IsRequiredParameter | Boolean | true |
Required |
ParameterDataType | Integer | 0 |
The data type. Valid values:
|
ParameterDescription | String | description1 |
Description |
ParameterName | String | param1 |
Parameter |
ParameterOperator | Integer | 0 |
OPERATOR. The optional enumeration values are:
Supports Equal, Like, and In for Wizard API, Equal for script API, and Equal and Const for registration API. |
ParameterPosition | Integer | 0 |
The location of the parameter. The following enumerated values are available:
The Wizard and script APIs support only Query, and the registration APIs support Query, Head, GET and DELETE methods, and Query, Head, and Body in PUT and POST methods. |
ScriptResponseParameters | Array of ScriptResponseParameter |
The response parameters of the script API. |
|
ColumnName | String | column2 |
The name of the table field to be associated with. Only tables codeless UI have the following name: |
ExampleValue | String | example2 |
Example |
ParameterDataType | Integer | 0 |
The data type. Valid values:
|
ParameterDescription | String | description2 |
Description |
ParameterName | String | param2 |
Parameter |
Status | Integer | 0 |
The status of the API. Valid values: 0 (unpublished) and 1 (published). |
TenantId | Long | 10000 |
The ID of the tenant. |
Timeout | Integer | 10000 |
The timeout period. Unit: milliseconds (ms). |
VisibleRange | Integer | 0 |
Visible range. Optional enumeration values include 0 (workspace) and 1 (private). |
WizardDetails | Struct |
The details of Wizard APIs. Only wizard APIs are returned. |
|
IsPagedResponse | Boolean | true |
Specifies whether to enable pagination. |
WizardConnection | Struct |
The data source information for the wizard API. |
|
ConnectionId | Long | 123 |
The ID of the data source. |
TableName | String | t |
The name of the source table. |
WizardRequestParameters | Array of WizardRequestParameter |
List of request parameters for the wizard API. |
|
ColumnName | String | column1 |
The table field name to be associated with the RDS instance. This parameter is only supported by codeless UI. |
DefaultValue | String | default1 |
Auto is the default value for License Type. |
ExampleValue | String | example1 |
Example. |
IsRequiredParameter | Boolean | true |
Indicates whether the service is required. |
ParameterDataType | Integer | 0 |
The data type. Valid values: 0(STRING), 1(INT), 2(LONG), 3(FLOAT), 4(DOUBLE), and 5(BOOLEAN). |
ParameterDescription | String | description1 |
The description of the snapshot. |
ParameterName | String | param1 |
The key of the parameter. |
ParameterOperator | Integer | 0 |
OPERATOR. Optional enumeration values include 0(Equal), 1(Like), 2(Const), and 3(In). API operations support Equal, Like, and In for the codeless UI, Equal for the script API, and Equal and Const for the registration API. |
ParameterPosition | Integer | 0 |
The location of the parameter. You can select 0(Path), 1(Query), 2(Head), or 3(Body). The Wizard and script APIs only support Query. The GET and DELETE methods in the registration API support Query and Head, while the PUT and POST methods support Query, Head, and Body. |
WizardResponseParameters | Array of WizardResponseParameter |
The response parameters of the codeless UI. |
|
ColumnName | String | column2 |
The table field name to be associated with the RDS instance. This parameter is only supported by codeless UI. |
ExampleValue | String | example2 |
Example. |
ParameterDataType | Integer | 0 |
The data type. Valid values: 0(STRING), 1(INT), 2(LONG), 3(FLOAT), 4(DOUBLE), and 5(BOOLEAN). |
ParameterDescription | String | description2 |
The description of the snapshot. |
ParameterName | String | param2 |
The key of parameter N. |
PageNumber | Integer | 1 |
The number of the page, which is consistent with the PageNumber value in the request. |
PageSize | Integer | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
TotalCount | Integer | 100 |
The total number of entries. |
HttpStatusCode | Integer | 200 |
The HTTP status code. |
ErrorMessage | String | The connection does not exist. |
The error message. |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
The error code. |
RequestId | String | 0000-ABCD-EFG**** |
The unique ID of the request. |
Success | Boolean | true |
Indicates whether the request was successful. |
Different fields are used to obtain the details of different types of APIs. The wizard API uses the WizardDetails field. The Script API uses the ScriptDetails field. The registration API uses the RegistrationDetails field.
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListDataServiceApis &PageNumber=1 &PageSize=10 &ProjectId=10000 &RegionId=cn-shanghai &TenantId=10001 &<common request parameters>
Sample success responses
XML
format
<RequestId> 0000-abcd-efg**** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <TotalCount> 100 </TotalCount> <PageSize> 10 </PageSize> <PageNumber> 1 </PageNumber> <Apis> <Status> 0 </Status> <VisibleRange> 0 </VisibleRange> <CreatedTime> 2020-06-23 T00:21:01+0800 </CreatedTime> <Description> Test for more information about the API description </Description> <ApiName> I name of the API </ApiName> <CreatorId> 1234567 </CreatorId> <RequestMethod> 0 </RequestMethod> <Timeout> 10000 </Timeout> <ProjectId> 10000 </ProjectId> <ResponseContentType> 0 </ResponseContentType> <OperatorId> 2345678 </OperatorId> <GroupId> abcde123456789 </GroupId> <TenantId> 10000 </TenantId> <ModifiedTime> 2020-06-23T00:21:01+0800 </ModifiedTime> <ApiId> 10002 </ApiId> <ApiMode> 0 </ApiMode> <ApiPath> /test/1 </ApiPath> </Apis> <Apis> <Protocols> 0 </Protocols> </Apis> <Apis> <WizardDetails> <Script> select a from t </Script> <ServiceContentType> 0 </ServiceContentType> <ScriptRequestParameters> <ColumnName> column1 </ColumnName> <DefaultValue> default1 </DefaultValue> <ExampleValue> example1 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterPosition> 0 </ParameterPosition> <ParameterName> param1 </ParameterName> <ParameterOperator> 0 </ParameterOperator> <ParameterDescription> description1 </ParameterDescription> <IsRequiredParameter> true </IsRequiredParameter> </ScriptRequestParameters> <ScriptRequestParameters> <ColumnName> column2 </ColumnName> <ExampleValue> example2 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterName> param2 </ParameterName> <ParameterDescription> description2 </ParameterDescription> </ScriptRequestParameters> <ServicePath> /index </ServicePath> <RegistrationErrorCodes> <ErrorCode> Invalid.Tenant.ConnectionNotExists </ErrorCode> <ErrorMessage> The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationErrorCodes> <RegistrationErrorCodes> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>name1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </RegistrationErrorCodes> <WizardResponseParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardResponseParameters> <WizardResponseParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardResponseParameters> <ServiceHost>http://www.abc.com</ServiceHost> <RegistrationRequestParameters> <ErrorCode>1001</ErrorCode> <ErrorMessage>fail to call</ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationRequestParameters> <RegistrationRequestParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>name1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </RegistrationRequestParameters> <IsPagedResponse>true</IsPagedResponse> <ServiceRequestBodyDescription>{"abc":1}</ServiceRequestBodyDescription> <WizardRequestParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardRequestParameters> <WizardRequestParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardRequestParameters> <SuccessfulResultSample>{"success": true}</SuccessfulResultSample> <WizardConnection> <TableName>t</TableName> <ConnectionId>123</ConnectionId> </WizardConnection> <FailedResultSample>{"success": false}</FailedResultSample> <ScriptResponseParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </ScriptResponseParameters> <ScriptResponseParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptResponseParameters> <ScriptConnection> <TableName>t</TableName> <ConnectionId>123</ConnectionId> </ScriptConnection> </WizardDetails> <ScriptDetails> <Script>select a from t</Script> <ServiceContentType>0</ServiceContentType> <ScriptRequestParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </ScriptRequestParameters> <ScriptRequestParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptRequestParameters> <ServicePath>/index</ServicePath> <RegistrationErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationErrorCodes> <RegistrationErrorCodes> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>name1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </RegistrationErrorCodes> <WizardResponseParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardResponseParameters> <WizardResponseParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardResponseParameters> <ServiceHost>http://www.abc.com</ServiceHost> <RegistrationRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationRequestParameters> <RegistrationRequestParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>name1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </RegistrationRequestParameters> <IsPagedResponse>true</IsPagedResponse> <ServiceRequestBodyDescription>{"abc":1}</ServiceRequestBodyDescription> <WizardRequestParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardRequestParameters> <WizardRequestParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardRequestParameters> <SuccessfulResultSample>{"success": true}</SuccessfulResultSample> <WizardConnection> <TableName>t</TableName> <ConnectionId>123</ConnectionId> </WizardConnection> <FailedResultSample>{"success": false}</FailedResultSample> <ScriptResponseParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </ScriptResponseParameters> <ScriptResponseParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptResponseParameters> <ScriptConnection> <TableName>t</TableName> <ConnectionId>123</ConnectionId> </ScriptConnection> </ScriptDetails> <RegistrationDetails> <Script>select a from t</Script> <ServiceContentType>0</ServiceContentType> <ScriptRequestParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </ScriptRequestParameters> <ScriptRequestParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptRequestParameters> <ServicePath>/index</ServicePath> <RegistrationErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationErrorCodes> <RegistrationErrorCodes> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>name1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </RegistrationErrorCodes> <WizardResponseParameters> <ColumnName>column1</ColumnName> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardResponseParameters> <WizardResponseParameters> <ColumnName>column2</ColumnName> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardResponseParameters> <ServiceHost>http://www.abc.com</ServiceHost> <RegistrationRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution> retry </ErrorSolution> </RegistrationRequestParameters> <RegistrationRequestParameters> <ColumnName> column1 </ColumnName> <DefaultValue> default1 </DefaultValue> <ExampleValue> example1 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterPosition> 0 </ParameterPosition> <ParameterName> name1 </ParameterName> <ParameterOperator> 0 </ParameterOperator> <ParameterDescription> description1 </ParameterDescription> <IsRequiredParameter> true </IsRequiredParameter> </RegistrationRequestParameters> <IsPagedResponse> true </IsPagedResponse> <ServiceRequestBodyDescription> {"abc":1} </ServiceRequestBodyDescription> <WizardRequestParameters> <ColumnName> column1 </ColumnName> <DefaultValue> default1 </DefaultValue> <ExampleValue> example1 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterPosition> 0 </ParameterPosition> <ParameterName> param1 </ParameterName> <ParameterOperator> 0 </ParameterOperator> <ParameterDescription> description1 </ParameterDescription> <IsRequiredParameter> true </IsRequiredParameter> </WizardRequestParameters> <WizardRequestParameters> <ColumnName> column2 </ColumnName> <ExampleValue> example2 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterName> param2 </ParameterName> <ParameterDescription> description2 </ParameterDescription> </WizardRequestParameters> <SuccessfulResultSample> {"success": true} </SuccessfulResultSample> <WizardConnection> <TableName> t </TableName> <ConnectionId> 123 </ConnectionId> </WizardConnection> <FailedResultSample> {"success": false} </FailedResultSample> <ScriptResponseParameters> <ColumnName> column1 </ColumnName> <DefaultValue> default1 </DefaultValue> <ExampleValue> example1 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterPosition> 0 </ParameterPosition> <ParameterName> param1 </ParameterName> <ParameterOperator> 0 </ParameterOperator> <ParameterDescription> description1 </ParameterDescription> <IsRequiredParameter> true </IsRequiredParameter> </ScriptResponseParameters> <ScriptResponseParameters> <ColumnName> column2 </ColumnName> <ExampleValue> example2 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterName> param2 </ParameterName> <ParameterDescription> description2 </ParameterDescription> </ScriptResponseParameters> <ScriptConnection> <TableName> t </TableName> <ConnectionId> 123 </ConnectionId> </ScriptConnection> </RegistrationDetails> </Apis> </Data> <ErrorCode> 0 </ErrorCode> <ErrorMessage> normal </ErrorMessage> <Success> true </Success>
JSON
Format
{"RequestId": "0000-abcd-EFG ******", "HttpStatusCode": 200, "Data": { "TotalCount": 100, "PageSize": 10, "PageNumber": 1, "Apis": [ { "Status": 0, "VisibleRange": 0, "CreatedTime": 0 ": " 2020-06-23T00:21:01+0800 ", " Description ": " Test API Description ", " ApiName ": " My API name ", " CreatorId ": 1234567, " RequestMethod ": 0, " Timeout ": 100000," ProjectId ": 100000," ResponseContentType ": 0, " OperatorId ": 2345678," GroupId ": " VOD ", " moditenantid ": 10000fiedtime": "" 2020-06-23T00:21:01+0800 ", " ApiId ": 10002, " ApiMode ": 0, "ApiPath": "/test/1" }, { "Protocols": 0 }, { "WizardDetails": { "Script": "select a from t", "ServiceContentType": 0, "ScriptRequestParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1"," ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription":" description2" } ], "ServicePath": "/index", "RegistrationErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1"," ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "WizardResponseParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceHost":" http://www.abc.com ", "RegistrationRequestParameters": [ { "ErrorCode": 1001, "ErrorMessage": "fail to call", "ErrorSolution": "retry" }, { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "IsPagedResponse": true, "ServiceRequestBodyDescription": "{\"abc\":1}", "WizardRequestParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ] , "SuccessfulResultSample": "{\"success\": true}", "WizardConnection": { "TableName": "t", "ConnectionId": 123 }, "FailedResultSample": "{\"success\": false}", "ScriptResponseParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ScriptConnection": { "TableName": "t", "ConnectionId": 123 } }, "ScriptDetails": { "Script": "select a from t", "ServiceContentType": 0, "ScriptRequestParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue":" example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2"," ParameterDescription": "description2" } ], "ServicePath": "/index", "RegistrationErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue":" example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "WizardResponseParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1"," ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription":" description2" } ], "ServiceHost":" http://www.abc.com ", "RegistrationRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "IsPagedResponse": true, "ServiceRequestBodyDescription": "{\"abc\":1}", "WizardRequestParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1"," ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription":" description2" } ], "SuccessfulResultSample": "{\"success\": true}", "WizardConnection": { "TableName": "t", "ConnectionId": 123 }, "FailedResultSample": "{\"success\": false}", "ScriptResponseParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ScriptConnection": { "TableName": "t", "ConnectionId": 123 } }, "RegistrationDetails": { "Script": "select a from t", "ServiceContentType": 0, "ScriptRequestParameters": [ { "ColumnName": "column1", "DefaultValue": "default1"," ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName":" param2", "ParameterDescription": "description2" } ], "ServicePath": "/index", "RegistrationErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "ColumnName": "column1", "DefaultValue": "default1"," ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "WizardResponseParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue":" example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2"," ParameterDescription": "description2" } ], "ServiceHost":" http://www.abc.com ", "RegistrationRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "IsPagedResponse": true, "ServiceRequestBodyDescription": "{\"abc\":1}", "WizardRequestParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1"," ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription":" description2" } ], "SuccessfulResultSample": "{\"success\": true}", "WizardConnection": { "TableName": "t", "ConnectionId": 123 }, "FailedResultSample": "{\"success\": false}", "ScriptResponseParameters": [ { "ColumnName": "column1", "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ColumnName": "column2", "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ScriptConnection": { "TableName": "t", "ConnectionId": 123 } } ] }, "ErrorCode": 0, "ErrorMessage": "normal", "Success": true}
Error codes
HttpCode | Error codes | Error message | Description |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The request for the resource exceeds your available upper limit. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks the system is busy, please try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | Your request is too frequent, please try to slow down the request speed. |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
Go to the Error CenterFor more information, see error codes.