Help Center> > API Reference >API Overview

API Overview

ModelArts provides self-developed APIs.

You can use the self-developed APIs of ModelArts to manage jobs, models, and services.

Table 1 Development environment APIs

API

Description

Creating a Development Environment Instance

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

Querying the List of 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 2 Job management APIs

Type

API

Description

Training Job Management

Creating a Training Job

This API is used to create a training job.

Querying the List of Training Jobs

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

Querying the Details About a Training Job Version

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 List of Training Job Versions

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 (New)

This API is used to query detailed information about training job logs by row.

Training Job Parameter Configuration

Creating a Training Job Configuration

This API is used to create a training job configuration.

Querying the List of 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 the List of 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

This API is used to view job statuses and status description.

Table 3 Model management APIs

API

Description

Importing a Model

This API is used to import a model.

Querying the List of 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 4 Service management APIs

API

Description

Deploying a Model Service

This API is used to deploy a model service.

Querying the List of 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.

Querying Service Event Logs

This API is used to query service event logs, including service operation records, key actions during deployment, and deployment failure causes.

Deleting a Model Service

This API is used to delete a model service.

Querying Supported Service Deployment Specifications

This API is used to query supported service deployment specifications.

Querying Dedicated Resource Pools

This API is used to query dedicated resource pools.

Table 5 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 list of workspaces with certain permissions. The list contains detailed information about the workspaces.

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 about a workspace.

Modifying a Workspace

This API is used to modify a workspace.