[ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Before You Start", "uri":"modelarts_03_0139.html", "doc_type":"api", "p_code":"", "code":"1" }, { "desc":"ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy model", "product_code":"modelarts", "title":"Overview", "uri":"modelarts_03_0001.html", "doc_type":"api", "p_code":"1", "code":"2" }, { "desc":"ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.In addition, ModelA", "product_code":"modelarts", "title":"API Calling", "uri":"modelarts_03_0140.html", "doc_type":"api", "p_code":"1", "code":"3" }, { "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.If a", "product_code":"modelarts", "title":"Endpoints", "uri":"modelarts_03_0141.html", "doc_type":"api", "p_code":"1", "code":"4" }, { "desc":"AccountAn account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It", "product_code":"modelarts", "title":"Basic Concepts", "uri":"modelarts_03_0143.html", "doc_type":"api", "p_code":"1", "code":"5" }, { "desc":"All ModelArts APIs are proprietary.You can use these APIs to manage datasets, training jobs, models, and services.Data management APIs include the APIs for managing datas", "product_code":"modelarts", "title":"API Overview", "uri":"modelarts_03_0002.html", "doc_type":"api", "p_code":"", "code":"6" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Calling APIs", "uri":"modelarts_03_0144.html", "doc_type":"api", "p_code":"", "code":"7" }, { "desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ", "product_code":"modelarts", "title":"Making an API Request", "uri":"modelarts_03_0005.html", "doc_type":"api", "p_code":"7", "code":"8" }, { "desc":"Requests for calling an API can be authenticated using either of the following methods: AK/SK-based authentication: Requests are authenticated by encrypting the request b", "product_code":"modelarts", "title":"Authentication", "uri":"modelarts_03_0004.html", "doc_type":"api", "p_code":"7", "code":"9" }, { "desc":"After sending a request, you will receive a response, including the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t", "product_code":"modelarts", "title":"Response", "uri":"modelarts_03_0003.html", "doc_type":"api", "p_code":"7", "code":"10" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Data Management", "uri":"modelarts_03_0202.html", "doc_type":"api", "p_code":"", "code":"11" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Data Management APIs", "uri":"modelarts_03_0299.html", "doc_type":"api", "p_code":"11", "code":"12" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Dataset Management", "uri":"dataset_management.html", "doc_type":"api", "p_code":"11", "code":"13" }, { "desc":"This API is used to query the created datasets that meet the search criteria by page.GET /v2/{project_id}/datasetsNoneStatus code: 200Querying the Dataset ListStatus code", "product_code":"modelarts", "title":"Response body for querying the dataset list.", "uri":"ListDatasets.html", "doc_type":"api", "p_code":"13", "code":"14" }, { "desc":"This API is used to create a dataset.POST /v2/{project_id}/datasetsStatus code: 201Creating an Image Classification Dataset{\n \"workspace_id\" : \"0\",\n \"dataset_name\" : \"d", "product_code":"modelarts", "title":"Creating a Dataset", "uri":"CreateDataset.html", "doc_type":"api", "p_code":"13", "code":"15" }, { "desc":"This API is used to query details about a dataset.GET /v2/{project_id}/datasets/{dataset_id}NoneStatus code: 200Querying Details About a DatasetStatus code: 200OKSee Erro", "product_code":"modelarts", "title":"Querying Details About a Dataset", "uri":"DescDataset.html", "doc_type":"api", "p_code":"13", "code":"16" }, { "desc":"This API is used to modify basic information about a dataset, such as the dataset name, description, current version, and labels.PUT /v2/{project_id}/datasets/{dataset_id", "product_code":"modelarts", "title":"Modifying a Dataset", "uri":"UpdateDataset.html", "doc_type":"api", "p_code":"13", "code":"17" }, { "desc":"This API is used to delete a dataset without deleting the source data of the dataset.DELETE /v2/{project_id}/datasets/{dataset_id}NoneNoneDeleting a DatasetStatus code: 2", "product_code":"modelarts", "title":"Deleting a Dataset", "uri":"DeleteDataset.html", "doc_type":"api", "p_code":"13", "code":"18" }, { "desc":"This API is used to query dataset statistics.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/statsNoneStatus code: 200Querying Dataset StatisticsStatus code: ", "product_code":"modelarts", "title":"Querying Dataset Statistics", "uri":"ListStats.html", "doc_type":"api", "p_code":"13", "code":"19" }, { "desc":"This API is used to query the monitoring data of a dataset within a specified time range.GET /v2/{project_id}/datasets/{dataset_id}/metricsNoneStatus code: 200Querying th", "product_code":"modelarts", "title":"Querying the Monitoring Data of a Dataset", "uri":"GetDatasetMetrics.html", "doc_type":"api", "p_code":"13", "code":"20" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Dataset Version Management", "uri":"dataset_version_management.html", "doc_type":"api", "p_code":"11", "code":"21" }, { "desc":"This API is used to query the version list of a specific dataset.GET /v2/{project_id}/datasets/{dataset_id}/versionsNoneStatus code: 200Querying the Version List of a Spe", "product_code":"modelarts", "title":"Querying the Dataset Version List", "uri":"ListDatasetVersions.html", "doc_type":"api", "p_code":"21", "code":"22" }, { "desc":"This API is used to create a dataset labeling version.POST /v2/{project_id}/datasets/{dataset_id}/versionsStatus code: 201Creating a Dataset Labeling VersionStatus code: ", "product_code":"modelarts", "title":"Creating a Dataset Labeling Version", "uri":"CreateDatasetVersion.html", "doc_type":"api", "p_code":"21", "code":"23" }, { "desc":"This API is used to query the details about a dataset version.GET /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}NoneStatus code: 200Querying Details About a", "product_code":"modelarts", "title":"Querying Details About a Dataset Version", "uri":"DescribeDatasetVersion.html", "doc_type":"api", "p_code":"21", "code":"24" }, { "desc":"This API is used to delete a dataset labeling version.DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id}NoneNoneDeleting a Dataset Labeling VersionStatus", "product_code":"modelarts", "title":"Deleting a Dataset Labeling Version", "uri":"DeleteDatasetVersion.html", "doc_type":"api", "p_code":"21", "code":"25" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Sample Management", "uri":"sample_management.html", "doc_type":"api", "p_code":"11", "code":"26" }, { "desc":"This API is used to query the sample list by page.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samplesNoneStatus code: 200Querying the Sample List by PageS", "product_code":"modelarts", "title":"Querying the Sample List", "uri":"ListSamples.html", "doc_type":"api", "p_code":"26", "code":"27" }, { "desc":"This API is used to add samples in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samplesStatus code: 200Adding Samples in BatchesStatus code: 200OK", "product_code":"modelarts", "title":"Adding Samples in Batches", "uri":"UploadSamplesJson.html", "doc_type":"api", "p_code":"26", "code":"28" }, { "desc":"This API is used to delete samples in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/deleteStatus code: 200Deleting Samples in BatchesStatus", "product_code":"modelarts", "title":"Deleting Samples in Batches", "uri":"DeleteSamples.html", "doc_type":"api", "p_code":"26", "code":"29" }, { "desc":"Query details about a sample.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id}NoneStatus code: 200Querying Details About a SampleStatus code", "product_code":"modelarts", "title":"Querying Details About a Sample", "uri":"DescribeSample.html", "doc_type":"api", "p_code":"26", "code":"30" }, { "desc":"This API is used to obtain sample search condition.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/search-conditionNoneStatus code: 200Obtaining Sample Search", "product_code":"modelarts", "title":"Obtaining Sample Search Condition", "uri":"ListSearch.html", "doc_type":"api", "p_code":"26", "code":"31" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Label Management", "uri":"topic_300000012.html", "doc_type":"api", "p_code":"11", "code":"32" }, { "desc":"This API is used to query all labels of a dataset.GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsNoneStatus code: 200Querying All Labels of a DatasetSt", "product_code":"modelarts", "title":"Querying the Dataset Label List", "uri":"ListLabels.html", "doc_type":"api", "p_code":"32", "code":"33" }, { "desc":"This API is used to create a dataset label.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsStatus code: 200Creating a Dataset LabelStatus code: 200OKSe", "product_code":"modelarts", "title":"Creating a Dataset Label", "uri":"CreateLabels.html", "doc_type":"api", "p_code":"32", "code":"34" }, { "desc":"This API is used to modify labels in batches.PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labelsStatus code: 200Modifying Labels in BatchesStatus code: 200", "product_code":"modelarts", "title":"Modifying Labels in Batches", "uri":"UpdateLabels.html", "doc_type":"api", "p_code":"32", "code":"35" }, { "desc":"This API is used to delete labels in batches.POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/deleteStatus code: 200Deleting Labels in BatchesStatus co", "product_code":"modelarts", "title":"Deleting Labels in Batches", "uri":"DeleteLabels.html", "doc_type":"api", "p_code":"32", "code":"36" }, { "desc":"This API is used to update a label by label names.PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}Status code: 204Updating a Label by Label", "product_code":"modelarts", "title":"Updating a Label by Label Names", "uri":"UpdateLabel.html", "doc_type":"api", "p_code":"32", "code":"37" }, { "desc":"This API is used to delete a label and the files that only contain this label.DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}NoneStatus", "product_code":"modelarts", "title":"Deleting a Label and the Files that Only Contain the Label", "uri":"DeleteLabelAndSamples.html", "doc_type":"api", "p_code":"32", "code":"38" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Manual Labeling", "uri":"manual_annotation_management.html", "doc_type":"api", "p_code":"11", "code":"39" }, { "desc":"This API is used to update sample labels in batches, including adding, modifying, and deleting sample labels. If the parameter Labels of a sample in the request body is n", "product_code":"modelarts", "title":"Updating Sample Labels in Batches", "uri":"UpdateSamples.html", "doc_type":"api", "p_code":"39", "code":"40" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Data Import Task", "uri":"data_import.html", "doc_type":"api", "p_code":"11", "code":"41" }, { "desc":"This API is used to query the dataset import task list by page.GET /v2/{project_id}/datasets/{dataset_id}/import-tasksNoneStatus code: 200Obtaining the Dataset Import Tas", "product_code":"modelarts", "title":"Querying the Dataset Import Task List", "uri":"ListImportTasks.html", "doc_type":"api", "p_code":"41", "code":"42" }, { "desc":"This API is used to create a dataset import task to import samples and labels from the storage system to the dataset.POST /v2/{project_id}/datasets/{dataset_id}/import-ta", "product_code":"modelarts", "title":"Creating an Import Task", "uri":"ImportTask.html", "doc_type":"api", "p_code":"41", "code":"43" }, { "desc":"This API is used to query details about a dataset import task.GET /v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id}NoneStatus code: 200Querying Details About ", "product_code":"modelarts", "title":"Querying Details About a Dataset Import Task", "uri":"DescImportTask.html", "doc_type":"api", "p_code":"41", "code":"44" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Data Export Task", "uri":"data_export.html", "doc_type":"api", "p_code":"11", "code":"45" }, { "desc":"This API is used to query the dataset export task list by page.GET /v2/{project_id}/datasets/{dataset_id}/export-tasksNoneStatus code: 200Querying the Export Task List by", "product_code":"modelarts", "title":"Querying the Dataset Export Task List", "uri":"GetExportTasksStatusOfDataset.html", "doc_type":"api", "p_code":"45", "code":"46" }, { "desc":"This API is used to create a dataset export task to export a dataset to OBS or new datasets.POST /v2/{project_id}/datasets/{dataset_id}/export-tasksStatus code: 200Creati", "product_code":"modelarts", "title":"Creating a Dataset Export Task", "uri":"ExportTask.html", "doc_type":"api", "p_code":"45", "code":"47" }, { "desc":"This API is used to query the status of a dataset export task.GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id}NoneStatus code: 200Querying the Status of", "product_code":"modelarts", "title":"Querying the Status of a Dataset Export Task", "uri":"GetExportTaskStatusOfDataset.html", "doc_type":"api", "p_code":"45", "code":"48" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Data Synchronization Task", "uri":"data_sync.html", "doc_type":"api", "p_code":"11", "code":"49" }, { "desc":"This API is used to synchronize samples and labeling information from the input dataset path to the dataset.POST /v2/{project_id}/datasets/{dataset_id}/sync-dataNoneNoneS", "product_code":"modelarts", "title":"Synchronizing a Dataset", "uri":"SyncDataSource.html", "doc_type":"api", "p_code":"49", "code":"50" }, { "desc":"This API is used to query the status of a dataset synchronization task.GET /v2/{project_id}/datasets/{dataset_id}/sync-data/statusNoneStatus code: 200Obtaining the Status", "product_code":"modelarts", "title":"Querying the Status of a Dataset Synchronization Task", "uri":"SyncDataSourceState.html", "doc_type":"api", "p_code":"49", "code":"51" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"DevEnviron", "uri":"modelarts_03_0108.html", "doc_type":"api", "p_code":"", "code":"52" }, { "desc":"This API is used to create a development environment instance for code development.Calling this API is an asynchronous operation. The job status can be obtained by callin", "product_code":"modelarts", "title":"Creating a Development Environment Instance", "uri":"modelarts_03_0110.html", "doc_type":"api", "p_code":"52", "code":"53" }, { "desc":"This API is used to query the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={p", "product_code":"modelarts", "title":"Querying a List of Development Environment Instances", "uri":"modelarts_03_0111.html", "doc_type":"api", "p_code":"52", "code":"54" }, { "desc":"This API is used to query the details about a development environment instance.GET /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parame", "product_code":"modelarts", "title":"Querying Details About a Development Environment Instance", "uri":"modelarts_03_0112.html", "doc_type":"api", "p_code":"52", "code":"55" }, { "desc":"This API is used to modify the description of a development environment instance or information about the auto stop function.PUT /v1/{project_id}/demanager/instances/{ins", "product_code":"modelarts", "title":"Modifying the Description of a Development Environment Instance", "uri":"modelarts_03_0113.html", "doc_type":"api", "p_code":"52", "code":"56" }, { "desc":"This API is used to delete a development environment instance.DELETE /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameters.Parameter", "product_code":"modelarts", "title":"Deleting a Development Environment Instance", "uri":"modelarts_03_0114.html", "doc_type":"api", "p_code":"52", "code":"57" }, { "desc":"This API is used to startor stop a notebook instance.POST /v1/{project_id}/demanager/instances/{instance_id}/actionTable 1 describes the required parameters.ParametersPar", "product_code":"modelarts", "title":"Managing a Development Environment Instance", "uri":"modelarts_03_0115.html", "doc_type":"api", "p_code":"52", "code":"58" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Training Management", "uri":"modelarts_03_0043.html", "doc_type":"api", "p_code":"", "code":"59" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Training Jobs", "uri":"modelarts_03_0044.html", "doc_type":"api", "p_code":"59", "code":"60" }, { "desc":"This API is used to create a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Traini", "product_code":"modelarts", "title":"Creating a Training Job", "uri":"modelarts_03_0045.html", "doc_type":"api", "p_code":"60", "code":"61" }, { "desc":"This API is used to query the created training jobs that meet the search criteria.GET /v1/{project_id}/training-jobsTable 1 describes the required parameters.URI paramete", "product_code":"modelarts", "title":"Querying a Training Job List", "uri":"modelarts_03_0046.html", "doc_type":"api", "p_code":"60", "code":"62" }, { "desc":"This API is used to query the details about a specified training job based on the job ID.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}Table 1 describe", "product_code":"modelarts", "title":"Querying the Details About a Training Job Version", "uri":"modelarts_03_0047.html", "doc_type":"api", "p_code":"60", "code":"63" }, { "desc":"This API is used to delete a version of a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Quer", "product_code":"modelarts", "title":"Deleting a Version of a Training Job", "uri":"modelarts_03_0048.html", "doc_type":"api", "p_code":"60", "code":"64" }, { "desc":"This API is used to query the version of a specified training job based on the job ID.GET /v1/{project_id}/training-jobs/{job_id}/versionsTable 1 describes the required p", "product_code":"modelarts", "title":"Querying a List of Training Job Versions", "uri":"modelarts_03_0049.html", "doc_type":"api", "p_code":"60", "code":"65" }, { "desc":"This API is used to create a version of a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Quer", "product_code":"modelarts", "title":"Creating a Version of a Training Job", "uri":"modelarts_03_0050.html", "doc_type":"api", "p_code":"60", "code":"66" }, { "desc":"This API is used to stop a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Training", "product_code":"modelarts", "title":"Stopping a Training Job", "uri":"modelarts_03_0051.html", "doc_type":"api", "p_code":"60", "code":"67" }, { "desc":"This API is used to modify the description of a training job.PUT /v1/{project_id}/training-jobs/{job_id}Table 1 describes the required parameters.ParametersParameterManda", "product_code":"modelarts", "title":"Modifying the Description of a Training Job", "uri":"modelarts_03_0052.html", "doc_type":"api", "p_code":"60", "code":"68" }, { "desc":"This API is used to delete a training job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Traini", "product_code":"modelarts", "title":"Deleting a Training Job", "uri":"modelarts_03_0053.html", "doc_type":"api", "p_code":"60", "code":"69" }, { "desc":"This API is used to obtain the name of a training job log file.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/log/file-namesTable 1 describes the requi", "product_code":"modelarts", "title":"Obtaining the Name of a Training Job Log File", "uri":"modelarts_03_0054.html", "doc_type":"api", "p_code":"60", "code":"70" }, { "desc":"This API is used to query the details about a built-in model.GET /v1/{project_id}/built-in-algorithmsTable 1 describes the required parameters.ParametersParameterMandator", "product_code":"modelarts", "title":"Querying a Built-in Algorithm", "uri":"modelarts_03_0056.html", "doc_type":"api", "p_code":"60", "code":"71" }, { "desc":"This API is used to query detailed information about training job logs by row.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/aom-logTable 1 describes t", "product_code":"modelarts", "title":"Querying Training Job Logs", "uri":"modelarts_03_0149.html", "doc_type":"api", "p_code":"60", "code":"72" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Training Job Parameter Configuration", "uri":"modelarts_03_0057.html", "doc_type":"api", "p_code":"59", "code":"73" }, { "desc":"This API is used to create a training job configuration.POST /v1/{project_id}/training-job-configsTable 1 describes the required parameters.ParametersParameterMandatoryTy", "product_code":"modelarts", "title":"Creating a Training Job Configuration", "uri":"modelarts_03_0058.html", "doc_type":"api", "p_code":"73", "code":"74" }, { "desc":"This API is used to query the created training job configurations that meet the search criteria.GET /v1/{project_id}/training-job-configsTable 1 describes the required pa", "product_code":"modelarts", "title":"Querying a List of Training Job Configurations", "uri":"modelarts_03_0059.html", "doc_type":"api", "p_code":"73", "code":"75" }, { "desc":"This API is used to modify a training job configuration.PUT /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required parameters.ParametersParamet", "product_code":"modelarts", "title":"Modifying a Training Job Configuration", "uri":"modelarts_03_0060.html", "doc_type":"api", "p_code":"73", "code":"76" }, { "desc":"This API is used to delete a training job configuration.DELETE /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required parameters.Parameter desc", "product_code":"modelarts", "title":"Deleting a Training Job Configuration", "uri":"modelarts_03_0061.html", "doc_type":"api", "p_code":"73", "code":"77" }, { "desc":"This API is used to query the details about a specified training job configuration.GET /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required p", "product_code":"modelarts", "title":"Querying the Details About a Training Job Configuration", "uri":"modelarts_03_0062.html", "doc_type":"api", "p_code":"73", "code":"78" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Visualization Jobs", "uri":"modelarts_03_0063.html", "doc_type":"api", "p_code":"59", "code":"79" }, { "desc":"This API is used to create a visualization job.Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a V", "product_code":"modelarts", "title":"Creating a Visualization Job", "uri":"modelarts_03_0064.html", "doc_type":"api", "p_code":"79", "code":"80" }, { "desc":"This API is used to query the visualization jobs that meet the search criteria.GET /v1/{project_id}/visualization-jobsTable 1 describes the required parameters.Parameters", "product_code":"modelarts", "title":"Querying a Visualization Job List", "uri":"modelarts_03_0065.html", "doc_type":"api", "p_code":"79", "code":"81" }, { "desc":"This API is used to query the details about a specified visualization job based on the job name.GET /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the requ", "product_code":"modelarts", "title":"Querying the Details About a Visualization Job", "uri":"modelarts_03_0066.html", "doc_type":"api", "p_code":"79", "code":"82" }, { "desc":"This API is used to modify the description of a visualization job.PUT /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the required parameters.ParametersPara", "product_code":"modelarts", "title":"Modifying the Description of a Visualization Job", "uri":"modelarts_03_0067.html", "doc_type":"api", "p_code":"79", "code":"83" }, { "desc":"This API is used to delete a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a ", "product_code":"modelarts", "title":"Deleting a Visualization Job", "uri":"modelarts_03_0068.html", "doc_type":"api", "p_code":"79", "code":"84" }, { "desc":"This API is used to stop a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a Vi", "product_code":"modelarts", "title":"Stopping a Visualization Job", "uri":"modelarts_03_0069.html", "doc_type":"api", "p_code":"79", "code":"85" }, { "desc":"This API is used to restart a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in Querying a", "product_code":"modelarts", "title":"Restarting a Visualization Job", "uri":"modelarts_03_0070.html", "doc_type":"api", "p_code":"79", "code":"86" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Resource and Engine Specifications", "uri":"modelarts_03_0071.html", "doc_type":"api", "p_code":"59", "code":"87" }, { "desc":"This API is used to query the resource specifications of a specified job.You must specify the resource specifications when creating a training job or an inference job.GET", "product_code":"modelarts", "title":"Querying Job Resource Specifications", "uri":"modelarts_03_0072.html", "doc_type":"api", "p_code":"87", "code":"88" }, { "desc":"This API is used to query the engine type and version of a specified job.You must specify the engine specifications when creating a training job or an inference job.GET /", "product_code":"modelarts", "title":"Querying Job Engine Specifications", "uri":"modelarts_03_0073.html", "doc_type":"api", "p_code":"87", "code":"89" }, { "desc":"Table 1 describes the job statuses.", "product_code":"modelarts", "title":"Job Statuses", "uri":"modelarts_03_0074.html", "doc_type":"api", "p_code":"59", "code":"90" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Model Management", "uri":"modelarts_03_0075.html", "doc_type":"api", "p_code":"", "code":"91" }, { "desc":"You can use the API to import a model.Ensure that the execution code and model have been uploaded to OBS. By default, the models generated by a training job are stored in", "product_code":"modelarts", "title":"Importing a Model", "uri":"modelarts_03_0076.html", "doc_type":"api", "p_code":"91", "code":"92" }, { "desc":"This API is used to query the models that meet the search criteria.GET /v1/{project_id}/modelsTable 1 describes the required parameters.ParametersParameterMandatoryTypeDe", "product_code":"modelarts", "title":"Querying a Model List", "uri":"modelarts_03_0077.html", "doc_type":"api", "p_code":"91", "code":"93" }, { "desc":"This API is used to query details about a model based on the model ID.GET /v1/{project_id}/models/{model_id}Table 1 describes the required parameters.ParametersParameterM", "product_code":"modelarts", "title":"Querying the Details About a Model", "uri":"modelarts_03_0078.html", "doc_type":"api", "p_code":"91", "code":"94" }, { "desc":"This API is used to delete a model based on the model ID. When cascade is set to true, the model specified by the model ID and models of different versions with the same ", "product_code":"modelarts", "title":"Deleting a Model", "uri":"modelarts_03_0079.html", "doc_type":"api", "p_code":"91", "code":"95" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Service Management", "uri":"modelarts_03_0081.html", "doc_type":"api", "p_code":"", "code":"96" }, { "desc":"This API is used to deploy a model as a service.POST /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject", "product_code":"modelarts", "title":"Deploying a Model as a Service", "uri":"modelarts_03_0082.html", "doc_type":"api", "p_code":"96", "code":"97" }, { "desc":"This API is used to obtain model services.GET /v1/{project_id}/servicesTable 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionproject_idYesS", "product_code":"modelarts", "title":"Querying a Service List", "uri":"modelarts_03_0083.html", "doc_type":"api", "p_code":"96", "code":"98" }, { "desc":"This API is used to query the details about a model service based on the service ID.GET /v1/{project_id}/services/{service_id}Table 1 describes the required parameters.Pa", "product_code":"modelarts", "title":"Querying the Details About a Service", "uri":"modelarts_03_0084.html", "doc_type":"api", "p_code":"96", "code":"99" }, { "desc":"This API is used to update configurations of a model service. It can also be used to start or stop a service.PUT /v1/{project_id}/services/{service_id}Table 1 describes t", "product_code":"modelarts", "title":"Updating Service Configurations", "uri":"modelarts_03_0086.html", "doc_type":"api", "p_code":"96", "code":"100" }, { "desc":"This API is used to query service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorTable 1 describes the required parameters.ParametersParameterMa", "product_code":"modelarts", "title":"Querying Service Monitoring Information", "uri":"modelarts_03_0087.html", "doc_type":"api", "p_code":"96", "code":"101" }, { "desc":"This API is used to query the update logs of a real-time service.GET /v1/{project_id}/services/{service_id}/logsTable 1 describes the required parameters.ParametersParame", "product_code":"modelarts", "title":"Querying Service Update Logs", "uri":"modelarts_03_0088.html", "doc_type":"api", "p_code":"96", "code":"102" }, { "desc":"This API is used to query service event logs, including service operation records, key actions during deployment, and deployment failure causes.GET /v1/{project_id}/servi", "product_code":"modelarts", "title":"Querying Service Event Logs", "uri":"modelarts_03_0155.html", "doc_type":"api", "p_code":"96", "code":"103" }, { "desc":"This API is used to delete a model service. You can delete your own services only.Table 1 describes the required parameters.ParametersParameterMandatoryTypeDescriptionpro", "product_code":"modelarts", "title":"Deleting a Service", "uri":"modelarts_03_0089.html", "doc_type":"api", "p_code":"96", "code":"104" }, { "desc":"This API is used to query supported service deployment specifications.URIGET /v1/{project_id}/services/specificationsNoneSample requestGET https://endpoint/v1/{project", "product_code":"modelarts", "title":"Querying Supported Service Deployment Specifications", "uri":"modelarts_03_0200.html", "doc_type":"api", "p_code":"96", "code":"105" }, { "desc":"This API is used to query dedicated resource pools.GET /v1/{project_id}/clustersParametersParameterMandatoryTypeDescriptionproject_idYesStringProject ID. For details abou", "product_code":"modelarts", "title":"Querying Dedicated Resource Pools", "uri":"modelarts_03_0201.html", "doc_type":"api", "p_code":"96", "code":"106" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Authorization Management", "uri":"authorization.html", "doc_type":"api", "p_code":"", "code":"107" }, { "desc":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", "product_code":"modelarts", "title":"Configuring Authorization", "uri":"CreateAuthorization.html", "doc_type":"api", "p_code":"107", "code":"108" }, { "desc":"This API is used to view an authorization list.GET /v2/{project_id}/authorizationsNoneStatus code: 200View an authorization list.Status code: 200OKSee Error Codes.", "product_code":"modelarts", "title":"Viewing an Authorization List", "uri":"GetAuthorizations.html", "doc_type":"api", "p_code":"107", "code":"109" }, { "desc":"This API is used to delete the authorization of a specified user or all users.DELETE /v2/{project_id}/authorizationsNoneNoneDelete the authorization of a specified user.S", "product_code":"modelarts", "title":"Deleting Authorization", "uri":"DeleteAuthorizations.html", "doc_type":"api", "p_code":"107", "code":"110" }, { "desc":"This API is used to create a ModelArts agency for dependent services such as OBS, SWR, and IEF.POST /v2/{project_id}/agencyNoneCreate a ModelArts agency.Status code: 200O", "product_code":"modelarts", "title":"Creating a ModelArts Agency", "uri":"CreateModelArtsAgency.html", "doc_type":"api", "p_code":"107", "code":"111" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Application Cases", "uri":"modelarts_03_0400.html", "doc_type":"api", "p_code":"", "code":"112" }, { "desc":"This section describes how to train a model on ModelArts by calling a series of APIs.The process for creating a training job using the TensorFlow framework is as follows:", "product_code":"modelarts", "title":"Creating a Training Job Using the TensorFlow Framework", "uri":"modelarts_03_0401.html", "doc_type":"api", "p_code":"112", "code":"113" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Permissions Policies and Supported Actions", "uri":"modelarts_03_0138.html", "doc_type":"api", "p_code":"", "code":"114" }, { "desc":"This section describes fine-grained permissions management for your ModelArts. If your current account does not require individual IAM users, skip this section.By default", "product_code":"modelarts", "title":"Introduction", "uri":"modelarts_03_0146.html", "doc_type":"api", "p_code":"114", "code":"115" }, { "desc":"ExeML APIs are inaccessible to external systems. To use ExeML functions on the console and manage permissions, perform the operations described in the following table.", "product_code":"modelarts", "title":"ExeML Permissions", "uri":"modelarts_03_0234.html", "doc_type":"api", "p_code":"114", "code":"116" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Data Management Permissions", "uri":"modelarts_03_0161.html", "doc_type":"api", "p_code":"114", "code":"117" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"DevEnviron Permissions", "uri":"modelarts_03_0162.html", "doc_type":"api", "p_code":"114", "code":"118" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Training Job Permissions", "uri":"modelarts_03_0163.html", "doc_type":"api", "p_code":"114", "code":"119" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Model Management Permissions", "uri":"modelarts_03_0164.html", "doc_type":"api", "p_code":"114", "code":"120" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Service Management Permissions", "uri":"modelarts_03_0165.html", "doc_type":"api", "p_code":"114", "code":"121" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Common Parameters", "uri":"modelarts_03_0093.html", "doc_type":"api", "p_code":"", "code":"122" }, { "desc":"Table 1 describes the status codes.", "product_code":"modelarts", "title":"Status Code", "uri":"modelarts_03_0094.html", "doc_type":"api", "p_code":"122", "code":"123" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Error Codes", "uri":"modelarts_03_0095.html", "doc_type":"api", "p_code":"122", "code":"124" }, { "desc":"A project ID is required for some requests when an API is called. Therefore, obtain the project ID before calling the API. Use either of the following methods:Obtaining a", "product_code":"modelarts", "title":"Obtaining a Project ID", "uri":"modelarts_03_0147.html", "doc_type":"api", "p_code":"122", "code":"125" }, { "desc":"When you call APIs, certain requests require the account name and ID. To obtain an account name and ID, do as follows:Sign up and log in to the console.Hover the cursor o", "product_code":"modelarts", "title":"Obtaining an Account Name and ID", "uri":"modelarts_03_0148.html", "doc_type":"api", "p_code":"122", "code":"126" }, { "desc":"When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows:Log in to the management console after registration.Hover the", "product_code":"modelarts", "title":"Obtaining a Username and ID", "uri":"modelarts_03_0006.html", "doc_type":"api", "p_code":"122", "code":"127" }, { "desc":"A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API.To do so, perform the following", "product_code":"modelarts", "title":"Obtaining a Project Name", "uri":"modelarts_03_0247.html", "doc_type":"api", "p_code":"122", "code":"128" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"modelarts", "title":"Change History", "uri":"modelarts_03_0097.html", "doc_type":"api", "p_code":"", "code":"129" } ]