Queries the information about an API in the published state in DataService Studio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetDataServicePublishedApi

The operation that you want to perform.
ApiId Long Yes 10001

The ID of the API to query.
ProjectId Long Yes 10002

The ID of the DataWorks workspace.
RegionId String Yes cn-shanghai

The ID of the region where your project resides.
TenantId Long Yes 10003

The ID of the tenant.

Response parameters

Parameter Type Example Description
Data Struct

The latest release state information of the API.
ApiId Long 10000

The ID of the data service API.
ApiMode Integer 0

The type of the API. Valid values: 0 (Wizard API), 1 (Script API), and 2 (registration API).

ApiName String Test API

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 snapshot.
GroupId String ab12**

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 10001

The ID of the DataWorks workspace.
Protocols List 0

The protocol used by the API. 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 Invalid.Tenant.ConnectionNotExists

The error code.
ErrorMessage String The connection does not exist.

The error message.
ErrorSolution String retry

Solution to the error.
RegistrationRequestParameters Array of RegistrationRequestParameter

The request parameters of the registered API.
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 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://example.aliyundoc.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 operation. Only script APIs are returned.
FailedResultSample String {"success": false}

Error return example.
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

ID of the data source.
TableName String t

The name of the source table.
ScriptErrorCodes Array of ScriptErrorCode

The list of error codes of the script API.
ErrorCode String 1001

Error codes
ErrorMessage String fail to call

The error message that is returned.
ErrorSolution String retry

Error resolution
ScriptRequestParameters Array of ScriptRequestParameter

The request parameters of the script API.
DefaultValue String default1

Default value
ExampleValue String example1

Example
IsRequiredParameter Boolean true

Required
ParameterDataType Integer 0

The data type. Valid values:

  • 0:String
  • 1:Int
  • 2:Long
  • 3:Float
  • 4:Double
  • 5:Boolean
ParameterDescription String description1

Description
ParameterName String param1

Parameter
ParameterOperator Integer 0

OPERATOR. The optional enumeration values are:

  • 0:Equal
  • 1:Like
  • 2:Const
  • 3:In

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:

  • 0:Path
  • 1:Query
  • 2:Head
  • 3:Body

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.
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.
SuccessfulResultSample String {"success": true}

Sample success responses.
Status Integer 1

The status of the API. Valid values: 0 (unpublished) and 1 (published).
TenantId Long 10001

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

Wizard API details. Only wizard APIs return.
FailedResultSample String {"success": false}

Error return example.
IsPagedResponse Boolean true

Specifies whether to enable pagination.
SuccessfulResultSample String {"success": true}

Sample success responses.
WizardConnection Struct

The data source information for the wizard API.
ConnectionId Long 123

ID of the data source.
TableName String t

The name of the source table.
WizardErrorCodes Array of WizardErrorCode

The list of error codes for the wizard API.
ErrorCode String 1001

The error code.
ErrorMessage String fail to call

The error message.
ErrorSolution String retry

Solution to the error.
WizardRequestParameters Array of WizardRequestParameter

List of request parameters for the wizard API.
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 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.

WizardResponseParameters Array of WizardResponseParameter

The list of response parameters for the wizard API.
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.
ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.
ErrorMessage String The connection does not exist.

The error message.
HttpStatusCode Integer 200

The HTTP status 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=GetDataServicePublishedApi &ApiId=10001 &ProjectId=10002 &RegionId=cn-shanghai &TenantId=10003 &<common request parameters>

Sample success responses

XML format 


     <RequestId>0000-ABCD-EFG****</RequestId> <HttpStatusCode>200</HttpStatusCode> <Data> <Status>1</Status> <VisibleRange>0</VisibleRange> <Protocols>0</Protocols> <WizardDetails> <Script>select a from t</Script> <ScriptErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>fail to call</ErrorMessage> <ErrorSolution>try</ErrorSolution> </ScriptErrorCodes> <ScriptErrorCodes> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </ScriptErrorCodes> <ScriptErrorCodes> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptErrorCodes> <ServiceContentType>0</ServiceContentType> <ScriptRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>fail to call</ErrorMessage> <ErrorSolution>try</ErrorSolution> </ScriptRequestParameters> <ScriptRequestParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptRequestParameters> <ServicePath>/index</ServicePath> <WizardErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardErrorCodes> <WizardErrorCodes> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardErrorCodes> <WizardErrorCodes> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardErrorCodes> <RegistrationErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationErrorCodes> <RegistrationErrorCodes> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>fail to call</ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardResponseParameters> <WizardResponseParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardResponseParameters> <ServiceHost>http://example.aliyundoc.com</ServiceHost> <RegistrationRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationRequestParameters> <RegistrationRequestParameters> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>fail to call</ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardRequestParameters> <WizardRequestParameters> <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> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution> try </ErrorSolution> </ScriptResponseParameters> <ScriptResponseParameters> <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> <ExampleValue> example2 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterName> param2 </ParameterName> <ParameterDescription> description2 </ParameterDescription> </ScriptResponseParameters> <ScriptConnection> <TableName> t </TableName> <ConnectionId> 123 </ConnectionId> </ScriptConnection> </WizardDetails> <CreatedTime> 2020-06-23 T00:21:01+0800 </CreatedTime> <Description> test for more information about the API description </Description> <ApiName> test the API name </ApiName> <CreatorId> 1234567 </CreatorId> <RequestMethod> 0 </RequestMethod> <Timeout> 10000 </Timeout> <ProjectId> 10001 </ProjectId> <ResponseContentType> 0 </ResponseContentType> <OperatorId> 2345678 </OperatorId> <RegistrationDetails> <Script> select a from t </Script> <ScriptErrorCodes> <ErrorCode> Invalid.Tenant.ConnectionNotExists </ErrorCode> <ErrorMessage> fail to call </ErrorMessage> <ErrorSolution> try </ErrorSolution> </ScriptErrorCodes> <ScriptErrorCodes> <DefaultValue> default1 </DefaultValue> <ExampleValue> example1 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterPosition> 0 </ParameterPosition> <ParameterName> param1 </ParameterName> <ParameterOperator> 0 </ParameterOperator> <ParameterDescription> description1 </ParameterDescription> <IsRequiredParameter> true </IsRequiredParameter> </ScriptErrorCodes> <ScriptErrorCodes> <ExampleValue> example2 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterName> param2 </ParameterName> <ParameterDescription> description2 </ParameterDescription> </ScriptErrorCodes> <ServiceContentType> 0 </ServiceContentType> <ScriptRequestParameters> <ErrorCode> Invalid.Tenant.ConnectionNotExists </ErrorCode> <ErrorMessage> The connection does not exist. </ErrorMessage> <ErrorSolution>try</ErrorSolution> </ScriptRequestParameters> <ScriptRequestParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptRequestParameters> <ServicePath>/index</ServicePath> <WizardErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardErrorCodes> <WizardErrorCodes> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardErrorCodes> <WizardErrorCodes> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardErrorCodes> <RegistrationErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationErrorCodes> <RegistrationErrorCodes> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardResponseParameters> <WizardResponseParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardResponseParameters> <ServiceHost>http://example.aliyundoc.com</ServiceHost> <RegistrationRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>fail to call</ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationRequestParameters> <RegistrationRequestParameters> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardRequestParameters> <WizardRequestParameters> <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> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>try</ErrorSolution> </ScriptResponseParameters> <ScriptResponseParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptResponseParameters> <ScriptConnection> <TableName>t</TableName> <ConnectionId>123</ConnectionId> </ScriptConnection> </RegistrationDetails> <GroupId>abcde123456789</GroupId> <TenantId>10001</TenantId> <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime> <ScriptDetails> <Script>select a from t</Script> <ScriptErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>try</ErrorSolution> </ScriptErrorCodes> <ScriptErrorCodes> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </ScriptErrorCodes> <ScriptErrorCodes> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptErrorCodes> <ServiceContentType>0</ServiceContentType> <ScriptRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>try</ErrorSolution> </ScriptRequestParameters> <ScriptRequestParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </ScriptRequestParameters> <ServicePath>/index</ServicePath> <WizardErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardErrorCodes> <WizardErrorCodes> <DefaultValue>default1</DefaultValue> <ExampleValue>example1</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterPosition>0</ParameterPosition> <ParameterName>param1</ParameterName> <ParameterOperator>0</ParameterOperator> <ParameterDescription>description1</ParameterDescription> <IsRequiredParameter>true</IsRequiredParameter> </WizardErrorCodes> <WizardErrorCodes> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardErrorCodes> <RegistrationErrorCodes> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationErrorCodes> <RegistrationErrorCodes> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardResponseParameters> <WizardResponseParameters> <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> <ExampleValue>example2</ExampleValue> <ParameterDataType>0</ParameterDataType> <ParameterName>param2</ParameterName> <ParameterDescription>description2</ParameterDescription> </WizardResponseParameters> <ServiceHost>http://example.aliyundoc.com</ServiceHost> <RegistrationRequestParameters> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </RegistrationRequestParameters> <RegistrationRequestParameters> <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> <ErrorCode>1001</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution>retry</ErrorSolution> </WizardRequestParameters> <WizardRequestParameters> <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> <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> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <ErrorSolution> try </ErrorSolution> </ScriptResponseParameters> <ScriptResponseParameters> <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> <ExampleValue> example2 </ExampleValue> <ParameterDataType> 0 </ParameterDataType> <ParameterName> param2 </ParameterName> <ParameterDescription> description2 </ParameterDescription> </ScriptResponseParameters> <ScriptConnection> <TableName> t </TableName> <ConnectionId> 123 </ConnectionId> </ScriptConnection> </ScriptDetails> <ApiId> 10000 </ApiId> <ApiMode> 0 </ApiMode> <ApiPath> /test/1 </ApiPath> </Data> <ErrorCode> 0 </ErrorCode> <ErrorMessage> normal </ErrorMessage> <Success> true </Success>

JSON Format 


     {"RequestId": "0000-ABCD-EFG****", "HttpStatusCode": 200, "Data": { "Status": 1, "VisibleRange": 0, "Protocols": 0, "WizardDetails": { "Script": "select a from t", "ScriptErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage":" The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, {"ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceContentType": 0, "ScriptRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "try"} , { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0," ParameterName": "param2", "ParameterDescription": "description2" } ], "ServicePath": "/index", "WizardErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue":" example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2"} ], "RegistrationErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "WizardResponseParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceHost":" http://example.aliyundoc.com ", "RegistrationRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "IsPagedResponse": true, "ServiceRequestBodyDescription": "{\"abc\":1}", "WizardRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { " DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName":" param2", "ParameterDescription": "description2" } ], "SuccessfulResultSample": "{\"success\": true}", "WizardConnection": { "TableName": "t", "ConnectionId": 123 }, "FailedResultSample": "{\"success\": false}", "ScriptResponseParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage":" The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, {"ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ScriptConnection": { "TableName": "t", "ConnectionId": 123 } }, "CreatedTime": "2020-06-23T00:21:01+0800", "Description": "Test API Description", "ApiName": " Test API name ", " CreatorId ": 1234567, " RequestMethod ": 0, " Timeout ": 100000," ProjectId ": 10001, " ResponseContentType ": 0, " OperatorId ": 2345678," RegistrationDetails ": { " Script ": " select a from t ", " ScriptErrorCodes ": [ { " ErrorCode ": " "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": " The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, {"ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceContentType": 0, "ScriptRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "try"} , { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0," ParameterName": "param2", "ParameterDescription": "description2" } ], "ServicePath": "/index", "WizardErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue":" example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2"} ], "RegistrationErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "WizardResponseParameters": [ { "ErrorCode":"Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceHost": " http://example.aliyundoc.com", "RegistrationRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "IsPagedResponse": true, "ServiceRequestBodyDescription": "{\"abc\":1}", "WizardRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { " DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName":" param2", "ParameterDescription": "description2" } ], "SuccessfulResultSample": "{\"success\": true}", "WizardConnection": { "TableName": "t", "ConnectionId": 123 }, "FailedResultSample": "{\"success\": false}", "ScriptResponseParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage":" The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, {"ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ScriptConnection": { "TableName": "t", "ConnectionId": 123 } }, "GroupId": "abcde123456789", "TenantId": 10001, "ModifiedTime":" 2020-06-23T00:21:01+0800", "ScriptDetails": { "Script": "select a from t", "ScriptErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceContentType": 0, "ScriptRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServicePath": "/index", "WizardErrorCodes": [ { "ErrorCode":" Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "RegistrationErrorCodes": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "WizardResponseParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1"," IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ServiceHost":" http://example.aliyundoc.com ", "RegistrationRequestParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "name1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true } ], "IsPagedResponse": true, "ServiceRequestBodyDescription": "{\"abc\":1}", "WizardRequestParameters": [ { "ErrorCode": 1001, "ErrorMessage": "The connection does not exist.", "ErrorSolution": "retry" }, { " DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, { "ExampleValue": "example2", "ParameterDataType": 0, "ParameterName":" param2", "ParameterDescription": "description2" } ], "SuccessfulResultSample": "{\"success\": true}", "WizardConnection": { "TableName": "t", "ConnectionId": 123 }, "FailedResultSample": "{\"success\": false}", "ScriptResponseParameters": [ { "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage":" The connection does not exist.", "ErrorSolution": "try" }, { "DefaultValue": "default1", "ExampleValue": "example1", "ParameterDataType": 0, "ParameterPosition": 0, "ParameterName": "param1", "ParameterOperator": 0, "ParameterDescription": "description1", "IsRequiredParameter": true }, {"ExampleValue": "example2", "ParameterDataType": 0, "ParameterName": "param2", "ParameterDescription": "description2" } ], "ScriptConnection": { "TableName": "t", "ConnectionId": 123 } }, "ApiId": 10000, "ApiMode": 0, "ApiPath": "/test/1" }, "ErrorCode": 0, "ErrorMessage": "normal", "Success": true}

Error codes

HttpCode Error codes Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. You have restricted access. Please activate DataWorks Enterprise Edition or above.
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.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
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.

Go to the Error Center For more information, see error codes.