Skip to main content
Version: 1.3.0

Mdq Table Interface

MdqTableRestfulApi class

Activate table operations

Interface address:/api/rest_j/v1/datasource/active

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Activate table operation

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
tableIdTable IDqueryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Generate the DDL statement for the new library table

Interface address:/api/rest_j/v1/datasource/displaysql

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Generate DDL statement for new library table

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
tableTableStringfalseString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Get partition statistics

Interface address:/api/rest_j/v1/datasource/getPartitionStatisticInfo

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get partition statistics

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
databaseDatasourcequeryfalsestring
partitionSortPartition SortStringfalseString
tableNametable namequeryfalsestring
partitionPathpartitionPathqueryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Get table information

Interface address:/api/rest_j/v1/datasource/getTableBaseInfo

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get table information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
databaseDatasourcequeryfalsestring
tableNametable namequeryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Get table field information

Interface address:/api/rest_j/v1/datasource/getTableFieldsInfo

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get table field information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
databaseDatasourcequeryfalsestring
tableNametable namequeryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Get table statistics

Interface address:/api/rest_j/v1/datasource/getTableStatisticInfo

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get table statistics

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
databaseDatasourcequeryfalsestring
pageNowpage numberqueryfalsestring
pageSizepage sizequeryfalsestring
partitionSortPartition Sortqueryfalsestring
tableNametable namequeryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Active ID

Interface address:/api/rest_j/v1/datasource/persistTable

Request method: POST

Request data type: application/json

Response data type: */*

Interface description:

Activated logo

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
tableTablefalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}