Help Center> > API Reference >API Overview

API Overview

ModelArts provides Huawei-developed APIs.

You can use the APIs to manage datasets, jobs, models, and services.

Table 1 Data management APIs

Type

API

Description

Datasets

Creating a Dataset

This API is used to create a dataset.

Querying a Dataset

This API is used to query the details about a dataset based on the dataset ID.

Querying Datasets

This API is used to query the created datasets that meet the search criteria.

Modifying a Dataset

This API is used to modify the name and description of a dataset.

Deleting a Dataset

This API is used to delete a dataset and its version records.

Releasing a New Version of a Dataset

This API is used to release a new version of a dataset.

Querying Historical Versions of a Dataset

This API is used to query the historical versions of a specified dataset, including the current unique temporary version.

Querying the Details About a Dataset Version

This API is used to view the name, description, and file list of a specified dataset version, and query files that meet the search criteria.

Querying the Differences Between Dataset Versions

This API is used to compare data changes between dataset versions, such as the change of file count.

Switching the Dataset Version

This API is used to switch the dataset from the current version to the specified version.

Synchronizing a Dataset

This API is used to synchronize the files on Object Storage Service (OBS) to the temporary version of a dataset.

Deleting Files from OBS

This API is used to delete the datasets and files stored in an OBS bucket and update the file changes to the temporary version of a dataset.

Viewing the Dataset Job Status

This API is used to query the status of time-consuming jobs such as creating datasets, creating dataset versions, switching datasets, and deleting datasets.

Modifying a Historical Version of a Dataset

This API is used to delete only the files in a historical version of a dataset. The files of the temporary version can be modified using the API in Deleting Files from OBS.

Dataset Statuses

Dataset statuses

Data Labeling Jobs

Creating a Data Labeling Job

This API is used to create a data labeling job.

Querying Data Labeling Jobs

This API is used to query data labeling jobs.

Deleting a Data Labeling Job

This API is used to delete a data labeling job.

Modifying a Data Labeling Job

This API is used to modify a data labeling job.

Saving the Validation Result of a Data Labeling Job

This API is used to extract samples that have been manually labeled for validation.

Manual Labeling

Querying Images

This API is used to query images based on label pagination.

Querying a Single Image

This API is used to query an image based on the image ID.

Modifying Image Information

This API is used to modify the label of an image or add a label to an image.

Deleting a Single Image

This API is used to delete a specified image.

Deleting Images in Batches

This API is used to delete the specified images in batches.

Querying the Label of a Specified Image

This API is used to query the label of a specified image.

Querying the Labels of Multiple Images

This API is used to query the labels of multiple images.

Querying All Image Labels

This API is used to query all labels of a manual labeling job.

Obtaining Label Statistics

This API is used to obtain label statistics.

Synchronizing OBS Data

This API is used to synchronize OBS data.

Querying the Status of OBS Synchronization

This API is used to query the status of OBS synchronization.

Querying the Validation Statistics of a Labeling Job

This API is used to extract samples that have been manually labeled for validation.

Table 2 Development environment APIs

API

Description

Querying the Authentication Information of a Development Environment Instance

This API is used to query the authentication information of a development environment instance. You can open the development environment instance with the authentication information.

Creating a Development Environment Instance

This API is used to create a development environment instance for code development.

Querying Development Environment Instances

This API is used to query the development environment instances that meet the search criteria.

Querying the Details About a Development Environment Instance

This API is used to query the details about a development environment instance.

Modifying the Description of a Development Environment Instance

This API is used to modify the description of a development environment instance.

Deleting a Development Environment Instance

This API is used to delete a development environment instance.

Starting or Stopping a Development Environment Instance

This API is used to start or stop a development environment instance.

Table 3 Job management APIs

Type

API

Description

Training Job Management

Creating a Training Job

This API is used to create a training job.

Querying Training Jobs

This API is used to query the created training jobs that meet the search criteria.

Querying the Details About a Training Job

This API is used to query the details about a specified training job based on the job ID.

Deleting a Version of a Training Job

This API is used to delete a version of a training job.

Querying the Details About a Training Job Version

This API is used to query the version of a specified training job based on the job ID.

Creating a Version of a Training Job

This API is used to create a version of a training job.

Stopping a Training Job

This API is used to stop a training job.

Modifying the Description of a Training Job

This API is used to modify the description of a training job.

Deleting a Training Job

This API is used to delete a training job.

Obtaining the Name of a Training Job Log File

This API is used to obtain the name of a training job log file.

Querying Training Job Logs

This API is used to query training job logs.

Querying a Preset Algorithm

This API is used to query the details about a preset model.

Training Job Parameter Configuration

Creating a Training Job Configuration

This API is used to create a training job configuration.

Querying Training Job Configurations

This API is used to query the created training job configurations that meet the search criteria.

Modifying a Training Job Configuration

This API is used to modify a training job configuration.

Deleting a Training Job Configuration

This API is used to delete a training job configuration.

Querying the Details About a Training Job Configuration

This API is used to query the details about a specified training job configuration.

Visualization Job Management

Creating a Visualization Job

This API is used to create a visualization job.

Querying Visualization Jobs

This API is used to query the visualization jobs that meet the search criteria.

Querying the Details About a Visualization Job

This API is used to query the details about a specified visualization job based on the job name.

Modifying the Description of a Visualization Job

This API is used to modify the description of a visualization job.

Deleting a Visualization Job

This API is used to delete a visualization job.

Stopping a Visualization Job

This API is used to stop a visualization job.

Restarting a Visualization Job

This API is used to restart a visualization job.

Resource and Engine Specifications

Querying Job Resource Specifications

This API is used to query the resource specifications of a specified job.

Querying Job Engine Specifications

This API is used to query the engine type and version of a specified job.

Job Statuses

Job Statuses

Job statuses and description

Table 4 Model management APIs

API

Description

Importing a Model

This API is used to import a model.

Querying Models

This API is used to query the models that meet the search criteria.

Querying the Details About a Model

This API is used to query the details about a model based on the model ID.

Deleting a Model

This API is used to delete a specified model based on the model ID. All versions of the model can be deleted in cascading mode.

Table 5 Service management APIs

API

Description

Deploying a Model Service

This API is used to deploy a model service.

Querying Model Services

This API is used to query model services.

Querying the Details About a Model Service

This API is used to query the details about a model service based on the service ID.

Starting or Stopping a Service Instance on an Edge Node

This API is used to start or stop a service instance on an edge node.

Updating a Model Service

This API is used to update a model service.

Querying Service Monitoring Information

This API is used to query service monitoring information. Only the services whose infer_type is real-time or edge can be queried.

Querying Service Update Logs

This API is used to query the update logs of a real-time service. Only the services whose infer_type is real-time or edge can be queried.

Deleting a Model Service

This API is used to delete a model service.

Table 6 Workspace management APIs

API

Description

Creating a Workspace

This API is used to create a workspace.

Querying the List of Workspaces

This API is used to query the workspace list that has permissions. The list contains detailed information.

Deleting a Workspace

This API is used to delete a workspace.

Querying the Details About a Workspace

This API is used to query the details of a workspace.

Modifying a Workspace

This API is used to modify a workspace.

Fine-grained API Permissions

This API is used to describe the detailed rights of the API for enterprise users to operate ModelArts.