forked from docs/modelarts
177 lines
35 KiB
ReStructuredText
177 lines
35 KiB
ReStructuredText
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 `Data Management APIs <data_management/data_management_apis.html#modelarts030299>`__.
|
|
|
|
Development Environment APIs
|
|
----------------------------
|
|
|
|
|
|
|
|
.. _modelarts030002enustopic0129435564table6223102719106:
|
|
|
|
.. table:: **Table 1** Development environment APIs
|
|
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+=======================================================================================================================================================================+============================================================================+
|
|
| `Creating a Development Environment Instance <devenviron/creating_a_development_environment_instance.html#modelarts030110>`__ | Create a development environment instance for code development. |
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| `Querying a List of Development Environment Instances <devenviron/querying_a_list_of_development_environment_instances.html#modelarts030111>`__ | Query the development environment instances that meet the search criteria. |
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| `Querying the Details About a Development Environment Instance <devenviron/querying_the_details_about_a_development_environment_instance.html#modelarts030112>`__ | Query the details about a development environment instance. |
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| `Modifying the Description of a Development Environment Instance <devenviron/modifying_the_description_of_a_development_environment_instance.html#modelarts030113>`__ | Modify the description of a development environment instance. |
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| `Deleting a Development Environment Instance <devenviron/deleting_a_development_environment_instance.html#modelarts030114>`__ | Delete a development environment instance. |
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
| `Managing a Development Environment Instance <devenviron/managing_a_development_environment_instance.html#modelarts030115>`__ | Start or stop a development environment instance. |
|
|
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
|
|
|
|
Training Management APIs
|
|
------------------------
|
|
|
|
|
|
|
|
.. _modelarts030002enustopic0129435564table19560011132619:
|
|
|
|
.. table:: **Table 2** Training management APIs
|
|
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Type | API | Description |
|
|
+======================================+=====================================================================================================================================================================================================+==============================================================================+
|
|
| Training Jobs | `Creating a Training Job <training_management/training_jobs/creating_a_training_job.html#modelarts030045>`__ | Create a training job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying a Training Job List <training_management/training_jobs/querying_a_training_job_list.html#modelarts030046>`__ | Query the created training jobs that meet the search criteria. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying the Details About a Training Job Version <training_management/training_jobs/querying_the_details_about_a_training_job_version.html#modelarts030047>`__ | Query the details about a specified training job based on the job ID. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Deleting a Version of a Training Job <training_management/training_jobs/deleting_a_version_of_a_training_job.html#modelarts030048>`__ | Delete a version of a training job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying a List of Training Job Versions <training_management/training_jobs/querying_a_list_of_training_job_versions.html#modelarts030049>`__ | Query the version of a specified training job based on the job ID. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Creating a Version of a Training Job <training_management/training_jobs/creating_a_version_of_a_training_job.html#modelarts030050>`__ | Create a version of a training job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Stopping a Training Job <training_management/training_jobs/stopping_a_training_job.html#modelarts030051>`__ | Stop a training job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Modifying the Description of a Training Job <training_management/training_jobs/modifying_the_description_of_a_training_job.html#modelarts030052>`__ | Modify the description of a training job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Deleting a Training Job <training_management/training_jobs/deleting_a_training_job.html#modelarts030053>`__ | Delete a training job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Obtaining the Name of a Training Job Log File <training_management/training_jobs/obtaining_the_name_of_a_training_job_log_file.html#modelarts030054>`__ | Obtain the name of a training job log file. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying a Built-in Algorithm <training_management/training_jobs/querying_a_built-in_algorithm.html#modelarts030056>`__ | Query the details about a built-in model. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying Training Job Logs <training_management/training_jobs/querying_training_job_logs.html#modelarts030149>`__ | Query detailed information about training job logs by row. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Training Job Parameter Configuration | `Creating a Training Job Configuration <training_management/training_job_parameter_configuration/creating_a_training_job_configuration.html#modelarts030058>`__ | Create a training job configuration. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying a List of Training Job Configurations <training_management/training_job_parameter_configuration/querying_a_list_of_training_job_configurations.html#modelarts030059>`__ | Query the created training job configurations that meet the search criteria. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Modifying a Training Job Configuration <training_management/training_job_parameter_configuration/modifying_a_training_job_configuration.html#modelarts030060>`__ | Modify a training job configuration. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Deleting a Training Job Configuration <training_management/training_job_parameter_configuration/deleting_a_training_job_configuration.html#modelarts030061>`__ | Delete a training job configuration. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying the Details About a Training Job Configuration <training_management/training_job_parameter_configuration/querying_the_details_about_a_training_job_configuration.html#modelarts030062>`__ | Query the details about a specified training job configuration. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Visualization Job Management | `Creating a Visualization Job <training_management/visualization_jobs/creating_a_visualization_job.html#modelarts030064>`__ | Create a visualization job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying a Visualization Job List <training_management/visualization_jobs/querying_a_visualization_job_list.html#modelarts030065>`__ | Query the visualization jobs that meet the search criteria. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying the Details About a Visualization Job <training_management/visualization_jobs/querying_the_details_about_a_visualization_job.html#modelarts030066>`__ | Query the details about a specified visualization job based on the job name. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Modifying the Description of a Visualization Job <training_management/visualization_jobs/modifying_the_description_of_a_visualization_job.html#modelarts030067>`__ | Modify the description of a visualization job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Deleting a Visualization Job <training_management/visualization_jobs/deleting_a_visualization_job.html#modelarts030068>`__ | Delete a visualization job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Stopping a Visualization Job <training_management/visualization_jobs/stopping_a_visualization_job.html#modelarts030069>`__ | Stop a visualization job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Restarting a Visualization Job <training_management/visualization_jobs/restarting_a_visualization_job.html#modelarts030070>`__ | Restart a visualization job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Resource and Engine Specifications | `Querying Job Resource Specifications <training_management/resource_and_engine_specifications/querying_job_resource_specifications.html#modelarts030072>`__ | Query the resource specifications of a specified job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| | `Querying Job Engine Specifications <training_management/resource_and_engine_specifications/querying_job_engine_specifications.html#modelarts030073>`__ | Query the engine type and version of a specified job. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
| Job Statuses | `Job Statuses <training_management/job_statuses.html#modelarts030074>`__ | View job statuses and status description. |
|
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
|
|
|
|
Model Management APIs
|
|
---------------------
|
|
|
|
|
|
|
|
.. _modelarts030002enustopic0129435564table172059163715:
|
|
|
|
.. table:: **Table 3** Model management APIs
|
|
|
|
+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+==========================================================================================================================+=============================================================================================================+
|
|
| `Importing a Model <model_management/models/importing_a_model.html#modelarts030076>`__ | Import a model. |
|
|
+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| `Querying a Model List <model_management/models/querying_a_model_list.html#modelarts030077>`__ | Query the models that meet the search criteria. |
|
|
+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| `Querying the Details About a Model <model_management/models/querying_the_details_about_a_model.html#modelarts030078>`__ | Query details about a model based on the model ID. |
|
|
+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| `Deleting a Model <model_management/models/deleting_a_model.html#modelarts030079>`__ | Delete a specified model based on the model ID. All versions of the model can be deleted in cascading mode. |
|
|
+--------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
|
|
Service Management APIs
|
|
-----------------------
|
|
|
|
|
|
|
|
.. _modelarts030002enustopic0129435564table17144179535:
|
|
|
|
.. table:: **Table 4** Service management APIs
|
|
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+=========================================================================================================================================================+==============================================================================================================================+
|
|
| `Deploying a Model as a Service <service_management/deploying_a_model_as_a_service.html#modelarts030082>`__ | Deploy a model service. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Querying a Service List <service_management/querying_a_service_list.html#modelarts030083>`__ | Query model services. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Querying the Details About a Service <service_management/querying_the_details_about_a_service.html#modelarts030084>`__ | Query the details about a model service based on the service ID. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Updating Service Configurations <service_management/updating_service_configurations.html#modelarts030086>`__ | Update a model service. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Querying Service Monitoring Information <service_management/querying_service_monitoring_information.html#modelarts030087>`__ | Query service monitoring information. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Querying Service Update Logs <service_management/querying_service_update_logs.html#modelarts030088>`__ | Query the update logs of a real-time service. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Querying Service Event Logs <service_management/querying_service_event_logs.html#modelarts030155>`__ | Query service event logs, including service operation records, key actions during deployment, and deployment failure causes. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Deleting a Service <service_management/deleting_a_service.html#modelarts030089>`__ | Delete a model service. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Querying Supported Service Deployment Specifications <service_management/querying_supported_service_deployment_specifications.html#modelarts030200>`__ | Query supported service deployment specifications. |
|
|
+---------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Authorization Management APIs
|
|
-----------------------------
|
|
|
|
|
|
|
|
.. _modelarts030002enustopic0129435564table19853112615335:
|
|
|
|
.. table:: **Table 5** Workspace management APIs
|
|
|
|
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| API | Description |
|
|
+=================================================================================================+=========================================================================================================================================================================================================================+
|
|
| `Viewing an Authorization List <authorization_management/viewing_an_authorization_list.html>`__ | View an authorization list. |
|
|
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Configuring Authorization <authorization_management/configuring_authorization.html>`__ | Configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned. |
|
|
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Deleting Authorization <authorization_management/deleting_authorization.html>`__ | Delete the authorization of a specified user or all users. |
|
|
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| `Creating a ModelArts Agency <authorization_management/creating_a_modelarts_agency.html>`__ | Create a ModelArts agency for dependent services such as OBS, SWR, and IEF. |
|
|
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|