GetDataServiceApi - DataWorks - Alibaba Cloud Documentation Center

Queries the details of a DataService Studio API in the development state.

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
TenantId	long	No	The tenant ID.	10002
ProjectId	long	Yes	The ID of the workspace.	10001
ApiId	long	Yes	The ID of the DataService Studio API.	10000

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code returned.	200
RequestId	string	The ID of the request.	0000-ABCD-EFG****
ErrorMessage	string	The error message returned.	The specified parameters are invalid.
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code returned.	1031203110005
Data	object	The returned data.
Timeout	integer	The timeout period of the API request. Unit: milliseconds.	10000
Status	integer	The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.	0
ApiId	long	The ID of the DataService Studio API.	10000
ApiMode	integer	The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.	0
ProjectId	long	The ID of the workspace.	10001
ResponseContentType	integer	The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.	0
CreatorId	string	The ID of the Alibaba Cloud account used by the creator of the API.	1234567
VisibleRange	integer	The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.	0
ModifiedTime	string	The time when the API was last modified.	2020-06-23T00:21:01+0800
OperatorId	string	The ID of the Alibaba Cloud account used by the user who last modified the API.	2345678
GroupId	string	The ID of the group.	ab123****
Description	string	The description.	Description of the test API
FolderId	long	The ID of the folder.	0
RequestMethod	integer	The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.	0
CreatedTime	string	The creation time.	2020-06-23T00:21:01+0800
ApiName	string	The name of the API.	Name of the test API
TenantId	long	The ID of the tenant.	10002
ApiPath	string	The path of the API.	/test/1
Protocols	array	The list of fields.
Protocol	integer	The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.	0
RegistrationDetails	object	The details of the API generated by registration. This parameter is returned only if the API is generated by registration.
ServiceHost	string	The address of the backend service.	http://example.aliyundoc.com
ServiceContentType	integer	The format in which the response of the API request is returned. Valid values: 0: indicates the JSON format. 1: indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.	0
ServicePath	string	The path of the backend service.	/index
SuccessfulResultSample	string	Sample success responses	{"success": true}
FailedResultSample	string	The sample error response of the API.	{"success": false}
ServiceRequestBodyDescription	string	The description of the request body initiated to call the backend service.	{"abc":1}
RegistrationErrorCodes	array<object>	The error codes returned for the API generated by registration.
RegistrationErrorCode	object	The returned result.
ErrorMessage	string	The error message.	fail to call
ErrorCode	string	The error code.	1001
ErrorSolution	string	The solution used to fix the error.	retry
RegistrationRequestParameters	array<object>	The request parameters of the API generated by registration.
RegistrationRequestParameter	object	The returned result.
ColumnName	string	The name of the associated field. This parameter is supported only if the API is generated in wizard mode.	column1
ParameterName	string	The name of the parameter.	name1
ParameterPosition	integer	The position of the parameter. Valid values: 0: indicates that the parameter is in the URL path of the request. 1: indicates that the parameter is in the Query parameter of the request URL. 2: indicates that the parameter is in the request header. 3: indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.	0
ParameterDescription	string	The description.	description1
DefaultValue	string	The default value.	default1
ParameterOperator	integer	The operator used for the value of the parameter. Valid values: 0: Equal 1: Like 2: Const 3: In APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.	0
ParameterDataType	integer	The data type of the parameter. Valid values: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ExampleValue	string	The sample value.	example1
IsRequiredParameter	boolean	Indicates whether the parameter is required.	true
ScriptDetails	object	The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.
Script	string	The SQL script.	select a from t
IsPagedResponse	boolean	Indicates whether the entries were returned by page.	true
ScriptRequestParameters	array<object>	The request parameters of the API generated in script mode.
ScriptRequestParameter	object	The returned result.
ColumnName	string	The name of the associated field. This parameter is supported only if the API is generated in wizard mode.	column1
ParameterName	string	The name of the parameter.	param1
ParameterPosition	integer	The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.	0
ParameterDescription	string	The description.	description1
DefaultValue	string	The default value.	default1
ParameterOperator	integer	The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.	0
ParameterDataType	integer	The data type of the parameter. Valid values: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ExampleValue	string	The sample value.	example1
IsRequiredParameter	boolean	Indicates whether the parameter is required.	true
ScriptResponseParameters	array<object>	The response parameters of the API generated in script mode.
ScriptResponseParameter	object	The returned result.
ParameterDescription	string	The description.	description2
ColumnName	string	The name of the associated field. This parameter is supported only if the API is generated in wizard mode.	column2
ParameterName	string	The name of the parameter.	param2
ParameterDataType	integer	The data type of the parameter. Valid values: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ExampleValue	string	The sample value.	example2
ScriptConnection	object	The data source information of the API generated in script mode.
TableName	string	The name of the table in the data source.	t
ConnectionId	long	The ID of the data source.	123
WizardDetails	object	The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.
IsPagedResponse	boolean	Indicates whether the entries were returned by page.	true
WizardRequestParameters	array<object>	The request parameters of the API generated in wizard mode.
WizardRequestParameter	object	The returned result.
ColumnName	string	The name of the associated field. This parameter is supported only if the API is generated in wizard mode.	column1
ParameterName	string	The name of the parameter.	param1
ParameterPosition	integer	The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.	0
ParameterDescription	string	The description.	description1
DefaultValue	string	The default value.	default1
ParameterOperator	integer	The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.	0
ParameterDataType	integer	The data type of the parameter. Valid values: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ExampleValue	string	The sample value.	example1
IsRequiredParameter	boolean	Indicates whether the parameter is required.	true
WizardResponseParameters	array<object>	The response parameters of the API generated in wizard mode.
WizardResponseParameter	object	The returned result.
ParameterDescription	string	The description.	description2
ColumnName	string	The name of the associated field. This parameter is supported only if the API is generated in wizard mode.	column2
ParameterName	string	The name of the parameter.	param2
ParameterDataType	integer	The data type of the parameter. Valid values: 0: String 1: Int 2: Long 3: Float 4: Double 5: Boolean 6: StringList 7: IntList 8: LongList 9: FloatList 10: DoubleList 11: BooleanList	0
ExampleValue	string	The sample value.	example2
WizardConnection	object	The data source information of the API generated in wizard mode.
TableName	string	The name of the table in the data source.	t
ConnectionId	long	The ID of the data source.	123

The details about the APIs of different types are returned in different parameters. The details about the API generated in wizard mode are returned in the WizardDetails parameter. The details about the API generated in script mode are returned in the ScriptDetails parameter. The details about the API generated by registration are returned in the RegistrationDetails parameter.

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "Timeout": 10000,
    "Status": 0,
    "ApiId": 10000,
    "ApiMode": 0,
    "ProjectId": 10001,
    "ResponseContentType": 0,
    "CreatorId": "1234567",
    "VisibleRange": 0,
    "ModifiedTime": "2020-06-23T00:21:01+0800",
    "OperatorId": "2345678",
    "GroupId": "ab123****",
    "Description": "Description of the test API\n",
    "FolderId": 0,
    "RequestMethod": 0,
    "CreatedTime": "2020-06-23T00:21:01+0800",
    "ApiName": "Name of the test API\n",
    "TenantId": 10002,
    "ApiPath": "/test/1",
    "Protocols": [
      0
    ],
    "RegistrationDetails": {
      "ServiceHost": "http://example.aliyundoc.com",
      "ServiceContentType": 0,
      "ServicePath": "/index",
      "SuccessfulResultSample": "{\"success\": true}",
      "FailedResultSample": "{\"success\": false}",
      "ServiceRequestBodyDescription": "{\"abc\":1}",
      "RegistrationErrorCodes": [
        {
          "ErrorMessage": "fail to call",
          "ErrorCode": "1001",
          "ErrorSolution": "retry"
        }
      ],
      "RegistrationRequestParameters": [
        {
          "ColumnName": "column1",
          "ParameterName": "name1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ParameterDataType": 0,
          "ExampleValue": "example1",
          "IsRequiredParameter": true
        }
      ]
    },
    "ScriptDetails": {
      "Script": "select a from t",
      "IsPagedResponse": true,
      "ScriptRequestParameters": [
        {
          "ColumnName": "column1",
          "ParameterName": "param1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ParameterDataType": 0,
          "ExampleValue": "example1",
          "IsRequiredParameter": true
        }
      ],
      "ScriptResponseParameters": [
        {
          "ParameterDescription": "description2",
          "ColumnName": "column2",
          "ParameterName": "param2",
          "ParameterDataType": 0,
          "ExampleValue": "example2"
        }
      ],
      "ScriptConnection": {
        "TableName": "t",
        "ConnectionId": 123
      }
    },
    "WizardDetails": {
      "IsPagedResponse": true,
      "WizardRequestParameters": [
        {
          "ColumnName": "column1",
          "ParameterName": "param1",
          "ParameterPosition": 0,
          "ParameterDescription": "description1",
          "DefaultValue": "default1",
          "ParameterOperator": 0,
          "ParameterDataType": 0,
          "ExampleValue": "example1",
          "IsRequiredParameter": true
        }
      ],
      "WizardResponseParameters": [
        {
          "ParameterDescription": "description2",
          "ColumnName": "column2",
          "ParameterName": "param2",
          "ParameterDataType": 0,
          "ExampleValue": "example2"
        }
      ],
      "WizardConnection": {
        "TableName": "t",
        "ConnectionId": 123
      }
    }
  }
}

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
2023-10-10	The Error code has changed	View Change Details