forked from docs/modelarts
proposalbot
0184ffbc66
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>
163 lines
24 KiB
ReStructuredText
163 lines
24 KiB
ReStructuredText
:original_name: modelarts_03_0002.html
|
|
|
|
.. _modelarts_03_0002:
|
|
|
|
API Overview
|
|
============
|
|
|
|
All ModelArts APIs are proprietary.
|
|
|
|
You can use these APIs to manage datasets, training jobs, models, and services.
|
|
|
|
Data Management APIs
|
|
--------------------
|
|
|
|
Data management APIs include the APIs for managing datasets, dataset versions, samples, and labels. Use these APIs to create datasets and label data. For details, see :ref:`Data Management APIs <modelarts_03_0299>`.
|
|
|
|
DevEnviron APIs
|
|
---------------
|
|
|
|
.. table:: **Table 1** DevEnviron APIs
|
|
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+============================================================================================+============================================================================+
|
|
| :ref:`Creating a Development Environment Instance <modelarts_03_0110>` | Create a development environment instance for code development. |
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| :ref:`Querying a List of Development Environment Instances <modelarts_03_0111>` | Query the development environment instances that meet the search criteria. |
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| :ref:`Querying Details About a Development Environment Instance <modelarts_03_0112>` | Query the details about a development environment instance. |
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| :ref:`Modifying the Description of a Development Environment Instance <modelarts_03_0113>` | Modify the description of a development environment instance. |
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| :ref:`Deleting a Development Environment Instance <modelarts_03_0114>` | Delete a development environment instance. |
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| :ref:`Managing a Development Environment Instance <modelarts_03_0115>` | Start or stop a development environment instance. |
|
|
+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
|
|
Training Management APIs
|
|
------------------------
|
|
|
|
.. table:: **Table 2** Training management APIs
|
|
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Type | API | Description |
|
|
+======================================+====================================================================================+==============================================================================+
|
|
| Training Jobs | :ref:`Creating a Training Job <modelarts_03_0045>` | Create a training job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a Training Job List <modelarts_03_0046>` | Query the created training jobs that meet the search criteria. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Details About a Training Job Version <modelarts_03_0047>` | Query the details about a specified training job based on the job ID. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Version of a Training Job <modelarts_03_0048>` | Delete a version of a training job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a List of Training Job Versions <modelarts_03_0049>` | Query the version of a specified training job based on the job ID. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Creating a Version of a Training Job <modelarts_03_0050>` | Create a version of a training job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Stopping a Training Job <modelarts_03_0051>` | Stop a training job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Modifying the Description of a Training Job <modelarts_03_0052>` | Modify the description of a training job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Training Job <modelarts_03_0053>` | Delete a training job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Obtaining the Name of a Training Job Log File <modelarts_03_0054>` | Obtain the name of a training job log file. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a Built-in Algorithm <modelarts_03_0056>` | Query the details about a built-in model. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Training Job Logs <modelarts_03_0149>` | Query detailed information about training job logs by row. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Training Job Parameter Configuration | :ref:`Creating a Training Job Configuration <modelarts_03_0058>` | Create a training job configuration. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a List of Training Job Configurations <modelarts_03_0059>` | Query the created training job configurations that meet the search criteria. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Modifying a Training Job Configuration <modelarts_03_0060>` | Modify a training job configuration. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Training Job Configuration <modelarts_03_0061>` | Delete a training job configuration. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Details About a Training Job Configuration <modelarts_03_0062>` | Query the details about a specified training job configuration. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Visualization Job Management | :ref:`Creating a Visualization Job <modelarts_03_0064>` | Create a visualization job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a Visualization Job List <modelarts_03_0065>` | Query the visualization jobs that meet the search criteria. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Details About a Visualization Job <modelarts_03_0066>` | Query the details about a specified visualization job based on the job name. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Modifying the Description of a Visualization Job <modelarts_03_0067>` | Modify the description of a visualization job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Visualization Job <modelarts_03_0068>` | Delete a visualization job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Stopping a Visualization Job <modelarts_03_0069>` | Stop a visualization job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Restarting a Visualization Job <modelarts_03_0070>` | Restart a visualization job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Resource and Engine Specifications | :ref:`Querying Job Resource Specifications <modelarts_03_0072>` | Query the resource specifications of a specified job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Job Engine Specifications <modelarts_03_0073>` | Query the engine type and version of a specified job. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Job Statuses | :ref:`Job Statuses <modelarts_03_0074>` | View job statuses and status description. |
|
|
+--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
|
|
Model Management APIs
|
|
---------------------
|
|
|
|
.. table:: **Table 3** Model management APIs
|
|
|
|
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+===============================================================+=============================================================================================================+
|
|
| :ref:`Importing a Model <modelarts_03_0076>` | Import a model. |
|
|
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying a Model List <modelarts_03_0077>` | Query the models that meet the search criteria. |
|
|
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying the Details About a Model <modelarts_03_0078>` | Query details about a model based on the model ID. |
|
|
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Deleting a Model <modelarts_03_0079>` | Delete a specified model based on the model ID. All versions of the model can be deleted in cascading mode. |
|
|
+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
|
|
Service Management APIs
|
|
-----------------------
|
|
|
|
.. table:: **Table 4** Service management APIs
|
|
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+=================================================================================+==============================================================================================================================+
|
|
| :ref:`Deploying a Model as a Service <modelarts_03_0082>` | Deploy a model service. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying a Service List <modelarts_03_0083>` | Query model services. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying the Details About a Service <modelarts_03_0084>` | Query the details about a model service based on the service ID. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Updating Service Configurations <modelarts_03_0086>` | Update a model service. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying Service Monitoring Information <modelarts_03_0087>` | Query service monitoring information. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying Service Update Logs <modelarts_03_0088>` | Query the update logs of a real-time service. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying Service Event Logs <modelarts_03_0155>` | Query service event logs, including service operation records, key actions during deployment, and deployment failure causes. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Deleting a Service <modelarts_03_0089>` | Delete a model service. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying Supported Service Deployment Specifications <modelarts_03_0200>` | Query supported service deployment specifications. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Querying Dedicated Resource Pools <modelarts_03_0201>` | Query dedicated resource pools. |
|
|
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Authorization Management APIs
|
|
-----------------------------
|
|
|
|
.. table:: **Table 5** Workspace management APIs
|
|
|
|
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+============================================================+======================================================================================================================================================+
|
|
| :ref:`Viewing an Authorization List <getauthorizations>` | View an authorization list. |
|
|
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Configuring Authorization <createauthorization>` | Configure ModelArts authorization. ModelArts functions such as real-time services can be properly used only after required permissions are assigned. |
|
|
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Deleting Authorization <deleteauthorizations>` | Delete the authorization of a specified user or all users. |
|
|
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Creating a ModelArts Agency <createmodelartsagency>` | Create a ModelArts agency for dependent services such as OBS, SWR, and IEF. |
|
|
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|