Package | Description |
---|---|
com.huawei.dli.restapi | |
com.huawei.dli.restapi.api |
Modifier and Type | Method and Description |
---|---|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
Modifier and Type | Method and Description |
---|---|
ApiResponse<ResponseInfo> |
RestApi.alertResourceOrGroupOwnerWithHttpInfo(String projectId,
UpdateResourceOwner body,
String xAuthToken)
Modify owner of resource
Modify owner of resource.
|
ApiResponse<GlobalResponse> |
RestApi.authorizeBucketWithHttpInfo(String projectId,
ObsBuckets obsBuckets,
String xAuthToken)
用户主动授权起OBS桶的操作权限给DLI服务, 用于保存用户作业的checkpoint、作业的运行日志等
|
ApiResponse<ResponseInfo> |
RestApi.cancelJob_0WithHttpInfo(String projectId,
String queueName,
String jobId,
String xAuthToken)
Cancel job
Canceling a job that has already been submitted can not be canceled if the job has been completed or failed.
|
ApiResponse<ResponseInfo> |
RestApi.cancelJobWithHttpInfo(String projectId,
String jobId,
String xAuthToken)
Cancel job
Canceling a job that has already been submitted can not be canceled if the job has been completed or failed.
|
ApiResponse<ResponseJobInfo> |
RestApi.checkSQLWithHttpInfo(String projectId,
SQLJobRequest sqLJobInfo,
String xAuthToken)
Check sql
Check the SQL grammar.
|
ApiResponse<UploadCommitJobResult> |
RestApi.commitUploadJobWithHttpInfo(String projectId,
UploadCommitJobRequest uploadCommitJobRequest,
String xAuthToken)
Commit direct upload job
Commit direct upload job for upload data to DLI.
|
ApiResponse<SessionInfo> |
RestApi.createBatchWithHttpInfo(String projectId,
Object body,
String xAuthToken,
String USER_ID)
Create batch
Create batch.
|
ApiResponse<EmptyResponse> |
RestApi.createClusterWithHttpInfo(String projectId,
String xAuthToken,
CreateClusterRequest createClusterRequest,
String USER_ID)
Create cluster
Create cluster.
|
ApiResponse<ResponseInfo> |
RestApi.createDatabaseWithHttpInfo(String projectId,
DatabaseInfo databaseInfo,
String xAuthToken)
Create database
create a database
|
ApiResponse<DownloadCreateJobResult> |
RestApi.createDownloadJobWithHttpInfo(String projectId,
EmptyBody emptyBody,
String xAuthToken)
Create direct download job
Create direct download job for download data from DLI.
|
ApiResponse<FlinkJobTemplateCreateResponse> |
RestApi.createFlinkJobTemplateWithHttpInfo(String projectId,
CreateFlinkJobTemplateRequest body,
String xAuthToken)
创建作业模板
Create job template on Data lake insight
|
ApiResponse<ObsSelectJobResult> |
RestApi.createObsSelectJobWithHttpInfo(String projectId,
ObsSelectJobRequest obsSelectJobRequest,
String xAuthToken)
Create Obs select job
Create Obs select job to DLI.
|
ApiResponse<ResponseQueueInfo> |
RestApi.createQueueWithHttpInfo(String projectId,
QueueInfo queueInfo,
String xAuthToken)
Create queue
Create a queue that will bind user-specified computing resources.
|
ApiResponse<ResponseInfo> |
RestApi.createTableWithHttpInfo(String projectId,
String databaseName,
TableInfo tableInfo,
String xAuthToken)
Create a new table
Data location:DLI and OBS,OBS must set data_location and data_type parameter
|
ApiResponse<CreateTsdbResp> |
RestApi.createTsdbWithHttpInfo(CreateTsdbReq createTsdbReq,
String projectId,
String xAuthToken)
创建时序数据库配置信息
|
ApiResponse<UploadCreateJobResult> |
RestApi.createUploadJobWithHttpInfo(String projectId,
UploadCreateJobRequest uploadCreateJobRequest,
String xAuthToken)
Create direct upload job
Create direct upload job for upload data to DLI.
|
ApiResponse<ResponseInfo> |
RestApi.dataAuthorizeWithHttpInfo(String projectId,
PrivilegeInfo privilegeInfo,
String xAuthToken)
List queue users
Privilege data permissions to the database or data table to other specified users.
|
ApiResponse<MessageInfo> |
RestApi.delBatchWithHttpInfo(String projectId,
String batchId,
String xAuthToken)
Delete specified batch
Delete specified batch.
|
ApiResponse<EmptyResponse> |
RestApi.deleteClusterWithHttpInfo(String projectId,
String clusterName,
String xAuthToken)
Delete cluster
Delete cluster.
|
ApiResponse<ResponseInfo> |
RestApi.deleteDatabaseWithHttpInfo(String projectId,
String databaseName,
String xAuthToken)
Delete database
Delete database by database name.
|
ApiResponse<FlinkJobTemplateDeleteResponse> |
RestApi.deleteFlinkJobTemplateWithHttpInfo(String projectId,
Long templateId,
String xAuthToken)
删除作业模板
当前模板被引用也允许删除模板
|
ApiResponse<List<GlobalBatchResponse>> |
RestApi.deleteFlinkJobWithHttpInfo(String projectId,
DeleteJobInBatchRequest deleteJobInBatchRequest,
String xAuthToken)
批量删除作业
|
ApiResponse<GlobalResponse> |
RestApi.deleteJobWithHttpInfo(String projectId,
Long jobId,
String xAuthToken)
删除作业
删除任何状态的作业
|
ApiResponse<ResponseInfo> |
RestApi.deleteQueueWithHttpInfo(String projectId,
String queueName,
String xAuthToken)
Delete queue
Delete the specified queue.
|
ApiResponse<EmptyResponse> |
RestApi.deleteResourceWithHttpInfo(String projectId,
String resourceName,
String group,
String xAuthToken)
Delete specified resource
Delete specified resource.
|
ApiResponse<ResponseInfo> |
RestApi.deleteTableWithHttpInfo(String projectId,
String databaseName,
String tableName,
String xAuthToken)
Delete table
Delete the specified table.
|
ApiResponse<GlobalResponse> |
RestApi.deleteTsdbWithHttpInfo(String projectId,
String tsdbId,
String xAuthToken)
删除时序数据库配置信息
删除时序数据库配置信息
|
ApiResponse<ColumnResult> |
RestApi.describeTableWithHttpInfo(String projectId,
String databaseName,
String tableName,
String xAuthToken)
Describe Table
Describes the metadata information for the specified table.
|
ApiResponse<ResponseJobInfo> |
RestApi.execute_0WithHttpInfo(String projectId,
String queueName,
SQLJobRequest sqLJobInfo,
String xAuthToken)
Submit job
This API is used to submit jobs to the cluster by executing SQL statements.
|
ApiResponse<ResponseJobInfo> |
RestApi.executeWithHttpInfo(String projectId,
SQLJobRequest sqLJobInfo,
String xAuthToken)
Submit job
This API is used to submit jobs to the cluster by executing SQL statements.
|
ApiResponse<ResponseJobInfo> |
RestApi.exportDataWithHttpInfo(String projectId,
ExportJobRequest exportInfo,
String xAuthToken)
Export data
Export the data to a file.
|
ApiResponse<SessionInfo> |
RestApi.getBatchInfoWithHttpInfo(String projectId,
String batchId,
String xAuthToken)
List specified batch
List specified batch.
|
ApiResponse<SessionInfos> |
RestApi.getBatchListWithHttpInfo(String projectId,
String xAuthToken,
String clusterName,
Integer from,
Integer size,
String jobId,
String jobName,
Long start,
Long end,
String order)
List all batchs
List all batchs.
|
ApiResponse<SessionLog> |
RestApi.getBatchLogWithHttpInfo(String projectId,
String batchId,
String xAuthToken,
Integer from,
Integer size,
String type,
Integer index)
Get specified batch log
Get specified batch log.
|
ApiResponse<SessionState> |
RestApi.getBatchStateWithHttpInfo(String projectId,
String batchId,
String xAuthToken)
Get specified session state
Get specified session state.
|
ApiResponse<ClusterInfo> |
RestApi.getClusterWithHttpInfo(String projectId,
String clusterName,
String xAuthToken)
List specified cluster
List specified cluster.
|
ApiResponse<FlinkJobApigSinksResponse> |
RestApi.getFlinkApigSinksWithHttpInfo(String projectId,
Long jobId,
String xAuthToken)
查询作业apig网关服务访问地址
The apig sinks is json format.
|
ApiResponse<GetFlinkJobDetailResponse> |
RestApi.getFlinkJobDetailWithHttpInfo(String projectId,
Long jobId,
String xAuthToken)
查询作业详情
Get job detail information.
|
ApiResponse<FlinkJobExecutePlanResponse> |
RestApi.getFlinkJobExecuteGraphWithHttpInfo(String projectId,
Long jobId,
String xAuthToken)
查询作业执行计划图
The execution graph is json format.
|
ApiResponse<QueryFlinkJobMetricsResponse> |
RestApi.getFlinkJobsMetricsWithHttpInfo(String projectId,
GetFlinkJobsMetricsBody getFlinkJobsMetricsBody,
String xAuthToken)
查询作业监控信息
查询作业监控信息, 支持同时查询多个作业监控信息
|
ApiResponse<QueryFlinkJobListResponse> |
RestApi.getFlinkJobsWithHttpInfo(String projectId,
String xAuthToken,
String name,
String status,
String queueName,
Boolean showDetail,
Long offset,
Integer limit,
String order,
Long rootJobId,
String userName,
String jobType,
String showJobType)
查询作业列表
作业列表查询, 支持以下参数: name, status, show_detail, cursor, next, limit, order, root_job_id.
|
ApiResponse<FlinkJobTemplateListResponse> |
RestApi.getFlinkJobTemplatesWithHttpInfo(String projectId,
String xAuthToken,
Long offset,
Integer limit,
String order)
查询作业模板列表
|
ApiResponse<DetailResult> |
RestApi.getImportExportJobInfoWithHttpInfo(String projectId,
String jobId,
String xAuthToken)
Import and Export detail
Query the details of imported and exported jobs, such as the job's databaseName, tableName, file size, and export mode.
|
ApiResponse<JobProgressResult> |
RestApi.getJobProgressWithHttpInfo(String projectId,
String jobId,
String xAuthToken)
Get job progress
Get job progress
|
ApiResponse<JobResult> |
RestApi.getJobResult_0WithHttpInfo(String projectId,
String queueName,
String jobId,
String xAuthToken,
Integer pageSize,
Integer currentPage)
Get job result
After the job executing the SQL query is completed, review the result of the job execution.
|
ApiResponse<JobResult> |
RestApi.getJobResultWithHttpInfo(String projectId,
String jobId,
String xAuthToken,
Integer pageSize,
Integer currentPage,
String queueName)
Get job result
After the job executing the SQL query is completed, review the result of the job execution.
|
ApiResponse<StatusResult> |
RestApi.getJobStatusWithHttpInfo(String projectId,
String jobId,
String xAuthToken)
Get job status
Get job status after job submission.
|
ApiResponse<PkgResourceInfo> |
RestApi.getResourceInfoWithHttpInfo(String projectId,
String resourceName,
String group,
String xAuthToken)
List specified resource
List specified resource.
|
ApiResponse<QueueInfo> |
RestApi.getSpecifiedQueueWithHttpInfo(String projectId,
String queueName,
String xAuthToken)
Get queue
Get the specified queue.
|
ApiResponse<TokenAuthResponse> |
TokenAuthApi.getTokenWithHttpInfo(TokenAuthInfo tokenAuthInfo)
get token
get token for authentication
|
ApiResponse<GetTsdbByIdResp> |
RestApi.getTsdbByIdWithHttpInfo(String projectId,
Long tsdbId,
String xAuthToken)
查询时序数据库配置信息详情
根据时序数据库ID,查询时序数据库详情
|
ApiResponse<GetTsdbListResp> |
RestApi.getTsdbListWithHttpInfo(String projectId,
Integer offset,
Integer limit,
String xAuthToken)
查询时序数据库配置信息列表
|
ApiResponse<ResponseJobInfo> |
RestApi.importDataWithHttpInfo(String projectId,
ImportJobRequest importExportInfo,
String xAuthToken)
Import data
Importing data from a file into a DLI table currently only supports importing data from OBS into DLI.
|
ApiResponse<DatabaseResult> |
RestApi.listAllDatabasesWithHttpInfo(String projectId,
String xAuthToken)
List all databases
List all databases info,include owner and table_number.
|
ApiResponse<JobListResult> |
RestApi.listAllJobsWithHttpInfo(String projectId,
String xAuthToken,
Integer pageSize,
Integer currentPage,
Long start,
Long end,
String jobType,
String tags,
String queueName,
String owner,
String jobStatus,
String order)
List all jobs
List all jobs
|
ApiResponse<QueueResult> |
RestApi.listAllQueuesWithHttpInfo(String projectId,
String xAuthToken,
String queueType)
List all queues
List all the queues under the project.
|
ApiResponse<TableListResult> |
RestApi.listAllTablesWithHttpInfo(String projectId,
String databaseName,
String xAuthToken,
String keyword,
Boolean withDetail,
Integer pageSize,
Integer currentPage,
String tableType)
List all tables
Query the specified database under the filter conditions or all of the table information.
|
ApiResponse<ClusterInfos> |
RestApi.listClusterWithHttpInfo(String projectId,
String xAuthToken)
List all clusters
List all clusters.
|
ApiResponse<PrivilegeResult> |
RestApi.listDatabaseUsersWithHttpInfo(String projectId,
String databaseName,
String xAuthToken)
List Database Users
View the current database has permission to use or access all user names.
|
ApiResponse<PrivilegeResult> |
RestApi.listQueueUsersWithHttpInfo(String projectId,
String queueName,
String xAuthToken)
List queue users
Queries all the user names of the specified queue that can be used.
|
ApiResponse<ResourceInfos> |
RestApi.listResourcesWithHttpInfo(String projectId,
String xAuthToken,
String kind)
List all resources
List all resources.
|
ApiResponse<JobListResult> |
RestApi.listSqlJobsWithHttpInfo(String projectId,
String xAuthToken,
Integer pageSize,
Integer currentPage,
String tags)
List all sql jobs
List all sql jobs
|
ApiResponse<PrivilegeResult> |
RestApi.listTableUserPrivilegesWithHttpInfo(String projectId,
String databaseName,
String tableName,
String userName,
String xAuthToken)
List Table User Privileges
Query the specified user's privileges list on the table.
|
ApiResponse<PrivilegeResult> |
RestApi.listTableUsersWithHttpInfo(String projectId,
String databaseName,
String tableName,
String xAuthToken)
List Table Users
View all users who have access to the columns of the specified table or table.
|
ApiResponse<JobResult> |
RestApi.previewJobResultWithHttpInfo(String projectId,
String jobId,
String xAuthToken,
String queueName)
Get job result
After the job executing the SQL query is completed, review the result of the job execution.
|
ApiResponse<QueueActionResponse> |
RestApi.queueActionWithHttpInfo(String projectId,
String queueName,
QueueActionRequest body,
String xAuthToken)
队列操作
|
ApiResponse<List<GlobalBatchResponse>> |
RestApi.runFlinkJobWithHttpInfo(String projectId,
RunFlinkJobRequest body,
String xAuthToken)
运行作业
触发运行作业
|
ApiResponse<ResponseInfo> |
RestApi.shareQueueWithHttpInfo(String projectId,
PrivilegeInfo privilegeInfo,
String xAuthToken)
Share queues
To share the specified queue with other users, you can assign the user the privilege to use the specified queue or to recover the usage privileges.
|
ApiResponse<PartitionResult> |
RestApi.showPartitionsWithHttpInfo(String projectId,
String databaseName,
String tableName,
String xAuthToken,
Integer offset,
Integer limit)
Show partition information
Describes the partition information for the specified table.
|
ApiResponse<List<GlobalBatchResponse>> |
RestApi.stopFlinkJobWithHttpInfo(String projectId,
StopFlinkJobRequest body,
String xAuthToken)
停止作业
|
ApiResponse<ResponseJobInfo> |
RestApi.storeJobResultWithHttpInfo(String projectId,
String jobId,
String xAuthToken,
ExportCommonInfo exportCommonInfo)
Export job result
Export the results of the SQL statement to the OBS object store and only support the export of query results for \"QUERY\" type jobs.
|
ApiResponse<JobStatusResponse> |
RestApi.submitFlinkJarJobWithHttpInfo(String projectId,
CreateFlinkJarJobRequest body,
String xAuthToken)
创建一个用户自定义Flink作业
用户自定义Flink作业目前支持jar格式, 运行在独享集群中
|
ApiResponse<JobStatusResponse> |
RestApi.submitFlinkSqlJobWithHttpInfo(String projectId,
SubmitFlinkSqlJobRequest body,
String xAuthToken)
提交流式SQL作业到DLI服务
通过POST方式, 提交流式SQL作业, 请求体为JSON格式
|
ApiResponse<JobUpdateResponse> |
RestApi.updateFlinkJarJobWithHttpInfo(String projectId,
Long jobId,
UpdateFlinkJarJobRequest body,
String xAuthToken)
更新用户自定义Flink作业
目前仅支持Jar格式, 运行在独享集群中
|
ApiResponse<GlobalResponse> |
RestApi.updateFlinkJobTemplateWithHttpInfo(String projectId,
Long templateId,
UpdateFlinkJobTemplateRequest body,
String xAuthToken)
更新作业模板
Update job template on Data lake insight
|
ApiResponse<JobUpdateResponse> |
RestApi.updateFlinkSqlJobWithHttpInfo(String projectId,
Long jobId,
UpdateFlinkSqlJobRequest body,
String xAuthToken)
更新流式SQL作业
流式SQL的语法扩展了Apache Flink SQL, 具体详情请参考DLI官方文档
|
ApiResponse<GlobalResponse> |
RestApi.updateTsdbWithHttpInfo(String projectId,
String tsdbId,
UpdateTsdbReq updateTsdbReq,
String xAuthToken)
修改时序数据库配置信息
修改时序数据库配置信息
|
ApiResponse<ResourceMsg> |
RestApi.uploadFilesWithHttpInfo(String projectId,
PkgResourceRequest body,
String xAuthToken,
String USER_ID)
Upload files
Upload files.
|
ApiResponse<ResourceMsg> |
RestApi.uploadJarsWithHttpInfo(String projectId,
PkgResourceRequest body,
String xAuthToken,
String USER_ID)
Upload jars
Upload jars.
|
ApiResponse<ResourceMsg> |
RestApi.uploadPyFilesWithHttpInfo(String projectId,
PkgResourceRequest body,
String xAuthToken,
String USER_ID)
Upload pyfiles
Upload pyfiles.
|
ApiResponse<ResourceMsg> |
RestApi.uploadResourcesWithHttpInfo(String projectId,
PkgResourceRequest body,
String xAuthToken,
String USER_ID)
Upload resources
Upload resources.
|
Copyright © 2023. All rights reserved.