vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/CLASS.TXT.json
Wuwan, Qi f81ead2467 ModelArts API 24.3.0 20241128 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-11-29 09:04:54 +00:00

2252 lines
88 KiB
JSON
Raw Blame History

[
{
"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.",
"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. To obtain the regions and endpoints, contact the enterprise admin",
"product_code":"modelarts",
"title":"Endpoint",
"uri":"modelarts_03_0141.html",
"doc_type":"api",
"p_code":"1",
"code":"4"
},
{
"desc":"For more constraints, see API description.",
"product_code":"modelarts",
"title":"Constraints",
"uri":"modelarts_03_0142.html",
"doc_type":"api",
"p_code":"1",
"code":"5"
},
{
"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":"6"
},
{
"desc":"All ModelArts APIs are proprietary.You can use these APIs to manage development environments, training jobs, AI applications, and services.",
"product_code":"modelarts",
"title":"API Overview",
"uri":"modelarts_03_0002.html",
"doc_type":"api",
"p_code":"",
"code":"7"
},
{
"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":"8"
},
{
"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":"8",
"code":"9"
},
{
"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":"8",
"code":"10"
},
{
"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":"8",
"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":"Development Environment Management",
"uri":"notebook.html",
"doc_type":"api",
"p_code":"",
"code":"12"
},
{
"desc":"This API is used to create a notebook instance based on the specified flavor, AI engine image, and storage. You can access the instance through a web page or SSH client. ",
"product_code":"modelarts",
"title":"Creating a Notebook Instance",
"uri":"CreateNotebook.html",
"doc_type":"api",
"p_code":"12",
"code":"13"
},
{
"desc":"This API is used to query notebook instances based on specified search criteria.NoneGET /v1/{project_id}/notebooksNoneStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Querying Notebook Instances",
"uri":"ListNotebooks.html",
"doc_type":"api",
"p_code":"12",
"code":"14"
},
{
"desc":"This API is used to query details about a notebook instance, including its ID, name, flavor, image, status, and accessible URLs.NoneGET /v1/{project_id}/notebooks/{id}Non",
"product_code":"modelarts",
"title":"Querying Details of a Notebook Instance",
"uri":"ShowNotebook.html",
"doc_type":"api",
"p_code":"12",
"code":"15"
},
{
"desc":"This API is used to update a development environment instance, including the name, description, specifications, and image ID. This API can be used only when the notebook ",
"product_code":"modelarts",
"title":"Updating a Notebook Instance",
"uri":"UpdateNotebook.html",
"doc_type":"api",
"p_code":"12",
"code":"16"
},
{
"desc":"This API is used to delete the container and all storage resources of a notebook instance.NoneDELETE /v1/{project_id}/notebooks/{id}NoneStatus code: 200Status code: 200OK",
"product_code":"modelarts",
"title":"Deleting a Notebook Instance",
"uri":"DeleteNotebook.html",
"doc_type":"api",
"p_code":"12",
"code":"17"
},
{
"desc":"A running instance can be saved as a container image. In the saved image, the installed dependency package (pip package) is not lost. In the VS Code remote development sc",
"product_code":"modelarts",
"title":"Saving a Running Instance as a Container Image",
"uri":"CreateImage.html",
"doc_type":"api",
"p_code":"12",
"code":"18"
},
{
"desc":"Obtain the available flavors.NoneGET /v1/{project_id}/notebooks/flavorsNoneStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Obtaining the Available Flavors",
"uri":"ListFlavors.html",
"doc_type":"api",
"p_code":"12",
"code":"19"
},
{
"desc":"This API is used to query the flavors available for a notebook instance.NoneGET /v1/{project_id}/notebooks/{id}/flavorsNoneStatus code: 200Status code: 200OKSee Error Cod",
"product_code":"modelarts",
"title":"Querying Flavors Available for a Notebook Instance",
"uri":"ShowSwitchableFlavors.html",
"doc_type":"api",
"p_code":"12",
"code":"20"
},
{
"desc":"This API is used to query the available duration of a running notebook instance.NoneGET /v1/{project_id}/notebooks/{id}/leaseNoneStatus code: 200Status code: 200OKSee Err",
"product_code":"modelarts",
"title":"Querying the Available Duration of a Running Notebook Instance",
"uri":"ShowLease.html",
"doc_type":"api",
"p_code":"12",
"code":"21"
},
{
"desc":"This API is used to prolong a notebook instance.NonePATCH /v1/{project_id}/notebooks/{id}/leaseStatus code: 200Prolong the available duration of a running notebook instan",
"product_code":"modelarts",
"title":"Prolonging a Notebook Instance",
"uri":"RenewLease.html",
"doc_type":"api",
"p_code":"12",
"code":"22"
},
{
"desc":"This API is used to start a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/startStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Starting a Notebook Instance",
"uri":"StartNotebook.html",
"doc_type":"api",
"p_code":"12",
"code":"23"
},
{
"desc":"This API is used to stop a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/stopNoneStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Stopping a Notebook Instance",
"uri":"StopNotebook.html",
"doc_type":"api",
"p_code":"12",
"code":"24"
},
{
"desc":"This API is used to obtain the notebook instances with OBS storage mounted.NoneGET /v1/{project_id}/notebooks/{instance_id}/storageNoneStatus code: 200Status code: 200OKS",
"product_code":"modelarts",
"title":"Obtaining the Notebook Instances with OBS Storage Mounted",
"uri":"ListAttachableObSs.html",
"doc_type":"api",
"p_code":"12",
"code":"25"
},
{
"desc":"An OBS parallel file system can be mounted to a specified file directory of a running notebook instance. After the mounting, objects in the OBS parallel file system can b",
"product_code":"modelarts",
"title":"OBS Storage Mounting",
"uri":"AttachObs.html",
"doc_type":"api",
"p_code":"12",
"code":"26"
},
{
"desc":"This API is used to obtain details about a notebook instance with OBS storage mounted.NoneGET /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}NoneStatus code",
"product_code":"modelarts",
"title":"Obtaining Details About a Notebook Instance with OBS Storage Mounted",
"uri":"ShowAttachableObs.html",
"doc_type":"api",
"p_code":"12",
"code":"27"
},
{
"desc":"This API is used to unmount OBS storage from a notebook instance. After OBS storage is unmounted, OBS objects remain unchanged but cannot be operated in the notebook cont",
"product_code":"modelarts",
"title":"Unmounting OBS Storage from a Notebook Instance",
"uri":"CancelObs.html",
"doc_type":"api",
"p_code":"12",
"code":"28"
},
{
"desc":"This API is used to query all images by page based on specified conditions.NoneGET /v1/{project_id}/imagesNoneStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Querying Supported Images",
"uri":"ListImage.html",
"doc_type":"api",
"p_code":"12",
"code":"29"
},
{
"desc":"Register a custom image with ModelArts Image Management.NonePOST /v1/{project_id}/imagesStatus code: 200The following is an example of how to register a custom image whos",
"product_code":"modelarts",
"title":"Registering a Custom Image",
"uri":"RegisterImage.html",
"doc_type":"api",
"p_code":"12",
"code":"30"
},
{
"desc":"Obtain the overview of user image information. The image name is used as the aggregated information.NoneGET /v1/{project_id}/images/groupNoneStatus code: 200Status code: ",
"product_code":"modelarts",
"title":"Obtaining User Image Groups",
"uri":"ListImageGroup.html",
"doc_type":"api",
"p_code":"12",
"code":"31"
},
{
"desc":"Obtain the details of an image.NoneGET /v1/{project_id}/images/{id}NoneStatus code: 200Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Obtaining Details of an Image",
"uri":"ShowImage.html",
"doc_type":"api",
"p_code":"12",
"code":"32"
},
{
"desc":"Delete an image object. For a private image, you can also delete the image content from SWR using parameters.NoneDELETE /v1/{project_id}/images/{id}NoneStatus code: 200St",
"product_code":"modelarts",
"title":"Deleting an Image",
"uri":"DeleteImage.html",
"doc_type":"api",
"p_code":"12",
"code":"33"
},
{
"desc":"This API is used to obtain all development environment instances that meet the search criteria.No constraintsGET /v1/{project_id}/notebooks/allNoneStatus code: 200Status ",
"product_code":"modelarts",
"title":"Querying All Notebook Instances",
"uri":"ListAllNotebooks.html",
"doc_type":"api",
"p_code":"12",
"code":"34"
},
{
"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":"algorithms.html",
"doc_type":"api",
"p_code":"",
"code":"35"
},
{
"desc":"This API is used to create an algorithm.POST /v2/{project_id}/algorithmsStatus code: 201The following is an example of how to create an algorithm whose name is TestModelA",
"product_code":"modelarts",
"title":"Creating an Algorithm",
"uri":"CreateAlgorithm.html",
"doc_type":"api",
"p_code":"35",
"code":"36"
},
{
"desc":"This API is used to query the algorithm list.GET /v2/{project_id}/algorithmsNoneStatus code: 200The following shows how to query all algorithms in jobs whose names contai",
"product_code":"modelarts",
"title":"Querying the Algorithm List",
"uri":"ListAlgorithms.html",
"doc_type":"api",
"p_code":"35",
"code":"37"
},
{
"desc":"This API is used to query a specified algorithm based on the algorithm ID.GET /v2/{project_id}/algorithms/{algorithm_id}NoneStatus code: 200The following shows how to que",
"product_code":"modelarts",
"title":"Querying Algorithm Details",
"uri":"ShowAlgorithmByUuid.html",
"doc_type":"api",
"p_code":"35",
"code":"38"
},
{
"desc":"This API is used to modify an algorithm.PUT /v2/{project_id}/algorithms/{algorithm_id}Status code: 201The following shows how to modify the algorithm whose UUID is 2e5451",
"product_code":"modelarts",
"title":"Modifying an Algorithm",
"uri":"ChangeAlgorithm.html",
"doc_type":"api",
"p_code":"35",
"code":"39"
},
{
"desc":"This API is used to delete an algorithm.DELETE /v2/{project_id}/algorithms/{algorithm_id}NoneNoneThe following shows how to modify the algorithm whose UUID is 2e5451fe-91",
"product_code":"modelarts",
"title":"Deleting an Algorithm",
"uri":"DeleteAlgorithm.html",
"doc_type":"api",
"p_code":"35",
"code":"40"
},
{
"desc":"Obtain supported hyperparameter search algorithms.GET /v2/{project_id}/search-algorithmsNoneStatus code: 200The following shows how to query information about the search ",
"product_code":"modelarts",
"title":"Obtaining Supported Hyperparameter Search Algorithms",
"uri":"ShowSearchAlgorithms.html",
"doc_type":"api",
"p_code":"35",
"code":"41"
},
{
"desc":"This API is used to create a training job.POST /v2/{project_id}/training-jobsStatus code: 201Status code: 400The following is an example of how to create a training job w",
"product_code":"modelarts",
"title":"Creating a Training Job",
"uri":"CreateTrainingJob.html",
"doc_type":"api",
"p_code":"35",
"code":"42"
},
{
"desc":"This API is used to query the details about a training job.GET /v2/{project_id}/training-jobs/{training_job_id}NoneStatus code: 200The following shows how to query a trai",
"product_code":"modelarts",
"title":"Querying the Details About a Training Job",
"uri":"ShowTrainingJobDetails.html",
"doc_type":"api",
"p_code":"35",
"code":"43"
},
{
"desc":"This API is used to modify the description of a training job.PUT /v2/{project_id}/training-jobs/{training_job_id}NoneThe following shows how to modify a training job with",
"product_code":"modelarts",
"title":"Modifying the Description of a Training Job",
"uri":"ChangeTrainingJobDescription.html",
"doc_type":"api",
"p_code":"35",
"code":"44"
},
{
"desc":"This API is used to delete a training job.DELETE /v2/{project_id}/training-jobs/{training_job_id}NoneNoneThe following shows how to delete a training job whose UUID is 3f",
"product_code":"modelarts",
"title":"Deleting a Training Job",
"uri":"DeleteTrainingJob.html",
"doc_type":"api",
"p_code":"35",
"code":"45"
},
{
"desc":"This API is used to terminate a training job. Only jobs in the Creating, Waiting, or Running state can be terminated.POST /v2/{project_id}/training-jobs/{training_job_id}",
"product_code":"modelarts",
"title":"Terminating a Training Job",
"uri":"StopTrainingJob.html",
"doc_type":"api",
"p_code":"35",
"code":"46"
},
{
"desc":"This API is used to query the logs of a specified task in a given training job (preview).GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/logs/preview",
"product_code":"modelarts",
"title":"Querying the Logs of a Specified Task in a Given Training Job (Preview)",
"uri":"ShowTrainingJobLogsPreview.html",
"doc_type":"api",
"p_code":"35",
"code":"47"
},
{
"desc":"This API is used to obtain the logs of a specified task of a training job (temporary OBS link, which is valid for 5 minutes). You can view all logs or download the logs.G",
"product_code":"modelarts",
"title":"Querying the Logs of a Specified Task in a Training Job (OBS Link)",
"uri":"ShowObsUrlOfTrainingJobLogs.html",
"doc_type":"api",
"p_code":"35",
"code":"48"
},
{
"desc":"This API is used to query the running metrics of a specified task in a training job.GET /v2/{project_id}/training-jobs/{training_job_id}/metrics/{task_id}NoneStatus code:",
"product_code":"modelarts",
"title":"Querying the Running Metrics of a Specified Task in a Training Job",
"uri":"ShowTrainingJobMetrics.html",
"doc_type":"api",
"p_code":"35",
"code":"49"
},
{
"desc":"This API is used to query the the created training jobs that meet the search criteria.POST /v2/{project_id}/training-job-searchesStatus code: 200The following is an examp",
"product_code":"modelarts",
"title":"Querying a Training Job List",
"uri":"ListTrainingJobs.html",
"doc_type":"api",
"p_code":"35",
"code":"50"
},
{
"desc":"This API is used to query all trails using hyperparameter search.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trialsNoneStatus code: 200The following s",
"product_code":"modelarts",
"title":"Querying All Trials Using Hyperparameter Search",
"uri":"ShowAutoSearchTrials.html",
"doc_type":"api",
"p_code":"35",
"code":"51"
},
{
"desc":"This API is used to query information about a trial using hyperparameter search based on the trial_id.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-tria",
"product_code":"modelarts",
"title":"Querying Information About a Trial Using Hyperparameter Search",
"uri":"ShowAutoSearchPerTrial.html",
"doc_type":"api",
"p_code":"35",
"code":"52"
},
{
"desc":"This API is used to obtain the summary of hyperparameter sensitivity analysis results.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-analysisNo",
"product_code":"modelarts",
"title":"Obtaining the Hyperparameter Sensitivity Analysis Result",
"uri":"ShowAutoSearchParamsAnalysis.html",
"doc_type":"api",
"p_code":"35",
"code":"53"
},
{
"desc":"This API is used to obtain the path for storing a hyperparameter sensitivity analysis image.GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-parameter-anal",
"product_code":"modelarts",
"title":"Obtaining the Path for Storing a Hyperparameter Sensitivity Analysis Image",
"uri":"ShowAutoSearchParamAnalysisResultPath.html",
"doc_type":"api",
"p_code":"35",
"code":"54"
},
{
"desc":"This API is used to early stop a trial of an auto search job.POST /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trial-earlystop/{trial_id}NoneStatus code: 2",
"product_code":"modelarts",
"title":"Early Stopping a Trial of an Auto Search Job",
"uri":"ShowAutoSearchTrialEarlyStop.html",
"doc_type":"api",
"p_code":"35",
"code":"55"
},
{
"desc":"This API is used to obtain information about the YAML template of an auto search job.GET /v2/{project_id}/training-jobs/autosearch/yaml-templatesNoneStatus code: 200The f",
"product_code":"modelarts",
"title":"Obtaining Information About the YAML Template of an Auto Search Job",
"uri":"ShowAutoSearchYamlTemplatesInfo.html",
"doc_type":"api",
"p_code":"35",
"code":"56"
},
{
"desc":"This API is used to obtain the content of the YAML template of an auto search job.GET /v2/{project_id}/training-jobs/autosearch/yaml-templates/{algorithm_type}/{algorithm",
"product_code":"modelarts",
"title":"Obtaining the Content of the YAML Template of an Auto Search Job",
"uri":"ShowAutoSearchYamlTemplateContent.html",
"doc_type":"api",
"p_code":"35",
"code":"57"
},
{
"desc":"This API is used to obtain the public flavors supported by a training job.GET /v2/{project_id}/training-job-flavorsNoneStatus code: 200The following shows how to query th",
"product_code":"modelarts",
"title":"Obtaining the General Specifications Supported by a Training Job",
"uri":"ShowTrainingJobFlavors.html",
"doc_type":"api",
"p_code":"35",
"code":"58"
},
{
"desc":"This API is used to obtain the preset AI frameworks supported by a training job.GET /v2/{project_id}/training-job-enginesNoneStatus code: 200The following shows how to qu",
"product_code":"modelarts",
"title":"Obtaining the Preset AI Frameworks Supported by a Training Job",
"uri":"ShowTrainingJobEngines.html",
"doc_type":"api",
"p_code":"35",
"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":"AI Application Management",
"uri":"ai_management.html",
"doc_type":"api",
"p_code":"",
"code":"60"
},
{
"desc":"This API is used to obtain the AI engine and runtime of models.GET /v1/{project_id}/models/ai-engine-runtimesStatus code: 200Status code: 401Status code: 403Status code: ",
"product_code":"modelarts",
"title":"Obtaining the Model Runtime",
"uri":"ShowModelEngineAndRuntime.html",
"doc_type":"api",
"p_code":"60",
"code":"61"
},
{
"desc":"This API is used to query the AI application list based on different search parameters.GET /v1/{project_id}/modelsStatus code: 200Status code: 200ModelsSee Error Codes.",
"product_code":"modelarts",
"title":"Querying the AI Application List",
"uri":"ListModels.html",
"doc_type":"api",
"p_code":"60",
"code":"62"
},
{
"desc":"Import a meta model to create an AI application. The execution code and model must be uploaded to OBS first. By default, the model generated by a training job is stored i",
"product_code":"modelarts",
"title":"Creating an AI Application",
"uri":"CreateModel.html",
"doc_type":"api",
"p_code":"60",
"code":"63"
},
{
"desc":"This API is used to query details about an AI application based on the AI application ID.GET /v1/{project_id}/models/{model_id}Status code: 200Status code: 200Model detai",
"product_code":"modelarts",
"title":"Obtaining Details About an AI Application",
"uri":"ShowModel.html",
"doc_type":"api",
"p_code":"60",
"code":"64"
},
{
"desc":"This interface is used to delete an AI application based on the AI application ID. When cascade is set to true, the AI application specified by the AI application ID and ",
"product_code":"modelarts",
"title":"Deleting an AI application",
"uri":"DeleteModel.html",
"doc_type":"api",
"p_code":"60",
"code":"65"
},
{
"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":"service_management.html",
"doc_type":"api",
"p_code":"",
"code":"66"
},
{
"desc":"This API is used to obtain service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorStatus code: 200Status code: 200Monitoring informationSee Erro",
"product_code":"modelarts",
"title":"Obtaining Service Monitoring",
"uri":"ShowServiceMonitorInfo.html",
"doc_type":"api",
"p_code":"66",
"code":"67"
},
{
"desc":"This API is used to obtain model services.GET /v1/{project_id}/servicesStatus code: 200Status code: 200Service listSee Error Codes.",
"product_code":"modelarts",
"title":"Obtaining Services",
"uri":"ListServices.html",
"doc_type":"api",
"p_code":"66",
"code":"68"
},
{
"desc":"This API is used to deploy a model as a service.POST /v1/{project_id}/servicesStatus code: 200Sample request of creating a real-time servicePOST https://{endpoint}/v1/{pr",
"product_code":"modelarts",
"title":"Deploying Services",
"uri":"CreateService.html",
"doc_type":"api",
"p_code":"66",
"code":"69"
},
{
"desc":"This API is used to obtain supported service deployment specifications.GET /v1/{project_id}/services/specificationsStatus code: 200Status code: 200Service deployment flav",
"product_code":"modelarts",
"title":"Obtaining Supported Service Deployment Specifications",
"uri":"ShowServiceSpecifications.html",
"doc_type":"api",
"p_code":"66",
"code":"70"
},
{
"desc":"This API is used to obtain the details about a model service based on the service ID.GET /v1/{project_id}/services/{service_id}Status code: 200Status code: 200Service Det",
"product_code":"modelarts",
"title":"Obtaining Service Details",
"uri":"ShowService.html",
"doc_type":"api",
"p_code":"66",
"code":"71"
},
{
"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}NoneThe following s",
"product_code":"modelarts",
"title":"Updating Service Configurations",
"uri":"UpdateService.html",
"doc_type":"api",
"p_code":"66",
"code":"72"
},
{
"desc":"This API is used to delete a model service. You can delete your own services only.DELETE /v1/{project_id}/services/{service_id}NoneThe following shows how to delete the m",
"product_code":"modelarts",
"title":"Deleting a Service",
"uri":"DeleteService.html",
"doc_type":"api",
"p_code":"66",
"code":"73"
},
{
"desc":"This API is used to obtain service event logs, including service operation records, key actions during deployment, and deployment failure causes.GET /v1/{project_id}/serv",
"product_code":"modelarts",
"title":"Obtaining Service Event Logs",
"uri":"ShowServiceEvents.html",
"doc_type":"api",
"p_code":"66",
"code":"74"
},
{
"desc":"This API is used to obtain the update logs of a real-time service.GET /v1/{project_id}/services/{service_id}/logsStatus code: 200Status code: 200Service update logsSee Er",
"product_code":"modelarts",
"title":"Obtaining Service Update Logs",
"uri":"ShowServiceUpdateLogs.html",
"doc_type":"api",
"p_code":"66",
"code":"75"
},
{
"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 Management",
"uri":"resource_management1.html",
"doc_type":"api",
"p_code":"",
"code":"76"
},
{
"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":"Configuration Management",
"uri":"config_management.html",
"doc_type":"api",
"p_code":"76",
"code":"77"
},
{
"desc":"This API is used to obtain the configuration parameters of the ModelArts OS service, such as the CIDR block and user resource quota.GET /v1/{project_id}/os-user-configNon",
"product_code":"modelarts",
"title":"Querying OS Configuration Parameters",
"uri":"ShowOsConfig.html",
"doc_type":"api",
"p_code":"77",
"code":"78"
},
{
"desc":"This API is used to obtain the quotas of some ModelArts OS resources, such as the quotas for resource pools and networks.GET /v1/{project_id}/quotasNoneStatus code: 200St",
"product_code":"modelarts",
"title":"Obtaining OS Quotas",
"uri":"ShowOsQuota.html",
"doc_type":"api",
"p_code":"77",
"code":"79"
},
{
"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":"Event Management",
"uri":"event_management.html",
"doc_type":"api",
"p_code":"76",
"code":"80"
},
{
"desc":"This API is used to obtain the event list.GET /v1/{project_id}/eventsNoneStatus code: 200Status code: 400Status code: 404Querying events of resource pool pool-6f5da086876",
"product_code":"modelarts",
"title":"Obtaining the Event List",
"uri":"ListEvents.html",
"doc_type":"api",
"p_code":"80",
"code":"81"
},
{
"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 Pool Job Management",
"uri":"workload_management.html",
"doc_type":"api",
"p_code":"76",
"code":"82"
},
{
"desc":"This API is used to obtain jobs in a dedicated resource pool.GET /v2/{project_id}/pools/{pool_name}/workloadsNoneStatus code: 200Status code: 400Status code: 404NoneStatu",
"product_code":"modelarts",
"title":"Obtaining Jobs in a Dedicated Resource Pool",
"uri":"ListWorkloads.html",
"doc_type":"api",
"p_code":"82",
"code":"83"
},
{
"desc":"This API is used to obtain statistics about dedicated resource pool jobs.GET /v2/{project_id}/statistics/pools/{pool_name}/workloadsNoneStatus code: 200Status code: 400St",
"product_code":"modelarts",
"title":"Obtaining Statistics About Dedicated Resource Pool Jobs",
"uri":"ShowWorkloadStatistics.html",
"doc_type":"api",
"p_code":"82",
"code":"84"
},
{
"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 Metrics",
"uri":"metrics_management.html",
"doc_type":"api",
"p_code":"76",
"code":"85"
},
{
"desc":"This API is used to obtain the real-time usage of all resource pools in the current project.GET /v2/{project_id}/metrics/runtime/poolsNoneStatus code: 200NoneStatus code:",
"product_code":"modelarts",
"title":"Obtaining the Real-Time Resource Usage",
"uri":"ShowPoolRuntimeMetrics.html",
"doc_type":"api",
"p_code":"85",
"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":"Plug-in Template Management",
"uri":"plugintemplate_management.html",
"doc_type":"api",
"p_code":"76",
"code":"87"
},
{
"desc":"This API is used to obtain details of a specified plug-in template.GET /v1/{project_id}/plugintemplates/{plugintemplate_name}NoneStatus code: 200Status code: 404NoneStatu",
"product_code":"modelarts",
"title":"Querying a Plug-in Template",
"uri":"ShowPluginTemplate.html",
"doc_type":"api",
"p_code":"87",
"code":"88"
},
{
"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":"Tag Management",
"uri":"tags_management.html",
"doc_type":"api",
"p_code":"76",
"code":"89"
},
{
"desc":"This API is used to add tags to a specified resource pool. Tags can be added in batches. If a tag to be added has the same key as an existing tag, the tag will overwrite ",
"product_code":"modelarts",
"title":"Creating Resource Pool Tags in Batches",
"uri":"BatchCreatePoolTags.html",
"doc_type":"api",
"p_code":"89",
"code":"90"
},
{
"desc":"This API is used to delete tags of a specified resource. Batch deletion is supported.DELETE /v1/{project_id}/pools/{pool_name}/tags/deleteStatus code: 204Status code: 400",
"product_code":"modelarts",
"title":"Deleting Resource Pool Tags in Batches",
"uri":"BatchDeletePoolTags.html",
"doc_type":"api",
"p_code":"89",
"code":"91"
},
{
"desc":"This API is used to query all tags of a resource pool in the current project. By default, all workspaces are queried. Tag data is not returned for workspaces on which the",
"product_code":"modelarts",
"title":"Querying All Tags of Resource Pools",
"uri":"ListPoolTags.html",
"doc_type":"api",
"p_code":"89",
"code":"92"
},
{
"desc":"This API is used to query tags of a specified resource pool.GET /v1/{project_id}/pools/{pool_name}/tagsNoneStatus code: 204Status code: 400Status code: 401Status code: 40",
"product_code":"modelarts",
"title":"Querying Tags of a Resource Pool",
"uri":"ShowPoolTags.html",
"doc_type":"api",
"p_code":"89",
"code":"93"
},
{
"desc":"This API is used to query resources by tag. Multiple tags can be ANDed. Fuzzy search by resource name is supported.POST /v1/{project_id}/pools/resource-instances/filterSt",
"product_code":"modelarts",
"title":"Querying Resource Pools by Tag",
"uri":"ListPoolsByTags.html",
"doc_type":"api",
"p_code":"89",
"code":"94"
},
{
"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":"Network Management",
"uri":"network_management.html",
"doc_type":"api",
"p_code":"76",
"code":"95"
},
{
"desc":"This API is used to create network resources.POST /v1/{project_id}/networksStatus code: 200Status code: 400Create a network.Status code: 200OKStatus code: 400Bad request.",
"product_code":"modelarts",
"title":"Creating Network Resources",
"uri":"CreateNetwork.html",
"doc_type":"api",
"p_code":"95",
"code":"96"
},
{
"desc":"This API is used to obtain network resources.GET /v1/{project_id}/networksNoneStatus code: 200Obtain resource pools.Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Obtaining Network Resources",
"uri":"ListNetworks.html",
"doc_type":"api",
"p_code":"95",
"code":"97"
},
{
"desc":"This API is used to obtain details about a specified network resource.GET /v1/{project_id}/networks/{network_name}NoneStatus code: 200Status code: 404Obtain details about",
"product_code":"modelarts",
"title":"Obtaining a Network Resource",
"uri":"ShowNetwork.html",
"doc_type":"api",
"p_code":"95",
"code":"98"
},
{
"desc":"This API is used to delete a specified network resource.DELETE /v1/{project_id}/networks/{network_name}NoneStatus code: 200Status code: 404Delete a network.Status code: 2",
"product_code":"modelarts",
"title":"Deleting a Network Resource",
"uri":"DeleteNetwork.html",
"doc_type":"api",
"p_code":"95",
"code":"99"
},
{
"desc":"This API is used to update a specified network resource.PATCH /v1/{project_id}/networks/{network_name}Status code: 200Status code: 400Status code: 404Interconnect with a ",
"product_code":"modelarts",
"title":"Updating a Network Resource",
"uri":"PatchNetwork.html",
"doc_type":"api",
"p_code":"95",
"code":"100"
},
{
"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":"Node Management",
"uri":"nodes_management.html",
"doc_type":"api",
"p_code":"76",
"code":"101"
},
{
"desc":"This API is used to obtain nodes in a resource pool.GET /v2/{project_id}/pools/{pool_name}/nodesNoneStatus code: 200Status code: 404Obtain nodes in a resource pool.Status",
"product_code":"modelarts",
"title":"Obtaining Nodes",
"uri":"ListPoolNodes.html",
"doc_type":"api",
"p_code":"101",
"code":"102"
},
{
"desc":"This API is used to delete nodes from a specified resource pool in batches. At least one node must be reserved in the resource pool.POST /v2/{project_id}/pools/{pool_name",
"product_code":"modelarts",
"title":"Deleting Nodes in Batches",
"uri":"BatchDeletePoolNodes.html",
"doc_type":"api",
"p_code":"101",
"code":"103"
},
{
"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 Pool Management",
"uri":"pools_management.html",
"doc_type":"api",
"p_code":"76",
"code":"104"
},
{
"desc":"This API is used to create resource pools.POST /v2/{project_id}/poolsStatus code: 200Status code: 400Status code: 409Create a physical pool.POST https://{endpoint}/v2/{pr",
"product_code":"modelarts",
"title":"Creating Resource Pools",
"uri":"CreatePool.html",
"doc_type":"api",
"p_code":"104",
"code":"105"
},
{
"desc":"This API is used to obtain resource pools.GET /v2/{project_id}/poolsNoneStatus code: 200Obtain resource pools.Status code: 200OKSee Error Codes.",
"product_code":"modelarts",
"title":"Obtaining Resource Pools",
"uri":"ListPools.html",
"doc_type":"api",
"p_code":"104",
"code":"106"
},
{
"desc":"This API is used to obtain details about a specified resource pool.GET /v2/{project_id}/pools/{pool_name}NoneStatus code: 200Status code: 404Obtain details about a resour",
"product_code":"modelarts",
"title":"Obtaining a Resource Pool",
"uri":"ShowPool.html",
"doc_type":"api",
"p_code":"104",
"code":"107"
},
{
"desc":"This API is used to delete a specified resource pool.DELETE /v2/{project_id}/pools/{pool_name}Status code: 200Status code: 404Delete a resource pool.Status code: 200OKSta",
"product_code":"modelarts",
"title":"Deleting a Resource Pool",
"uri":"DeletePool.html",
"doc_type":"api",
"p_code":"104",
"code":"108"
},
{
"desc":"This API is used to update a specified resource pool.PATCH /v2/{project_id}/pools/{pool_name}Status code: 200Status code: 400Status code: 404Expand the capacity of a reso",
"product_code":"modelarts",
"title":"Updating a Resource Pool",
"uri":"PatchPool.html",
"doc_type":"api",
"p_code":"104",
"code":"109"
},
{
"desc":"This API is used to obtain the monitored resource pool information.GET /v2/{project_id}/pools/{pool_name}/monitorNoneStatus code: 200Status code: 404Obtain the monitored ",
"product_code":"modelarts",
"title":"Monitoring a Resource Pool",
"uri":"ShowPoolMonitor.html",
"doc_type":"api",
"p_code":"104",
"code":"110"
},
{
"desc":"This API is used to obtain resource pool statistics.GET /v2/{project_id}/statistics/poolsNoneStatus code: 200Status code: 500Obtaining the monitored information of a reso",
"product_code":"modelarts",
"title":"Obtaining Resource Pool Statistics",
"uri":"ShowPoolStatistics.html",
"doc_type":"api",
"p_code":"104",
"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":"Resource Specifications Management",
"uri":"resourceflavor_management.html",
"doc_type":"api",
"p_code":"76",
"code":"112"
},
{
"desc":"Obtain resource specifications.GET /v1/{project_id}/resourceflavorsNoneStatus code: 200Status code: 401Status code: 404This API is used to obtain resource specifications.",
"product_code":"modelarts",
"title":"Obtaining Resource Specifications",
"uri":"ListResourceFlavors.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":"Authorization Management",
"uri":"authorization.html",
"doc_type":"api",
"p_code":"",
"code":"114"
},
{
"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":"114",
"code":"115"
},
{
"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":"114",
"code":"116"
},
{
"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":"114",
"code":"117"
},
{
"desc":"This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF.POST /v2/{project_id}/agencyNoneThe following is an example",
"product_code":"modelarts",
"title":"Creating a ModelArts Agency",
"uri":"CreateModelArtsAgency.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":"Use Cases",
"uri":"modelarts_03_0400.html",
"doc_type":"api",
"p_code":"",
"code":"119"
},
{
"desc":"This section describes how to create a development environment instance by calling ModelArts APIs.The process for creating a development environment instance is as follow",
"product_code":"modelarts",
"title":"Creating a Development Environment Instance",
"uri":"modelarts_03_0406.html",
"doc_type":"api",
"p_code":"119",
"code":"120"
},
{
"desc":"This section describes how to train a model by calling ModelArts APIs.The process for creating a training job using PyTorch is as follows:, which will be added in a reque",
"product_code":"modelarts",
"title":"Using PyTorch to Create a Training Job (New-Version Training)",
"uri":"modelarts_03_0407.html",
"doc_type":"api",
"p_code":"119",
"code":"121"
},
{
"desc":"This section describes how to train a model by calling ModelArts APIs.The process of creating a training job using TensorFlow is as follows:Call the API for authenticatio",
"product_code":"modelarts",
"title":"Using TensorFlow to Create a Training Job (Old-Version Training)",
"uri":"modelarts_03_0401.html",
"doc_type":"api",
"p_code":"119",
"code":"122"
},
{
"desc":"This section describes how to manage agency authorization by calling ModelArts APIs.The process of managing ModelArts authorization is as follows:, which will be added in",
"product_code":"modelarts",
"title":"Managing ModelArts Authorization",
"uri":"modelarts_03_0405.html",
"doc_type":"api",
"p_code":"119",
"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":"Common Parameters",
"uri":"modelarts_03_0093.html",
"doc_type":"api",
"p_code":"",
"code":"124"
},
{
"desc":"Table 1 describes the status codes.",
"product_code":"modelarts",
"title":"Status Code",
"uri":"modelarts_03_0094.html",
"doc_type":"api",
"p_code":"124",
"code":"125"
},
{
"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":"124",
"code":"126"
},
{
"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. Use either of the following me",
"product_code":"modelarts",
"title":"Obtaining a Project ID and Name",
"uri":"modelarts_03_0147.html",
"doc_type":"api",
"p_code":"124",
"code":"127"
},
{
"desc":"When you call APIs, certain requests require the domain name and ID. To obtain a domain name and ID, do as follows:Log in to the ModelArts console.In the upper right corn",
"product_code":"modelarts",
"title":"Obtaining a Tenant Name and ID",
"uri":"modelarts_03_0148.html",
"doc_type":"api",
"p_code":"124",
"code":"128"
},
{
"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.In the up",
"product_code":"modelarts",
"title":"Obtaining a Username and ID",
"uri":"modelarts_03_0006.html",
"doc_type":"api",
"p_code":"124",
"code":"129"
},
{
"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":"Historical APIs",
"uri":"modelarts_03_0293.html",
"doc_type":"api",
"p_code":"",
"code":"130"
},
{
"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 (Old Version)",
"uri":"dataset_management.html",
"doc_type":"api",
"p_code":"130",
"code":"131"
},
{
"desc":"This API is used to query the created datasets that meet the search criteria by page.You can debug this API through automatic authentication in or use the SDK sample cod",
"product_code":"modelarts",
"title":"Querying the Dataset List",
"uri":"ListDatasets.html",
"doc_type":"api",
"p_code":"131",
"code":"132"
},
{
"desc":"This API is used to create a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{project_id",
"product_code":"modelarts",
"title":"Creating a Dataset",
"uri":"CreateDataset.html",
"doc_type":"api",
"p_code":"131",
"code":"133"
},
{
"desc":"This API is used to query details about a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2",
"product_code":"modelarts",
"title":"Querying Details About a Dataset",
"uri":"DescDataset.html",
"doc_type":"api",
"p_code":"131",
"code":"134"
},
{
"desc":"Modify basic information about a dataset, such as name, description, version, and labels.You can debug this API in which supports automatic authentication. API Explorer ",
"product_code":"modelarts",
"title":"Modifying a Dataset",
"uri":"UpdateDataset.html",
"doc_type":"api",
"p_code":"131",
"code":"135"
},
{
"desc":"This API is used to delete a dataset without deleting the source data of the dataset.You can debug this API through automatic authentication in or use the SDK sample cod",
"product_code":"modelarts",
"title":"Deleting a Dataset",
"uri":"DeleteDataset.html",
"doc_type":"api",
"p_code":"131",
"code":"136"
},
{
"desc":"Obtain dataset statistics.You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SD",
"product_code":"modelarts",
"title":"Obtaining Dataset Statistics",
"uri":"GetDatasetStats.html",
"doc_type":"api",
"p_code":"131",
"code":"137"
},
{
"desc":"This API is used to query the monitoring data of a dataset within a specified time range.You can debug this API through automatic authentication in or use the SDK sample",
"product_code":"modelarts",
"title":"Querying the Monitoring Data of a Dataset",
"uri":"GetDatasetMetrics.html",
"doc_type":"api",
"p_code":"131",
"code":"138"
},
{
"desc":"This API is used to query the version list of a specific dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API E",
"product_code":"modelarts",
"title":"Querying the Dataset Version List",
"uri":"ListDatasetVersions.html",
"doc_type":"api",
"p_code":"131",
"code":"139"
},
{
"desc":"This API is used to create a dataset labeling version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POS",
"product_code":"modelarts",
"title":"Creating a Dataset Labeling Version",
"uri":"CreateDatasetVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"140"
},
{
"desc":"This API is used to query the details about a dataset version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl",
"product_code":"modelarts",
"title":"Querying Details About a Dataset Version",
"uri":"DescribeDatasetVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"141"
},
{
"desc":"This API is used to delete a dataset labeling version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DEL",
"product_code":"modelarts",
"title":"Deleting a Dataset Labeling Version",
"uri":"DeleteDatasetVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"142"
},
{
"desc":"Obtain a sample list by page.You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the",
"product_code":"modelarts",
"title":"Obtaining a Sample List",
"uri":"ListSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"143"
},
{
"desc":"This API is used to add samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj",
"product_code":"modelarts",
"title":"Adding Samples in Batches",
"uri":"UploadSamplesJson.html",
"doc_type":"api",
"p_code":"131",
"code":"144"
},
{
"desc":"This API is used to delete samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{p",
"product_code":"modelarts",
"title":"Deleting Samples in Batches",
"uri":"DeleteSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"145"
},
{
"desc":"Obtain details about a sample.You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide th",
"product_code":"modelarts",
"title":"Obtaining Details About a Sample",
"uri":"DescribeSample.html",
"doc_type":"api",
"p_code":"131",
"code":"146"
},
{
"desc":"This API is used to obtain sample search condition.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v",
"product_code":"modelarts",
"title":"Obtaining Sample Search Condition",
"uri":"ListSearch.html",
"doc_type":"api",
"p_code":"131",
"code":"147"
},
{
"desc":"Obtain a sample list of a team labeling task by page.You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code ",
"product_code":"modelarts",
"title":"Obtaining a Sample List of a Team Labeling Task by Page",
"uri":"ListWorkforceTaskSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"148"
},
{
"desc":"Obtain samples labeled by a team. The API can be called only after an acceptance task is initiated.You can debug this API in which supports automatic authentication. API",
"product_code":"modelarts",
"title":"Obtaining Details About a Team Labeling Sample",
"uri":"DescribeWorkforceTaskSample.html",
"doc_type":"api",
"p_code":"131",
"code":"149"
},
{
"desc":"This API is used to query all labels of a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2",
"product_code":"modelarts",
"title":"Querying the Dataset Label List",
"uri":"ListLabels.html",
"doc_type":"api",
"p_code":"131",
"code":"150"
},
{
"desc":"This API is used to create a dataset label.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj",
"product_code":"modelarts",
"title":"Creating a Dataset Label",
"uri":"CreateLabels.html",
"doc_type":"api",
"p_code":"131",
"code":"151"
},
{
"desc":"This API is used to modify labels in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{pro",
"product_code":"modelarts",
"title":"Modifying Labels in Batches",
"uri":"UpdateLabels.html",
"doc_type":"api",
"p_code":"131",
"code":"152"
},
{
"desc":"This API is used to delete labels in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{pr",
"product_code":"modelarts",
"title":"Deleting Labels in Batches",
"uri":"DeleteLabels.html",
"doc_type":"api",
"p_code":"131",
"code":"153"
},
{
"desc":"This API is used to update a label by label names.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2",
"product_code":"modelarts",
"title":"Updating a Label by Label Names",
"uri":"UpdateLabel.html",
"doc_type":"api",
"p_code":"131",
"code":"154"
},
{
"desc":"This API is used to delete a label and the files that only contain this label.You can debug this API through automatic authentication in or use the SDK sample code gener",
"product_code":"modelarts",
"title":"Deleting a Label and the Files that Only Contain the Label",
"uri":"DeleteLabelAndSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"155"
},
{
"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":"131",
"code":"156"
},
{
"desc":"This API is used to query the team labeling task list of a dataset.You can debug this API through automatic authentication in or use the SDK sample code generated by API",
"product_code":"modelarts",
"title":"Querying the Team Labeling Task List of a Dataset",
"uri":"ListWorkforceTasks.html",
"doc_type":"api",
"p_code":"131",
"code":"157"
},
{
"desc":"This API is used to create a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/",
"product_code":"modelarts",
"title":"Creating a Team Labeling Task",
"uri":"CreateWorkforceTask.html",
"doc_type":"api",
"p_code":"131",
"code":"158"
},
{
"desc":"This API is used to query the details about a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API E",
"product_code":"modelarts",
"title":"Querying Details About a Team Labeling Task",
"uri":"DescWorkforceTask.html",
"doc_type":"api",
"p_code":"131",
"code":"159"
},
{
"desc":"This API is used to start a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{",
"product_code":"modelarts",
"title":"Starting a Team Labeling Task",
"uri":"StartWorkforceTask.html",
"doc_type":"api",
"p_code":"131",
"code":"160"
},
{
"desc":"This API is used to update a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{",
"product_code":"modelarts",
"title":"Updating a Team Labeling Task",
"uri":"UpdateWorkforceTask.html",
"doc_type":"api",
"p_code":"131",
"code":"161"
},
{
"desc":"This API is used to delete a team labeling task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v",
"product_code":"modelarts",
"title":"Deleting a Team Labeling Task",
"uri":"DeleteWorkforceTask.html",
"doc_type":"api",
"p_code":"131",
"code":"162"
},
{
"desc":"This API is used to create a team labeling acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explore",
"product_code":"modelarts",
"title":"Creating a Team Labeling Acceptance Task",
"uri":"StartWorkforceSamplingTask.html",
"doc_type":"api",
"p_code":"131",
"code":"163"
},
{
"desc":"This API is used to query the report of a team labeling acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated b",
"product_code":"modelarts",
"title":"Querying the Report of a Team Labeling Acceptance Task",
"uri":"GetWorkforceSamplingTask.html",
"doc_type":"api",
"p_code":"131",
"code":"164"
},
{
"desc":"Determine the acceptance scope for a team labeling task, including all labeled data, and update the sample data accordingly.You can debug this API in which supports auto",
"product_code":"modelarts",
"title":"Updating Status of a Team Labeling Acceptance Task",
"uri":"UpdateWorkforceSamplingTask.html",
"doc_type":"api",
"p_code":"131",
"code":"165"
},
{
"desc":"This API is used to query details about team labeling task statistics.You can debug this API through automatic authentication in or use the SDK sample code generated by ",
"product_code":"modelarts",
"title":"Querying Details About Team Labeling Task Statistics",
"uri":"ListWorkforceTaskStats.html",
"doc_type":"api",
"p_code":"131",
"code":"166"
},
{
"desc":"This API is used to query details about the progress of a team labeling task member.You can debug this API through automatic authentication in or use the SDK sample code",
"product_code":"modelarts",
"title":"Querying Details About the Progress of a Team Labeling Task Member",
"uri":"GetWorkforceTaskMetrics.html",
"doc_type":"api",
"p_code":"131",
"code":"167"
},
{
"desc":"This API is used to query the team labeling task list by a team member.You can debug this API through automatic authentication in or use the SDK sample code generated by",
"product_code":"modelarts",
"title":"Querying the Team Labeling Task List by a Team Member",
"uri":"ListWorkerTasks.html",
"doc_type":"api",
"p_code":"131",
"code":"168"
},
{
"desc":"This API is used to submit sample review comments of an acceptance task.You can debug this API through automatic authentication in or use the SDK sample code generated b",
"product_code":"modelarts",
"title":"Submitting Sample Review Comments of an Acceptance Task",
"uri":"AcceptSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"169"
},
{
"desc":"This API is used to review team labeling results.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2",
"product_code":"modelarts",
"title":"Reviewing Team Labeling Results",
"uri":"ReviewSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"170"
},
{
"desc":"This API is used to update labels of team labeling samples in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by ",
"product_code":"modelarts",
"title":"Updating Labels of Team Labeling Samples in Batches",
"uri":"UpdateWorkforceTaskSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"171"
},
{
"desc":"This API is used to query the labeling team list.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.GET /v2/",
"product_code":"modelarts",
"title":"Querying the Labeling Team List",
"uri":"ListWorkforces.html",
"doc_type":"api",
"p_code":"131",
"code":"172"
},
{
"desc":"This API is used to create a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v2/{proj",
"product_code":"modelarts",
"title":"Creating a Labeling Team",
"uri":"CreateWorkforce.html",
"doc_type":"api",
"p_code":"131",
"code":"173"
},
{
"desc":"This API is used to query the details about a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor",
"product_code":"modelarts",
"title":"Querying Details About a Labeling Team",
"uri":"DescWorkforce.html",
"doc_type":"api",
"p_code":"131",
"code":"174"
},
{
"desc":"This API is used to update a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2/{proje",
"product_code":"modelarts",
"title":"Updating a Labeling Team",
"uri":"UpdateWorkforce.html",
"doc_type":"api",
"p_code":"131",
"code":"175"
},
{
"desc":"This API is used to delete a labeling team.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE /v2/{pr",
"product_code":"modelarts",
"title":"Deleting a Labeling Team",
"uri":"DeleteWorkforce.html",
"doc_type":"api",
"p_code":"131",
"code":"176"
},
{
"desc":"This API is used to send an email to a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor",
"product_code":"modelarts",
"title":"Sending an Email to a Labeling Team Member",
"uri":"SendEmails.html",
"doc_type":"api",
"p_code":"131",
"code":"177"
},
{
"desc":"This API is used to query the list of all labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Ex",
"product_code":"modelarts",
"title":"Querying the List of All Labeling Team Members",
"uri":"ListAllWorkers.html",
"doc_type":"api",
"p_code":"131",
"code":"178"
},
{
"desc":"This API is used to query the list of labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor",
"product_code":"modelarts",
"title":"Querying the List of Labeling Team Members",
"uri":"ListWorkers.html",
"doc_type":"api",
"p_code":"131",
"code":"179"
},
{
"desc":"This API is used to create a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.POST /v",
"product_code":"modelarts",
"title":"Creating a Labeling Team Member",
"uri":"CreateWorker.html",
"doc_type":"api",
"p_code":"131",
"code":"180"
},
{
"desc":"This API is used to delete labeling team members in batches.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explor",
"product_code":"modelarts",
"title":"Deleting Labeling Team Members in Batches",
"uri":"BatchDeleteWorkers.html",
"doc_type":"api",
"p_code":"131",
"code":"181"
},
{
"desc":"This API is used to query details about labeling team members.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl",
"product_code":"modelarts",
"title":"Querying Details About Labeling Team Members",
"uri":"DescWorker.html",
"doc_type":"api",
"p_code":"131",
"code":"182"
},
{
"desc":"This API is used to update a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.PUT /v2",
"product_code":"modelarts",
"title":"Updating a Labeling Team Member",
"uri":"UpdateWorker.html",
"doc_type":"api",
"p_code":"131",
"code":"183"
},
{
"desc":"This API is used to delete a labeling team member.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.DELETE ",
"product_code":"modelarts",
"title":"Deleting a Labeling Team Member",
"uri":"DeleteWorker.html",
"doc_type":"api",
"p_code":"131",
"code":"184"
},
{
"desc":"This API is used to query the dataset import task list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp",
"product_code":"modelarts",
"title":"Querying the Dataset Import Task List",
"uri":"ListImportTasks.html",
"doc_type":"api",
"p_code":"131",
"code":"185"
},
{
"desc":"This API is used to create a dataset import task to import samples and labels from the storage system to the dataset.You can debug this API through automatic authenticati",
"product_code":"modelarts",
"title":"Creating an Import Task",
"uri":"ImportTask.html",
"doc_type":"api",
"p_code":"131",
"code":"186"
},
{
"desc":"This API is used to query details about a dataset import task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl",
"product_code":"modelarts",
"title":"Querying Details About a Dataset Import Task",
"uri":"DescImportTask.html",
"doc_type":"api",
"p_code":"131",
"code":"187"
},
{
"desc":"This API is used to query the dataset export task list by page.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp",
"product_code":"modelarts",
"title":"Querying the Dataset Export Task List",
"uri":"GetExportTasksStatusOfDataset.html",
"doc_type":"api",
"p_code":"131",
"code":"188"
},
{
"desc":"This API is used to create a dataset export task to export a dataset to OBS or new datasets.You can debug this API through automatic authentication in or use the SDK sam",
"product_code":"modelarts",
"title":"Creating a Dataset Export Task",
"uri":"ExportTask.html",
"doc_type":"api",
"p_code":"131",
"code":"189"
},
{
"desc":"This API is used to query the status of a dataset export task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Expl",
"product_code":"modelarts",
"title":"Querying the Status of a Dataset Export Task",
"uri":"GetExportTaskStatusOfDataset.html",
"doc_type":"api",
"p_code":"131",
"code":"190"
},
{
"desc":"Synchronize samples and labeling information from the input dataset path to the dataset. Text datasets do not support this operation.You can debug this API through automa",
"product_code":"modelarts",
"title":"Synchronizing a Dataset",
"uri":"SyncDataSource.html",
"doc_type":"api",
"p_code":"131",
"code":"191"
},
{
"desc":"This API is used to query the status of a dataset synchronization task.You can debug this API through automatic authentication in or use the SDK sample code generated by",
"product_code":"modelarts",
"title":"Querying the Status of a Dataset Synchronization Task",
"uri":"SyncDataSourceState.html",
"doc_type":"api",
"p_code":"131",
"code":"192"
},
{
"desc":"Obtain a list of auto labeling samples in a dataset.You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code e",
"product_code":"modelarts",
"title":"Obtaining an Auto Labeling Sample List",
"uri":"ListAutoAnnotationSamples.html",
"doc_type":"api",
"p_code":"131",
"code":"193"
},
{
"desc":"This API is used to query details about an auto labeling sample.You can debug this API through automatic authentication in or use the SDK sample code generated by API Ex",
"product_code":"modelarts",
"title":"Querying Details About an Auto Labeling Sample",
"uri":"DescribeAutoAnnotationSample.html",
"doc_type":"api",
"p_code":"131",
"code":"194"
},
{
"desc":"Obtain auto labeling tasks by page, including auto labeling and auto grouping tasks. You can specify type to obtain the list of a specific type of tasks.Auto labeling mea",
"product_code":"modelarts",
"title":"Obtaining an Auto Labeling Task List by Page",
"uri":"ListTasks.html",
"doc_type":"api",
"p_code":"131",
"code":"195"
},
{
"desc":"This interface is used to start an intelligent task. Two types of intelligent tasks are supported: intelligent labeling and automatic grouping. You can specify the task_t",
"product_code":"modelarts",
"title":"Starting Intelligent Tasks",
"uri":"CreateTask.html",
"doc_type":"api",
"p_code":"131",
"code":"196"
},
{
"desc":"Obtain details about an auto labeling task, including auto labeling and auto grouping tasks. You can specify the task_id parameter to obtain the details about a specific ",
"product_code":"modelarts",
"title":"Obtaining Details About an Auto Labeling Task",
"uri":"AutoAnnotationProgress.html",
"doc_type":"api",
"p_code":"131",
"code":"197"
},
{
"desc":"This interface is used to stop an intelligent task. Intelligent labeling and automatic grouping tasks can be stopped. You can specify the task_id parameter to stop a spec",
"product_code":"modelarts",
"title":"Stopping an Intelligent Task",
"uri":"StopAutoAnnotation.html",
"doc_type":"api",
"p_code":"131",
"code":"198"
},
{
"desc":"This API is used to obtain processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_type parameter to obtain a specific type",
"product_code":"modelarts",
"title":"Querying the List of a Processing Task",
"uri":"ListProcessorTasks.html",
"doc_type":"api",
"p_code":"131",
"code":"199"
},
{
"desc":"This API is used to create a processing task, including feature analysis tasks and data processing tasks. You can specify the id field of template composite parameter in ",
"product_code":"modelarts",
"title":"Creating a Processing Task",
"uri":"CreateProcessorTask.html",
"doc_type":"api",
"p_code":"131",
"code":"200"
},
{
"desc":"This API is used to query the algorithm type for data processing.You can debug this API through automatic authentication in or use the SDK sample code generated by API E",
"product_code":"modelarts",
"title":"Querying the Algorithm Type for Data Processing",
"uri":"GetProcessorTaskItems.html",
"doc_type":"api",
"p_code":"131",
"code":"201"
},
{
"desc":"This API is used to obtain details about processing tasks, including feature analysis tasks and data processing tasks. You can specify the task_id parameter to obtain the",
"product_code":"modelarts",
"title":"Querying Details About a Processing Task",
"uri":"DescribeProcessorTask.html",
"doc_type":"api",
"p_code":"131",
"code":"202"
},
{
"desc":"This API is used to update a processing task, including feature analysis tasks and data processing tasks. Only the description of tasks can be updated. You can specify th",
"product_code":"modelarts",
"title":"Updating a Processing Task",
"uri":"UpdateProcessorTask.html",
"doc_type":"api",
"p_code":"131",
"code":"203"
},
{
"desc":"This API is used to delete a processing task, including feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the task_id paramet",
"product_code":"modelarts",
"title":"Deleting a Processing Task",
"uri":"DeleteProcessorTask.html",
"doc_type":"api",
"p_code":"131",
"code":"204"
},
{
"desc":"This API is used to query the version list of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code generated by A",
"product_code":"modelarts",
"title":"Querying the Version List of a Data Processing Task",
"uri":"ListProcessorTaskVersions.html",
"doc_type":"api",
"p_code":"131",
"code":"205"
},
{
"desc":"This API is used to create a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer",
"product_code":"modelarts",
"title":"Creating a Data Processing Task Version",
"uri":"CreateProcessorTaskVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"206"
},
{
"desc":"This API is used to query the details about the version of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code g",
"product_code":"modelarts",
"title":"Querying the Details About the Version of a Data Processing Task",
"uri":"DescProcessorTaskVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"207"
},
{
"desc":"This API is used to delete a data processing task version.You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer",
"product_code":"modelarts",
"title":"Deleting a Data Processing Task Version",
"uri":"DeleteProcessorTaskVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"208"
},
{
"desc":"Obtain the result of a data processing task version.You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code e",
"product_code":"modelarts",
"title":"Obtaining the Result of a Data Processing Task Version",
"uri":"ListProcessorTaskVersionResults.html",
"doc_type":"api",
"p_code":"131",
"code":"209"
},
{
"desc":"This API is used to stop the version of a data processing task.You can debug this API through automatic authentication in or use the SDK sample code generated by API Exp",
"product_code":"modelarts",
"title":"Stopping the Version of a Data Processing Task",
"uri":"StopProcessorTaskVersion.html",
"doc_type":"api",
"p_code":"131",
"code":"210"
},
{
"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 (Old Version)",
"uri":"modelarts_03_0108.html",
"doc_type":"api",
"p_code":"130",
"code":"211"
},
{
"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":"211",
"code":"212"
},
{
"desc":"This API is used to obtain the development environment instances that meet the search criteria.GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={",
"product_code":"modelarts",
"title":"Obtaining Development Environment Instances",
"uri":"modelarts_03_0111.html",
"doc_type":"api",
"p_code":"211",
"code":"213"
},
{
"desc":"This API is used to obtain details about a development environment instance.GET /v1/{project_id}/demanager/instances/{instance_id}Table 1 describes the required parameter",
"product_code":"modelarts",
"title":"Obtaining Details About a Development Environment Instance",
"uri":"modelarts_03_0112.html",
"doc_type":"api",
"p_code":"211",
"code":"214"
},
{
"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":"211",
"code":"215"
},
{
"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":"211",
"code":"216"
},
{
"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":"211",
"code":"217"
},
{
"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 (Old Version)",
"uri":"modelarts_03_0043.html",
"doc_type":"api",
"p_code":"130",
"code":"218"
},
{
"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":"218",
"code":"219"
},
{
"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":"219",
"code":"220"
},
{
"desc":"This API is used to obtain the created training jobs that meet the search criteria.GET /v1/{project_id}/training-jobsTable 1 describes the required parameters.URI paramet",
"product_code":"modelarts",
"title":"Querying a Training Job List",
"uri":"modelarts_03_0046.html",
"doc_type":"api",
"p_code":"219",
"code":"221"
},
{
"desc":"This API is used to obtain 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 describ",
"product_code":"modelarts",
"title":"Querying the Details About a Training Job Version",
"uri":"modelarts_03_0047.html",
"doc_type":"api",
"p_code":"219",
"code":"222"
},
{
"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":"219",
"code":"223"
},
{
"desc":"This API is used to obtain 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 ",
"product_code":"modelarts",
"title":"Obtaining Training Job Versions",
"uri":"modelarts_03_0049.html",
"doc_type":"api",
"p_code":"219",
"code":"224"
},
{
"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":"219",
"code":"225"
},
{
"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":"219",
"code":"226"
},
{
"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":"219",
"code":"227"
},
{
"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":"219",
"code":"228"
},
{
"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":"219",
"code":"229"
},
{
"desc":"This API is used to obtain the details about a built-in model.GET /v1/{project_id}/built-in-algorithmsTable 1 describes the required parameters.ParametersParameterMandato",
"product_code":"modelarts",
"title":"Querying a Built-in Algorithm",
"uri":"modelarts_03_0056.html",
"doc_type":"api",
"p_code":"219",
"code":"230"
},
{
"desc":"This API is used to obtain detailed information about training job logs by row.GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/aom-logTable 1 describes ",
"product_code":"modelarts",
"title":"Querying Training Job Logs",
"uri":"modelarts_03_0149.html",
"doc_type":"api",
"p_code":"219",
"code":"231"
},
{
"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":"218",
"code":"232"
},
{
"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":"232",
"code":"233"
},
{
"desc":"This API is used to obtain the created training job configurations that meet the search criteria.GET /v1/{project_id}/training-job-configsTable 1 describes the required p",
"product_code":"modelarts",
"title":"Querying a List of Training Job Configurations",
"uri":"modelarts_03_0059.html",
"doc_type":"api",
"p_code":"232",
"code":"234"
},
{
"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":"232",
"code":"235"
},
{
"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.ParametersPara",
"product_code":"modelarts",
"title":"Deleting a Training Job Configuration",
"uri":"modelarts_03_0061.html",
"doc_type":"api",
"p_code":"232",
"code":"236"
},
{
"desc":"This API is used to obtain the details about a specified training job configuration.GET /v1/{project_id}/training-job-configs/{config_name}Table 1 describes the required ",
"product_code":"modelarts",
"title":"Querying the Details About a Training Job Configuration",
"uri":"modelarts_03_0062.html",
"doc_type":"api",
"p_code":"232",
"code":"237"
},
{
"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":"218",
"code":"238"
},
{
"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":"238",
"code":"239"
},
{
"desc":"This API is used to obtain the visualization jobs that meet the search criteria.GET /v1/{project_id}/visualization-jobsTable 1 describes the required parameters.Parameter",
"product_code":"modelarts",
"title":"Querying a Visualization Job List",
"uri":"modelarts_03_0065.html",
"doc_type":"api",
"p_code":"238",
"code":"240"
},
{
"desc":"This API is used to obtain the details about a specified visualization job based on the job name.GET /v1/{project_id}/visualization-jobs/{job_id}Table 1 describes the req",
"product_code":"modelarts",
"title":"Querying the Details About a Visualization Job",
"uri":"modelarts_03_0066.html",
"doc_type":"api",
"p_code":"238",
"code":"241"
},
{
"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":"238",
"code":"242"
},
{
"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":"238",
"code":"243"
},
{
"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":"238",
"code":"244"
},
{
"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":"238",
"code":"245"
},
{
"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":"218",
"code":"246"
},
{
"desc":"This API is used to obtain the resource specifications of a specified job.You must specify the resource specifications when creating a training job or an inference job.GE",
"product_code":"modelarts",
"title":"Querying Job Resource Specifications",
"uri":"modelarts_03_0072.html",
"doc_type":"api",
"p_code":"246",
"code":"247"
},
{
"desc":"This API is used to obtain 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":"246",
"code":"248"
},
{
"desc":"Table 1 describes the job statuses.",
"product_code":"modelarts",
"title":"Job Statuses",
"uri":"modelarts_03_0074.html",
"doc_type":"api",
"p_code":"218",
"code":"249"
},
{
"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":"250"
}
]
View Git Blame Copy Permalink