Mdq Table Interface

MdqTableRestfulApi class

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 name Parameter description Request type Required Data type schema
tableId Table ID query false string

Response Status:

Status code Description schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
table Table String false String

Response Status:

Status code Description schema
200 OK Message
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
database Datasource query false string
partitionSort Partition Sort String false String
tableName table name query false string
partitionPath partitionPath query false string

Response Status:

Status code Description schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
database Datasource query false string
tableName table name query false string

Response Status:

Status code Description schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
database Datasource query false string
tableName table name query false string

Response Status:

Status code Description schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Request type Required Data type schema
database Datasource query false string
pageNow page number query false string
pageSize page size query false string
partitionSort Partition Sort query false string
tableName table name query false string

Response Status:

Status code Description schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

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 name Parameter description Required Request type Data type schema
table Table false String String

Response Status:

Status code Description schema
200 OK Message
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

Response parameters:

parameter name parameter description type schema
data Dataset object
message Description string
method request url string
status Status integer(int32) integer(int32)

Sample Response:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }