Help Center> RES> API Reference> API Overview

API Overview

Type

API

Description

Workspace

Querying the enterprise project list

This API is used to query the enterprise project IDs of a user in the current project.

Creating a workspace

This API is used to create an independent workspace in RES for resource isolation.

Querying the workspace list

This API is used to query the list of workspaces for which the current user has operation permissions.

Querying the details about a workspace

This API is used to query the details about a specified workspace.

Updating a workspace

This API is used to update workspace information. Only the description can be updated.

Deleting a workspace

This API is used to delete a specified workspace.

Querying specifications

Querying training specifications

This API is used to query the offline computing specifications, real-time computing specifications, and ranking model training specifications provided by RES. Training specifications are required when you create data sources and scenarios.

Data source

Creating a data source

This API is used to create a data source in a specified workspace.

Querying the list of data sources

This API is used to query the data source list in a workspace.

Querying the data source details

This API is used to query the details about a data source.

Modifying a data source

This API is used to modify the configurations of a specified data source.

Modifying a data source feature

This API is used to modify a data source feature.

Deleting a data source

This API is used to delete a data source.

Querying the data source task result

This API is used to query the result of an offline task in a specified data source, including data format, data detection, data exploration, and effect evaluation.

Scenario

Creating a custom scenario

This API is used to create a custom scenario in a specified workspace.

Creating an intelligent scenario

This API is used to create an intelligent scenario in a specified workspace.

Viewing the details of a scenario

This API is used to query the details about a specified scenario.

Querying the list of scenarios

This API is used to query the scenario list in a workspace.

Updating a custom scenario

This API is used to update a custom scenario.

Updating an intelligent scenario

This API is used to update an intelligent scenario.

Deleting a scenario

This API is used to delete a scenario. Deleted scenarios cannot be recovered. Exercise caution when performing this operation.

Training a job

Creating a training job

This API is used to create the metadata of a training job. When the metadata is created, you can manually execute the job.

Creating multiple training jobs

This API is used to create jobs in batches.

Querying a training job

This API is used to query a job of a specified type in resource_id (data source ID or scenario ID).

Modifying the parameters of a training job

This API is used to modify the metadata of a specified job.

Changing the status of a training job

This API is used to change the job status (enabled or disabled).

Querying the candidate sets of a training job

This API is used to query the candidate sets of the scenario identified by workspaces_id and resource_id.

Deleting a training job

This API is used to delete a training job.

Online service

Creating an online service

This API is used to create the metadata of an online service. When the metadata is created, you can manually publish the service.

Querying the details about an online service

This API is used to query online services based on the specified workspace_id, resource_id, and category values.

Modifying the parameters of an online service

This API is used to modify the metadata of a specified online service.

Changing the status of an online service

This API is used to change the status (enabled or disabled) of an online service.

Deleting an online service

This API is used to delete an online service instance.

Schedule

Executing a job

This API is used to execute an independent job.

Executing a scenario

This API is used to execute all jobs and services in a scenario.