diff --git a/docs/modelarts/api-ref/ALL_META.TXT.json b/docs/modelarts/api-ref/ALL_META.TXT.json index 3aac759dd..095a2dcf2 100644 --- a/docs/modelarts/api-ref/ALL_META.TXT.json +++ b/docs/modelarts/api-ref/ALL_META.TXT.json @@ -4,7 +4,7 @@ }, { "uri":"modelarts_03_0139.html", - "node_id":"en-us_topic_0000002268768401.xml", + "node_id":"en-us_topic_0000002374896637.xml", "product_code":"modelarts", "code":"1", "des":"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.", @@ -23,7 +23,7 @@ }, { "uri":"modelarts_03_0001.html", - "node_id":"en-us_topic_0000002268768173.xml", + "node_id":"en-us_topic_0000002374856609.xml", "product_code":"modelarts", "code":"2", "des":"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", @@ -42,7 +42,7 @@ }, { "uri":"modelarts_03_0141.html", - "node_id":"en-us_topic_0000002268848205.xml", + "node_id":"en-us_topic_0000002374896737.xml", "product_code":"modelarts", "code":"3", "des":"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", @@ -61,7 +61,7 @@ }, { "uri":"modelarts_03_0142.html", - "node_id":"en-us_topic_0000002268848117.xml", + "node_id":"en-us_topic_0000002374896657.xml", "product_code":"modelarts", "code":"4", "des":"For more constraints, see API description.", @@ -80,7 +80,7 @@ }, { "uri":"modelarts_03_0143.html", - "node_id":"en-us_topic_0000002268848365.xml", + "node_id":"en-us_topic_0000002374856673.xml", "product_code":"modelarts", "code":"5", "des":"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", @@ -99,10 +99,10 @@ }, { "uri":"modelarts_03_0002.html", - "node_id":"en-us_topic_0000002268848097.xml", + "node_id":"en-us_topic_0000002341058546.xml", "product_code":"modelarts", "code":"6", - "des":"All ModelArts APIs are proprietary.You can use these APIs to manage development environments, training jobs, models, and services.", + "des":"All ModelArts APIs are proprietary.You can use these APIs to manage development environments, training jobs, AI applications, and services.", "doc_type":"api", "kw":"API Overview,API Reference", "search_title":"", @@ -118,7 +118,7 @@ }, { "uri":"modelarts_03_0144.html", - "node_id":"en-us_topic_0000002233928716.xml", + "node_id":"en-us_topic_0000002340898630.xml", "product_code":"modelarts", "code":"7", "des":"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.", @@ -136,7 +136,7 @@ }, { "uri":"modelarts_03_0005.html", - "node_id":"en-us_topic_0000002268768417.xml", + "node_id":"en-us_topic_0000002374896665.xml", "product_code":"modelarts", "code":"8", "des":"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 ", @@ -155,7 +155,7 @@ }, { "uri":"modelarts_03_0004.html", - "node_id":"en-us_topic_0000002233769032.xml", + "node_id":"en-us_topic_0000002340898762.xml", "product_code":"modelarts", "code":"9", "des":"You can use either of the authentication methods below to call APIs. AK/SK-based authentication is recommended because it is more secure than token-based authentication.T", @@ -174,7 +174,7 @@ }, { "uri":"modelarts_03_0003.html", - "node_id":"en-us_topic_0000002233928712.xml", + "node_id":"en-us_topic_0000002340898622.xml", "product_code":"modelarts", "code":"10", "des":"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", @@ -193,7 +193,7 @@ }, { "uri":"notebook.html", - "node_id":"en-us_topic_0000002268726205.xml", + "node_id":"en-us_topic_0000002341058366.xml", "product_code":"modelarts", "code":"11", "des":"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.", @@ -210,7 +210,7 @@ }, { "uri":"CreateNotebook.html", - "node_id":"en-us_topic_0000002268726213.xml", + "node_id":"en-us_topic_0000002341058378.xml", "product_code":"modelarts", "code":"12", "des":"You can create a notebook instance based on the specified instance specifications, AI engine images, and storage parameters. You can access the notebook instance through ", @@ -229,7 +229,7 @@ }, { "uri":"ListNotebooks.html", - "node_id":"en-us_topic_0000002233726926.xml", + "node_id":"en-us_topic_0000002374896573.xml", "product_code":"modelarts", "code":"13", "des":"This API is used to query the notebook instance list. You can query the notebook instance list that meets the search criteria as required.NoneGET /v1/{project_id}/noteboo", @@ -248,7 +248,7 @@ }, { "uri":"ListAllNotebooks.html", - "node_id":"en-us_topic_0000002233886838.xml", + "node_id":"en-us_topic_0000002374856557.xml", "product_code":"modelarts", "code":"14", "des":"This API is used to query the list of all notebook instances. You can query the list of notebook instances that meet the search criteria as required.No constraintsGET /v1", @@ -267,7 +267,7 @@ }, { "uri":"ShowNotebook.html", - "node_id":"en-us_topic_0000002233726938.xml", + "node_id":"en-us_topic_0000002374896597.xml", "product_code":"modelarts", "code":"15", "des":"This API is used to query details about a notebook instance, including the instance ID, name, specifications, image, instance status, and URL that can be opened.NoneGET /", @@ -286,7 +286,7 @@ }, { "uri":"UpdateNotebook.html", - "node_id":"en-us_topic_0000002233726946.xml", + "node_id":"en-us_topic_0000002374896605.xml", "product_code":"modelarts", "code":"16", "des":"This API is used to update a notebook instance, including the name, description, specifications, and image ID. This API can be used only when the notebook instance is sto", @@ -305,7 +305,7 @@ }, { "uri":"DeleteNotebook.html", - "node_id":"en-us_topic_0000002268806141.xml", + "node_id":"en-us_topic_0000002340898570.xml", "product_code":"modelarts", "code":"17", "des":"This API is used to delete a notebook instance. The resources to be deleted include the notebook container and all corresponding storage resources.NoneDELETE /v1/{project", @@ -324,7 +324,7 @@ }, { "uri":"CreateImage.html", - "node_id":"en-us_topic_0000002268806193.xml", + "node_id":"en-us_topic_0000002340898654.xml", "product_code":"modelarts", "code":"18", "des":"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", @@ -343,7 +343,7 @@ }, { "uri":"ListFlavors.html", - "node_id":"en-us_topic_0000002233886782.xml", + "node_id":"en-us_topic_0000002374856437.xml", "product_code":"modelarts", "code":"19", "des":"This API is used to query the list of valid specifications supported by a notebook instance.NoneGET /v1/{project_id}/notebooks/flavorsNoneStatus code: 200Status code: 200", @@ -362,7 +362,7 @@ }, { "uri":"ShowSwitchableFlavors.html", - "node_id":"en-us_topic_0000002233726934.xml", + "node_id":"en-us_topic_0000002374896589.xml", "product_code":"modelarts", "code":"20", "des":"This API is used to query the list of flavors that can be switched during notebook instance creation.NoneGET /v1/{project_id}/notebooks/{id}/flavorsNoneStatus code: 200St", @@ -381,7 +381,7 @@ }, { "uri":"ShowLease.html", - "node_id":"en-us_topic_0000002233726898.xml", + "node_id":"en-us_topic_0000002374896493.xml", "product_code":"modelarts", "code":"21", "des":"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", @@ -400,7 +400,7 @@ }, { "uri":"RenewLease.html", - "node_id":"en-us_topic_0000002268726197.xml", + "node_id":"en-us_topic_0000002341058350.xml", "product_code":"modelarts", "code":"22", "des":"This API is used to prolong the running time of a running notebook instance.NonePATCH /v1/{project_id}/notebooks/{id}/leaseStatus code: 200Prolong the duration of a runni", @@ -419,7 +419,7 @@ }, { "uri":"StartNotebook.html", - "node_id":"en-us_topic_0000002233726950.xml", + "node_id":"en-us_topic_0000002374896609.xml", "product_code":"modelarts", "code":"23", "des":"This API is used to start a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/startNoneStatus code: 200Status code: 200OKSee Error Codes.", @@ -438,7 +438,7 @@ }, { "uri":"StopNotebook.html", - "node_id":"en-us_topic_0000002233726930.xml", + "node_id":"en-us_topic_0000002374896581.xml", "product_code":"modelarts", "code":"24", "des":"This API is used to stop a notebook instance.NonePOST /v1/{project_id}/notebooks/{id}/stopNoneStatus code: 200Status code: 200OKSee Error Codes.", @@ -457,7 +457,7 @@ }, { "uri":"ListAttachableObSs.html", - "node_id":"en-us_topic_0000002233886758.xml", + "node_id":"en-us_topic_0000002374896533.xml", "product_code":"modelarts", "code":"25", "des":"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", @@ -476,7 +476,7 @@ }, { "uri":"AttachObs.html", - "node_id":"en-us_topic_0000002233886774.xml", + "node_id":"en-us_topic_0000002374856421.xml", "product_code":"modelarts", "code":"26", "des":"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", @@ -495,7 +495,7 @@ }, { "uri":"ShowAttachableObs.html", - "node_id":"en-us_topic_0000002268726221.xml", + "node_id":"en-us_topic_0000002341058386.xml", "product_code":"modelarts", "code":"27", "des":"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", @@ -514,7 +514,7 @@ }, { "uri":"CancelObs.html", - "node_id":"en-us_topic_0000002268726189.xml", + "node_id":"en-us_topic_0000002374856405.xml", "product_code":"modelarts", "code":"28", "des":"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", @@ -533,7 +533,7 @@ }, { "uri":"ListImage.html", - "node_id":"en-us_topic_0000002233726910.xml", + "node_id":"en-us_topic_0000002341058306.xml", "product_code":"modelarts", "code":"29", "des":"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.", @@ -552,7 +552,7 @@ }, { "uri":"RegisterImage.html", - "node_id":"en-us_topic_0000002233726914.xml", + "node_id":"en-us_topic_0000002340898538.xml", "product_code":"modelarts", "code":"30", "des":"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", @@ -571,7 +571,7 @@ }, { "uri":"ListImageGroup.html", - "node_id":"en-us_topic_0000002233886754.xml", + "node_id":"en-us_topic_0000002374896521.xml", "product_code":"modelarts", "code":"31", "des":"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: ", @@ -590,7 +590,7 @@ }, { "uri":"ShowImage.html", - "node_id":"en-us_topic_0000002268726181.xml", + "node_id":"en-us_topic_0000002340898530.xml", "product_code":"modelarts", "code":"32", "des":"Obtain the details of an image.NoneGET /v1/{project_id}/images/{id}NoneStatus code: 200Status code: 200OKSee Error Codes.", @@ -609,7 +609,7 @@ }, { "uri":"DeleteImage.html", - "node_id":"en-us_topic_0000002268806157.xml", + "node_id":"en-us_topic_0000002340898598.xml", "product_code":"modelarts", "code":"33", "des":"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", @@ -628,7 +628,7 @@ }, { "uri":"algorithms.html", - "node_id":"en-us_topic_0000002268806117.xml", + "node_id":"en-us_topic_0000002374856381.xml", "product_code":"modelarts", "code":"34", "des":"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.", @@ -645,7 +645,7 @@ }, { "uri":"CreateAlgorithm.html", - "node_id":"en-us_topic_0000002268726177.xml", + "node_id":"en-us_topic_0000002340898522.xml", "product_code":"modelarts", "code":"35", "des":"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", @@ -664,7 +664,7 @@ }, { "uri":"ListAlgorithms.html", - "node_id":"en-us_topic_0000002233886762.xml", + "node_id":"en-us_topic_0000002341058318.xml", "product_code":"modelarts", "code":"36", "des":"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", @@ -683,7 +683,7 @@ }, { "uri":"ShowAlgorithmByUuid.html", - "node_id":"en-us_topic_0000002233886802.xml", + "node_id":"en-us_topic_0000002374856465.xml", "product_code":"modelarts", "code":"37", "des":"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", @@ -702,7 +702,7 @@ }, { "uri":"ChangeAlgorithm.html", - "node_id":"en-us_topic_0000002233886746.xml", + "node_id":"en-us_topic_0000002374856345.xml", "product_code":"modelarts", "code":"38", "des":"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", @@ -721,7 +721,7 @@ }, { "uri":"DeleteAlgorithm.html", - "node_id":"en-us_topic_0000002233886750.xml", + "node_id":"en-us_topic_0000002374896505.xml", "product_code":"modelarts", "code":"39", "des":"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", @@ -740,7 +740,7 @@ }, { "uri":"ShowSearchAlgorithms.html", - "node_id":"en-us_topic_0000002268726173.xml", + "node_id":"en-us_topic_0000002340898510.xml", "product_code":"modelarts", "code":"40", "des":"Obtain supported hyperparameter search algorithms.GET /v2/{project_id}/search-algorithmsNoneStatus code: 200The following shows how to query information about the search ", @@ -759,7 +759,7 @@ }, { "uri":"CreateTrainingJob.html", - "node_id":"en-us_topic_0000002233886778.xml", + "node_id":"en-us_topic_0000002374856429.xml", "product_code":"modelarts", "code":"41", "des":"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", @@ -778,7 +778,7 @@ }, { "uri":"ShowTrainingJobDetails.html", - "node_id":"en-us_topic_0000002233886842.xml", + "node_id":"en-us_topic_0000002341058454.xml", "product_code":"modelarts", "code":"42", "des":"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", @@ -797,7 +797,7 @@ }, { "uri":"ChangeTrainingJobDescription.html", - "node_id":"en-us_topic_0000002233726922.xml", + "node_id":"en-us_topic_0000002374856413.xml", "product_code":"modelarts", "code":"43", "des":"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", @@ -816,7 +816,7 @@ }, { "uri":"DeleteTrainingJob.html", - "node_id":"en-us_topic_0000002268726165.xml", + "node_id":"en-us_topic_0000002341058266.xml", "product_code":"modelarts", "code":"44", "des":"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", @@ -835,7 +835,7 @@ }, { "uri":"StopTrainingJob.html", - "node_id":"en-us_topic_0000002268726201.xml", + "node_id":"en-us_topic_0000002341058358.xml", "product_code":"modelarts", "code":"45", "des":"This API is used to terminate a training job. Only jobs in the creating, awaiting, or running state can be terminated.POST /v2/{project_id}/training-jobs/{training_job_id", @@ -854,7 +854,7 @@ }, { "uri":"ShowTrainingJobLogsPreview.html", - "node_id":"en-us_topic_0000002233886850.xml", + "node_id":"en-us_topic_0000002341058466.xml", "product_code":"modelarts", "code":"46", "des":"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", @@ -873,7 +873,7 @@ }, { "uri":"ShowObsUrlOfTrainingJobLogs.html", - "node_id":"en-us_topic_0000002268806137.xml", + "node_id":"en-us_topic_0000002340898562.xml", "product_code":"modelarts", "code":"47", "des":"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", @@ -892,7 +892,7 @@ }, { "uri":"ShowTrainingJobMetrics.html", - "node_id":"en-us_topic_0000002268806213.xml", + "node_id":"en-us_topic_0000002374896693.xml", "product_code":"modelarts", "code":"48", "des":"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:", @@ -911,7 +911,7 @@ }, { "uri":"ListTrainingJobs.html", - "node_id":"en-us_topic_0000002268726209.xml", + "node_id":"en-us_topic_0000002341058374.xml", "product_code":"modelarts", "code":"49", "des":"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", @@ -930,7 +930,7 @@ }, { "uri":"ShowAutoSearchTrials.html", - "node_id":"en-us_topic_0000002268726273.xml", + "node_id":"en-us_topic_0000002374856541.xml", "product_code":"modelarts", "code":"50", "des":"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", @@ -949,7 +949,7 @@ }, { "uri":"ShowAutoSearchPerTrial.html", - "node_id":"en-us_topic_0000002268726265.xml", + "node_id":"en-us_topic_0000002341058482.xml", "product_code":"modelarts", "code":"51", "des":"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", @@ -968,7 +968,7 @@ }, { "uri":"ShowAutoSearchParamsAnalysis.html", - "node_id":"en-us_topic_0000002233727006.xml", + "node_id":"en-us_topic_0000002340898694.xml", "product_code":"modelarts", "code":"52", "des":"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", @@ -987,7 +987,7 @@ }, { "uri":"ShowAutoSearchParamAnalysisResultPath.html", - "node_id":"en-us_topic_0000002268806185.xml", + "node_id":"en-us_topic_0000002340898642.xml", "product_code":"modelarts", "code":"53", "des":"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", @@ -1006,7 +1006,7 @@ }, { "uri":"ShowAutoSearchTrialEarlyStop.html", - "node_id":"en-us_topic_0000002268726253.xml", + "node_id":"en-us_topic_0000002341058430.xml", "product_code":"modelarts", "code":"54", "des":"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", @@ -1025,7 +1025,7 @@ }, { "uri":"ShowAutoSearchYamlTemplatesInfo.html", - "node_id":"en-us_topic_0000002233886834.xml", + "node_id":"en-us_topic_0000002374856521.xml", "product_code":"modelarts", "code":"55", "des":"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", @@ -1044,7 +1044,7 @@ }, { "uri":"ShowAutoSearchYamlTemplateContent.html", - "node_id":"en-us_topic_0000002268726269.xml", + "node_id":"en-us_topic_0000002374856533.xml", "product_code":"modelarts", "code":"56", "des":"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", @@ -1063,7 +1063,7 @@ }, { "uri":"ListTrainingJobEvents.html", - "node_id":"en-us_topic_0000002233726978.xml", + "node_id":"en-us_topic_0000002374896653.xml", "product_code":"modelarts", "code":"57", "des":"This API is used to obtain the events of a training job.GET /v2/{project_id}/training-jobs/{training_job_id}/eventsStatus code: 200Status code: 400Status code: 200okStatu", @@ -1082,7 +1082,7 @@ }, { "uri":"ShowTrainingJobFlavors.html", - "node_id":"en-us_topic_0000002268726257.xml", + "node_id":"en-us_topic_0000002341058438.xml", "product_code":"modelarts", "code":"58", "des":"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", @@ -1101,7 +1101,7 @@ }, { "uri":"ShowTrainingJobEngines.html", - "node_id":"en-us_topic_0000002233726986.xml", + "node_id":"en-us_topic_0000002341058446.xml", "product_code":"modelarts", "code":"59", "des":"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", @@ -1120,29 +1120,29 @@ }, { "uri":"ai_management.html", - "node_id":"en-us_topic_0000002233886830.xml", + "node_id":"en-us_topic_0000002374856513.xml", "product_code":"modelarts", "code":"60", "des":"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.", "doc_type":"api", - "kw":"Model Management", + "kw":"AI Application Management", "search_title":"", "metedata":[ { "documenttype":"api" } ], - "title":"Model Management", + "title":"AI Application Management", "githuburl":"" }, { "uri":"ShowModelEngineAndRuntime.html", - "node_id":"en-us_topic_0000002268806169.xml", + "node_id":"en-us_topic_0000002340898614.xml", "product_code":"modelarts", "code":"61", "des":"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: ", "doc_type":"api", - "kw":"Obtaining the Model Runtime,Model Management,API Reference", + "kw":"Obtaining the Model Runtime,AI Application Management,API Reference", "search_title":"", "metedata":[ { @@ -1156,12 +1156,12 @@ }, { "uri":"ListModels.html", - "node_id":"en-us_topic_0000002268726185.xml", + "node_id":"en-us_topic_0000002374856397.xml", "product_code":"modelarts", "code":"62", - "des":"This API is used to query the model list based on different search parameters.GET /v1/{project_id}/modelsStatus code: 200Status code: 200ModelsSee Error Codes.", + "des":"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.", "doc_type":"api", - "kw":"Querying the Model List,Model Management,API Reference", + "kw":"Querying the AI Application List,AI Application Management,API Reference", "search_title":"", "metedata":[ { @@ -1170,36 +1170,17 @@ "operation_id":"ListModels" } ], - "title":"Querying the Model List", - "githuburl":"" - }, - { - "uri":"CreateModel.html", - "node_id":"en-us_topic_0000002268726281.xml", - "product_code":"modelarts", - "code":"63", - "des":"Import a meta model to create a model.The execution code and model must be uploaded to OBS first. By default, the model generated by a training job is stored in OBS.The b", - "doc_type":"api", - "kw":"Creating a model,Model Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"CreateModel" - } - ], - "title":"Creating a model", + "title":"Querying the AI Application List", "githuburl":"" }, { "uri":"ShowModel.html", - "node_id":"en-us_topic_0000002268806197.xml", + "node_id":"en-us_topic_0000002340898662.xml", "product_code":"modelarts", - "code":"64", - "des":"This API is used to query details about a model based on the model ID.GET /v1/{project_id}/models/{model_id}Status code: 200Status code: 200Model detailsSee Error Codes.", + "code":"63", + "des":"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", "doc_type":"api", - "kw":"Obtaining Details About a model,Model Management,API Reference", + "kw":"Obtaining Details About an AI Application,AI Application Management,API Reference", "search_title":"", "metedata":[ { @@ -1208,17 +1189,17 @@ "operation_id":"ShowModel" } ], - "title":"Obtaining Details About a model", + "title":"Obtaining Details About an AI Application", "githuburl":"" }, { "uri":"DeleteModel.html", - "node_id":"en-us_topic_0000002233726958.xml", + "node_id":"en-us_topic_0000002374896617.xml", "product_code":"modelarts", - "code":"65", - "des":"This interface 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 other models with the same name but d", + "code":"64", + "des":"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 ", "doc_type":"api", - "kw":"Deleting a model,Model Management,API Reference", + "kw":"Deleting an AI application,AI Application Management,API Reference", "search_title":"", "metedata":[ { @@ -1227,14 +1208,14 @@ "operation_id":"DeleteModel" } ], - "title":"Deleting a model", + "title":"Deleting an AI application", "githuburl":"" }, { "uri":"service_management.html", - "node_id":"en-us_topic_0000002268806125.xml", + "node_id":"en-us_topic_0000002374896541.xml", "product_code":"modelarts", - "code":"66", + "code":"65", "des":"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.", "doc_type":"api", "kw":"Service Management", @@ -1249,9 +1230,9 @@ }, { "uri":"ShowServiceMonitorInfo.html", - "node_id":"en-us_topic_0000002268726277.xml", + "node_id":"en-us_topic_0000002374856549.xml", "product_code":"modelarts", - "code":"67", + "code":"66", "des":"This API is used to obtain service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorStatus code: 200Status code: 200Monitoring informationSee Erro", "doc_type":"api", "kw":"Obtaining Service Monitoring,Service Management,API Reference", @@ -1268,9 +1249,9 @@ }, { "uri":"ListServices.html", - "node_id":"en-us_topic_0000002233886822.xml", + "node_id":"en-us_topic_0000002374856497.xml", "product_code":"modelarts", - "code":"68", + "code":"67", "des":"This API is used to obtain model services.GET /v1/{project_id}/servicesStatus code: 200Status code: 200Service listSee Error Codes.", "doc_type":"api", "kw":"Obtaining Services,Service Management,API Reference", @@ -1287,9 +1268,9 @@ }, { "uri":"CreateService.html", - "node_id":"en-us_topic_0000002268726241.xml", + "node_id":"en-us_topic_0000002341058406.xml", "product_code":"modelarts", - "code":"69", + "code":"68", "des":"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", "doc_type":"api", "kw":"Deploying Services,Service Management,API Reference", @@ -1306,9 +1287,9 @@ }, { "uri":"ShowServiceSpecifications.html", - "node_id":"en-us_topic_0000002233886770.xml", + "node_id":"en-us_topic_0000002341058334.xml", "product_code":"modelarts", - "code":"70", + "code":"69", "des":"This API is used to obtain supported service deployment specifications.GET /v1/{project_id}/services/specificationsStatus code: 200Status code: 200Service deployment flav", "doc_type":"api", "kw":"Obtaining Supported Service Deployment Specifications,Service Management,API Reference", @@ -1325,9 +1306,9 @@ }, { "uri":"ShowService.html", - "node_id":"en-us_topic_0000002233726906.xml", + "node_id":"en-us_topic_0000002341058298.xml", "product_code":"modelarts", - "code":"71", + "code":"70", "des":"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", "doc_type":"api", "kw":"Obtaining Service Details,Service Management,API Reference", @@ -1344,9 +1325,9 @@ }, { "uri":"UpdateService.html", - "node_id":"en-us_topic_0000002268726249.xml", + "node_id":"en-us_topic_0000002341058422.xml", "product_code":"modelarts", - "code":"72", + "code":"71", "des":"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", "doc_type":"api", "kw":"Updating Service Configurations,Service Management,API Reference", @@ -1363,9 +1344,9 @@ }, { "uri":"DeleteService.html", - "node_id":"en-us_topic_0000002233726998.xml", + "node_id":"en-us_topic_0000002340898678.xml", "product_code":"modelarts", - "code":"73", + "code":"72", "des":"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", "doc_type":"api", "kw":"Deleting a Service,Service Management,API Reference", @@ -1382,9 +1363,9 @@ }, { "uri":"ShowServiceEvents.html", - "node_id":"en-us_topic_0000002268726169.xml", + "node_id":"en-us_topic_0000002341058274.xml", "product_code":"modelarts", - "code":"74", + "code":"73", "des":"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", "doc_type":"api", "kw":"Obtaining Service Event Logs,Service Management,API Reference", @@ -1401,9 +1382,9 @@ }, { "uri":"ShowServiceUpdateLogs.html", - "node_id":"en-us_topic_0000002268806109.xml", + "node_id":"en-us_topic_0000002374856353.xml", "product_code":"modelarts", - "code":"75", + "code":"74", "des":"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", "doc_type":"api", "kw":"Obtaining Service Update Logs,Service Management,API Reference", @@ -1419,10 +1400,141 @@ "githuburl":"" }, { - "uri":"resource_management1.html", - "node_id":"en-us_topic_0000002233726954.xml", + "uri":"topic_300003000.html", + "node_id":"en-us_topic_0000002340898498.xml", + "product_code":"modelarts", + "code":"75", + "des":"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.", + "doc_type":"api", + "kw":"Service Task Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Service Task Management", + "githuburl":"" + }, + { + "uri":"CreateTasks.html", + "node_id":"en-us_topic_0000002374896565.xml", "product_code":"modelarts", "code":"76", + "des":"This API is used to create a service task.POST /v1/{project_id}/services/{service_id}/tasksStatus code: 201Status code: 400Status code: 404Create a common edge service ta", + "doc_type":"api", + "kw":"Creating a Service Task,Service Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreateTasks" + } + ], + "title":"Creating a Service Task", + "githuburl":"" + }, + { + "uri":"ListTasksDetails.html", + "node_id":"en-us_topic_0000002374896701.xml", + "product_code":"modelarts", + "code":"77", + "des":"This API is used to obtain service tasks.GET /v1/{project_id}/services/{service_id}/tasksNoneStatus code: 200Status code: 400Status code: 404Query the first five service ", + "doc_type":"api", + "kw":"Obtaining Service Tasks,Service Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListTasksDetails" + } + ], + "title":"Obtaining Service Tasks", + "githuburl":"" + }, + { + "uri":"ShowTask.html", + "node_id":"en-us_topic_0000002374896669.xml", + "product_code":"modelarts", + "code":"78", + "des":"This API is used to obtain a service task.GET /v1/{project_id}/services/{service_id}/tasks/{task_id}NoneStatus code: 200Status code: 400Status code: 404Obtain a specified", + "doc_type":"api", + "kw":"Obtaining a Service Task,Service Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowTask" + } + ], + "title":"Obtaining a Service Task", + "githuburl":"" + }, + { + "uri":"DeleteTask.html", + "node_id":"en-us_topic_0000002374856389.xml", + "product_code":"modelarts", + "code":"79", + "des":"This API is used to delete a service task.DELETE /v1/{project_id}/services/{service_id}/tasks/{task_id}NoneStatus code: 400Status code: 404Delete a specified service task", + "doc_type":"api", + "kw":"Deleting a Service Task,Service Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteTask" + } + ], + "title":"Deleting a Service Task", + "githuburl":"" + }, + { + "uri":"StartTask.html", + "node_id":"en-us_topic_0000002340898554.xml", + "product_code":"modelarts", + "code":"80", + "des":"This API is used to start a service task. This parameter applies only to IEF. It cannot be used in ModelArts Edge.POST /v1/{project_id}/services/{service_id}/tasks/{task_", + "doc_type":"api", + "kw":"Starting a Service Task,Service Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"StartTask" + } + ], + "title":"Starting a Service Task", + "githuburl":"" + }, + { + "uri":"StopTask.html", + "node_id":"en-us_topic_0000002374896717.xml", + "product_code":"modelarts", + "code":"81", + "des":"This API is used to stop a service task. This parameter applies only to IEF. It cannot be used in ModelArts Edge.POST /v1/{project_id}/services/{service_id}/tasks/{task_i", + "doc_type":"api", + "kw":"Stopping a Service Task,Service Task Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"StopTask" + } + ], + "title":"Stopping a Service Task", + "githuburl":"" + }, + { + "uri":"resource_management1.html", + "node_id":"en-us_topic_0000002374896613.xml", + "product_code":"modelarts", + "code":"82", "des":"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.", "doc_type":"api", "kw":"Resource Management", @@ -1436,10 +1548,65 @@ "githuburl":"" }, { - "uri":"config_management.html", - "node_id":"en-us_topic_0000002268720669.xml", + "uri":"workload_management.html", + "node_id":"en-us_topic_0000002341058314.xml", "product_code":"modelarts", - "code":"77", + "code":"83", + "des":"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.", + "doc_type":"api", + "kw":"Resource Pool Job Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Resource Pool Job Management", + "githuburl":"" + }, + { + "uri":"ListWorkloads.html", + "node_id":"en-us_topic_0000002374896489.xml", + "product_code":"modelarts", + "code":"84", + "des":"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: 404Obtain jo", + "doc_type":"api", + "kw":"Obtaining Jobs in a Dedicated Resource Pool,Resource Pool Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListWorkloads" + } + ], + "title":"Obtaining Jobs in a Dedicated Resource Pool", + "githuburl":"" + }, + { + "uri":"ShowWorkloadStatistics.html", + "node_id":"en-us_topic_0000002341058322.xml", + "product_code":"modelarts", + "code":"85", + "des":"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", + "doc_type":"api", + "kw":"Obtaining Statistics About Dedicated Resource Pool Jobs,Resource Pool Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowWorkloadStatistics" + } + ], + "title":"Obtaining Statistics About Dedicated Resource Pool Jobs", + "githuburl":"" + }, + { + "uri":"config_management.html", + "node_id":"en-us_topic_0000002374896537.xml", + "product_code":"modelarts", + "code":"86", "des":"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.", "doc_type":"api", "kw":"Configuration Management", @@ -1454,9 +1621,9 @@ }, { "uri":"ShowOsConfig.html", - "node_id":"en-us_topic_0000002233881234.xml", + "node_id":"en-us_topic_0000002341058338.xml", "product_code":"modelarts", - "code":"78", + "code":"87", "des":"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", "doc_type":"api", "kw":"Querying OS Configuration Parameters,Configuration Management,API Reference", @@ -1473,9 +1640,9 @@ }, { "uri":"ShowOsQuota.html", - "node_id":"en-us_topic_0000002233721414.xml", + "node_id":"en-us_topic_0000002374856417.xml", "product_code":"modelarts", - "code":"79", + "code":"88", "des":"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", "doc_type":"api", "kw":"Obtaining OS Quotas,Configuration Management,API Reference", @@ -1490,138 +1657,11 @@ "title":"Obtaining OS Quotas", "githuburl":"" }, - { - "uri":"event_management.html", - "node_id":"en-us_topic_0000002233721398.xml", - "product_code":"modelarts", - "code":"80", - "des":"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.", - "doc_type":"api", - "kw":"Event Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"Event Management", - "githuburl":"" - }, - { - "uri":"ListEvents.html", - "node_id":"en-us_topic_0000002268720677.xml", - "product_code":"modelarts", - "code":"81", - "des":"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", - "doc_type":"api", - "kw":"Obtaining the Event List,Event Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ListEvents" - } - ], - "title":"Obtaining the Event List", - "githuburl":"" - }, - { - "uri":"workload_management.html", - "node_id":"en-us_topic_0000002233721426.xml", - "product_code":"modelarts", - "code":"82", - "des":"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.", - "doc_type":"api", - "kw":"Resource Pool Job Management", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"Resource Pool Job Management", - "githuburl":"" - }, - { - "uri":"ListWorkloads.html", - "node_id":"en-us_topic_0000002233881262.xml", - "product_code":"modelarts", - "code":"83", - "des":"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", - "doc_type":"api", - "kw":"Obtaining Jobs in a Dedicated Resource Pool,Resource Pool Job Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ListWorkloads" - } - ], - "title":"Obtaining Jobs in a Dedicated Resource Pool", - "githuburl":"" - }, - { - "uri":"ShowWorkloadStatistics.html", - "node_id":"en-us_topic_0000002268720673.xml", - "product_code":"modelarts", - "code":"84", - "des":"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", - "doc_type":"api", - "kw":"Obtaining Statistics About Dedicated Resource Pool Jobs,Resource Pool Job Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowWorkloadStatistics" - } - ], - "title":"Obtaining Statistics About Dedicated Resource Pool Jobs", - "githuburl":"" - }, - { - "uri":"metrics_management.html", - "node_id":"en-us_topic_0000002268800589.xml", - "product_code":"modelarts", - "code":"85", - "des":"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.", - "doc_type":"api", - "kw":"Resource Metrics", - "search_title":"", - "metedata":[ - { - "documenttype":"api" - } - ], - "title":"Resource Metrics", - "githuburl":"" - }, - { - "uri":"ShowPoolRuntimeMetrics.html", - "node_id":"en-us_topic_0000002233721422.xml", - "product_code":"modelarts", - "code":"86", - "des":"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:", - "doc_type":"api", - "kw":"Obtaining the Real-Time Resource Usage,Resource Metrics,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ShowPoolRuntimeMetrics" - } - ], - "title":"Obtaining the Real-Time Resource Usage", - "githuburl":"" - }, { "uri":"plugintemplate_management.html", - "node_id":"en-us_topic_0000002268800581.xml", + "node_id":"en-us_topic_0000002374856401.xml", "product_code":"modelarts", - "code":"87", + "code":"89", "des":"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.", "doc_type":"api", "kw":"Plug-in Template Management", @@ -1636,10 +1676,10 @@ }, { "uri":"ShowPluginTemplate.html", - "node_id":"en-us_topic_0000002233881242.xml", + "node_id":"en-us_topic_0000002340898514.xml", "product_code":"modelarts", - "code":"88", - "des":"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", + "code":"90", + "des":"This API is used to obtain details of a specified plug-in template.GET /v1/{project_id}/plugintemplates/{plugintemplate_name}NoneStatus code: 200Status code: 404The follo", "doc_type":"api", "kw":"Querying a Plug-in Template,Plug-in Template Management,API Reference", "search_title":"", @@ -1654,122 +1694,215 @@ "githuburl":"" }, { - "uri":"tags_management.html", - "node_id":"en-us_topic_0000002233881266.xml", + "uri":"ListPluginTemplates.html", + "node_id":"en-us_topic_0000002374896517.xml", "product_code":"modelarts", - "code":"89", + "code":"91", + "des":"This API is used to obtain plug-in templates.GET /v2/{project_id}/plugintemplatesNoneStatus code: 200Status code: 404The following is an example of how to query details a", + "doc_type":"api", + "kw":"Query Plug-in Templates,Plug-in Template Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListPluginTemplates" + } + ], + "title":"Query Plug-in Templates", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "node_id":"en-us_topic_0000002341058330.xml", + "product_code":"modelarts", + "code":"92", "des":"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.", "doc_type":"api", - "kw":"Tag Management", + "kw":"Virtual Resource Flavors", "search_title":"", "metedata":[ { "documenttype":"api" } ], - "title":"Tag Management", + "title":"Virtual Resource Flavors", "githuburl":"" }, { - "uri":"BatchCreatePoolTags.html", - "node_id":"en-us_topic_0000002233721402.xml", - "product_code":"modelarts", - "code":"90", - "des":"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 ", - "doc_type":"api", - "kw":"Creating Resource Pool Tags in Batches,Tag Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"BatchCreatePoolTags" - } - ], - "title":"Creating Resource Pool Tags in Batches", - "githuburl":"" - }, - { - "uri":"BatchDeletePoolTags.html", - "node_id":"en-us_topic_0000002268800601.xml", - "product_code":"modelarts", - "code":"91", - "des":"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", - "doc_type":"api", - "kw":"Deleting Resource Pool Tags in Batches,Tag Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"BatchDeletePoolTags" - } - ], - "title":"Deleting Resource Pool Tags in Batches", - "githuburl":"" - }, - { - "uri":"ListPoolTags.html", - "node_id":"en-us_topic_0000002268720665.xml", - "product_code":"modelarts", - "code":"92", - "des":"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", - "doc_type":"api", - "kw":"Querying All Tags of Resource Pools,Tag Management,API Reference", - "search_title":"", - "metedata":[ - { - "opensource":"true", - "documenttype":"api", - "operation_id":"ListPoolTags" - } - ], - "title":"Querying All Tags of Resource Pools", - "githuburl":"" - }, - { - "uri":"ShowPoolTags.html", - "node_id":"en-us_topic_0000002233721406.xml", + "uri":"ShowVirtualResourceTemplate.html", + "node_id":"en-us_topic_0000002374896577.xml", "product_code":"modelarts", "code":"93", - "des":"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", + "des":"This API is used to obtain details about a specified virtual resource allocation template.GET /v1/{project_id}/virtualresourcetemplates/{virtualresourcetemplate_name}None", "doc_type":"api", - "kw":"Querying Tags of a Resource Pool,Tag Management,API Reference", + "kw":"Obtaining Virtual Resource Flavor Templates,Virtual Resource Flavors,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"ShowPoolTags" + "operation_id":"ShowVirtualResourceTemplate" } ], - "title":"Querying Tags of a Resource Pool", + "title":"Obtaining Virtual Resource Flavor Templates", "githuburl":"" }, { - "uri":"ListPoolsByTags.html", - "node_id":"en-us_topic_0000002233881258.xml", + "uri":"ListVirtualresourceFlavors.html", + "node_id":"en-us_topic_0000002374856425.xml", "product_code":"modelarts", "code":"94", - "des":"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", + "des":"This API is used to obtain virtual resource flavors.GET /v1/{project_id}/virtualresourceflavorsNoneStatus code: 200Status code: 404Obtain virtual NPU allocation resource ", "doc_type":"api", - "kw":"Querying Resource Pools by Tag,Tag Management,API Reference", + "kw":"Obtaining Virtual Resource Flavors,Virtual Resource Flavors,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"ListPoolsByTags" + "operation_id":"ListVirtualresourceFlavors" } ], - "title":"Querying Resource Pools by Tag", + "title":"Obtaining Virtual Resource Flavors", + "githuburl":"" + }, + { + "uri":"nodes_management.html", + "node_id":"en-us_topic_0000002374896593.xml", + "product_code":"modelarts", + "code":"95", + "des":"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.", + "doc_type":"api", + "kw":"Node Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Node Management", + "githuburl":"" + }, + { + "uri":"ListPoolNodes.html", + "node_id":"en-us_topic_0000002341058362.xml", + "product_code":"modelarts", + "code":"96", + "des":"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", + "doc_type":"api", + "kw":"Obtaining Nodes in a Resource Pool,Node Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListPoolNodes" + } + ], + "title":"Obtaining Nodes in a Resource Pool", + "githuburl":"" + }, + { + "uri":"BatchDeletePoolNodes.html", + "node_id":"en-us_topic_0000002374856393.xml", + "product_code":"modelarts", + "code":"97", + "des":"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", + "doc_type":"api", + "kw":"Deleting Nodes in Batches,Node Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchDeletePoolNodes" + } + ], + "title":"Deleting Nodes in Batches", + "githuburl":"" + }, + { + "uri":"BatchUpdatePoolNodes.html", + "node_id":"en-us_topic_0000002341058258.xml", + "product_code":"modelarts", + "code":"98", + "des":"This API is used to update nodes in batches.POST /v2/{project_id}/pools/{pool_name}/nodes/batch-updateStatus code: 200Status code: 404Enable node HA redundancy.Status cod", + "doc_type":"api", + "kw":"Updating Nodes in Batches,Node Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchUpdatePoolNodes" + } + ], + "title":"Updating Nodes in Batches", + "githuburl":"" + }, + { + "uri":"BatchLockPoolNodes.html", + "node_id":"en-us_topic_0000002374856357.xml", + "product_code":"modelarts", + "code":"99", + "des":"This API is used to lock node functions in batches. Locked functions cannot be used on the console.POST /v2/{project_id}/pools/{pool_name}/nodes/batch-lockStatus code: 20", + "doc_type":"api", + "kw":"Locking Node Functions in Batches,Node Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchLockPoolNodes" + } + ], + "title":"Locking Node Functions in Batches", + "githuburl":"" + }, + { + "uri":"BatchUnlockPoolNodes.html", + "node_id":"en-us_topic_0000002374856365.xml", + "product_code":"modelarts", + "code":"100", + "des":"This API is used to unlock node functions in batches. Locked functions cannot be used on the console, but can be used after being unlocked.POST /v2/{project_id}/pools/{po", + "doc_type":"api", + "kw":"Unlocking Node Functions in Batches,Node Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchUnlockPoolNodes" + } + ], + "title":"Unlocking Node Functions in Batches", + "githuburl":"" + }, + { + "uri":"BatchBindPoolNodes.html", + "node_id":"en-us_topic_0000002374896585.xml", + "product_code":"modelarts", + "code":"101", + "des":"This API is used to bind nodes in a logical subpool to another logical subpool when node binding is enabled for a physical dedicated pool.POST /v2/{project_id}/pools/{poo", + "doc_type":"api", + "kw":"Binding Nodes to a Logical Subpool in Batches,Node Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"BatchBindPoolNodes" + } + ], + "title":"Binding Nodes to a Logical Subpool in Batches", "githuburl":"" }, { "uri":"network_management.html", - "node_id":"en-us_topic_0000002268800577.xml", + "node_id":"en-us_topic_0000002374856337.xml", "product_code":"modelarts", - "code":"95", + "code":"102", "des":"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.", "doc_type":"api", "kw":"Network Management", @@ -1784,9 +1917,9 @@ }, { "uri":"CreateNetwork.html", - "node_id":"en-us_topic_0000002268720661.xml", + "node_id":"en-us_topic_0000002374896529.xml", "product_code":"modelarts", - "code":"96", + "code":"103", "des":"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.", "doc_type":"api", "kw":"Creating Network Resources,Network Management,API Reference", @@ -1803,9 +1936,9 @@ }, { "uri":"ListNetworks.html", - "node_id":"en-us_topic_0000002233881246.xml", + "node_id":"en-us_topic_0000002340898566.xml", "product_code":"modelarts", - "code":"97", + "code":"104", "des":"This API is used to obtain network resources.GET /v1/{project_id}/networksNoneStatus code: 200Obtain resource pools.Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Obtaining Network Resources,Network Management,API Reference", @@ -1822,9 +1955,9 @@ }, { "uri":"ShowNetwork.html", - "node_id":"en-us_topic_0000002268720689.xml", + "node_id":"en-us_topic_0000002374896561.xml", "product_code":"modelarts", - "code":"98", + "code":"105", "des":"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", "doc_type":"api", "kw":"Obtaining a Network Resource,Network Management,API Reference", @@ -1841,9 +1974,9 @@ }, { "uri":"DeleteNetwork.html", - "node_id":"en-us_topic_0000002268800597.xml", + "node_id":"en-us_topic_0000002374856349.xml", "product_code":"modelarts", - "code":"99", + "code":"106", "des":"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", "doc_type":"api", "kw":"Deleting a Network Resource,Network Management,API Reference", @@ -1860,9 +1993,9 @@ }, { "uri":"PatchNetwork.html", - "node_id":"en-us_topic_0000002233881230.xml", + "node_id":"en-us_topic_0000002340898494.xml", "product_code":"modelarts", - "code":"100", + "code":"107", "des":"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 ", "doc_type":"api", "kw":"Updating a Network Resource,Network Management,API Reference", @@ -1878,65 +2011,361 @@ "githuburl":"" }, { - "uri":"nodes_management.html", - "node_id":"en-us_topic_0000002233721434.xml", + "uri":"tags_management.html", + "node_id":"en-us_topic_0000002340898550.xml", "product_code":"modelarts", - "code":"101", + "code":"108", "des":"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.", "doc_type":"api", - "kw":"Node Management", + "kw":"Tag Management", "search_title":"", "metedata":[ { "documenttype":"api" } ], - "title":"Node Management", + "title":"Tag Management", "githuburl":"" }, { - "uri":"ListPoolNodes.html", - "node_id":"en-us_topic_0000002268720685.xml", + "uri":"ListPoolTags.html", + "node_id":"en-us_topic_0000002374856377.xml", "product_code":"modelarts", - "code":"102", - "des":"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", + "code":"109", + "des":"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", "doc_type":"api", - "kw":"Obtaining Nodes,Node Management,API Reference", + "kw":"Obtaining All Resource Tags of a Resource Pool,Tag Management,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"ListPoolNodes" + "operation_id":"ListPoolTags" } ], - "title":"Obtaining Nodes", + "title":"Obtaining All Resource Tags of a Resource Pool", "githuburl":"" }, { - "uri":"BatchDeletePoolNodes.html", - "node_id":"en-us_topic_0000002268800585.xml", + "uri":"ShowPoolTags.html", + "node_id":"en-us_topic_0000002340898526.xml", "product_code":"modelarts", - "code":"103", - "des":"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", + "code":"110", + "des":"This API is used to obtain resource tags of a specified resource pool.GET /v1/{project_id}/pools/{pool_name}/tagsNoneStatus code: 204Status code: 400Status code: 401Statu", "doc_type":"api", - "kw":"Deleting Nodes in Batches,Node Management,API Reference", + "kw":"Obtaining Resource Tags of a Resource Pool,Tag Management,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"BatchDeletePoolNodes" + "operation_id":"ShowPoolTags" } ], - "title":"Deleting Nodes in Batches", + "title":"Obtaining Resource Tags of a Resource Pool", + "githuburl":"" + }, + { + "uri":"UpdatePoolTags.html", + "node_id":"en-us_topic_0000002341058354.xml", + "product_code":"modelarts", + "code":"111", + "des":"This API is used to modify resource tags of a specified resource pool.POST /v1/{project_id}/pools/{pool_name}/tagsStatus code: 200Status code: 400Status code: 401Status c", + "doc_type":"api", + "kw":"Modifying Resource Tags of a Resource Pool,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdatePoolTags" + } + ], + "title":"Modifying Resource Tags of a Resource Pool", + "githuburl":"" + }, + { + "uri":"ListNodeTags.html", + "node_id":"en-us_topic_0000002341058346.xml", + "product_code":"modelarts", + "code":"112", + "des":"This API is used to obtain all tags of nodes in the current project. By default, all workspaces are queried. Tag data is not returned for workspaces on which the user doe", + "doc_type":"api", + "kw":"Obtaining All Resource Tags of Nodes,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListNodeTags" + } + ], + "title":"Obtaining All Resource Tags of Nodes", + "githuburl":"" + }, + { + "uri":"ShowNodeTags.html", + "node_id":"en-us_topic_0000002341058278.xml", + "product_code":"modelarts", + "code":"113", + "des":"This API is used to obtain resource tags of a specified node.GET /v1/{project_id}/nodes/{node_name}/tagsNoneStatus code: 204Status code: 400Status code: 401Status code: 4", + "doc_type":"api", + "kw":"Obtaining Resource Tags of Nodes,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowNodeTags" + } + ], + "title":"Obtaining Resource Tags of Nodes", + "githuburl":"" + }, + { + "uri":"UpdateNodeTags.html", + "node_id":"en-us_topic_0000002374856409.xml", + "product_code":"modelarts", + "code":"114", + "des":"This API is used to modify resource tags of a specified node.POST /v1/{project_id}/nodes/{node_name}/tagsStatus code: 200Status code: 400Status code: 401Status code: 403S", + "doc_type":"api", + "kw":"Modifying Resource Tags of Nodes,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateNodeTags" + } + ], + "title":"Modifying Resource Tags of Nodes", + "githuburl":"" + }, + { + "uri":"event_management.html", + "node_id":"en-us_topic_0000002374896545.xml", + "product_code":"modelarts", + "code":"115", + "des":"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.", + "doc_type":"api", + "kw":"Event Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Event Management", + "githuburl":"" + }, + { + "uri":"ListEvents.html", + "node_id":"en-us_topic_0000002374896485.xml", + "product_code":"modelarts", + "code":"116", + "des":"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", + "doc_type":"api", + "kw":"Obtaining the Event List,Event Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListEvents" + } + ], + "title":"Obtaining the Event List", + "githuburl":"" + }, + { + "uri":"topic_300000008.html", + "node_id":"en-us_topic_0000002374856341.xml", + "product_code":"modelarts", + "code":"117", + "des":"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.", + "doc_type":"api", + "kw":"Plug-in Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Plug-in Management", + "githuburl":"" + }, + { + "uri":"CreatePlugin.html", + "node_id":"en-us_topic_0000002340898574.xml", + "product_code":"modelarts", + "code":"118", + "des":"This API is used to create plug-in instances.POST /v2/{project_id}/pools/{pool_name}/pluginsStatus code: 200Status code: 400This API is used to create plug-in instances.S", + "doc_type":"api", + "kw":"Create a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CreatePlugin" + } + ], + "title":"Create a Plug-in", + "githuburl":"" + }, + { + "uri":"ListPlugins.html", + "node_id":"en-us_topic_0000002341058262.xml", + "product_code":"modelarts", + "code":"119", + "des":"This API is used to list plug-in instances.GET /v2/{project_id}/pools/{pool_name}/pluginsNoneStatus code: 200This API is used to list plug-in instances.Status code: 200Re", + "doc_type":"api", + "kw":"Query Plug-ins,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListPlugins" + } + ], + "title":"Query Plug-ins", + "githuburl":"" + }, + { + "uri":"PatchPlugin.html", + "node_id":"en-us_topic_0000002340898502.xml", + "product_code":"modelarts", + "code":"120", + "des":"This API is used to update a plug-in instance.PATCH /v2/{project_id}/pools/{pool_name}/plugins/{template_name}Status code: 200Status code: 400This API is used to update a", + "doc_type":"api", + "kw":"Update a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"PatchPlugin" + } + ], + "title":"Update a Plug-in", + "githuburl":"" + }, + { + "uri":"DeletePlugin.html", + "node_id":"en-us_topic_0000002340898482.xml", + "product_code":"modelarts", + "code":"121", + "des":"This API is used to delete plug-in instances.DELETE /v2/{project_id}/pools/{pool_name}/plugins/{template_name}NoneStatus code: 200Status code: 400This API is used to dele", + "doc_type":"api", + "kw":"Delete a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeletePlugin" + } + ], + "title":"Delete a Plug-in", + "githuburl":"" + }, + { + "uri":"ShowPlugin.html", + "node_id":"en-us_topic_0000002341058310.xml", + "product_code":"modelarts", + "code":"122", + "des":"This API is used to query details of a plug-in instance.GET /v2/{project_id}/pools/{pool_name}/plugins/{template_name}NoneStatus code: 200Status code: 400This API is used", + "doc_type":"api", + "kw":"Query Details of a Plug-in,Plug-in Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowPlugin" + } + ], + "title":"Query Details of a Plug-in", + "githuburl":"" + }, + { + "uri":"resourceflavor_management.html", + "node_id":"en-us_topic_0000002374896553.xml", + "product_code":"modelarts", + "code":"123", + "des":"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.", + "doc_type":"api", + "kw":"Resource Specifications Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Resource Specifications Management", + "githuburl":"" + }, + { + "uri":"ListResourceFlavors.html", + "node_id":"en-us_topic_0000002374856441.xml", + "product_code":"modelarts", + "code":"124", + "des":"Obtain resource specifications.GET /v1/{project_id}/resourceflavorsNoneStatus code: 200Status code: 401Status code: 404This API is used to obtain resource specifications.", + "doc_type":"api", + "kw":"Obtaining Resource Specifications,Resource Specifications Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListResourceFlavors" + } + ], + "title":"Obtaining Resource Specifications", + "githuburl":"" + }, + { + "uri":"topic_300000010.html", + "node_id":"en-us_topic_0000002340898582.xml", + "product_code":"modelarts", + "code":"125", + "des":"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.", + "doc_type":"api", + "kw":"Order Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Order Management", + "githuburl":"" + }, + { + "uri":"ListOrders.html", + "node_id":"en-us_topic_0000002340898490.xml", + "product_code":"modelarts", + "code":"126", + "des":"This API is used to obtain orders.GET /v1/{project_id}/ordersStatus code: 200Status code: 400Status code: 404Obtain successful orders of resource pool pool-5ed5 by page, ", + "doc_type":"api", + "kw":"Querying Orders,Order Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListOrders" + } + ], + "title":"Querying Orders", "githuburl":"" }, { "uri":"pools_management.html", - "node_id":"en-us_topic_0000002233881250.xml", + "node_id":"en-us_topic_0000002340898534.xml", "product_code":"modelarts", - "code":"104", + "code":"127", "des":"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.", "doc_type":"api", "kw":"Resource Pool Management", @@ -1951,9 +2380,9 @@ }, { "uri":"CreatePool.html", - "node_id":"en-us_topic_0000002268800593.xml", + "node_id":"en-us_topic_0000002374856433.xml", "product_code":"modelarts", - "code":"105", + "code":"128", "des":"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", "doc_type":"api", "kw":"Creating Resource Pools,Resource Pool Management,API Reference", @@ -1970,9 +2399,9 @@ }, { "uri":"ListPools.html", - "node_id":"en-us_topic_0000002233721410.xml", + "node_id":"en-us_topic_0000002341058290.xml", "product_code":"modelarts", - "code":"106", + "code":"129", "des":"This API is used to obtain resource pools.GET /v2/{project_id}/poolsNoneStatus code: 200Obtain resource pools.Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Obtaining Resource Pools,Resource Pool Management,API Reference", @@ -1989,9 +2418,9 @@ }, { "uri":"ShowPool.html", - "node_id":"en-us_topic_0000002233881254.xml", + "node_id":"en-us_topic_0000002341058302.xml", "product_code":"modelarts", - "code":"107", + "code":"130", "des":"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", "doc_type":"api", "kw":"Obtaining a Resource Pool,Resource Pool Management,API Reference", @@ -2008,9 +2437,9 @@ }, { "uri":"DeletePool.html", - "node_id":"en-us_topic_0000002268720681.xml", + "node_id":"en-us_topic_0000002340898558.xml", "product_code":"modelarts", - "code":"108", + "code":"131", "des":"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", "doc_type":"api", "kw":"Deleting a Resource Pool,Resource Pool Management,API Reference", @@ -2027,9 +2456,9 @@ }, { "uri":"PatchPool.html", - "node_id":"en-us_topic_0000002268800569.xml", + "node_id":"en-us_topic_0000002374896497.xml", "product_code":"modelarts", - "code":"109", + "code":"132", "des":"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", "doc_type":"api", "kw":"Updating a Resource Pool,Resource Pool Management,API Reference", @@ -2046,9 +2475,9 @@ }, { "uri":"ShowPoolMonitor.html", - "node_id":"en-us_topic_0000002233721430.xml", + "node_id":"en-us_topic_0000002341058270.xml", "product_code":"modelarts", - "code":"110", + "code":"133", "des":"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 ", "doc_type":"api", "kw":"Monitoring a Resource Pool,Resource Pool Management,API Reference", @@ -2065,10 +2494,10 @@ }, { "uri":"ShowPoolStatistics.html", - "node_id":"en-us_topic_0000002233881270.xml", + "node_id":"en-us_topic_0000002340898542.xml", "product_code":"modelarts", - "code":"111", - "des":"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", + "code":"134", + "des":"This API is used to obtain resource pool statistics.GET /v2/{project_id}/statistics/poolsNoneStatus code: 200Status code: 500Obtain resource pool statistics.Status code: ", "doc_type":"api", "kw":"Obtaining Resource Pool Statistics,Resource Pool Management,API Reference", "search_title":"", @@ -2083,46 +2512,65 @@ "githuburl":"" }, { - "uri":"resourceflavor_management.html", - "node_id":"en-us_topic_0000002268720693.xml", + "uri":"RetryPoolScope.html", + "node_id":"en-us_topic_0000002374856385.xml", "product_code":"modelarts", - "code":"112", + "code":"135", + "des":"This API is used to retry the job type that fails to be enabled.POST /v2/{project_id}/pools/{pool_name}/retry-scopeStatus code: 400Retry the Infer job type.Status code: 2", + "doc_type":"api", + "kw":"Retrying the Job Type That Fails to Be Enabled,Resource Pool Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"RetryPoolScope" + } + ], + "title":"Retrying the Job Type That Fails to Be Enabled", + "githuburl":"" + }, + { + "uri":"metrics_management.html", + "node_id":"en-us_topic_0000002374896509.xml", + "product_code":"modelarts", + "code":"136", "des":"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.", "doc_type":"api", - "kw":"Resource Specifications Management", + "kw":"Resource Metrics", "search_title":"", "metedata":[ { "documenttype":"api" } ], - "title":"Resource Specifications Management", + "title":"Resource Metrics", "githuburl":"" }, { - "uri":"ListResourceFlavors.html", - "node_id":"en-us_topic_0000002268800573.xml", + "uri":"ShowPoolRuntimeMetrics.html", + "node_id":"en-us_topic_0000002374896569.xml", "product_code":"modelarts", - "code":"113", - "des":"Obtain resource specifications.GET /v1/{project_id}/resourceflavorsNoneStatus code: 200Status code: 401Status code: 404This API is used to obtain resource specifications.", + "code":"137", + "des":"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: 200Obtain the real-", "doc_type":"api", - "kw":"Obtaining Resource Specifications,Resource Specifications Management,API Reference", + "kw":"Obtaining the Real-Time Resource Usage,Resource Metrics,API Reference", "search_title":"", "metedata":[ { "opensource":"true", "documenttype":"api", - "operation_id":"ListResourceFlavors" + "operation_id":"ShowPoolRuntimeMetrics" } ], - "title":"Obtaining Resource Specifications", + "title":"Obtaining the Real-Time Resource Usage", "githuburl":"" }, { "uri":"authorization.html", - "node_id":"en-us_topic_0000002233886810.xml", + "node_id":"en-us_topic_0000002374856473.xml", "product_code":"modelarts", - "code":"114", + "code":"138", "des":"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.", "doc_type":"api", "kw":"Authorization Management", @@ -2137,9 +2585,9 @@ }, { "uri":"GetAuthorizations.html", - "node_id":"en-us_topic_0000002233886790.xml", + "node_id":"en-us_topic_0000002374856453.xml", "product_code":"modelarts", - "code":"115", + "code":"139", "des":"This API is used to view an authorization list.GET /v2/{project_id}/authorizationsNoneStatus code: 200View an authorization list.Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Viewing an Authorization List,Authorization Management,API Reference", @@ -2156,9 +2604,9 @@ }, { "uri":"CreateAuthorization.html", - "node_id":"en-us_topic_0000002233726942.xml", + "node_id":"en-us_topic_0000002374896601.xml", "product_code":"modelarts", - "code":"116", + "code":"140", "des":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", "doc_type":"api", "kw":"Configuring Authorization,Authorization Management,API Reference", @@ -2175,9 +2623,9 @@ }, { "uri":"DeleteAuthorizations.html", - "node_id":"en-us_topic_0000002268806133.xml", + "node_id":"en-us_topic_0000002374896557.xml", "product_code":"modelarts", - "code":"117", + "code":"141", "des":"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", "doc_type":"api", "kw":"Deleting Authorization,Authorization Management,API Reference", @@ -2194,9 +2642,9 @@ }, { "uri":"CreateModelArtsAgency.html", - "node_id":"en-us_topic_0000002233886814.xml", + "node_id":"en-us_topic_0000002374856481.xml", "product_code":"modelarts", - "code":"118", + "code":"142", "des":"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", "doc_type":"api", "kw":"Creating a ModelArts Agency,Authorization Management,API Reference", @@ -2213,9 +2661,9 @@ }, { "uri":"modelarts_03_0400.html", - "node_id":"en-us_topic_0000002233928704.xml", + "node_id":"en-us_topic_0000002374856361.xml", "product_code":"modelarts", - "code":"119", + "code":"143", "des":"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.", "doc_type":"api", "kw":"Use Cases", @@ -2230,9 +2678,9 @@ }, { "uri":"modelarts_03_0406.html", - "node_id":"en-us_topic_0000002233928696.xml", + "node_id":"en-us_topic_0000002374896525.xml", "product_code":"modelarts", - "code":"120", + "code":"144", "des":"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", "doc_type":"api", "kw":"Creating a Development Environment Instance,Use Cases,API Reference", @@ -2247,9 +2695,9 @@ }, { "uri":"modelarts_03_0407.html", - "node_id":"en-us_topic_0000002268848093.xml", + "node_id":"en-us_topic_0000002340898518.xml", "product_code":"modelarts", - "code":"121", + "code":"145", "des":"This section describes how to train a model by calling ModelArts APIs.The process for creating a training job using PyTorch is as follows:Obtain a user token, which will ", "doc_type":"api", "kw":"Using PyTorch to Create a Training Job (New-Version Training),Use Cases,API Reference", @@ -2262,28 +2710,11 @@ "title":"Using PyTorch to Create a Training Job (New-Version Training)", "githuburl":"" }, - { - "uri":"modelarts_03_0401.html", - "node_id":"en-us_topic_0000002268768129.xml", - "product_code":"modelarts", - "code":"122", - "des":"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", - "doc_type":"api", - "kw":"Using TensorFlow to Create a Training Job (Old-Version Training),Use Cases,API Reference", - "search_title":"", - "metedata":[ - { - - } - ], - "title":"Using TensorFlow to Create a Training Job (Old-Version Training)", - "githuburl":"" - }, { "uri":"modelarts_03_0405.html", - "node_id":"en-us_topic_0000002268848085.xml", + "node_id":"en-us_topic_0000002374896513.xml", "product_code":"modelarts", - "code":"123", + "code":"146", "des":"This section describes how to manage agency authorization by calling ModelArts APIs.The process of managing ModelArts authorization is as follows:Obtain a user token, whi", "doc_type":"api", "kw":"Managing ModelArts Authorization,Use Cases,API Reference", @@ -2298,12 +2729,12 @@ }, { "uri":"modelarts_03_0093.html", - "node_id":"en-us_topic_0000002268848169.xml", + "node_id":"en-us_topic_0000002374896713.xml", "product_code":"modelarts", - "code":"124", + "code":"147", "des":"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.", "doc_type":"api", - "kw":"Common Parameters", + "kw":"Appendix", "search_title":"", "metedata":[ { @@ -2311,17 +2742,17 @@ "prodname":"modelarts" } ], - "title":"Common Parameters", + "title":"Appendix", "githuburl":"" }, { "uri":"modelarts_03_0094.html", - "node_id":"en-us_topic_0000002268848277.xml", + "node_id":"en-us_topic_0000002374856625.xml", "product_code":"modelarts", - "code":"125", + "code":"148", "des":"Table 1 describes the status codes.", "doc_type":"api", - "kw":"Status Code,Common Parameters,API Reference", + "kw":"Status Code,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -2335,12 +2766,12 @@ }, { "uri":"modelarts_03_0095.html", - "node_id":"en-us_topic_0000002233928684.xml", + "node_id":"en-us_topic_0000002374856325.xml", "product_code":"modelarts", - "code":"126", + "code":"149", "des":"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.", "doc_type":"api", - "kw":"Error Codes,Common Parameters,API Reference", + "kw":"Error Codes,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -2353,12 +2784,12 @@ }, { "uri":"modelarts_03_0147.html", - "node_id":"en-us_topic_0000002268848161.xml", + "node_id":"en-us_topic_0000002374896705.xml", "product_code":"modelarts", - "code":"127", + "code":"150", "des":"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", "doc_type":"api", - "kw":"Obtaining a Project ID and Name,Common Parameters,API Reference", + "kw":"Obtaining a Project ID and Name,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -2372,12 +2803,12 @@ }, { "uri":"modelarts_03_0148.html", - "node_id":"en-us_topic_0000002233928976.xml", + "node_id":"en-us_topic_0000002374896821.xml", "product_code":"modelarts", - "code":"128", - "des":"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", + "code":"151", + "des":"When you call APIs, certain requests require a tenant name and ID. To obtain a tenant name and ID, do as follows:Log in to the console.In the upper right corner, click yo", "doc_type":"api", - "kw":"Obtaining a Tenant Name and ID,Common Parameters,API Reference", + "kw":"Obtaining a Tenant Name and ID,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -2391,12 +2822,12 @@ }, { "uri":"modelarts_03_0006.html", - "node_id":"en-us_topic_0000002268768373.xml", + "node_id":"en-us_topic_0000002374896801.xml", "product_code":"modelarts", - "code":"129", + "code":"152", "des":"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", "doc_type":"api", - "kw":"Obtaining a Username and ID,Common Parameters,API Reference", + "kw":"Obtaining a Username and ID,Appendix,API Reference", "search_title":"", "metedata":[ { @@ -2410,9 +2841,9 @@ }, { "uri":"modelarts_03_0293.html", - "node_id":"en-us_topic_0000002268768165.xml", + "node_id":"en-us_topic_0000002340898658.xml", "product_code":"modelarts", - "code":"130", + "code":"153", "des":"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.", "doc_type":"api", "kw":"Historical APIs", @@ -2427,9 +2858,9 @@ }, { "uri":"dataset_management.html", - "node_id":"en-us_topic_0000002268848185.xml", + "node_id":"en-us_topic_0000002374896725.xml", "product_code":"modelarts", - "code":"131", + "code":"154", "des":"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.", "doc_type":"api", "kw":"Data Management (Old Version)", @@ -2444,9 +2875,9 @@ }, { "uri":"ListDatasets.html", - "node_id":"en-us_topic_0000002233768876.xml", + "node_id":"en-us_topic_0000002374856493.xml", "product_code":"modelarts", - "code":"132", + "code":"155", "des":"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", "doc_type":"api", "kw":"Querying the Dataset List,Data Management (Old Version),API Reference", @@ -2463,9 +2894,9 @@ }, { "uri":"CreateDataset.html", - "node_id":"en-us_topic_0000002233768900.xml", + "node_id":"en-us_topic_0000002374856525.xml", "product_code":"modelarts", - "code":"133", + "code":"156", "des":"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", "doc_type":"api", "kw":"Creating a Dataset,Data Management (Old Version),API Reference", @@ -2482,9 +2913,9 @@ }, { "uri":"DescDataset.html", - "node_id":"en-us_topic_0000002233769052.xml", + "node_id":"en-us_topic_0000002341058550.xml", "product_code":"modelarts", - "code":"134", + "code":"157", "des":"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", "doc_type":"api", "kw":"Querying Details About a Dataset,Data Management (Old Version),API Reference", @@ -2501,9 +2932,9 @@ }, { "uri":"UpdateDataset.html", - "node_id":"en-us_topic_0000002268848221.xml", + "node_id":"en-us_topic_0000002374896745.xml", "product_code":"modelarts", - "code":"135", + "code":"158", "des":"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 ", "doc_type":"api", "kw":"Modifying a Dataset,Data Management (Old Version),API Reference", @@ -2520,9 +2951,9 @@ }, { "uri":"DeleteDataset.html", - "node_id":"en-us_topic_0000002268848313.xml", + "node_id":"en-us_topic_0000002340898794.xml", "product_code":"modelarts", - "code":"136", + "code":"159", "des":"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", "doc_type":"api", "kw":"Deleting a Dataset,Data Management (Old Version),API Reference", @@ -2539,9 +2970,9 @@ }, { "uri":"GetDatasetStats.html", - "node_id":"en-us_topic_0000002233769152.xml", + "node_id":"en-us_topic_0000002374856681.xml", "product_code":"modelarts", - "code":"137", + "code":"160", "des":"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", "doc_type":"api", "kw":"Obtaining Dataset Statistics,Data Management (Old Version),API Reference", @@ -2558,9 +2989,9 @@ }, { "uri":"GetDatasetMetrics.html", - "node_id":"en-us_topic_0000002268848337.xml", + "node_id":"en-us_topic_0000002340898806.xml", "product_code":"modelarts", - "code":"138", + "code":"161", "des":"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", "doc_type":"api", "kw":"Querying the Monitoring Data of a Dataset,Data Management (Old Version),API Reference", @@ -2577,9 +3008,9 @@ }, { "uri":"ListDatasetVersions.html", - "node_id":"en-us_topic_0000002233769024.xml", + "node_id":"en-us_topic_0000002340898758.xml", "product_code":"modelarts", - "code":"139", + "code":"162", "des":"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", "doc_type":"api", "kw":"Querying the Dataset Version List,Data Management (Old Version),API Reference", @@ -2596,9 +3027,9 @@ }, { "uri":"CreateDatasetVersion.html", - "node_id":"en-us_topic_0000002233768932.xml", + "node_id":"en-us_topic_0000002374856561.xml", "product_code":"modelarts", - "code":"140", + "code":"163", "des":"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", "doc_type":"api", "kw":"Creating a Dataset Labeling Version,Data Management (Old Version),API Reference", @@ -2615,9 +3046,9 @@ }, { "uri":"DescribeDatasetVersion.html", - "node_id":"en-us_topic_0000002233768984.xml", + "node_id":"en-us_topic_0000002374856593.xml", "product_code":"modelarts", - "code":"141", + "code":"164", "des":"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", "doc_type":"api", "kw":"Querying Details About a Dataset Version,Data Management (Old Version),API Reference", @@ -2634,9 +3065,9 @@ }, { "uri":"DeleteDatasetVersion.html", - "node_id":"en-us_topic_0000002233928884.xml", + "node_id":"en-us_topic_0000002374896773.xml", "product_code":"modelarts", - "code":"142", + "code":"165", "des":"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", "doc_type":"api", "kw":"Deleting a Dataset Labeling Version,Data Management (Old Version),API Reference", @@ -2653,9 +3084,9 @@ }, { "uri":"ListSamples.html", - "node_id":"en-us_topic_0000002268848293.xml", + "node_id":"en-us_topic_0000002340898782.xml", "product_code":"modelarts", - "code":"143", + "code":"166", "des":"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", "doc_type":"api", "kw":"Obtaining a Sample List,Data Management (Old Version),API Reference", @@ -2672,9 +3103,9 @@ }, { "uri":"UploadSamplesJson.html", - "node_id":"en-us_topic_0000002268848129.xml", + "node_id":"en-us_topic_0000002374896673.xml", "product_code":"modelarts", - "code":"144", + "code":"167", "des":"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", "doc_type":"api", "kw":"Adding Samples in Batches,Data Management (Old Version),API Reference", @@ -2691,9 +3122,9 @@ }, { "uri":"DeleteSamples.html", - "node_id":"en-us_topic_0000002233768868.xml", + "node_id":"en-us_topic_0000002374896621.xml", "product_code":"modelarts", - "code":"145", + "code":"168", "des":"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", "doc_type":"api", "kw":"Deleting Samples in Batches,Data Management (Old Version),API Reference", @@ -2710,9 +3141,9 @@ }, { "uri":"DescribeSample.html", - "node_id":"en-us_topic_0000002233769036.xml", + "node_id":"en-us_topic_0000002340898766.xml", "product_code":"modelarts", - "code":"146", + "code":"169", "des":"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", "doc_type":"api", "kw":"Obtaining Details About a Sample,Data Management (Old Version),API Reference", @@ -2729,9 +3160,9 @@ }, { "uri":"ListSearch.html", - "node_id":"en-us_topic_0000002233768968.xml", + "node_id":"en-us_topic_0000002374856585.xml", "product_code":"modelarts", - "code":"147", + "code":"170", "des":"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", "doc_type":"api", "kw":"Obtaining Sample Search Condition,Data Management (Old Version),API Reference", @@ -2748,9 +3179,9 @@ }, { "uri":"ListWorkforceTaskSamples.html", - "node_id":"en-us_topic_0000002268848305.xml", + "node_id":"en-us_topic_0000002340898790.xml", "product_code":"modelarts", - "code":"148", + "code":"171", "des":"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 ", "doc_type":"api", "kw":"Obtaining a Sample List of a Team Labeling Task by Page,Data Management (Old Version),API Reference", @@ -2767,9 +3198,9 @@ }, { "uri":"DescribeWorkforceTaskSample.html", - "node_id":"en-us_topic_0000002268848345.xml", + "node_id":"en-us_topic_0000002340898810.xml", "product_code":"modelarts", - "code":"149", + "code":"172", "des":"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", "doc_type":"api", "kw":"Obtaining Details About a Team Labeling Sample,Data Management (Old Version),API Reference", @@ -2786,9 +3217,9 @@ }, { "uri":"ListLabels.html", - "node_id":"en-us_topic_0000002233928784.xml", + "node_id":"en-us_topic_0000002341058490.xml", "product_code":"modelarts", - "code":"150", + "code":"173", "des":"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", "doc_type":"api", "kw":"Querying the Dataset Label List,Data Management (Old Version),API Reference", @@ -2805,9 +3236,9 @@ }, { "uri":"CreateLabels.html", - "node_id":"en-us_topic_0000002233928908.xml", + "node_id":"en-us_topic_0000002374856637.xml", "product_code":"modelarts", - "code":"151", + "code":"174", "des":"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", "doc_type":"api", "kw":"Creating a Dataset Label,Data Management (Old Version),API Reference", @@ -2824,9 +3255,9 @@ }, { "uri":"UpdateLabels.html", - "node_id":"en-us_topic_0000002233928952.xml", + "node_id":"en-us_topic_0000002374856661.xml", "product_code":"modelarts", - "code":"152", + "code":"175", "des":"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", "doc_type":"api", "kw":"Modifying Labels in Batches,Data Management (Old Version),API Reference", @@ -2843,9 +3274,9 @@ }, { "uri":"DeleteLabels.html", - "node_id":"en-us_topic_0000002268848357.xml", + "node_id":"en-us_topic_0000002374856669.xml", "product_code":"modelarts", - "code":"153", + "code":"176", "des":"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", "doc_type":"api", "kw":"Deleting Labels in Batches,Data Management (Old Version),API Reference", @@ -2862,9 +3293,9 @@ }, { "uri":"UpdateLabel.html", - "node_id":"en-us_topic_0000002268848373.xml", + "node_id":"en-us_topic_0000002374896825.xml", "product_code":"modelarts", - "code":"154", + "code":"177", "des":"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", "doc_type":"api", "kw":"Updating a Label by Label Names,Data Management (Old Version),API Reference", @@ -2881,9 +3312,9 @@ }, { "uri":"DeleteLabelAndSamples.html", - "node_id":"en-us_topic_0000002268848381.xml", + "node_id":"en-us_topic_0000002374896829.xml", "product_code":"modelarts", - "code":"155", + "code":"178", "des":"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", "doc_type":"api", "kw":"Deleting a Label and the Files that Only Contain the Label,Data Management (Old Version),API Referen", @@ -2900,9 +3331,9 @@ }, { "uri":"UpdateSamples.html", - "node_id":"en-us_topic_0000002233928860.xml", + "node_id":"en-us_topic_0000002374896761.xml", "product_code":"modelarts", - "code":"156", + "code":"179", "des":"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", "doc_type":"api", "kw":"Updating Sample Labels in Batches,Data Management (Old Version),API Reference", @@ -2919,9 +3350,9 @@ }, { "uri":"ListWorkforceTasks.html", - "node_id":"en-us_topic_0000002233768884.xml", + "node_id":"en-us_topic_0000002374856509.xml", "product_code":"modelarts", - "code":"157", + "code":"180", "des":"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", "doc_type":"api", "kw":"Querying the Team Labeling Task List of a Dataset,Data Management (Old Version),API Reference", @@ -2938,9 +3369,9 @@ }, { "uri":"CreateWorkforceTask.html", - "node_id":"en-us_topic_0000002233928824.xml", + "node_id":"en-us_topic_0000002341058510.xml", "product_code":"modelarts", - "code":"158", + "code":"181", "des":"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/", "doc_type":"api", "kw":"Creating a Team Labeling Task,Data Management (Old Version),API Reference", @@ -2957,9 +3388,9 @@ }, { "uri":"DescWorkforceTask.html", - "node_id":"en-us_topic_0000002268768273.xml", + "node_id":"en-us_topic_0000002340898742.xml", "product_code":"modelarts", - "code":"159", + "code":"182", "des":"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", "doc_type":"api", "kw":"Querying Details About a Team Labeling Task,Data Management (Old Version),API Reference", @@ -2976,9 +3407,9 @@ }, { "uri":"StartWorkforceTask.html", - "node_id":"en-us_topic_0000002268848237.xml", + "node_id":"en-us_topic_0000002374896753.xml", "product_code":"modelarts", - "code":"160", + "code":"183", "des":"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/{", "doc_type":"api", "kw":"Starting a Team Labeling Task,Data Management (Old Version),API Reference", @@ -2995,9 +3426,9 @@ }, { "uri":"UpdateWorkforceTask.html", - "node_id":"en-us_topic_0000002233768952.xml", + "node_id":"en-us_topic_0000002374856577.xml", "product_code":"modelarts", - "code":"161", + "code":"184", "des":"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/{", "doc_type":"api", "kw":"Updating a Team Labeling Task,Data Management (Old Version),API Reference", @@ -3014,9 +3445,9 @@ }, { "uri":"DeleteWorkforceTask.html", - "node_id":"en-us_topic_0000002233928892.xml", + "node_id":"en-us_topic_0000002374856629.xml", "product_code":"modelarts", - "code":"162", + "code":"185", "des":"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", "doc_type":"api", "kw":"Deleting a Team Labeling Task,Data Management (Old Version),API Reference", @@ -3033,9 +3464,9 @@ }, { "uri":"StartWorkforceSamplingTask.html", - "node_id":"en-us_topic_0000002268768205.xml", + "node_id":"en-us_topic_0000002340898698.xml", "product_code":"modelarts", - "code":"163", + "code":"186", "des":"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", "doc_type":"api", "kw":"Creating a Team Labeling Acceptance Task,Data Management (Old Version),API Reference", @@ -3052,9 +3483,9 @@ }, { "uri":"GetWorkforceSamplingTask.html", - "node_id":"en-us_topic_0000002268848353.xml", + "node_id":"en-us_topic_0000002340898818.xml", "product_code":"modelarts", - "code":"164", + "code":"187", "des":"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", "doc_type":"api", "kw":"Querying the Report of a Team Labeling Acceptance Task,Data Management (Old Version),API Reference", @@ -3071,9 +3502,9 @@ }, { "uri":"UpdateWorkforceSamplingTask.html", - "node_id":"en-us_topic_0000002268848229.xml", + "node_id":"en-us_topic_0000002374896749.xml", "product_code":"modelarts", - "code":"165", + "code":"188", "des":"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", "doc_type":"api", "kw":"Updating Status of a Team Labeling Acceptance Task,Data Management (Old Version),API Reference", @@ -3090,9 +3521,9 @@ }, { "uri":"ListWorkforceTaskStats.html", - "node_id":"en-us_topic_0000002233768940.xml", + "node_id":"en-us_topic_0000002374856569.xml", "product_code":"modelarts", - "code":"166", + "code":"189", "des":"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 ", "doc_type":"api", "kw":"Querying Details About Team Labeling Task Statistics,Data Management (Old Version),API Reference", @@ -3109,9 +3540,9 @@ }, { "uri":"GetWorkforceTaskMetrics.html", - "node_id":"en-us_topic_0000002233928772.xml", + "node_id":"en-us_topic_0000002341058478.xml", "product_code":"modelarts", - "code":"167", + "code":"190", "des":"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", "doc_type":"api", "kw":"Querying Details About the Progress of a Team Labeling Task Member,Data Management (Old Version),API", @@ -3128,9 +3559,9 @@ }, { "uri":"ListWorkerTasks.html", - "node_id":"en-us_topic_0000002268848329.xml", + "node_id":"en-us_topic_0000002340898802.xml", "product_code":"modelarts", - "code":"168", + "code":"191", "des":"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", "doc_type":"api", "kw":"Querying the Team Labeling Task List by a Team Member,Data Management (Old Version),API Reference", @@ -3147,9 +3578,9 @@ }, { "uri":"AcceptSamples.html", - "node_id":"en-us_topic_0000002268768297.xml", + "node_id":"en-us_topic_0000002341058530.xml", "product_code":"modelarts", - "code":"169", + "code":"192", "des":"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", "doc_type":"api", "kw":"Submitting Sample Review Comments of an Acceptance Task,Data Management (Old Version),API Reference", @@ -3166,9 +3597,9 @@ }, { "uri":"ReviewSamples.html", - "node_id":"en-us_topic_0000002268848321.xml", + "node_id":"en-us_topic_0000002340898798.xml", "product_code":"modelarts", - "code":"170", + "code":"193", "des":"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", "doc_type":"api", "kw":"Reviewing Team Labeling Results,Data Management (Old Version),API Reference", @@ -3185,9 +3616,9 @@ }, { "uri":"UpdateWorkforceTaskSamples.html", - "node_id":"en-us_topic_0000002233769076.xml", + "node_id":"en-us_topic_0000002341058562.xml", "product_code":"modelarts", - "code":"171", + "code":"194", "des":"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 ", "doc_type":"api", "kw":"Updating Labels of Team Labeling Samples in Batches,Data Management (Old Version),API Reference", @@ -3204,9 +3635,9 @@ }, { "uri":"ListWorkforces.html", - "node_id":"en-us_topic_0000002268768221.xml", + "node_id":"en-us_topic_0000002340898714.xml", "product_code":"modelarts", - "code":"172", + "code":"195", "des":"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/", "doc_type":"api", "kw":"Querying the Labeling Team List,Data Management (Old Version),API Reference", @@ -3223,9 +3654,9 @@ }, { "uri":"CreateWorkforce.html", - "node_id":"en-us_topic_0000002233768992.xml", + "node_id":"en-us_topic_0000002374856597.xml", "product_code":"modelarts", - "code":"173", + "code":"196", "des":"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", "doc_type":"api", "kw":"Creating a Labeling Team,Data Management (Old Version),API Reference", @@ -3242,9 +3673,9 @@ }, { "uri":"DescWorkforce.html", - "node_id":"en-us_topic_0000002268768409.xml", + "node_id":"en-us_topic_0000002341058590.xml", "product_code":"modelarts", - "code":"174", + "code":"197", "des":"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", "doc_type":"api", "kw":"Querying Details About a Labeling Team,Data Management (Old Version),API Reference", @@ -3261,9 +3692,9 @@ }, { "uri":"UpdateWorkforce.html", - "node_id":"en-us_topic_0000002233928984.xml", + "node_id":"en-us_topic_0000002341058594.xml", "product_code":"modelarts", - "code":"175", + "code":"198", "des":"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", "doc_type":"api", "kw":"Updating a Labeling Team,Data Management (Old Version),API Reference", @@ -3280,9 +3711,9 @@ }, { "uri":"DeleteWorkforce.html", - "node_id":"en-us_topic_0000002268848137.xml", + "node_id":"en-us_topic_0000002374896681.xml", "product_code":"modelarts", - "code":"176", + "code":"199", "des":"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", "doc_type":"api", "kw":"Deleting a Labeling Team,Data Management (Old Version),API Reference", @@ -3299,9 +3730,9 @@ }, { "uri":"SendEmails.html", - "node_id":"en-us_topic_0000002233768976.xml", + "node_id":"en-us_topic_0000002374856589.xml", "product_code":"modelarts", - "code":"177", + "code":"200", "des":"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", "doc_type":"api", "kw":"Sending an Email to a Labeling Team Member,Data Management (Old Version),API Reference", @@ -3318,9 +3749,9 @@ }, { "uri":"ListAllWorkers.html", - "node_id":"en-us_topic_0000002233928756.xml", + "node_id":"en-us_topic_0000002341058462.xml", "product_code":"modelarts", - "code":"178", + "code":"201", "des":"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", "doc_type":"api", "kw":"Querying the List of All Labeling Team Members,Data Management (Old Version),API Reference", @@ -3337,9 +3768,9 @@ }, { "uri":"ListWorkers.html", - "node_id":"en-us_topic_0000002268768333.xml", + "node_id":"en-us_topic_0000002374896781.xml", "product_code":"modelarts", - "code":"179", + "code":"202", "des":"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", "doc_type":"api", "kw":"Querying the List of Labeling Team Members,Data Management (Old Version),API Reference", @@ -3356,9 +3787,9 @@ }, { "uri":"CreateWorker.html", - "node_id":"en-us_topic_0000002268848121.xml", + "node_id":"en-us_topic_0000002374856517.xml", "product_code":"modelarts", - "code":"180", + "code":"203", "des":"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", "doc_type":"api", "kw":"Creating a Labeling Team Member,Data Management (Old Version),API Reference", @@ -3375,9 +3806,9 @@ }, { "uri":"BatchDeleteWorkers.html", - "node_id":"en-us_topic_0000002233928932.xml", + "node_id":"en-us_topic_0000002374856649.xml", "product_code":"modelarts", - "code":"181", + "code":"204", "des":"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", "doc_type":"api", "kw":"Deleting Labeling Team Members in Batches,Data Management (Old Version),API Reference", @@ -3394,9 +3825,9 @@ }, { "uri":"DescWorker.html", - "node_id":"en-us_topic_0000002268848177.xml", + "node_id":"en-us_topic_0000002374896721.xml", "product_code":"modelarts", - "code":"182", + "code":"205", "des":"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", "doc_type":"api", "kw":"Querying Details About Labeling Team Members,Data Management (Old Version),API Reference", @@ -3413,9 +3844,9 @@ }, { "uri":"UpdateWorker.html", - "node_id":"en-us_topic_0000002233768908.xml", + "node_id":"en-us_topic_0000002374856537.xml", "product_code":"modelarts", - "code":"183", + "code":"206", "des":"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", "doc_type":"api", "kw":"Updating a Labeling Team Member,Data Management (Old Version),API Reference", @@ -3432,9 +3863,9 @@ }, { "uri":"DeleteWorker.html", - "node_id":"en-us_topic_0000002233769084.xml", + "node_id":"en-us_topic_0000002341058566.xml", "product_code":"modelarts", - "code":"184", + "code":"207", "des":"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 ", "doc_type":"api", "kw":"Deleting a Labeling Team Member,Data Management (Old Version),API Reference", @@ -3451,9 +3882,9 @@ }, { "uri":"ListImportTasks.html", - "node_id":"en-us_topic_0000002268768249.xml", + "node_id":"en-us_topic_0000002340898730.xml", "product_code":"modelarts", - "code":"185", + "code":"208", "des":"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", "doc_type":"api", "kw":"Querying the Dataset Import Task List,Data Management (Old Version),API Reference", @@ -3470,9 +3901,9 @@ }, { "uri":"ImportTask.html", - "node_id":"en-us_topic_0000002268768265.xml", + "node_id":"en-us_topic_0000002340898738.xml", "product_code":"modelarts", - "code":"186", + "code":"209", "des":"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", "doc_type":"api", "kw":"Creating an Import Task,Data Management (Old Version),API Reference", @@ -3489,9 +3920,9 @@ }, { "uri":"DescImportTask.html", - "node_id":"en-us_topic_0000002233769000.xml", + "node_id":"en-us_topic_0000002374856601.xml", "product_code":"modelarts", - "code":"187", + "code":"210", "des":"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", "doc_type":"api", "kw":"Querying Details About a Dataset Import Task,Data Management (Old Version),API Reference", @@ -3508,9 +3939,9 @@ }, { "uri":"GetExportTasksStatusOfDataset.html", - "node_id":"en-us_topic_0000002233769144.xml", + "node_id":"en-us_topic_0000002374856677.xml", "product_code":"modelarts", - "code":"188", + "code":"211", "des":"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", "doc_type":"api", "kw":"Querying the Dataset Export Task List,Data Management (Old Version),API Reference", @@ -3527,9 +3958,9 @@ }, { "uri":"ExportTask.html", - "node_id":"en-us_topic_0000002233928848.xml", + "node_id":"en-us_topic_0000002341058522.xml", "product_code":"modelarts", - "code":"189", + "code":"212", "des":"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", "doc_type":"api", "kw":"Creating a Dataset Export Task,Data Management (Old Version),API Reference", @@ -3546,9 +3977,9 @@ }, { "uri":"GetExportTaskStatusOfDataset.html", - "node_id":"en-us_topic_0000002268768153.xml", + "node_id":"en-us_topic_0000002340898638.xml", "product_code":"modelarts", - "code":"190", + "code":"213", "des":"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", "doc_type":"api", "kw":"Querying the Status of a Dataset Export Task,Data Management (Old Version),API Reference", @@ -3565,9 +3996,9 @@ }, { "uri":"SyncDataSource.html", - "node_id":"en-us_topic_0000002268848261.xml", + "node_id":"en-us_topic_0000002374856617.xml", "product_code":"modelarts", - "code":"191", + "code":"214", "des":"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", "doc_type":"api", "kw":"Synchronizing a Dataset,Data Management (Old Version),API Reference", @@ -3584,9 +4015,9 @@ }, { "uri":"SyncDataSourceState.html", - "node_id":"en-us_topic_0000002233769092.xml", + "node_id":"en-us_topic_0000002341058570.xml", "product_code":"modelarts", - "code":"192", + "code":"215", "des":"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", "doc_type":"api", "kw":"Querying the Status of a Dataset Synchronization Task,Data Management (Old Version),API Reference", @@ -3603,9 +4034,9 @@ }, { "uri":"ListAutoAnnotationSamples.html", - "node_id":"en-us_topic_0000002233928968.xml", + "node_id":"en-us_topic_0000002374896817.xml", "product_code":"modelarts", - "code":"193", + "code":"216", "des":"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", "doc_type":"api", "kw":"Obtaining an Auto Labeling Sample List,Data Management (Old Version),API Reference", @@ -3622,9 +4053,9 @@ }, { "uri":"DescribeAutoAnnotationSample.html", - "node_id":"en-us_topic_0000002268768313.xml", + "node_id":"en-us_topic_0000002341058538.xml", "product_code":"modelarts", - "code":"194", + "code":"217", "des":"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", "doc_type":"api", "kw":"Querying Details About an Auto Labeling Sample,Data Management (Old Version),API Reference", @@ -3641,9 +4072,9 @@ }, { "uri":"ListTasks.html", - "node_id":"en-us_topic_0000002233769120.xml", + "node_id":"en-us_topic_0000002341058586.xml", "product_code":"modelarts", - "code":"195", + "code":"218", "des":"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", "doc_type":"api", "kw":"Obtaining an Auto Labeling Task List by Page,Data Management (Old Version),API Reference", @@ -3660,9 +4091,9 @@ }, { "uri":"CreateTask.html", - "node_id":"en-us_topic_0000002233769136.xml", + "node_id":"en-us_topic_0000002340898826.xml", "product_code":"modelarts", - "code":"196", + "code":"219", "des":"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", "doc_type":"api", "kw":"Starting Intelligent Tasks,Data Management (Old Version),API Reference", @@ -3679,9 +4110,9 @@ }, { "uri":"AutoAnnotationProgress.html", - "node_id":"en-us_topic_0000002233768924.xml", + "node_id":"en-us_topic_0000002374856553.xml", "product_code":"modelarts", - "code":"197", + "code":"220", "des":"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 ", "doc_type":"api", "kw":"Obtaining Details About an Auto Labeling Task,Data Management (Old Version),API Reference", @@ -3698,9 +4129,9 @@ }, { "uri":"StopAutoAnnotation.html", - "node_id":"en-us_topic_0000002268848145.xml", + "node_id":"en-us_topic_0000002374896689.xml", "product_code":"modelarts", - "code":"198", + "code":"221", "des":"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", "doc_type":"api", "kw":"Stopping an Intelligent Task,Data Management (Old Version),API Reference", @@ -3717,9 +4148,9 @@ }, { "uri":"ListProcessorTasks.html", - "node_id":"en-us_topic_0000002233928900.xml", + "node_id":"en-us_topic_0000002374856633.xml", "product_code":"modelarts", - "code":"199", + "code":"222", "des":"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", "doc_type":"api", "kw":"Querying the List of a Processing Task,Data Management (Old Version),API Reference", @@ -3736,9 +4167,9 @@ }, { "uri":"CreateProcessorTask.html", - "node_id":"en-us_topic_0000002233768916.xml", + "node_id":"en-us_topic_0000002374856545.xml", "product_code":"modelarts", - "code":"200", + "code":"223", "des":"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 ", "doc_type":"api", "kw":"Creating a Processing Task,Data Management (Old Version),API Reference", @@ -3755,9 +4186,9 @@ }, { "uri":"GetProcessorTaskItems.html", - "node_id":"en-us_topic_0000002268848101.xml", + "node_id":"en-us_topic_0000002341058402.xml", "product_code":"modelarts", - "code":"201", + "code":"224", "des":"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", "doc_type":"api", "kw":"Querying the Algorithm Type for Data Processing,Data Management (Old Version),API Reference", @@ -3774,9 +4205,9 @@ }, { "uri":"DescribeProcessorTask.html", - "node_id":"en-us_topic_0000002268848253.xml", + "node_id":"en-us_topic_0000002374856613.xml", "product_code":"modelarts", - "code":"202", + "code":"225", "des":"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", "doc_type":"api", "kw":"Querying Details About a Processing Task,Data Management (Old Version),API Reference", @@ -3793,9 +4224,9 @@ }, { "uri":"UpdateProcessorTask.html", - "node_id":"en-us_topic_0000002233928764.xml", + "node_id":"en-us_topic_0000002341058470.xml", "product_code":"modelarts", - "code":"203", + "code":"226", "des":"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", "doc_type":"api", "kw":"Updating a Processing Task,Data Management (Old Version),API Reference", @@ -3812,9 +4243,9 @@ }, { "uri":"DeleteProcessorTask.html", - "node_id":"en-us_topic_0000002268848213.xml", + "node_id":"en-us_topic_0000002374896741.xml", "product_code":"modelarts", - "code":"204", + "code":"227", "des":"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", "doc_type":"api", "kw":"Deleting a Processing Task,Data Management (Old Version),API Reference", @@ -3831,9 +4262,9 @@ }, { "uri":"ListProcessorTaskVersions.html", - "node_id":"en-us_topic_0000002233769016.xml", + "node_id":"en-us_topic_0000002340898754.xml", "product_code":"modelarts", - "code":"205", + "code":"228", "des":"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", "doc_type":"api", "kw":"Querying the Version List of a Data Processing Task,Data Management (Old Version),API Reference", @@ -3850,9 +4281,9 @@ }, { "uri":"CreateProcessorTaskVersion.html", - "node_id":"en-us_topic_0000002268768393.xml", + "node_id":"en-us_topic_0000002374896813.xml", "product_code":"modelarts", - "code":"206", + "code":"229", "des":"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", "doc_type":"api", "kw":"Creating a Data Processing Task Version,Data Management (Old Version),API Reference", @@ -3869,9 +4300,9 @@ }, { "uri":"DescProcessorTaskVersion.html", - "node_id":"en-us_topic_0000002233928800.xml", + "node_id":"en-us_topic_0000002341058498.xml", "product_code":"modelarts", - "code":"207", + "code":"230", "des":"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", "doc_type":"api", "kw":"Querying the Details About the Version of a Data Processing Task,Data Management (Old Version),API R", @@ -3888,9 +4319,9 @@ }, { "uri":"DeleteProcessorTaskVersion.html", - "node_id":"en-us_topic_0000002268848245.xml", + "node_id":"en-us_topic_0000002374896757.xml", "product_code":"modelarts", - "code":"208", + "code":"231", "des":"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", "doc_type":"api", "kw":"Deleting a Data Processing Task Version,Data Management (Old Version),API Reference", @@ -3907,9 +4338,9 @@ }, { "uri":"ListProcessorTaskVersionResults.html", - "node_id":"en-us_topic_0000002268768425.xml", + "node_id":"en-us_topic_0000002340898830.xml", "product_code":"modelarts", - "code":"209", + "code":"232", "des":"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", "doc_type":"api", "kw":"Obtaining the Result of a Data Processing Task Version,Data Management (Old Version),API Reference", @@ -3926,9 +4357,9 @@ }, { "uri":"StopProcessorTaskVersion.html", - "node_id":"en-us_topic_0000002233768944.xml", + "node_id":"en-us_topic_0000002374856573.xml", "product_code":"modelarts", - "code":"210", + "code":"233", "des":"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", "doc_type":"api", "kw":"Stopping the Version of a Data Processing Task,Data Management (Old Version),API Reference", @@ -3945,9 +4376,9 @@ }, { "uri":"modelarts_03_0108.html", - "node_id":"en-us_topic_0000002233928916.xml", + "node_id":"en-us_topic_0000002374856641.xml", "product_code":"modelarts", - "code":"211", + "code":"234", "des":"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.", "doc_type":"api", "kw":"DevEnviron (Old Version)", @@ -3964,9 +4395,9 @@ }, { "uri":"modelarts_03_0110.html", - "node_id":"en-us_topic_0000002233928720.xml", + "node_id":"en-us_topic_0000002341058418.xml", "product_code":"modelarts", - "code":"212", + "code":"235", "des":"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", "doc_type":"api", "kw":"Creating a Development Environment Instance,DevEnviron (Old Version),API Reference", @@ -3983,9 +4414,9 @@ }, { "uri":"modelarts_03_0111.html", - "node_id":"en-us_topic_0000002233928868.xml", + "node_id":"en-us_topic_0000002374896765.xml", "product_code":"modelarts", - "code":"213", + "code":"236", "des":"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={", "doc_type":"api", "kw":"Obtaining Development Environment Instances,DevEnviron (Old Version),API Reference", @@ -4002,9 +4433,9 @@ }, { "uri":"modelarts_03_0112.html", - "node_id":"en-us_topic_0000002268768381.xml", + "node_id":"en-us_topic_0000002374896805.xml", "product_code":"modelarts", - "code":"214", + "code":"237", "des":"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", "doc_type":"api", "kw":"Obtaining Details About a Development Environment Instance,DevEnviron (Old Version),API Reference", @@ -4021,9 +4452,9 @@ }, { "uri":"modelarts_03_0113.html", - "node_id":"en-us_topic_0000002268768145.xml", + "node_id":"en-us_topic_0000002374856477.xml", "product_code":"modelarts", - "code":"215", + "code":"238", "des":"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", "doc_type":"api", "kw":"Modifying the Description of a Development Environment Instance,DevEnviron (Old Version),API Referen", @@ -4040,9 +4471,9 @@ }, { "uri":"modelarts_03_0114.html", - "node_id":"en-us_topic_0000002268768189.xml", + "node_id":"en-us_topic_0000002340898682.xml", "product_code":"modelarts", - "code":"216", + "code":"239", "des":"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", "doc_type":"api", "kw":"Deleting a Development Environment Instance,DevEnviron (Old Version),API Reference", @@ -4059,9 +4490,9 @@ }, { "uri":"modelarts_03_0115.html", - "node_id":"en-us_topic_0000002233768880.xml", + "node_id":"en-us_topic_0000002374856501.xml", "product_code":"modelarts", - "code":"217", + "code":"240", "des":"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", "doc_type":"api", "kw":"Managing a Development Environment Instance,DevEnviron (Old Version),API Reference", @@ -4078,9 +4509,9 @@ }, { "uri":"modelarts_03_0043.html", - "node_id":"en-us_topic_0000002268768197.xml", + "node_id":"en-us_topic_0000002340898690.xml", "product_code":"modelarts", - "code":"218", + "code":"241", "des":"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.", "doc_type":"api", "kw":"Training Management (Old Version)", @@ -4097,9 +4528,9 @@ }, { "uri":"modelarts_03_0044.html", - "node_id":"en-us_topic_0000002233928992.xml", + "node_id":"en-us_topic_0000002341058598.xml", "product_code":"modelarts", - "code":"219", + "code":"242", "des":"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.", "doc_type":"api", "kw":"Training Jobs", @@ -4116,9 +4547,9 @@ }, { "uri":"modelarts_03_0045.html", - "node_id":"en-us_topic_0000002233928724.xml", + "node_id":"en-us_topic_0000002341058426.xml", "product_code":"modelarts", - "code":"220", + "code":"243", "des":"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", "doc_type":"api", "kw":"Creating a Training Job,Training Jobs,API Reference", @@ -4135,9 +4566,9 @@ }, { "uri":"modelarts_03_0046.html", - "node_id":"en-us_topic_0000002233769008.xml", + "node_id":"en-us_topic_0000002374856605.xml", "product_code":"modelarts", - "code":"221", + "code":"244", "des":"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", "doc_type":"api", "kw":"Querying a Training Job List,Training Jobs,API Reference", @@ -4154,9 +4585,9 @@ }, { "uri":"modelarts_03_0047.html", - "node_id":"en-us_topic_0000002268768213.xml", + "node_id":"en-us_topic_0000002340898706.xml", "product_code":"modelarts", - "code":"222", + "code":"245", "des":"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", "doc_type":"api", "kw":"Querying the Details About a Training Job Version,Training Jobs,API Reference", @@ -4173,9 +4604,9 @@ }, { "uri":"modelarts_03_0048.html", - "node_id":"en-us_topic_0000002268848153.xml", + "node_id":"en-us_topic_0000002374896697.xml", "product_code":"modelarts", - "code":"223", + "code":"246", "des":"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", "doc_type":"api", "kw":"Deleting a Version of a Training Job,Training Jobs,API Reference", @@ -4192,9 +4623,9 @@ }, { "uri":"modelarts_03_0049.html", - "node_id":"en-us_topic_0000002233928776.xml", + "node_id":"en-us_topic_0000002341058486.xml", "product_code":"modelarts", - "code":"224", + "code":"247", "des":"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 ", "doc_type":"api", "kw":"Obtaining Training Job Versions,Training Jobs,API Reference", @@ -4211,9 +4642,9 @@ }, { "uri":"modelarts_03_0050.html", - "node_id":"en-us_topic_0000002268848193.xml", + "node_id":"en-us_topic_0000002374896729.xml", "product_code":"modelarts", - "code":"225", + "code":"248", "des":"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", "doc_type":"api", "kw":"Creating a Version of a Training Job,Training Jobs,API Reference", @@ -4230,9 +4661,9 @@ }, { "uri":"modelarts_03_0051.html", - "node_id":"en-us_topic_0000002268768289.xml", + "node_id":"en-us_topic_0000002340898750.xml", "product_code":"modelarts", - "code":"226", + "code":"249", "des":"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", "doc_type":"api", "kw":"Stopping a Training Job,Training Jobs,API Reference", @@ -4249,9 +4680,9 @@ }, { "uri":"modelarts_03_0052.html", - "node_id":"en-us_topic_0000002268768305.xml", + "node_id":"en-us_topic_0000002341058534.xml", "product_code":"modelarts", - "code":"227", + "code":"250", "des":"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", "doc_type":"api", "kw":"Modifying the Description of a Training Job,Training Jobs,API Reference", @@ -4268,9 +4699,9 @@ }, { "uri":"modelarts_03_0053.html", - "node_id":"en-us_topic_0000002233768892.xml", + "node_id":"en-us_topic_0000002340898666.xml", "product_code":"modelarts", - "code":"228", + "code":"251", "des":"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", "doc_type":"api", "kw":"Deleting a Training Job,Training Jobs,API Reference", @@ -4287,9 +4718,9 @@ }, { "uri":"modelarts_03_0054.html", - "node_id":"en-us_topic_0000002268848301.xml", + "node_id":"en-us_topic_0000002340898786.xml", "product_code":"modelarts", - "code":"229", + "code":"252", "des":"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", "doc_type":"api", "kw":"Obtaining the Name of a Training Job Log File,Training Jobs,API Reference", @@ -4306,9 +4737,9 @@ }, { "uri":"modelarts_03_0056.html", - "node_id":"en-us_topic_0000002268768181.xml", + "node_id":"en-us_topic_0000002340898674.xml", "product_code":"modelarts", - "code":"230", + "code":"253", "des":"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", "doc_type":"api", "kw":"Querying a Built-in Algorithm,Training Jobs,API Reference", @@ -4325,9 +4756,9 @@ }, { "uri":"modelarts_03_0149.html", - "node_id":"en-us_topic_0000002233928924.xml", + "node_id":"en-us_topic_0000002374856645.xml", "product_code":"modelarts", - "code":"231", + "code":"254", "des":"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 ", "doc_type":"api", "kw":"Querying Training Job Logs,Training Jobs,API Reference", @@ -4344,9 +4775,9 @@ }, { "uri":"modelarts_03_0057.html", - "node_id":"en-us_topic_0000002233769112.xml", + "node_id":"en-us_topic_0000002341058582.xml", "product_code":"modelarts", - "code":"232", + "code":"255", "des":"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.", "doc_type":"api", "kw":"Training Job Parameter Configuration", @@ -4362,9 +4793,9 @@ }, { "uri":"modelarts_03_0058.html", - "node_id":"en-us_topic_0000002233928792.xml", + "node_id":"en-us_topic_0000002341058494.xml", "product_code":"modelarts", - "code":"233", + "code":"256", "des":"This API is used to create a training job configuration.POST /v1/{project_id}/training-job-configsTable 1 describes the required parameters.ParametersParameterMandatoryTy", "doc_type":"api", "kw":"Creating a Training Job Configuration,Training Job Parameter Configuration,API Reference", @@ -4381,9 +4812,9 @@ }, { "uri":"modelarts_03_0059.html", - "node_id":"en-us_topic_0000002233928816.xml", + "node_id":"en-us_topic_0000002341058506.xml", "product_code":"modelarts", - "code":"234", + "code":"257", "des":"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", "doc_type":"api", "kw":"Querying a List of Training Job Configurations,Training Job Parameter Configuration,API Reference", @@ -4400,9 +4831,9 @@ }, { "uri":"modelarts_03_0060.html", - "node_id":"en-us_topic_0000002233928740.xml", + "node_id":"en-us_topic_0000002341058442.xml", "product_code":"modelarts", - "code":"235", + "code":"258", "des":"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", "doc_type":"api", "kw":"Modifying a Training Job Configuration,Training Job Parameter Configuration,API Reference", @@ -4419,9 +4850,9 @@ }, { "uri":"modelarts_03_0061.html", - "node_id":"en-us_topic_0000002233928732.xml", + "node_id":"en-us_topic_0000002341058434.xml", "product_code":"modelarts", - "code":"236", + "code":"259", "des":"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", "doc_type":"api", "kw":"Deleting a Training Job Configuration,Training Job Parameter Configuration,API Reference", @@ -4438,9 +4869,9 @@ }, { "uri":"modelarts_03_0062.html", - "node_id":"en-us_topic_0000002233769068.xml", + "node_id":"en-us_topic_0000002341058558.xml", "product_code":"modelarts", - "code":"237", + "code":"260", "des":"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 ", "doc_type":"api", "kw":"Querying the Details About a Training Job Configuration,Training Job Parameter Configuration,API Ref", @@ -4457,9 +4888,9 @@ }, { "uri":"modelarts_03_0063.html", - "node_id":"en-us_topic_0000002233928856.xml", + "node_id":"en-us_topic_0000002341058526.xml", "product_code":"modelarts", - "code":"238", + "code":"261", "des":"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.", "doc_type":"api", "kw":"Visualization Jobs", @@ -4476,9 +4907,9 @@ }, { "uri":"modelarts_03_0064.html", - "node_id":"en-us_topic_0000002233768872.xml", + "node_id":"en-us_topic_0000002374896629.xml", "product_code":"modelarts", - "code":"239", + "code":"262", "des":"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", "doc_type":"api", "kw":"Creating a Visualization Job,Visualization Jobs,API Reference", @@ -4495,9 +4926,9 @@ }, { "uri":"modelarts_03_0065.html", - "node_id":"en-us_topic_0000002268768225.xml", + "node_id":"en-us_topic_0000002340898718.xml", "product_code":"modelarts", - "code":"240", + "code":"263", "des":"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", "doc_type":"api", "kw":"Querying a Visualization Job List,Visualization Jobs,API Reference", @@ -4514,9 +4945,9 @@ }, { "uri":"modelarts_03_0066.html", - "node_id":"en-us_topic_0000002233768960.xml", + "node_id":"en-us_topic_0000002374856581.xml", "product_code":"modelarts", - "code":"241", + "code":"264", "des":"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", "doc_type":"api", "kw":"Querying the Details About a Visualization Job,Visualization Jobs,API Reference", @@ -4533,9 +4964,9 @@ }, { "uri":"modelarts_03_0067.html", - "node_id":"en-us_topic_0000002268848285.xml", + "node_id":"en-us_topic_0000002340898774.xml", "product_code":"modelarts", - "code":"242", + "code":"265", "des":"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", "doc_type":"api", "kw":"Modifying the Description of a Visualization Job,Visualization Jobs,API Reference", @@ -4552,9 +4983,9 @@ }, { "uri":"modelarts_03_0068.html", - "node_id":"en-us_topic_0000002268768357.xml", + "node_id":"en-us_topic_0000002374896793.xml", "product_code":"modelarts", - "code":"243", + "code":"266", "des":"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 ", "doc_type":"api", "kw":"Deleting a Visualization Job,Visualization Jobs,API Reference", @@ -4571,9 +5002,9 @@ }, { "uri":"modelarts_03_0069.html", - "node_id":"en-us_topic_0000002268768389.xml", + "node_id":"en-us_topic_0000002374896809.xml", "product_code":"modelarts", - "code":"244", + "code":"267", "des":"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", "doc_type":"api", "kw":"Stopping a Visualization Job,Visualization Jobs,API Reference", @@ -4590,9 +5021,9 @@ }, { "uri":"modelarts_03_0070.html", - "node_id":"en-us_topic_0000002268848269.xml", + "node_id":"en-us_topic_0000002374856621.xml", "product_code":"modelarts", - "code":"245", + "code":"268", "des":"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", "doc_type":"api", "kw":"Restarting a Visualization Job,Visualization Jobs,API Reference", @@ -4609,9 +5040,9 @@ }, { "uri":"modelarts_03_0071.html", - "node_id":"en-us_topic_0000002233928808.xml", + "node_id":"en-us_topic_0000002341058502.xml", "product_code":"modelarts", - "code":"246", + "code":"269", "des":"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.", "doc_type":"api", "kw":"Resource and Engine Specifications", @@ -4627,9 +5058,9 @@ }, { "uri":"modelarts_03_0072.html", - "node_id":"en-us_topic_0000002233928832.xml", + "node_id":"en-us_topic_0000002341058514.xml", "product_code":"modelarts", - "code":"247", + "code":"270", "des":"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", "doc_type":"api", "kw":"Querying Job Resource Specifications,Resource and Engine Specifications,API Reference", @@ -4646,9 +5077,9 @@ }, { "uri":"modelarts_03_0073.html", - "node_id":"en-us_topic_0000002268848201.xml", + "node_id":"en-us_topic_0000002374896733.xml", "product_code":"modelarts", - "code":"248", + "code":"271", "des":"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 ", "doc_type":"api", "kw":"Querying Job Engine Specifications,Resource and Engine Specifications,API Reference", @@ -4665,9 +5096,9 @@ }, { "uri":"modelarts_03_0074.html", - "node_id":"en-us_topic_0000002233928960.xml", + "node_id":"en-us_topic_0000002374856665.xml", "product_code":"modelarts", - "code":"249", + "code":"272", "des":"Table 1 describes the job statuses.", "doc_type":"api", "kw":"Job Statuses,Training Management (Old Version),API Reference", diff --git a/docs/modelarts/api-ref/AcceptSamples.html b/docs/modelarts/api-ref/AcceptSamples.html index 3b8f365d6..22f482a38 100644 --- a/docs/modelarts/api-ref/AcceptSamples.html +++ b/docs/modelarts/api-ref/AcceptSamples.html @@ -1,11 +1,11 @@ - +

Submitting Sample Review Comments of an Acceptance Task

Function

This API is used to submit sample review comments of an acceptance task.

-

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

-

URI

POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-comment

+

URI

POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-comment

@@ -49,7 +49,7 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Table 2 Request body parameters

Parameter

+
@@ -63,7 +63,7 @@ - @@ -72,7 +72,7 @@
Table 2 Request body parameters

Parameter

Mandatory

Yes

Array of SampleComment objects

+

Array of SampleComment objects

Review comment list.

-
Table 3 SampleComment

Parameter

+
@@ -152,7 +152,7 @@
{ }

Status Codes

-
Table 3 SampleComment

Parameter

Mandatory

Status Code

+
diff --git a/docs/modelarts/api-ref/AttachObs.html b/docs/modelarts/api-ref/AttachObs.html index 329e69f99..ae5a55a67 100644 --- a/docs/modelarts/api-ref/AttachObs.html +++ b/docs/modelarts/api-ref/AttachObs.html @@ -1,11 +1,11 @@ - +

OBS Storage Mounting

Function

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 be read and written in the container as a file system.

Constraints

None

-

URI

POST /v1/{project_id}/notebooks/{instance_id}/storage

+

URI

POST /v1/{project_id}/notebooks/{instance_id}/storage

Status Code

Description

@@ -40,7 +40,7 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Table 2 Request body parameters

Parameter

+
@@ -83,7 +83,7 @@

Response Parameters

Status code: 200

-
Table 2 Request body parameters

Parameter

Mandatory

Table 3 Response body parameters

Parameter

+
@@ -155,7 +155,7 @@ }

Status Codes

-
Table 3 Response body parameters

Parameter

Type

Status Code

+
diff --git a/docs/modelarts/api-ref/AutoAnnotationProgress.html b/docs/modelarts/api-ref/AutoAnnotationProgress.html index a9afe0fd0..877bafbbf 100644 --- a/docs/modelarts/api-ref/AutoAnnotationProgress.html +++ b/docs/modelarts/api-ref/AutoAnnotationProgress.html @@ -1,178 +1,178 @@ - +

Obtaining Details About an Auto Labeling Task

-

Function

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 task.

+

Function

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 task.

-

Debugging

You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SDK code example debugging.

+

Debugging

You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SDK code example debugging.

-

URI

GET /v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}

+

URI

GET /v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}

-

Status Code

Description

Table 1 URI parameters

Parameter

+
- - - - - - - - - - - - - - -
Table 1 URI parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

dataset_id

+

dataset_id

Yes

+

Yes

String

+

String

Dataset ID

+

Dataset ID

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details, see Obtaining a Project ID and Name.

+

Project ID. For details, see Obtaining a Project ID and Name.

task_id

+

task_id

Yes

+

Yes

String

+

String

Task ID

+

Task ID

-

Request Parameters

None

+

Request Parameters

None

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 2 Response body parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -180,572 +180,572 @@
Table 2 Response body parameters

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

Task running status code

+

Task running status code

config

+

config

SmartTaskConfig object

+

SmartTaskConfig object

Task configuration

+

Task configuration

create_time

+

create_time

String

+

String

Task creation time

+

Task creation time

elapsed_time

+

elapsed_time

Long

+

Long

Execution time

+

Execution time

error_code

+

error_code

String

+

String

Error code

+

Error code

error_detail

+

error_detail

String

+

String

Error details

+

Error details

error_msg

+

error_msg

String

+

String

Error message

+

Error message

message

+

message

String

+

String

Task running information.

+

Task running information.

progress

+

progress

Float

+

Float

Percentage of current task progress.

+

Percentage of current task progress.

resource_id

+

resource_id

String

+

String

Resource ID.

+

Resource ID.

result

+

result

Result object

+

Result object

Task result.

+

Task result.

status

+

status

Integer

+

Integer

Task status. Options:

-
  • -1: queuing

    -
  • 0: initializing

    -
  • 1: running

    -
  • 2: failed

    -
  • 3: succeeded

    -
  • 4: stopping

    -
  • 5: stopped

    +

Task status. Options:

+
  • -1: queuing

    +
  • 0: initializing

    +
  • 1: running

    +
  • 2: failed

    +
  • 3: succeeded

    +
  • 4: stopping

    +
  • 5: stopped

task_id

+

task_id

String

+

String

Task ID

+

Task ID

task_name

+

task_name

String

+

String

Task name

+

Task name

export_type

+

export_type

Integer

+

Integer

Export type. Options: Options:

-
  • 0: Export to OBS.

    -
  • 1: Export to sample attributes.

    +

Export type. Options: Options:

+
  • 0: Export to OBS.

    +
  • 1: Export to sample attributes.

-
Table 3 SmartTaskConfig

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 SmartTaskConfig

Parameter

Type

+

Type

Description

+

Description

algorithm_type

+

algorithm_type

String

+

String

Algorithm type for auto labeling. Options:

-
  • fast: Only labeled samples are used for training.

    -
  • accurate: Unlabeled samples are also used for semi-supervised training.

    +

Algorithm type for auto labeling. Options:

+
  • fast: Only labeled samples are used for training.

    +
  • accurate: Unlabeled samples are also used for semi-supervised training.

ambiguity

+

ambiguity

Boolean

+

Boolean

Whether to perform clustering based on the image blurring degree.

+

Whether to perform clustering based on the image blurring degree.

annotation_output

+

annotation_output

String

+

String

Output path of the active learning labeling result

+

Output path of the active learning labeling result

collect_rule

+

collect_rule

String

+

String

Sample collection rule. The default value is all, indicating full collection. Only all is available.

+

Sample collection rule. The default value is all, indicating full collection. Only all is available.

collect_sample

+

collect_sample

Boolean

+

Boolean

Whether to enable sample collection. Options:

-
  • true: Sample collection is enabled. (Default)

    -
  • false: Sample collection is disabled.

    +

Whether to enable sample collection. Options:

+
  • true: Sample collection is enabled. (Default)

    +
  • false: Sample collection is disabled.

confidence_scope

+

confidence_scope

String

+

String

Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90.

+

Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90.

description

+

description

String

+

String

Job description

+

Job description

engine_name

+

engine_name

String

+

String

Engine name

+

Engine name

export_format

+

export_format

Integer

+

Integer

Format of the exported directory. Options:

-
  • 1: tree structure, for example, rabbits/1.jpg,bees/2.jpg.

    -
  • 2: tile structure, for example, 1.jpg, 1.txt; 2.jpg, 2.txt

    +

Format of the exported directory. Options:

+
  • 1: tree structure, for example, rabbits/1.jpg,bees/2.jpg.

    +
  • 2: tile structure, for example, 1.jpg, 1.txt; 2.jpg, 2.txt

export_params

+

export_params

ExportParams object

+

ExportParams object

Parameters of a dataset export task

+

Parameters of a dataset export task

flavor

+

flavor

Flavor object

+

Flavor object

Training resource flavor

+

Training resource flavor

image_brightness

+

image_brightness

Boolean

+

Boolean

Whether to perform clustering based on the image brightness

+

Whether to perform clustering based on the image brightness

image_colorfulness

+

image_colorfulness

Boolean

+

Boolean

Whether to perform clustering based on the image color

+

Whether to perform clustering based on the image color

inf_cluster_id

+

inf_cluster_id

String

+

String

ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using a dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the vpc_id parameter does not take effect.

+

ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using a dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the vpc_id parameter does not take effect.

inf_config_list

+

inf_config_list

Array of InfConfig objects

+

Array of InfConfig objects

Configuration list required for running an inference job, which is optional and left blank by default

+

Configuration list required for running an inference job, which is optional and left blank by default

inf_output

+

inf_output

String

+

String

Output path of inference in active learning

+

Output path of inference in active learning

infer_result_output_dir

+

infer_result_output_dir

String

+

String

OBS directory for storing sample prediction results. This parameter is optional. The {service_id}-infer-result subdirectory in the output_dir directory is used by default.

+

OBS directory for storing sample prediction results. This parameter is optional. The {service_id}-infer-result subdirectory in the output_dir directory is used by default.

key_sample_output

+

key_sample_output

String

+

String

Output path of hard examples in active learning

+

Output path of hard examples in active learning

log_url

+

log_url

String

+

String

OBS URL of the logs of a training job. By default, this parameter is left blank.

+

OBS URL of the logs of a training job. By default, this parameter is left blank.

manifest_path

+

manifest_path

String

+

String

Path of the manifest file, which is used as the input for training and inference

+

Path of the manifest file, which is used as the input for training and inference

model_id

+

model_id

String

+

String

Model ID

+

Model ID

model_name

+

model_name

String

+

String

Model name

+

Model name

model_parameter

+

model_parameter

String

+

String

Model parameters

+

Model parameters

model_version

+

model_version

String

+

String

Model version

+

Model version

n_clusters

+

n_clusters

Integer

+

Integer

Number of clusters

+

Number of clusters

name

+

name

String

+

String

Task name

+

Task name

output_dir

+

output_dir

String

+

String

Sample output path. The format is as follows: Dataset output path/Dataset name-Dataset ID/annotation/auto-deploy/. Example: /test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/.

+

Sample output path. The format is as follows: Dataset output path/Dataset name-Dataset ID/annotation/auto-deploy/. Example: /test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/.

parameters

+

parameters

Array of TrainingParameter objects

+

Array of TrainingParameter objects

Running parameters of a training job

+

Running parameters of a training job

pool_id

+

pool_id

String

+

String

Resource pool ID

+

Resource pool ID

property

+

property

String

+

String

Attribute name

+

Attribute name

req_uri

+

req_uri

String

+

String

Inference path of a batch job

+

Inference path of a batch job

result_type

+

result_type

Integer

+

Integer

Processing mode of auto grouping results. Options:

-
  • 0: The results are saved to OBS.

    -
  • 1: The results are saved to samples.

    +

Processing mode of auto grouping results. Options:

+
  • 0: The results are saved to OBS.

    +
  • 1: The results are saved to samples.

samples

+

samples

Array of SampleLabels objects

+

Array of SampleLabels objects

Labeling information for samples to be auto labeled

+

Labeling information for samples to be auto labeled

stop_time

+

stop_time

Integer

+

Integer

Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos.

+

Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos.

time

+

time

String

+

String

Timestamp in active learning

+

Timestamp in active learning

train_data_path

+

train_data_path

String

+

String

Path for storing existing training datasets

+

Path for storing existing training datasets

train_url

+

train_url

String

+

String

OBS URL of the output file of a training job. By default, this parameter is left blank.

+

OBS URL of the output file of a training job. By default, this parameter is left blank.

version_format

+

version_format

String

+

String

Format of a dataset version. Options:

-
  • Default

    -
  • CarbonData (supported only by table datasets)

    -
  • CSV

    +

Format of a dataset version. Options:

+
  • Default

    +
  • CarbonData (supported only by table datasets)

    +
  • CSV

worker_server_num

+

worker_server_num

Integer

+

Integer

Number of workers in a training job

+

Number of workers in a training job

-
Table 4 ExportParams

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 ExportParams

Parameter

Type

+

Type

Description

+

Description

clear_hard_property

+

clear_hard_property

Boolean

+

Boolean

Whether to clear hard example attributes. Options:

-
  • true: Hard example attributes are cleared. (Default)

    -
  • false: Hard example attributes are not cleared.

    +

Whether to clear hard example attributes. Options:

+
  • true: Hard example attributes are cleared. (Default)

    +
  • false: Hard example attributes are not cleared.

export_dataset_version_format

+

export_dataset_version_format

String

+

String

Format of the dataset version to be exported

+

Format of the dataset version to be exported

export_dataset_version_name

+

export_dataset_version_name

String

+

String

Name of the dataset version to be exported

+

Name of the dataset version to be exported

export_dest

+

export_dest

String

+

String

Dataset export type. Options:

-
  • DIR: Export to OBS. (default)

    -
  • NEW_DATASET: Export to a new dataset.

    +

Dataset export type. Options:

+
  • DIR: Export to OBS. (default)

    +
  • NEW_DATASET: Export to a new dataset.

export_new_dataset_name

+

export_new_dataset_name

String

+

String

Name of the new dataset to which data is exported

+

Name of the new dataset to which data is exported

export_new_dataset_work_path

+

export_new_dataset_work_path

String

+

String

Working directory of the new dataset to which data is exported

+

Working directory of the new dataset to which data is exported

ratio_sample_usage

+

ratio_sample_usage

Boolean

+

Boolean

Whether to randomly allocate data to the training and validation datasets based on the specified ratio. Options:

-
  • true: The data is randomly allocated to the training and validation datasets.

    -
  • false: The data is not randomly allocated to the training and validation datasets. (Default)

    +

Whether to randomly allocate data to the training and validation datasets based on the specified ratio. Options:

+
  • true: The data is randomly allocated to the training and validation datasets.

    +
  • false: The data is not randomly allocated to the training and validation datasets. (Default)

sample_state

+

sample_state

String

+

String

Sample status. Options:

-
  • __ALL__: labeled

    -
  • __NONE__: unlabeled

    -
  • __UNCHECK__: to be accepted

    -
  • __ACCEPTED__: accepted

    -
  • __REJECTED__: rejected

    -
  • __UNREVIEWED__: to be reviewed

    -
  • __REVIEWED__: reviewed

    -
  • __WORKFORCE_SAMPLED__: sampled

    -
  • __WORKFORCE_SAMPLED_UNCHECK__: sampling pending check

    -
  • __WORKFORCE_SAMPLED_CHECKED__: sampling checked

    -
  • __WORKFORCE_SAMPLED_ACCEPTED__: sampling accepted

    -
  • __WORKFORCE_SAMPLED_REJECTED__: sampling rejected

    -
  • __AUTO_ANNOTATION__: to be confirmed

    +

Sample status. Options:

+
  • __ALL__: labeled

    +
  • __NONE__: unlabeled

    +
  • __UNCHECK__: to be accepted

    +
  • __ACCEPTED__: accepted

    +
  • __REJECTED__: rejected

    +
  • __UNREVIEWED__: to be reviewed

    +
  • __REVIEWED__: reviewed

    +
  • __WORKFORCE_SAMPLED__: sampled

    +
  • __WORKFORCE_SAMPLED_UNCHECK__: sampling pending check

    +
  • __WORKFORCE_SAMPLED_CHECKED__: sampling checked

    +
  • __WORKFORCE_SAMPLED_ACCEPTED__: sampling accepted

    +
  • __WORKFORCE_SAMPLED_REJECTED__: sampling rejected

    +
  • __AUTO_ANNOTATION__: to be confirmed

samples

+

samples

Array of strings

+

Array of strings

ID list of exported samples

+

ID list of exported samples

search_conditions

+

search_conditions

Array of SearchCondition objects

+

Array of SearchCondition objects

Exported search criteria. Multiple search criteria are in the OR relationship.

+

Exported search criteria. Multiple search criteria are in the OR relationship.

train_sample_ratio

+

train_sample_ratio

String

+

String

Split ratio of training and validation datasets for specified version release. The default value is 1.00, indicating that all data is allocated to the training dataset.

+

Split ratio of training and validation datasets for specified version release. The default value is 1.00, indicating that all data is allocated to the training dataset.

-
Table 5 SearchCondition

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 SearchCondition

Parameter

Type

+

Type

Description

+

Description

coefficient

+

coefficient

String

+

String

Filter by difficulty coefficient

+

Filter by difficulty coefficient

frame_in_video

+

frame_in_video

Integer

+

Integer

A frame in the video

+

A frame in the video

hard

+

hard

String

+

String

Whether a sample is a hard example. Options:

-
  • 0: The label is not a hard example.

    -
  • 1: The label is a hard example.

    +

Whether a sample is a hard example. Options:

+
  • 0: The label is not a hard example.

    +
  • 1: The label is a hard example.

import_origin

+

import_origin

String

+

String

Filter by data source

+

Filter by data source

kvp

+

kvp

String

+

String

CT dosage, filtered by dosage.

+

CT dosage, filtered by dosage.

label_list

+

label_list

SearchLabels object

+

SearchLabels object

Label search criteria

+

Label search criteria

labeler

+

labeler

String

+

String

Annotator

+

Annotator

metadata

+

metadata

SearchProp object

+

SearchProp object

Search by sample attribute

+

Search by sample attribute

parent_sample_id

+

parent_sample_id

String

+

String

Parent sample ID

+

Parent sample ID

sample_dir

+

sample_dir

String

+

String

Directory where samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported.

+

Directory where samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported.

sample_name

+

sample_name

String

+

String

Search by sample name, including the file name extension

+

Search by sample name, including the file name extension

sample_time

+

sample_time

String

+

String

When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. Options:

-
  • month: Search for samples added in the last 30 days

    -
  • day: Search for samples added from yesterday (one day before) to today.

    -
  • yyyyMMdd-yyyyMMdd: Search for samples added in a specified period. The format is Start date-End date. Maximum number of days for the search: 30. For example, 20190901-2019091501 indicates that samples generated from September 1 to September 15, 2019 are searched for.

    +

When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. Options:

+
  • month: Search for samples added in the last 30 days

    +
  • day: Search for samples added from yesterday (one day before) to today.

    +
  • yyyyMMdd-yyyyMMdd: Search for samples added in a specified period. The format is Start date-End date. Maximum number of days for the search: 30. For example, 20190901-2019091501 indicates that samples generated from September 1 to September 15, 2019 are searched for.

score

+

score

String

+

String

Search by confidence

+

Search by confidence

slice_thickness

+

slice_thickness

String

+

String

DICOM layer thickness. Samples are filtered by layer thickness.

+

DICOM layer thickness. Samples are filtered by layer thickness.

study_date

+

study_date

String

+

String

DICOM scanning time

+

DICOM scanning time

time_in_video

+

time_in_video

String

+

String

A time point in the video

+

A time point in the video

-
Table 6 SearchLabels

Parameter

+
- - - - - - - - @@ -753,54 +753,54 @@
Table 6 SearchLabels

Parameter

Type

+

Type

Description

+

Description

labels

+

labels

Array of SearchLabel objects

+

Array of SearchLabel objects

Label search criteria

+

Label search criteria

op

+

op

String

+

String

If you want to search for multiple labels, op must be specified. If you search for only one label, op can be left blank. Options:

-
  • OR: OR operation

    -
  • AND: AND operation

    +

If you want to search for multiple labels, op must be specified. If you search for only one label, op can be left blank. Options:

+
  • OR: OR operation

    +
  • AND: AND operation

-
Table 7 SearchLabel

Parameter

+
- - - - - - - - - - - - - - @@ -808,428 +808,428 @@
Table 7 SearchLabel

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Label name

+

Label name

op

+

op

String

+

String

Operation type between multiple attributes. Options:

-
  • OR: OR operation

    -
  • AND: AND operation

    +

Operation type between multiple attributes. Options:

+
  • OR: OR operation

    +
  • AND: AND operation

property

+

property

Map<String,Array<String>>

+

Map<String,Array<String>>

Label attribute, which is in the Object format and stores any key-value pairs. key indicates the attribute name, and value indicates the value list. If value is null, the search is not performed by value. Otherwise, the search value can be any value in the list.

+

Label attribute, which is in the Object format and stores any key-value pairs. key indicates the attribute name, and value indicates the value list. If value is null, the search is not performed by value. Otherwise, the search value can be any value in the list.

type

+

type

Integer

+

Integer

Label type. Options:

-
  • 0: image classification

    -
  • 1: object detection

    -
  • 3: image segmentation

    -
  • 100: text classification

    -
  • 101: named entity recognition

    -
  • 102: text triplet relationship

    -
  • 103: text triplet entity

    -
  • 200: sound classification

    -
  • 201: speech content

    -
  • 202: speech paragraph labeling

    -
  • 600: video labeling

    +

Label type. Options:

+
  • 0: image classification

    +
  • 1: object detection

    +
  • 3: image segmentation

    +
  • 100: text classification

    +
  • 101: named entity recognition

    +
  • 102: text triplet relationship

    +
  • 103: text triplet entity

    +
  • 200: sound classification

    +
  • 201: speech content

    +
  • 202: speech paragraph labeling

    +
  • 600: video labeling

-
Table 8 SearchProp

Parameter

+
- - - - - - - -
Table 8 SearchProp

Parameter

Type

+

Type

Description

+

Description

op

+

op

String

+

String

Relationship between attribute values. Options:

-
  • AND: AND relationship

    -
  • OR: OR relationship

    +

Relationship between attribute values. Options:

+
  • AND: AND relationship

    +
  • OR: OR relationship

props

+

props

Map<String,Array<String>>

+

Map<String,Array<String>>

Search criteria of an attribute. Multiple search criteria can be set.

+

Search criteria of an attribute. Multiple search criteria can be set.

-
Table 9 Flavor

Parameter

+
- - - - -
Table 9 Flavor

Parameter

Type

+

Type

Description

+

Description

code

+

code

String

+

String

Attribute code of a resource specification, which is used for task creating

+

Attribute code of a resource specification, which is used for task creating

-
Table 10 InfConfig

Parameter

+
- - - - - - - - - - - - - - - - -
Table 10 InfConfig

Parameter

Type

+

Type

Description

+

Description

envs

+

envs

Map<String,String>

+

Map<String,String>

Environment variable key-value pair required for running a model. This parameter is optional. By default, it is left blank. To ensure data security, do not enter sensitive information in environment variables.

+

Environment variable key-value pair required for running a model. This parameter is optional. By default, it is left blank. To ensure data security, do not enter sensitive information in environment variables.

instance_count

+

instance_count

Integer

+

Integer

Number of instances (compute nodes) for deploying a model

+

Number of instances (compute nodes) for deploying a model

model_id

+

model_id

String

+

String

Model ID

+

Model ID

specification

+

specification

String

+

String

Resource specifications of real-time services. For details, see Deploying a Service.

+

Resource specifications of real-time services. For details, see Deploying a Service.

weight

+

weight

Integer

+

Integer

Traffic weight allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of the weights must be 100.

+

Traffic weight allocated to a model. This parameter is mandatory only when infer_type is set to real-time. The sum of the weights must be 100.

-
Table 11 TrainingParameter

Parameter

+
- - - - - - - -
Table 11 TrainingParameter

Parameter

Type

+

Type

Description

+

Description

label

+

label

String

+

String

Parameter name

+

Parameter name

value

+

value

String

+

String

Parameter value

+

Parameter value

-
Table 12 Result

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 12 Result

Parameter

Type

+

Type

Description

+

Description

annotated_sample_count

+

annotated_sample_count

Integer

+

Integer

Number of labeled samples.

+

Number of labeled samples.

confidence_scope

+

confidence_scope

String

+

String

Confidence. The value ranges from 0 to 1.

+

Confidence. The value ranges from 0 to 1.

dataset_name

+

dataset_name

String

+

String

Dataset name

+

Dataset name

dataset_type

+

dataset_type

String

+

String

Dataset type. Options:

-
  • 0: image classification

    -
  • 1: object detection

    -
  • 3: image segmentation

    -
  • 100: text classification

    -
  • 101: named entity recognition

    -
  • 102: text triplet

    -
  • 200: sound classification

    -
  • 201: speech content

    -
  • 202: speech paragraph labeling

    -
  • 400: table dataset

    -
  • 600: video labeling

    -
  • 900: free format

    +

Dataset type. Options:

+
  • 0: image classification

    +
  • 1: object detection

    +
  • 3: image segmentation

    +
  • 100: text classification

    +
  • 101: named entity recognition

    +
  • 102: text triplet

    +
  • 200: sound classification

    +
  • 201: speech content

    +
  • 202: speech paragraph labeling

    +
  • 400: table dataset

    +
  • 600: video labeling

    +
  • 900: free format

description

+

description

String

+

String

Result description

+

Result description

dlf_model_job_name

+

dlf_model_job_name

String

+

String

DLF model inference job name

+

DLF model inference job name

dlf_service_job_name

+

dlf_service_job_name

String

+

String

DLF real-time service job name

+

DLF real-time service job name

dlf_train_job_name

+

dlf_train_job_name

String

+

String

DLF training job name

+

DLF training job name

events

+

events

Array of Event objects

+

Array of Event objects

Event

+

Event

hard_example_path

+

hard_example_path

String

+

String

Path for storing hard examples

+

Path for storing hard examples

hard_select_tasks

+

hard_select_tasks

Array of HardSelectTask objects

+

Array of HardSelectTask objects

List of selected hard example jobs

+

List of selected hard example jobs

manifest_path

+

manifest_path

String

+

String

Path for storing the manifest files

+

Path for storing the manifest files

model_id

+

model_id

String

+

String

Model ID

+

Model ID

model_name

+

model_name

String

+

String

Model name

+

Model name

model_version

+

model_version

String

+

String

Model version

+

Model version

samples

+

samples

Array of SampleLabels objects

+

Array of SampleLabels objects

Inference result of the real-time video service.

+

Inference result of the real-time video service.

service_id

+

service_id

String

+

String

Real-time service ID

+

Real-time service ID

service_name

+

service_name

String

+

String

Real-time service name

+

Real-time service name

service_resource

+

service_resource

String

+

String

ID of the real-time service bound to a user.

+

ID of the real-time service bound to a user.

total_sample_count

+

total_sample_count

Integer

+

Integer

Total number of samples

+

Total number of samples

train_data_path

+

train_data_path

String

+

String

Path for storing training data

+

Path for storing training data

train_job_id

+

train_job_id

String

+

String

Training job ID

+

Training job ID

train_job_name

+

train_job_name

String

+

String

Training job name

+

Training job name

unconfirmed_sample_count

+

unconfirmed_sample_count

Integer

+

Integer

Number of samples to be confirmed

+

Number of samples to be confirmed

version_id

+

version_id

String

+

String

Dataset version ID

+

Dataset version ID

version_name

+

version_name

String

+

String

Dataset version name

+

Dataset version name

workspace_id

+

workspace_id

String

+

String

Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

+

Workspace ID. If no workspace is created, the default value is 0. If a workspace is created and used, use the actual value.

-
Table 13 Event

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1237,202 +1237,202 @@
Table 13 Event

Parameter

Type

+

Type

Description

+

Description

create_time

+

create_time

Long

+

Long

Event creation time

+

Event creation time

description

+

description

String

+

String

Event description

+

Event description

elapsed_time

+

elapsed_time

Long

+

Long

Time when an event is executed

+

Time when an event is executed

error_code

+

error_code

String

+

String

Error code

+

Error code

error_message

+

error_message

String

+

String

Error message

+

Error message

events

+

events

Array of Event objects

+

Array of Event objects

List of sub-events

+

List of sub-events

level

+

level

Integer

+

Integer

Event severity.

+

Event severity.

name

+

name

String

+

String

Event name

+

Event name

ordinal

+

ordinal

Integer

+

Integer

Sequence number.

+

Sequence number.

parent_name

+

parent_name

String

+

String

Parent event name.

+

Parent event name.

status

+

status

String

+

String

Event status. Options:

-
  • waiting: DCS instance restoration is waiting to begin.

    -
  • running

    -
  • failed: indicates that a job fails to be processed.

    -
  • success: The subtask is successfully executed.

    +

Event status. Options:

+
  • waiting: DCS instance restoration is waiting to begin.

    +
  • running

    +
  • failed: indicates that a job fails to be processed.

    +
  • success: The subtask is successfully executed.

-
Table 14 HardSelectTask

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 14 HardSelectTask

Parameter

Type

+

Type

Description

+

Description

create_at

+

create_at

Long

+

Long

Task creation time

+

Task creation time

dataset_id

+

dataset_id

String

+

String

Dataset ID

+

Dataset ID

dataset_name

+

dataset_name

String

+

String

Dataset name

+

Dataset name

hard_select_task_id

+

hard_select_task_id

String

+

String

ID of selected hard example task

+

ID of selected hard example task

task_status

+

task_status

String

+

String

Task status

+

Task status

time

+

time

Long

+

Long

Execution time

+

Execution time

update_at

+

update_at

Long

+

Long

Task update time

+

Task update time

-
Table 15 SampleLabels

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 15 SampleLabels

Parameter

Type

+

Type

Description

+

Description

labels

+

labels

Array of SampleLabel objects

+

Array of SampleLabel objects

List of sample labels. If this parameter is left blank, all sample labels are deleted.

+

List of sample labels. If this parameter is left blank, all sample labels are deleted.

metadata

+

metadata

SampleMetadata object

+

SampleMetadata object

Attribute key-value pair of the sample metadata

+

Attribute key-value pair of the sample metadata

sample_id

+

sample_id

String

+

String

Sample ID

+

Sample ID

sample_type

+

sample_type

Integer

+

Integer

Sample type. Options:

-
  • 0: image

    -
  • 1: text

    -
  • 2: audio

    -
  • 4: table

    -
  • 6: video

    -
  • 9: free format

    +

Sample type. Options:

+
  • 0: image

    +
  • 1: text

    +
  • 2: audio

    +
  • 4: table

    +
  • 6: video

    +
  • 9: free format

sample_usage

+

sample_usage

String

+

String

Sample usage. Options:

-
  • TRAIN: training

    -
  • EVAL: validation

    -
  • TEST: test

    -
  • INFERENCE: inference

    +

Sample usage. Options:

+
  • TRAIN: training

    +
  • EVAL: validation

    +
  • TEST: test

    +
  • INFERENCE: inference

source

+

source

String

+

String

Source address of sample data, which can be obtained by calling the sample list API.

+

Source address of sample data, which can be obtained by calling the sample list API.

worker_id

+

worker_id

String

+

String

ID of a labeling team member

+

ID of a labeling team member

-
Table 16 SampleLabel

Parameter

+
- - - - - - - - - - - - - - - - - - - - @@ -1440,251 +1440,251 @@
Table 16 SampleLabel

Parameter

Type

+

Type

Description

+

Description

annotated_by

+

annotated_by

String

+

String

Video labeling method, which is used to determine whether a video is labeled manually or automatically. Options:

-
  • human: manual labeling

    -
  • auto: auto labeling

    +

Video labeling method, which is used to determine whether a video is labeled manually or automatically. Options:

+
  • human: manual labeling

    +
  • auto: auto labeling

id

+

id

String

+

String

Label ID

+

Label ID

name

+

name

String

+

String

Label name

+

Label name

property

+

property

SampleLabelProperty object

+

SampleLabelProperty object

Attribute key-value pair of the sample label, such as the object shape and shape feature

+

Attribute key-value pair of the sample label, such as the object shape and shape feature

score

+

score

Float

+

Float

Confidence. The value ranges from 0 to 1.

+

Confidence. The value ranges from 0 to 1.

type

+

type

Integer

+

Integer

Label type. Options:

-
  • 0: image classification

    -
  • 1: object detection

    -
  • 3: image segmentation

    -
  • 100: text classification

    -
  • 101: named entity recognition

    -
  • 102: text triplet relationship

    -
  • 103: text triplet entity

    -
  • 200: sound classification

    -
  • 201: speech content

    -
  • 202: speech paragraph labeling

    -
  • 600: video labeling

    +

Label type. Options:

+
  • 0: image classification

    +
  • 1: object detection

    +
  • 3: image segmentation

    +
  • 100: text classification

    +
  • 101: named entity recognition

    +
  • 102: text triplet relationship

    +
  • 103: text triplet entity

    +
  • 200: sound classification

    +
  • 201: speech content

    +
  • 202: speech paragraph labeling

    +
  • 600: video labeling

-
Table 17 SampleLabelProperty

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 SampleLabelProperty

Parameter

Type

+

Type

Description

+

Description

@modelarts:content

+

@modelarts:content

String

+

String

Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points)

+

Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points)

@modelarts:end_index

+

@modelarts:end_index

Integer

+

Integer

End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Examples:

-
  • If the text is "Barack Hussein Obama II (born on August 4, 1961) is an attorney and politician.", the start_index and end_index of Barack Hussein Obama II are 0 and 23, respectively.

    -
  • If the text is "Hope is the thing with feathers", start_index and end_index of Hope are 0 and 4, respectively.

    +

End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Examples:

+
  • If the text is "Barack Hussein Obama II (born on August 4, 1961) is an attorney and politician.", the start_index and end_index of Barack Hussein Obama II are 0 and 23, respectively.

    +
  • If the text is "Hope is the thing with feathers", start_index and end_index of Hope are 0 and 4, respectively.

@modelarts:end_time

+

@modelarts:end_time

String

+

String

Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

+

Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

@modelarts:feature

+

@modelarts:feature

Object

+

Object

Shape feature, which is a default attribute dedicated to the object detection label, with type of List The upper left corner of an image is used as the coordinate origin [0, 0]. Each coordinate point is represented by [x, y]. x indicates the horizontal coordinate, and y indicates the vertical coordinate (both x and y are greater than or equal to 0). The format of each shape is as follows:

-
  • bndbox: consists of two points, for example, [[0,10],[50,95]]. The upper left vertex of the rectangle is the first point, and the lower right vertex is the second point. That is, the x-coordinate of the first point must be less than the x-coordinate of the second point, and the y-coordinate of the first point must be less than the y-coordinate of the second point.

    -
  • polygon: consists of multiple points that are connected in sequence to form a polygon, for example, [[0,100],[50,95],[10,60],[500,400]].

    -
  • circle: consists of the center and radius, for example, [[100,100],[50]].

    -
  • line: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.

    -
  • dashed: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.

    -
  • point: consists of one point, for example, [[0,100]].

    -
  • polyline: consists of multiple points, for example, [[0,100],[50,95],[10,60],[500,400]].

    +

Shape feature, which is a default attribute dedicated to the object detection label, with type of List The upper left corner of an image is used as the coordinate origin [0, 0]. Each coordinate point is represented by [x, y]. x indicates the horizontal coordinate, and y indicates the vertical coordinate (both x and y are greater than or equal to 0). The format of each shape is as follows:

+
  • bndbox: consists of two points, for example, [[0,10],[50,95]]. The upper left vertex of the rectangle is the first point, and the lower right vertex is the second point. That is, the x-coordinate of the first point must be less than the x-coordinate of the second point, and the y-coordinate of the first point must be less than the y-coordinate of the second point.

    +
  • polygon: consists of multiple points that are connected in sequence to form a polygon, for example, [[0,100],[50,95],[10,60],[500,400]].

    +
  • circle: consists of the center and radius, for example, [[100,100],[50]].

    +
  • line: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.

    +
  • dashed: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.

    +
  • point: consists of one point, for example, [[0,100]].

    +
  • polyline: consists of multiple points, for example, [[0,100],[50,95],[10,60],[500,400]].

@modelarts:from

+

@modelarts:from

String

+

String

Start entity ID of the triplet relationship label, which is a default attribute dedicated to the triplet relationship label

+

Start entity ID of the triplet relationship label, which is a default attribute dedicated to the triplet relationship label

@modelarts:hard

+

@modelarts:hard

String

+

String

Whether the sample is labeled as a hard example, which is a default attribute. Options:

-
  • 0/false: The label is not a hard example.

    -
  • 1/true: The label is a hard example.

    +

Whether the sample is labeled as a hard example, which is a default attribute. Options:

+
  • 0/false: The label is not a hard example.

    +
  • 1/true: The label is a hard example.

@modelarts:hard_coefficient

+

@modelarts:hard_coefficient

String

+

String

Coefficient of difficulty of each label level, which is a default attribute. The value ranges from 0 to 1.

+

Coefficient of difficulty of each label level, which is a default attribute. The value ranges from 0 to 1.

@modelarts:hard_reasons

+

@modelarts:hard_reasons

String

+

String

Reasons why the sample is a hard example, which is a default attribute. Use a hyphen (-) to separate every two hard example reason IDs, for example, 3-20-21-19. Options:

-
  • 0: No object is identified.

    -
  • 1: The confidence is low.

    -
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.

    -
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.

    -
  • 4: The prediction results of multiple consecutive similar images are inconsistent.

    -
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.

    -
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.

    -
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.

    -
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.

    -
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.

    -
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.

    -
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.

    -
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.

    -
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.

    -
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.

    -
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.

    -
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.

    -
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.

    -
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.

    -
  • 19: The data augmentation result based on GaussianBlur is inconsistent with the prediction result of the original image.

    -
  • 20: The data augmentation result based on fliplr is inconsistent with the prediction result of the original image.

    -
  • 21: The data augmentation result based on Crop is inconsistent with the prediction result of the original image.

    -
  • 22: The data augmentation result based on flipud is inconsistent with the prediction result of the original image.

    -
  • 23: The data augmentation result based on scale is inconsistent with the prediction result of the original image.

    -
  • 24: The data augmentation result based on translate is inconsistent with the prediction result of the original image.

    -
  • 25: The data augmentation result based on shear is inconsistent with the prediction result of the original image.

    -
  • 26: The data augmentation result based on superpixels is inconsistent with the prediction result of the original image.

    -
  • 27: The data augmentation result based on sharpen is inconsistent with the prediction result of the original image.

    -
  • 28: The data augmentation result based on add is inconsistent with the prediction result of the original image.

    -
  • 29: The data augmentation result based on invert is inconsistent with the prediction result of the original image.

    -
  • 30: The data is predicted to be abnormal.

    +

Reasons why the sample is a hard example, which is a default attribute. Use a hyphen (-) to separate every two hard example reason IDs, for example, 3-20-21-19. Options:

+
  • 0: No object is identified.

    +
  • 1: The confidence is low.

    +
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.

    +
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.

    +
  • 4: The prediction results of multiple consecutive similar images are inconsistent.

    +
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.

    +
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.

    +
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.

    +
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.

    +
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.

    +
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.

    +
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.

    +
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.

    +
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.

    +
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.

    +
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.

    +
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.

    +
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.

    +
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.

    +
  • 19: The data augmentation result based on GaussianBlur is inconsistent with the prediction result of the original image.

    +
  • 20: The data augmentation result based on fliplr is inconsistent with the prediction result of the original image.

    +
  • 21: The data augmentation result based on Crop is inconsistent with the prediction result of the original image.

    +
  • 22: The data augmentation result based on flipud is inconsistent with the prediction result of the original image.

    +
  • 23: The data augmentation result based on scale is inconsistent with the prediction result of the original image.

    +
  • 24: The data augmentation result based on translate is inconsistent with the prediction result of the original image.

    +
  • 25: The data augmentation result based on shear is inconsistent with the prediction result of the original image.

    +
  • 26: The data augmentation result based on superpixels is inconsistent with the prediction result of the original image.

    +
  • 27: The data augmentation result based on sharpen is inconsistent with the prediction result of the original image.

    +
  • 28: The data augmentation result based on add is inconsistent with the prediction result of the original image.

    +
  • 29: The data augmentation result based on invert is inconsistent with the prediction result of the original image.

    +
  • 30: The data is predicted to be abnormal.

@modelarts:shape

+

@modelarts:shape

String

+

String

Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. Options:

-
  • bndbox: rectangle

    -
  • polygon: polygon

    -
  • circle: circle

    -
  • line: straight line

    -
  • dashed: dashed line

    -
  • point: point

    -
  • polyline: polyline

    +

Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. Options:

+
  • bndbox: rectangle

    +
  • polygon: polygon

    +
  • circle: circle

    +
  • line: straight line

    +
  • dashed: dashed line

    +
  • point: point

    +
  • polyline: polyline

@modelarts:source

+

@modelarts:source

String

+

String

Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator

+

Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator

@modelarts:start_index

+

@modelarts:start_index

Integer

+

Integer

Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index.

+

Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index.

@modelarts:start_time

+

@modelarts:start_time

String

+

String

Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

+

Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.)

@modelarts:to

+

@modelarts:to

String

+

String

Direction entity ID of the triplet relationship label, which is a default attribute dedicated to the triplet relationship label

+

Direction entity ID of the triplet relationship label, which is a default attribute dedicated to the triplet relationship label

-
Table 18 SampleMetadata

Parameter

+
- - - - - - - - - - - - - - - - -
Table 18 SampleMetadata

Parameter

Type

+

Type

Description

+

Description

@modelarts:import_origin

+

@modelarts:import_origin

Integer

+

Integer

Sample source, which is a default attribute.

+

Sample source, which is a default attribute.

@modelarts:hard

+

@modelarts:hard

Double

+

Double

Whether the sample is labeled as a hard sample, which is a default attribute. Options:

-
  • 0: The label is not a hard example.

    -
  • 1: The label is a hard example.

    +

Whether the sample is labeled as a hard sample, which is a default attribute. Options:

+
  • 0: The label is not a hard example.

    +
  • 1: The label is a hard example.

@modelarts:hard_coefficient

+

@modelarts:hard_coefficient

Double

+

Double

Coefficient of difficulty of each sample level, which is a default attribute. The value ranges from 0 to 1.

+

Coefficient of difficulty of each sample level, which is a default attribute. The value ranges from 0 to 1.

@modelarts:hard_reasons

+

@modelarts:hard_reasons

Array of integers

+

Array of integers

ID of a hard example reason, which is a default attribute. Options:

-
  • 0: No object is identified.

    -
  • 1: The confidence is low.

    -
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.

    -
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.

    -
  • 4: The prediction results of multiple consecutive similar images are inconsistent.

    -
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.

    -
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.

    -
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.

    -
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.

    -
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.

    -
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.

    -
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.

    -
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.

    -
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.

    -
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.

    -
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.

    -
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.

    -
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.

    -
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.

    -
  • 19: The data augmentation result based on GaussianBlur is inconsistent with the prediction result of the original image.

    -
  • 20: The data augmentation result based on fliplr is inconsistent with the prediction result of the original image.

    -
  • 21: The data augmentation result based on Crop is inconsistent with the prediction result of the original image.

    -
  • 22: The data augmentation result based on flipud is inconsistent with the prediction result of the original image.

    -
  • 23: The data augmentation result based on scale is inconsistent with the prediction result of the original image.

    -
  • 24: The data augmentation result based on translate is inconsistent with the prediction result of the original image.

    -
  • 25: The data augmentation result based on shear is inconsistent with the prediction result of the original image.

    -
  • 26: The data augmentation result based on superpixels is inconsistent with the prediction result of the original image.

    -
  • 27: The data augmentation result based on sharpen is inconsistent with the prediction result of the original image.

    -
  • 28: The data augmentation result based on add is inconsistent with the prediction result of the original image.

    -
  • 29: The data augmentation result based on invert is inconsistent with the prediction result of the original image.

    -
  • 30: The data is predicted to be abnormal.

    +

ID of a hard example reason, which is a default attribute. Options:

+
  • 0: No object is identified.

    +
  • 1: The confidence is low.

    +
  • 2: The clustering result based on the training dataset is inconsistent with the prediction result.

    +
  • 3: The prediction result is greatly different from the data of the same type in the training dataset.

    +
  • 4: The prediction results of multiple consecutive similar images are inconsistent.

    +
  • 5: There is a large offset between the image resolution and the feature distribution of the training dataset.

    +
  • 6: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset.

    +
  • 7: There is a large offset between the brightness of the image and the feature distribution of the training dataset.

    +
  • 8: There is a large offset between the saturation of the image and the feature distribution of the training dataset.

    +
  • 9: There is a large offset between the color richness of the image and the feature distribution of the training dataset.

    +
  • 10: There is a large offset between the definition of the image and the feature distribution of the training dataset.

    +
  • 11: There is a large offset between the number of frames of the image and the feature distribution of the training dataset.

    +
  • 12: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset.

    +
  • 13: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset.

    +
  • 14: There is a large offset between the area portion of image frames and the feature distribution of the training dataset.

    +
  • 15: There is a large offset between the edge of image frames and the feature distribution of the training dataset.

    +
  • 16: There is a large offset between the brightness of image frames and the feature distribution of the training dataset.

    +
  • 17: There is a large offset between the definition of image frames and the feature distribution of the training dataset.

    +
  • 18: There is a large offset between the stack of image frames and the feature distribution of the training dataset.

    +
  • 19: The data augmentation result based on GaussianBlur is inconsistent with the prediction result of the original image.

    +
  • 20: The data augmentation result based on fliplr is inconsistent with the prediction result of the original image.

    +
  • 21: The data augmentation result based on Crop is inconsistent with the prediction result of the original image.

    +
  • 22: The data augmentation result based on flipud is inconsistent with the prediction result of the original image.

    +
  • 23: The data augmentation result based on scale is inconsistent with the prediction result of the original image.

    +
  • 24: The data augmentation result based on translate is inconsistent with the prediction result of the original image.

    +
  • 25: The data augmentation result based on shear is inconsistent with the prediction result of the original image.

    +
  • 26: The data augmentation result based on superpixels is inconsistent with the prediction result of the original image.

    +
  • 27: The data augmentation result based on sharpen is inconsistent with the prediction result of the original image.

    +
  • 28: The data augmentation result based on add is inconsistent with the prediction result of the original image.

    +
  • 29: The data augmentation result based on invert is inconsistent with the prediction result of the original image.

    +
  • 30: The data is predicted to be abnormal.

@modelarts:size

+

@modelarts:size

Array of objects

+

Array of objects

image size, including width, height, and depth. The type is List[/topic/body/section/table/tgroup/tbody/row/entry/p/br. {""}) (br]. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is 3). For example, [100,200,3] and [100,200] are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label.

+

image size, including width, height, and depth. The type is List[/topic/body/section/table/tgroup/tbody/row/entry/p/br. {""}) (br]. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is 3). For example, [100,200,3] and [100,200] are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label.

-

Request Example

Run the following command to obtain details about an auto labeling task:

-
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}
+

Request Example

Run the following command to obtain details about an auto labeling task:

+
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}
-

Response Example

Status code: 200

-

OK

-
{
+

Response Example

Status code: 200

+

OK

+
{
   "resource_id" : "XGrRZuCV1qmMxnsmD5u",
   "create_time" : "2020-11-23 11:08:20",
   "progress" : 10.0,
@@ -1707,38 +1707,38 @@
   }
 }
-

Status Code

-

Status Code

+

Status Code

+
- - - - - - - - -

Status Code

Description

+

Description

200

+

200

OK

+

OK

401

+

401

Unauthorized

+

Unauthorized

403

+

403

Forbidden

+

Forbidden

404

+

404

Not Found

+

Not Found

-

Error Code

For details, see Error Codes.

+

Error Code

For details, see Error Codes.

diff --git a/docs/modelarts/api-ref/BatchBindPoolNodes.html b/docs/modelarts/api-ref/BatchBindPoolNodes.html new file mode 100644 index 000000000..ae2f38200 --- /dev/null +++ b/docs/modelarts/api-ref/BatchBindPoolNodes.html @@ -0,0 +1,182 @@ + + +

Binding Nodes to a Logical Subpool in Batches

+

Function

This API is used to bind nodes in a logical subpool to another logical subpool when node binding is enabled for a physical dedicated pool.

+
+

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-bind

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+

pool_name

+

Yes

+

String

+

Resource pool ID. The value is the metadata.name field in the resource pool details.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

nodes

+

Yes

+

Array of BindNodeItem objects

+

List of nodes to be bound with another pool.

+

drain

+

No

+

Boolean

+

Whether to drain the node to be bound with another pool. true: Drain the node.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 BindNodeItem

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of the node to be bound with another pool.

+

quotaName

+

Yes

+

String

+

ID of the logical subpool bound to the node. If the value is empty, the node is not bound to any logical subpool.

+
+
+
+

Response Parameters

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Requests

Bind nodes to logical subpool pool-a26d-prjid.

+
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-bind
+
+{
+  "nodes" : [ {
+    "name" : "os-node-created-8888g",
+    "quotaName" : "pool-a26d-prjid"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

OK.

+
{ }
+

Status code: 404

+

Not found.

+
{
+  "error_code" : "ModelArts.50015001",
+  "error_msg" : "pool not found"
+}
+
+

Status Codes

+
+ + + + + + + + + + +

Status Code

+

Description

+

200

+

OK.

+

404

+

Not found.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/modelarts/api-ref/BatchDeletePoolNodes.html b/docs/modelarts/api-ref/BatchDeletePoolNodes.html index 99b7160c7..7e5b024f9 100644 --- a/docs/modelarts/api-ref/BatchDeletePoolNodes.html +++ b/docs/modelarts/api-ref/BatchDeletePoolNodes.html @@ -1,9 +1,9 @@ - +

Deleting Nodes in Batches

-

Function

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.

+

Function

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.

-

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-delete

+

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-delete

@@ -30,7 +30,7 @@ - @@ -38,7 +38,7 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

String

Name of a resource pool

+

Resource pool ID. The value is the metadata.name field in the resource pool details.

Table 2 Request body parameters

Parameter

+
@@ -63,30 +63,26 @@

Response Parameters

Status code: 404

-
Table 2 Request body parameters

Parameter

Mandatory

Table 3 Response body parameters

Parameter

+
- - - - - - - - @@ -107,7 +103,7 @@ }

Status Codes

-
Table 3 Response body parameters

Parameter

Type

+

Type

Description

+

Description

error_code

+

error_code

String

+

String

Error code.

-

Minimum: 8

-

Maximum: 36

+

Error code.

error_msg

+

error_msg

String

+

String

Error message.

-

Minimum: 2

-

Maximum: 512

+

Error message.

Status Code

+
diff --git a/docs/modelarts/api-ref/BatchDeleteWorkers.html b/docs/modelarts/api-ref/BatchDeleteWorkers.html index 655ec73db..d1b39904b 100644 --- a/docs/modelarts/api-ref/BatchDeleteWorkers.html +++ b/docs/modelarts/api-ref/BatchDeleteWorkers.html @@ -1,11 +1,11 @@ - +

Deleting Labeling Team Members in Batches

Function

This API is used to delete labeling team members in batches.

-

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

+

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

-

URI

POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete

+

URI

POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete

Status Code

Description

@@ -40,7 +40,7 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Table 2 Request body parameters

Parameter

+
@@ -65,7 +65,7 @@

Response Parameters

Status code: 200

-
Table 2 Request body parameters

Parameter

Mandatory

Table 3 Response body parameters

Parameter

+
@@ -89,7 +89,7 @@ - @@ -108,7 +108,7 @@
Table 3 Response body parameters

Parameter

Type

results

Array of BatchResponse objects

+

Array of BatchResponse objects

Result of deleting team members in batches.

-
Table 4 BatchResponse

Parameter

+
@@ -161,7 +161,7 @@ }

Status Codes

-
Table 4 BatchResponse

Parameter

Type

Status Code

+
diff --git a/docs/modelarts/api-ref/BatchLockPoolNodes.html b/docs/modelarts/api-ref/BatchLockPoolNodes.html new file mode 100644 index 000000000..34a92be0c --- /dev/null +++ b/docs/modelarts/api-ref/BatchLockPoolNodes.html @@ -0,0 +1,174 @@ + + +

Locking Node Functions in Batches

+

Function

This API is used to lock node functions in batches. Locked functions cannot be used on the console.

+
+

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-lock

+ +

Status Code

Description

+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+

pool_name

+

Yes

+

String

+

Resource pool ID. The value is the metadata.name field in the resource pool details.

+
+
+ +

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

nodeNames

+

Yes

+

Array of strings

+

Names of nodes to be locked.

+

actions

+

Yes

+

Array of strings

+

Action performed for a lock. The options are as follows:

+
  • delete: Delete a lock.

    +
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

nodes

+

Array of strings

+

Names of nodes that are successfully updated.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Requests

Lock node functions in batches.

+
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-lock
+
+{
+  "nodeNames" : [ "os-node-created-xzz78" ],
+  "actions" : [ "delete" ]
+}
+
+

Example Responses

Status code: 200

+

OK.

+
{
+  "nodes" : [ {
+    "name" : "os-node-created-xzz78"
+  } ]
+}
+

Status code: 404

+

Not found.

+
{
+  "error_code" : "ModelArts.50015001",
+  "error_msg" : "pool not found"
+}
+
+

Status Codes

+
+ + + + + + + + + + +

Status Code

+

Description

+

200

+

OK.

+

404

+

Not found.

+
+
+
+

Error Codes

See Error Codes.

+
+ +
+ +
+ diff --git a/docs/modelarts/api-ref/BatchUnlockPoolNodes.html b/docs/modelarts/api-ref/BatchUnlockPoolNodes.html new file mode 100644 index 000000000..a058727f2 --- /dev/null +++ b/docs/modelarts/api-ref/BatchUnlockPoolNodes.html @@ -0,0 +1,174 @@ + + +

Unlocking Node Functions in Batches

+

Function

This API is used to unlock node functions in batches. Locked functions cannot be used on the console, but can be used after being unlocked.

+
+

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-unlock

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+

pool_name

+

Yes

+

String

+

Resource pool ID. The value is the metadata.name field in the resource pool details.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

nodeNames

+

Yes

+

Array of strings

+

Names of nodes to be locked.

+

actions

+

Yes

+

Array of strings

+

Action performed for a lock. The options are as follows:

+
  • delete: Delete a lock.

    +
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

nodes

+

Array of strings

+

Names of nodes that are successfully updated.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Requests

Unlock node functions in batches.

+
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-unlock
+
+{
+  "nodeNames" : [ "os-node-created-xzz78" ],
+  "actions" : [ "delete" ]
+}
+
+

Example Responses

Status code: 200

+

OK.

+
{
+  "nodes" : [ {
+    "name" : "os-node-created-xzz78"
+  } ]
+}
+

Status code: 404

+

Not found.

+
{
+  "error_code" : "ModelArts.50015001",
+  "error_msg" : "pool not found"
+}
+
+

Status Codes

+
+ + + + + + + + + + +

Status Code

+

Description

+

200

+

OK.

+

404

+

Not found.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/modelarts/api-ref/BatchUpdatePoolNodes.html b/docs/modelarts/api-ref/BatchUpdatePoolNodes.html new file mode 100644 index 000000000..3390047f4 --- /dev/null +++ b/docs/modelarts/api-ref/BatchUpdatePoolNodes.html @@ -0,0 +1,183 @@ + + +

Updating Nodes in Batches

+

Function

This API is used to update nodes in batches.

+
+

URI

POST /v2/{project_id}/pools/{pool_name}/nodes/batch-update

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+

pool_name

+

Yes

+

String

+

Resource pool ID. The value is the metadata.name field in the resource pool details.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

nodeNames

+

Yes

+

Array of strings

+

List of node names to be updated.

+

action

+

Yes

+

String

+

Action performed for updating a node. The options are as follows:

+
  • openHaRedundant: Enable HA redundancy.

    +
  • closeHaRedundant: Disable HA redundancy.

    +
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

successNodeNames

+

Array of strings

+

Names of nodes that are successfully updated.

+

failNodeNames

+

Array of strings

+

Names of nodes that fail to be updated.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+
+
+
+

Example Requests

Enable node HA redundancy.

+
POST /v2/{project_id}/pools/{pool_name}/nodes/batch-update
+
+{
+  "nodeNames" : [ "os-node-created-xzz78" ],
+  "action" : "openHaRedundant"
+}
+
+

Example Responses

Status code: 200

+

OK.

+
{
+  "nodes" : [ {
+    "name" : "os-node-created-xzz78",
+    "status" : "success"
+  } ]
+}
+

Status code: 404

+

Not found.

+
{
+  "error_code" : "ModelArts.50015001",
+  "error_msg" : "pool not found"
+}
+
+

Status Codes

+
+ + + + + + + + + + +

Status Code

+

Description

+

200

+

OK.

+

404

+

Not found.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/modelarts/api-ref/CLASS.TXT.json b/docs/modelarts/api-ref/CLASS.TXT.json index 736638bff..8acdff384 100644 --- a/docs/modelarts/api-ref/CLASS.TXT.json +++ b/docs/modelarts/api-ref/CLASS.TXT.json @@ -45,7 +45,7 @@ "code":"5" }, { - "desc":"All ModelArts APIs are proprietary.You can use these APIs to manage development environments, training jobs, models, and services.", + "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", @@ -533,7 +533,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":"Model Management", + "title":"AI Application Management", "uri":"ai_management.html", "doc_type":"api", "p_code":"", @@ -549,40 +549,31 @@ "code":"61" }, { - "desc":"This API is used to query the model list based on different search parameters.GET /v1/{project_id}/modelsStatus code: 200Status code: 200ModelsSee Error Codes.", + "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 Model List", + "title":"Querying the AI Application List", "uri":"ListModels.html", "doc_type":"api", "p_code":"60", "code":"62" }, { - "desc":"Import a meta model to create a model.The execution code and model must be uploaded to OBS first. By default, the model generated by a training job is stored in OBS.The b", + "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":"Creating a model", - "uri":"CreateModel.html", + "title":"Obtaining Details About an AI Application", + "uri":"ShowModel.html", "doc_type":"api", "p_code":"60", "code":"63" }, { - "desc":"This API is used to query details about a model based on the model ID.GET /v1/{project_id}/models/{model_id}Status code: 200Status code: 200Model detailsSee Error Codes.", + "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":"Obtaining Details About a model", - "uri":"ShowModel.html", - "doc_type":"api", - "p_code":"60", - "code":"64" - }, - { - "desc":"This interface 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 other models with the same name but d", - "product_code":"modelarts", - "title":"Deleting a model", + "title":"Deleting an AI application", "uri":"DeleteModel.html", "doc_type":"api", "p_code":"60", - "code":"65" + "code":"64" }, { "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.", @@ -591,7 +582,7 @@ "uri":"service_management.html", "doc_type":"api", "p_code":"", - "code":"66" + "code":"65" }, { "desc":"This API is used to obtain service monitoring information.GET /v1/{project_id}/services/{service_id}/monitorStatus code: 200Status code: 200Monitoring informationSee Erro", @@ -599,8 +590,8 @@ "title":"Obtaining Service Monitoring", "uri":"ShowServiceMonitorInfo.html", "doc_type":"api", - "p_code":"66", - "code":"67" + "p_code":"65", + "code":"66" }, { "desc":"This API is used to obtain model services.GET /v1/{project_id}/servicesStatus code: 200Status code: 200Service listSee Error Codes.", @@ -608,8 +599,8 @@ "title":"Obtaining Services", "uri":"ListServices.html", "doc_type":"api", - "p_code":"66", - "code":"68" + "p_code":"65", + "code":"67" }, { "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", @@ -617,8 +608,8 @@ "title":"Deploying Services", "uri":"CreateService.html", "doc_type":"api", - "p_code":"66", - "code":"69" + "p_code":"65", + "code":"68" }, { "desc":"This API is used to obtain supported service deployment specifications.GET /v1/{project_id}/services/specificationsStatus code: 200Status code: 200Service deployment flav", @@ -626,8 +617,8 @@ "title":"Obtaining Supported Service Deployment Specifications", "uri":"ShowServiceSpecifications.html", "doc_type":"api", - "p_code":"66", - "code":"70" + "p_code":"65", + "code":"69" }, { "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", @@ -635,8 +626,8 @@ "title":"Obtaining Service Details", "uri":"ShowService.html", "doc_type":"api", - "p_code":"66", - "code":"71" + "p_code":"65", + "code":"70" }, { "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", @@ -644,8 +635,8 @@ "title":"Updating Service Configurations", "uri":"UpdateService.html", "doc_type":"api", - "p_code":"66", - "code":"72" + "p_code":"65", + "code":"71" }, { "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", @@ -653,8 +644,8 @@ "title":"Deleting a Service", "uri":"DeleteService.html", "doc_type":"api", - "p_code":"66", - "code":"73" + "p_code":"65", + "code":"72" }, { "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", @@ -662,8 +653,8 @@ "title":"Obtaining Service Event Logs", "uri":"ShowServiceEvents.html", "doc_type":"api", - "p_code":"66", - "code":"74" + "p_code":"65", + "code":"73" }, { "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", @@ -671,9 +662,72 @@ "title":"Obtaining Service Update Logs", "uri":"ShowServiceUpdateLogs.html", "doc_type":"api", - "p_code":"66", + "p_code":"65", + "code":"74" + }, + { + "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 Task Management", + "uri":"topic_300003000.html", + "doc_type":"api", + "p_code":"", "code":"75" }, + { + "desc":"This API is used to create a service task.POST /v1/{project_id}/services/{service_id}/tasksStatus code: 201Status code: 400Status code: 404Create a common edge service ta", + "product_code":"modelarts", + "title":"Creating a Service Task", + "uri":"CreateTasks.html", + "doc_type":"api", + "p_code":"75", + "code":"76" + }, + { + "desc":"This API is used to obtain service tasks.GET /v1/{project_id}/services/{service_id}/tasksNoneStatus code: 200Status code: 400Status code: 404Query the first five service ", + "product_code":"modelarts", + "title":"Obtaining Service Tasks", + "uri":"ListTasksDetails.html", + "doc_type":"api", + "p_code":"75", + "code":"77" + }, + { + "desc":"This API is used to obtain a service task.GET /v1/{project_id}/services/{service_id}/tasks/{task_id}NoneStatus code: 200Status code: 400Status code: 404Obtain a specified", + "product_code":"modelarts", + "title":"Obtaining a Service Task", + "uri":"ShowTask.html", + "doc_type":"api", + "p_code":"75", + "code":"78" + }, + { + "desc":"This API is used to delete a service task.DELETE /v1/{project_id}/services/{service_id}/tasks/{task_id}NoneStatus code: 400Status code: 404Delete a specified service task", + "product_code":"modelarts", + "title":"Deleting a Service Task", + "uri":"DeleteTask.html", + "doc_type":"api", + "p_code":"75", + "code":"79" + }, + { + "desc":"This API is used to start a service task. This parameter applies only to IEF. It cannot be used in ModelArts Edge.POST /v1/{project_id}/services/{service_id}/tasks/{task_", + "product_code":"modelarts", + "title":"Starting a Service Task", + "uri":"StartTask.html", + "doc_type":"api", + "p_code":"75", + "code":"80" + }, + { + "desc":"This API is used to stop a service task. This parameter applies only to IEF. It cannot be used in ModelArts Edge.POST /v1/{project_id}/services/{service_id}/tasks/{task_i", + "product_code":"modelarts", + "title":"Stopping a Service Task", + "uri":"StopTask.html", + "doc_type":"api", + "p_code":"75", + "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", @@ -681,52 +735,7 @@ "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" + "code":"82" }, { "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.", @@ -734,17 +743,17 @@ "title":"Resource Pool Job Management", "uri":"workload_management.html", "doc_type":"api", - "p_code":"76", - "code":"82" + "p_code":"82", + "code":"83" }, { - "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", + "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: 404Obtain jo", "product_code":"modelarts", "title":"Obtaining Jobs in a Dedicated Resource Pool", "uri":"ListWorkloads.html", "doc_type":"api", - "p_code":"82", - "code":"83" + "p_code":"83", + "code":"84" }, { "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", @@ -752,26 +761,35 @@ "title":"Obtaining Statistics About Dedicated Resource Pool Jobs", "uri":"ShowWorkloadStatistics.html", "doc_type":"api", - "p_code":"82", - "code":"84" + "p_code":"83", + "code":"85" }, { "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", + "title":"Configuration Management", + "uri":"config_management.html", "doc_type":"api", - "p_code":"76", - "code":"85" + "p_code":"82", + "code":"86" }, { - "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:", + "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":"Obtaining the Real-Time Resource Usage", - "uri":"ShowPoolRuntimeMetrics.html", + "title":"Querying OS Configuration Parameters", + "uri":"ShowOsConfig.html", "doc_type":"api", - "p_code":"85", - "code":"86" + "p_code":"86", + "code":"87" + }, + { + "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":"86", + "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.", @@ -779,143 +797,71 @@ "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", + "p_code":"82", "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 ", + "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: 404The follo", "product_code":"modelarts", - "title":"Creating Resource Pool Tags in Batches", - "uri":"BatchCreatePoolTags.html", + "title":"Querying a Plug-in Template", + "uri":"ShowPluginTemplate.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", + "desc":"This API is used to obtain plug-in templates.GET /v2/{project_id}/plugintemplatesNoneStatus code: 200Status code: 404The following is an example of how to query details a", "product_code":"modelarts", - "title":"Deleting Resource Pool Tags in Batches", - "uri":"BatchDeletePoolTags.html", + "title":"Query Plug-in Templates", + "uri":"ListPluginTemplates.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", + "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":"Querying All Tags of Resource Pools", - "uri":"ListPoolTags.html", + "title":"Virtual Resource Flavors", + "uri":"topic_300000003.html", "doc_type":"api", - "p_code":"89", + "p_code":"82", "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", + "desc":"This API is used to obtain details about a specified virtual resource allocation template.GET /v1/{project_id}/virtualresourcetemplates/{virtualresourcetemplate_name}None", "product_code":"modelarts", - "title":"Querying Tags of a Resource Pool", - "uri":"ShowPoolTags.html", + "title":"Obtaining Virtual Resource Flavor Templates", + "uri":"ShowVirtualResourceTemplate.html", "doc_type":"api", - "p_code":"89", + "p_code":"92", "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", + "desc":"This API is used to obtain virtual resource flavors.GET /v1/{project_id}/virtualresourceflavorsNoneStatus code: 200Status code: 404Obtain virtual NPU allocation resource ", "product_code":"modelarts", - "title":"Querying Resource Pools by Tag", - "uri":"ListPoolsByTags.html", + "title":"Obtaining Virtual Resource Flavors", + "uri":"ListVirtualresourceFlavors.html", "doc_type":"api", - "p_code":"89", + "p_code":"92", "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" + "p_code":"82", + "code":"95" }, { "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", + "title":"Obtaining Nodes in a Resource Pool", "uri":"ListPoolNodes.html", "doc_type":"api", - "p_code":"101", - "code":"102" + "p_code":"95", + "code":"96" }, { "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", @@ -923,89 +869,242 @@ "title":"Deleting Nodes in Batches", "uri":"BatchDeletePoolNodes.html", "doc_type":"api", - "p_code":"101", - "code":"103" + "p_code":"95", + "code":"97" + }, + { + "desc":"This API is used to update nodes in batches.POST /v2/{project_id}/pools/{pool_name}/nodes/batch-updateStatus code: 200Status code: 404Enable node HA redundancy.Status cod", + "product_code":"modelarts", + "title":"Updating Nodes in Batches", + "uri":"BatchUpdatePoolNodes.html", + "doc_type":"api", + "p_code":"95", + "code":"98" + }, + { + "desc":"This API is used to lock node functions in batches. Locked functions cannot be used on the console.POST /v2/{project_id}/pools/{pool_name}/nodes/batch-lockStatus code: 20", + "product_code":"modelarts", + "title":"Locking Node Functions in Batches", + "uri":"BatchLockPoolNodes.html", + "doc_type":"api", + "p_code":"95", + "code":"99" + }, + { + "desc":"This API is used to unlock node functions in batches. Locked functions cannot be used on the console, but can be used after being unlocked.POST /v2/{project_id}/pools/{po", + "product_code":"modelarts", + "title":"Unlocking Node Functions in Batches", + "uri":"BatchUnlockPoolNodes.html", + "doc_type":"api", + "p_code":"95", + "code":"100" + }, + { + "desc":"This API is used to bind nodes in a logical subpool to another logical subpool when node binding is enabled for a physical dedicated pool.POST /v2/{project_id}/pools/{poo", + "product_code":"modelarts", + "title":"Binding Nodes to a Logical Subpool in Batches", + "uri":"BatchBindPoolNodes.html", + "doc_type":"api", + "p_code":"95", + "code":"101" }, { "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", + "title":"Network Management", + "uri":"network_management.html", "doc_type":"api", - "p_code":"76", + "p_code":"82", + "code":"102" + }, + { + "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":"102", + "code":"103" + }, + { + "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":"102", "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", + "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":"Creating Resource Pools", - "uri":"CreatePool.html", + "title":"Obtaining a Network Resource", + "uri":"ShowNetwork.html", "doc_type":"api", - "p_code":"104", + "p_code":"102", "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.", + "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":"Obtaining Resource Pools", - "uri":"ListPools.html", + "title":"Deleting a Network Resource", + "uri":"DeleteNetwork.html", "doc_type":"api", - "p_code":"104", + "p_code":"102", "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", + "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":"Obtaining a Resource Pool", - "uri":"ShowPool.html", + "title":"Updating a Network Resource", + "uri":"PatchNetwork.html", "doc_type":"api", - "p_code":"104", + "p_code":"102", "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", + "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":"Deleting a Resource Pool", - "uri":"DeletePool.html", + "title":"Tag Management", + "uri":"tags_management.html", "doc_type":"api", - "p_code":"104", + "p_code":"82", "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", + "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":"Updating a Resource Pool", - "uri":"PatchPool.html", + "title":"Obtaining All Resource Tags of a Resource Pool", + "uri":"ListPoolTags.html", "doc_type":"api", - "p_code":"104", + "p_code":"108", "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 ", + "desc":"This API is used to obtain resource tags of a specified resource pool.GET /v1/{project_id}/pools/{pool_name}/tagsNoneStatus code: 204Status code: 400Status code: 401Statu", "product_code":"modelarts", - "title":"Monitoring a Resource Pool", - "uri":"ShowPoolMonitor.html", + "title":"Obtaining Resource Tags of a Resource Pool", + "uri":"ShowPoolTags.html", "doc_type":"api", - "p_code":"104", + "p_code":"108", "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", + "desc":"This API is used to modify resource tags of a specified resource pool.POST /v1/{project_id}/pools/{pool_name}/tagsStatus code: 200Status code: 400Status code: 401Status c", "product_code":"modelarts", - "title":"Obtaining Resource Pool Statistics", - "uri":"ShowPoolStatistics.html", + "title":"Modifying Resource Tags of a Resource Pool", + "uri":"UpdatePoolTags.html", "doc_type":"api", - "p_code":"104", + "p_code":"108", "code":"111" }, + { + "desc":"This API is used to obtain all tags of nodes in the current project. By default, all workspaces are queried. Tag data is not returned for workspaces on which the user doe", + "product_code":"modelarts", + "title":"Obtaining All Resource Tags of Nodes", + "uri":"ListNodeTags.html", + "doc_type":"api", + "p_code":"108", + "code":"112" + }, + { + "desc":"This API is used to obtain resource tags of a specified node.GET /v1/{project_id}/nodes/{node_name}/tagsNoneStatus code: 204Status code: 400Status code: 401Status code: 4", + "product_code":"modelarts", + "title":"Obtaining Resource Tags of Nodes", + "uri":"ShowNodeTags.html", + "doc_type":"api", + "p_code":"108", + "code":"113" + }, + { + "desc":"This API is used to modify resource tags of a specified node.POST /v1/{project_id}/nodes/{node_name}/tagsStatus code: 200Status code: 400Status code: 401Status code: 403S", + "product_code":"modelarts", + "title":"Modifying Resource Tags of Nodes", + "uri":"UpdateNodeTags.html", + "doc_type":"api", + "p_code":"108", + "code":"114" + }, + { + "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":"82", + "code":"115" + }, + { + "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":"115", + "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":"Plug-in Management", + "uri":"topic_300000008.html", + "doc_type":"api", + "p_code":"82", + "code":"117" + }, + { + "desc":"This API is used to create plug-in instances.POST /v2/{project_id}/pools/{pool_name}/pluginsStatus code: 200Status code: 400This API is used to create plug-in instances.S", + "product_code":"modelarts", + "title":"Create a Plug-in", + "uri":"CreatePlugin.html", + "doc_type":"api", + "p_code":"117", + "code":"118" + }, + { + "desc":"This API is used to list plug-in instances.GET /v2/{project_id}/pools/{pool_name}/pluginsNoneStatus code: 200This API is used to list plug-in instances.Status code: 200Re", + "product_code":"modelarts", + "title":"Query Plug-ins", + "uri":"ListPlugins.html", + "doc_type":"api", + "p_code":"117", + "code":"119" + }, + { + "desc":"This API is used to update a plug-in instance.PATCH /v2/{project_id}/pools/{pool_name}/plugins/{template_name}Status code: 200Status code: 400This API is used to update a", + "product_code":"modelarts", + "title":"Update a Plug-in", + "uri":"PatchPlugin.html", + "doc_type":"api", + "p_code":"117", + "code":"120" + }, + { + "desc":"This API is used to delete plug-in instances.DELETE /v2/{project_id}/pools/{pool_name}/plugins/{template_name}NoneStatus code: 200Status code: 400This API is used to dele", + "product_code":"modelarts", + "title":"Delete a Plug-in", + "uri":"DeletePlugin.html", + "doc_type":"api", + "p_code":"117", + "code":"121" + }, + { + "desc":"This API is used to query details of a plug-in instance.GET /v2/{project_id}/pools/{pool_name}/plugins/{template_name}NoneStatus code: 200Status code: 400This API is used", + "product_code":"modelarts", + "title":"Query Details of a Plug-in", + "uri":"ShowPlugin.html", + "doc_type":"api", + "p_code":"117", + "code":"122" + }, { "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" + "p_code":"82", + "code":"123" }, { "desc":"Obtain resource specifications.GET /v1/{project_id}/resourceflavorsNoneStatus code: 200Status code: 401Status code: 404This API is used to obtain resource specifications.", @@ -1013,8 +1112,125 @@ "title":"Obtaining Resource Specifications", "uri":"ListResourceFlavors.html", "doc_type":"api", - "p_code":"112", - "code":"113" + "p_code":"123", + "code":"124" + }, + { + "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":"Order Management", + "uri":"topic_300000010.html", + "doc_type":"api", + "p_code":"82", + "code":"125" + }, + { + "desc":"This API is used to obtain orders.GET /v1/{project_id}/ordersStatus code: 200Status code: 400Status code: 404Obtain successful orders of resource pool pool-5ed5 by page, ", + "product_code":"modelarts", + "title":"Querying Orders", + "uri":"ListOrders.html", + "doc_type":"api", + "p_code":"125", + "code":"126" + }, + { + "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":"82", + "code":"127" + }, + { + "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":"127", + "code":"128" + }, + { + "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":"127", + "code":"129" + }, + { + "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":"127", + "code":"130" + }, + { + "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":"127", + "code":"131" + }, + { + "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":"127", + "code":"132" + }, + { + "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":"127", + "code":"133" + }, + { + "desc":"This API is used to obtain resource pool statistics.GET /v2/{project_id}/statistics/poolsNoneStatus code: 200Status code: 500Obtain resource pool statistics.Status code: ", + "product_code":"modelarts", + "title":"Obtaining Resource Pool Statistics", + "uri":"ShowPoolStatistics.html", + "doc_type":"api", + "p_code":"127", + "code":"134" + }, + { + "desc":"This API is used to retry the job type that fails to be enabled.POST /v2/{project_id}/pools/{pool_name}/retry-scopeStatus code: 400Retry the Infer job type.Status code: 2", + "product_code":"modelarts", + "title":"Retrying the Job Type That Fails to Be Enabled", + "uri":"RetryPoolScope.html", + "doc_type":"api", + "p_code":"127", + "code":"135" + }, + { + "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":"82", + "code":"136" + }, + { + "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: 200Obtain the real-", + "product_code":"modelarts", + "title":"Obtaining the Real-Time Resource Usage", + "uri":"ShowPoolRuntimeMetrics.html", + "doc_type":"api", + "p_code":"136", + "code":"137" }, { "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.", @@ -1023,7 +1239,7 @@ "uri":"authorization.html", "doc_type":"api", "p_code":"", - "code":"114" + "code":"138" }, { "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.", @@ -1031,8 +1247,8 @@ "title":"Viewing an Authorization List", "uri":"GetAuthorizations.html", "doc_type":"api", - "p_code":"114", - "code":"115" + "p_code":"138", + "code":"139" }, { "desc":"This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services c", @@ -1040,8 +1256,8 @@ "title":"Configuring Authorization", "uri":"CreateAuthorization.html", "doc_type":"api", - "p_code":"114", - "code":"116" + "p_code":"138", + "code":"140" }, { "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", @@ -1049,8 +1265,8 @@ "title":"Deleting Authorization", "uri":"DeleteAuthorizations.html", "doc_type":"api", - "p_code":"114", - "code":"117" + "p_code":"138", + "code":"141" }, { "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", @@ -1058,8 +1274,8 @@ "title":"Creating a ModelArts Agency", "uri":"CreateModelArtsAgency.html", "doc_type":"api", - "p_code":"114", - "code":"118" + "p_code":"138", + "code":"142" }, { "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.", @@ -1068,7 +1284,7 @@ "uri":"modelarts_03_0400.html", "doc_type":"api", "p_code":"", - "code":"119" + "code":"143" }, { "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", @@ -1076,8 +1292,8 @@ "title":"Creating a Development Environment Instance", "uri":"modelarts_03_0406.html", "doc_type":"api", - "p_code":"119", - "code":"120" + "p_code":"143", + "code":"144" }, { "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:Obtain a user token, which will ", @@ -1085,17 +1301,8 @@ "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" + "p_code":"143", + "code":"145" }, { "desc":"This section describes how to manage agency authorization by calling ModelArts APIs.The process of managing ModelArts authorization is as follows:Obtain a user token, whi", @@ -1103,17 +1310,17 @@ "title":"Managing ModelArts Authorization", "uri":"modelarts_03_0405.html", "doc_type":"api", - "p_code":"119", - "code":"123" + "p_code":"143", + "code":"146" }, { "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", + "title":"Appendix", "uri":"modelarts_03_0093.html", "doc_type":"api", "p_code":"", - "code":"124" + "code":"147" }, { "desc":"Table 1 describes the status codes.", @@ -1121,8 +1328,8 @@ "title":"Status Code", "uri":"modelarts_03_0094.html", "doc_type":"api", - "p_code":"124", - "code":"125" + "p_code":"147", + "code":"148" }, { "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.", @@ -1130,8 +1337,8 @@ "title":"Error Codes", "uri":"modelarts_03_0095.html", "doc_type":"api", - "p_code":"124", - "code":"126" + "p_code":"147", + "code":"149" }, { "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", @@ -1139,17 +1346,17 @@ "title":"Obtaining a Project ID and Name", "uri":"modelarts_03_0147.html", "doc_type":"api", - "p_code":"124", - "code":"127" + "p_code":"147", + "code":"150" }, { - "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", + "desc":"When you call APIs, certain requests require a tenant name and ID. To obtain a tenant name and ID, do as follows:Log in to the console.In the upper right corner, click yo", "product_code":"modelarts", "title":"Obtaining a Tenant Name and ID", "uri":"modelarts_03_0148.html", "doc_type":"api", - "p_code":"124", - "code":"128" + "p_code":"147", + "code":"151" }, { "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", @@ -1157,8 +1364,8 @@ "title":"Obtaining a Username and ID", "uri":"modelarts_03_0006.html", "doc_type":"api", - "p_code":"124", - "code":"129" + "p_code":"147", + "code":"152" }, { "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.", @@ -1167,7 +1374,7 @@ "uri":"modelarts_03_0293.html", "doc_type":"api", "p_code":"", - "code":"130" + "code":"153" }, { "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.", @@ -1175,8 +1382,8 @@ "title":"Data Management (Old Version)", "uri":"dataset_management.html", "doc_type":"api", - "p_code":"130", - "code":"131" + "p_code":"153", + "code":"154" }, { "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", @@ -1184,8 +1391,8 @@ "title":"Querying the Dataset List", "uri":"ListDatasets.html", "doc_type":"api", - "p_code":"131", - "code":"132" + "p_code":"154", + "code":"155" }, { "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", @@ -1193,8 +1400,8 @@ "title":"Creating a Dataset", "uri":"CreateDataset.html", "doc_type":"api", - "p_code":"131", - "code":"133" + "p_code":"154", + "code":"156" }, { "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", @@ -1202,8 +1409,8 @@ "title":"Querying Details About a Dataset", "uri":"DescDataset.html", "doc_type":"api", - "p_code":"131", - "code":"134" + "p_code":"154", + "code":"157" }, { "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 ", @@ -1211,8 +1418,8 @@ "title":"Modifying a Dataset", "uri":"UpdateDataset.html", "doc_type":"api", - "p_code":"131", - "code":"135" + "p_code":"154", + "code":"158" }, { "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", @@ -1220,8 +1427,8 @@ "title":"Deleting a Dataset", "uri":"DeleteDataset.html", "doc_type":"api", - "p_code":"131", - "code":"136" + "p_code":"154", + "code":"159" }, { "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", @@ -1229,8 +1436,8 @@ "title":"Obtaining Dataset Statistics", "uri":"GetDatasetStats.html", "doc_type":"api", - "p_code":"131", - "code":"137" + "p_code":"154", + "code":"160" }, { "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", @@ -1238,8 +1445,8 @@ "title":"Querying the Monitoring Data of a Dataset", "uri":"GetDatasetMetrics.html", "doc_type":"api", - "p_code":"131", - "code":"138" + "p_code":"154", + "code":"161" }, { "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", @@ -1247,8 +1454,8 @@ "title":"Querying the Dataset Version List", "uri":"ListDatasetVersions.html", "doc_type":"api", - "p_code":"131", - "code":"139" + "p_code":"154", + "code":"162" }, { "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", @@ -1256,8 +1463,8 @@ "title":"Creating a Dataset Labeling Version", "uri":"CreateDatasetVersion.html", "doc_type":"api", - "p_code":"131", - "code":"140" + "p_code":"154", + "code":"163" }, { "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", @@ -1265,8 +1472,8 @@ "title":"Querying Details About a Dataset Version", "uri":"DescribeDatasetVersion.html", "doc_type":"api", - "p_code":"131", - "code":"141" + "p_code":"154", + "code":"164" }, { "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", @@ -1274,8 +1481,8 @@ "title":"Deleting a Dataset Labeling Version", "uri":"DeleteDatasetVersion.html", "doc_type":"api", - "p_code":"131", - "code":"142" + "p_code":"154", + "code":"165" }, { "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", @@ -1283,8 +1490,8 @@ "title":"Obtaining a Sample List", "uri":"ListSamples.html", "doc_type":"api", - "p_code":"131", - "code":"143" + "p_code":"154", + "code":"166" }, { "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", @@ -1292,8 +1499,8 @@ "title":"Adding Samples in Batches", "uri":"UploadSamplesJson.html", "doc_type":"api", - "p_code":"131", - "code":"144" + "p_code":"154", + "code":"167" }, { "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", @@ -1301,8 +1508,8 @@ "title":"Deleting Samples in Batches", "uri":"DeleteSamples.html", "doc_type":"api", - "p_code":"131", - "code":"145" + "p_code":"154", + "code":"168" }, { "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", @@ -1310,8 +1517,8 @@ "title":"Obtaining Details About a Sample", "uri":"DescribeSample.html", "doc_type":"api", - "p_code":"131", - "code":"146" + "p_code":"154", + "code":"169" }, { "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", @@ -1319,8 +1526,8 @@ "title":"Obtaining Sample Search Condition", "uri":"ListSearch.html", "doc_type":"api", - "p_code":"131", - "code":"147" + "p_code":"154", + "code":"170" }, { "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 ", @@ -1328,8 +1535,8 @@ "title":"Obtaining a Sample List of a Team Labeling Task by Page", "uri":"ListWorkforceTaskSamples.html", "doc_type":"api", - "p_code":"131", - "code":"148" + "p_code":"154", + "code":"171" }, { "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", @@ -1337,8 +1544,8 @@ "title":"Obtaining Details About a Team Labeling Sample", "uri":"DescribeWorkforceTaskSample.html", "doc_type":"api", - "p_code":"131", - "code":"149" + "p_code":"154", + "code":"172" }, { "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", @@ -1346,8 +1553,8 @@ "title":"Querying the Dataset Label List", "uri":"ListLabels.html", "doc_type":"api", - "p_code":"131", - "code":"150" + "p_code":"154", + "code":"173" }, { "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", @@ -1355,8 +1562,8 @@ "title":"Creating a Dataset Label", "uri":"CreateLabels.html", "doc_type":"api", - "p_code":"131", - "code":"151" + "p_code":"154", + "code":"174" }, { "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", @@ -1364,8 +1571,8 @@ "title":"Modifying Labels in Batches", "uri":"UpdateLabels.html", "doc_type":"api", - "p_code":"131", - "code":"152" + "p_code":"154", + "code":"175" }, { "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", @@ -1373,8 +1580,8 @@ "title":"Deleting Labels in Batches", "uri":"DeleteLabels.html", "doc_type":"api", - "p_code":"131", - "code":"153" + "p_code":"154", + "code":"176" }, { "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", @@ -1382,8 +1589,8 @@ "title":"Updating a Label by Label Names", "uri":"UpdateLabel.html", "doc_type":"api", - "p_code":"131", - "code":"154" + "p_code":"154", + "code":"177" }, { "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", @@ -1391,8 +1598,8 @@ "title":"Deleting a Label and the Files that Only Contain the Label", "uri":"DeleteLabelAndSamples.html", "doc_type":"api", - "p_code":"131", - "code":"155" + "p_code":"154", + "code":"178" }, { "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", @@ -1400,8 +1607,8 @@ "title":"Updating Sample Labels in Batches", "uri":"UpdateSamples.html", "doc_type":"api", - "p_code":"131", - "code":"156" + "p_code":"154", + "code":"179" }, { "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", @@ -1409,8 +1616,8 @@ "title":"Querying the Team Labeling Task List of a Dataset", "uri":"ListWorkforceTasks.html", "doc_type":"api", - "p_code":"131", - "code":"157" + "p_code":"154", + "code":"180" }, { "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/", @@ -1418,8 +1625,8 @@ "title":"Creating a Team Labeling Task", "uri":"CreateWorkforceTask.html", "doc_type":"api", - "p_code":"131", - "code":"158" + "p_code":"154", + "code":"181" }, { "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", @@ -1427,8 +1634,8 @@ "title":"Querying Details About a Team Labeling Task", "uri":"DescWorkforceTask.html", "doc_type":"api", - "p_code":"131", - "code":"159" + "p_code":"154", + "code":"182" }, { "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/{", @@ -1436,8 +1643,8 @@ "title":"Starting a Team Labeling Task", "uri":"StartWorkforceTask.html", "doc_type":"api", - "p_code":"131", - "code":"160" + "p_code":"154", + "code":"183" }, { "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/{", @@ -1445,8 +1652,8 @@ "title":"Updating a Team Labeling Task", "uri":"UpdateWorkforceTask.html", "doc_type":"api", - "p_code":"131", - "code":"161" + "p_code":"154", + "code":"184" }, { "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", @@ -1454,8 +1661,8 @@ "title":"Deleting a Team Labeling Task", "uri":"DeleteWorkforceTask.html", "doc_type":"api", - "p_code":"131", - "code":"162" + "p_code":"154", + "code":"185" }, { "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", @@ -1463,8 +1670,8 @@ "title":"Creating a Team Labeling Acceptance Task", "uri":"StartWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"131", - "code":"163" + "p_code":"154", + "code":"186" }, { "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", @@ -1472,8 +1679,8 @@ "title":"Querying the Report of a Team Labeling Acceptance Task", "uri":"GetWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"131", - "code":"164" + "p_code":"154", + "code":"187" }, { "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", @@ -1481,8 +1688,8 @@ "title":"Updating Status of a Team Labeling Acceptance Task", "uri":"UpdateWorkforceSamplingTask.html", "doc_type":"api", - "p_code":"131", - "code":"165" + "p_code":"154", + "code":"188" }, { "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 ", @@ -1490,8 +1697,8 @@ "title":"Querying Details About Team Labeling Task Statistics", "uri":"ListWorkforceTaskStats.html", "doc_type":"api", - "p_code":"131", - "code":"166" + "p_code":"154", + "code":"189" }, { "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", @@ -1499,8 +1706,8 @@ "title":"Querying Details About the Progress of a Team Labeling Task Member", "uri":"GetWorkforceTaskMetrics.html", "doc_type":"api", - "p_code":"131", - "code":"167" + "p_code":"154", + "code":"190" }, { "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", @@ -1508,8 +1715,8 @@ "title":"Querying the Team Labeling Task List by a Team Member", "uri":"ListWorkerTasks.html", "doc_type":"api", - "p_code":"131", - "code":"168" + "p_code":"154", + "code":"191" }, { "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", @@ -1517,8 +1724,8 @@ "title":"Submitting Sample Review Comments of an Acceptance Task", "uri":"AcceptSamples.html", "doc_type":"api", - "p_code":"131", - "code":"169" + "p_code":"154", + "code":"192" }, { "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", @@ -1526,8 +1733,8 @@ "title":"Reviewing Team Labeling Results", "uri":"ReviewSamples.html", "doc_type":"api", - "p_code":"131", - "code":"170" + "p_code":"154", + "code":"193" }, { "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 ", @@ -1535,8 +1742,8 @@ "title":"Updating Labels of Team Labeling Samples in Batches", "uri":"UpdateWorkforceTaskSamples.html", "doc_type":"api", - "p_code":"131", - "code":"171" + "p_code":"154", + "code":"194" }, { "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/", @@ -1544,8 +1751,8 @@ "title":"Querying the Labeling Team List", "uri":"ListWorkforces.html", "doc_type":"api", - "p_code":"131", - "code":"172" + "p_code":"154", + "code":"195" }, { "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", @@ -1553,8 +1760,8 @@ "title":"Creating a Labeling Team", "uri":"CreateWorkforce.html", "doc_type":"api", - "p_code":"131", - "code":"173" + "p_code":"154", + "code":"196" }, { "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", @@ -1562,8 +1769,8 @@ "title":"Querying Details About a Labeling Team", "uri":"DescWorkforce.html", "doc_type":"api", - "p_code":"131", - "code":"174" + "p_code":"154", + "code":"197" }, { "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", @@ -1571,8 +1778,8 @@ "title":"Updating a Labeling Team", "uri":"UpdateWorkforce.html", "doc_type":"api", - "p_code":"131", - "code":"175" + "p_code":"154", + "code":"198" }, { "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", @@ -1580,8 +1787,8 @@ "title":"Deleting a Labeling Team", "uri":"DeleteWorkforce.html", "doc_type":"api", - "p_code":"131", - "code":"176" + "p_code":"154", + "code":"199" }, { "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", @@ -1589,8 +1796,8 @@ "title":"Sending an Email to a Labeling Team Member", "uri":"SendEmails.html", "doc_type":"api", - "p_code":"131", - "code":"177" + "p_code":"154", + "code":"200" }, { "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", @@ -1598,8 +1805,8 @@ "title":"Querying the List of All Labeling Team Members", "uri":"ListAllWorkers.html", "doc_type":"api", - "p_code":"131", - "code":"178" + "p_code":"154", + "code":"201" }, { "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", @@ -1607,8 +1814,8 @@ "title":"Querying the List of Labeling Team Members", "uri":"ListWorkers.html", "doc_type":"api", - "p_code":"131", - "code":"179" + "p_code":"154", + "code":"202" }, { "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", @@ -1616,8 +1823,8 @@ "title":"Creating a Labeling Team Member", "uri":"CreateWorker.html", "doc_type":"api", - "p_code":"131", - "code":"180" + "p_code":"154", + "code":"203" }, { "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", @@ -1625,8 +1832,8 @@ "title":"Deleting Labeling Team Members in Batches", "uri":"BatchDeleteWorkers.html", "doc_type":"api", - "p_code":"131", - "code":"181" + "p_code":"154", + "code":"204" }, { "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", @@ -1634,8 +1841,8 @@ "title":"Querying Details About Labeling Team Members", "uri":"DescWorker.html", "doc_type":"api", - "p_code":"131", - "code":"182" + "p_code":"154", + "code":"205" }, { "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", @@ -1643,8 +1850,8 @@ "title":"Updating a Labeling Team Member", "uri":"UpdateWorker.html", "doc_type":"api", - "p_code":"131", - "code":"183" + "p_code":"154", + "code":"206" }, { "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 ", @@ -1652,8 +1859,8 @@ "title":"Deleting a Labeling Team Member", "uri":"DeleteWorker.html", "doc_type":"api", - "p_code":"131", - "code":"184" + "p_code":"154", + "code":"207" }, { "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", @@ -1661,8 +1868,8 @@ "title":"Querying the Dataset Import Task List", "uri":"ListImportTasks.html", "doc_type":"api", - "p_code":"131", - "code":"185" + "p_code":"154", + "code":"208" }, { "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", @@ -1670,8 +1877,8 @@ "title":"Creating an Import Task", "uri":"ImportTask.html", "doc_type":"api", - "p_code":"131", - "code":"186" + "p_code":"154", + "code":"209" }, { "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", @@ -1679,8 +1886,8 @@ "title":"Querying Details About a Dataset Import Task", "uri":"DescImportTask.html", "doc_type":"api", - "p_code":"131", - "code":"187" + "p_code":"154", + "code":"210" }, { "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", @@ -1688,8 +1895,8 @@ "title":"Querying the Dataset Export Task List", "uri":"GetExportTasksStatusOfDataset.html", "doc_type":"api", - "p_code":"131", - "code":"188" + "p_code":"154", + "code":"211" }, { "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", @@ -1697,8 +1904,8 @@ "title":"Creating a Dataset Export Task", "uri":"ExportTask.html", "doc_type":"api", - "p_code":"131", - "code":"189" + "p_code":"154", + "code":"212" }, { "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", @@ -1706,8 +1913,8 @@ "title":"Querying the Status of a Dataset Export Task", "uri":"GetExportTaskStatusOfDataset.html", "doc_type":"api", - "p_code":"131", - "code":"190" + "p_code":"154", + "code":"213" }, { "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", @@ -1715,8 +1922,8 @@ "title":"Synchronizing a Dataset", "uri":"SyncDataSource.html", "doc_type":"api", - "p_code":"131", - "code":"191" + "p_code":"154", + "code":"214" }, { "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", @@ -1724,8 +1931,8 @@ "title":"Querying the Status of a Dataset Synchronization Task", "uri":"SyncDataSourceState.html", "doc_type":"api", - "p_code":"131", - "code":"192" + "p_code":"154", + "code":"215" }, { "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", @@ -1733,8 +1940,8 @@ "title":"Obtaining an Auto Labeling Sample List", "uri":"ListAutoAnnotationSamples.html", "doc_type":"api", - "p_code":"131", - "code":"193" + "p_code":"154", + "code":"216" }, { "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", @@ -1742,8 +1949,8 @@ "title":"Querying Details About an Auto Labeling Sample", "uri":"DescribeAutoAnnotationSample.html", "doc_type":"api", - "p_code":"131", - "code":"194" + "p_code":"154", + "code":"217" }, { "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", @@ -1751,8 +1958,8 @@ "title":"Obtaining an Auto Labeling Task List by Page", "uri":"ListTasks.html", "doc_type":"api", - "p_code":"131", - "code":"195" + "p_code":"154", + "code":"218" }, { "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", @@ -1760,8 +1967,8 @@ "title":"Starting Intelligent Tasks", "uri":"CreateTask.html", "doc_type":"api", - "p_code":"131", - "code":"196" + "p_code":"154", + "code":"219" }, { "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 ", @@ -1769,8 +1976,8 @@ "title":"Obtaining Details About an Auto Labeling Task", "uri":"AutoAnnotationProgress.html", "doc_type":"api", - "p_code":"131", - "code":"197" + "p_code":"154", + "code":"220" }, { "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", @@ -1778,8 +1985,8 @@ "title":"Stopping an Intelligent Task", "uri":"StopAutoAnnotation.html", "doc_type":"api", - "p_code":"131", - "code":"198" + "p_code":"154", + "code":"221" }, { "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", @@ -1787,8 +1994,8 @@ "title":"Querying the List of a Processing Task", "uri":"ListProcessorTasks.html", "doc_type":"api", - "p_code":"131", - "code":"199" + "p_code":"154", + "code":"222" }, { "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 ", @@ -1796,8 +2003,8 @@ "title":"Creating a Processing Task", "uri":"CreateProcessorTask.html", "doc_type":"api", - "p_code":"131", - "code":"200" + "p_code":"154", + "code":"223" }, { "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", @@ -1805,8 +2012,8 @@ "title":"Querying the Algorithm Type for Data Processing", "uri":"GetProcessorTaskItems.html", "doc_type":"api", - "p_code":"131", - "code":"201" + "p_code":"154", + "code":"224" }, { "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", @@ -1814,8 +2021,8 @@ "title":"Querying Details About a Processing Task", "uri":"DescribeProcessorTask.html", "doc_type":"api", - "p_code":"131", - "code":"202" + "p_code":"154", + "code":"225" }, { "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", @@ -1823,8 +2030,8 @@ "title":"Updating a Processing Task", "uri":"UpdateProcessorTask.html", "doc_type":"api", - "p_code":"131", - "code":"203" + "p_code":"154", + "code":"226" }, { "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", @@ -1832,8 +2039,8 @@ "title":"Deleting a Processing Task", "uri":"DeleteProcessorTask.html", "doc_type":"api", - "p_code":"131", - "code":"204" + "p_code":"154", + "code":"227" }, { "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", @@ -1841,8 +2048,8 @@ "title":"Querying the Version List of a Data Processing Task", "uri":"ListProcessorTaskVersions.html", "doc_type":"api", - "p_code":"131", - "code":"205" + "p_code":"154", + "code":"228" }, { "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", @@ -1850,8 +2057,8 @@ "title":"Creating a Data Processing Task Version", "uri":"CreateProcessorTaskVersion.html", "doc_type":"api", - "p_code":"131", - "code":"206" + "p_code":"154", + "code":"229" }, { "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", @@ -1859,8 +2066,8 @@ "title":"Querying the Details About the Version of a Data Processing Task", "uri":"DescProcessorTaskVersion.html", "doc_type":"api", - "p_code":"131", - "code":"207" + "p_code":"154", + "code":"230" }, { "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", @@ -1868,8 +2075,8 @@ "title":"Deleting a Data Processing Task Version", "uri":"DeleteProcessorTaskVersion.html", "doc_type":"api", - "p_code":"131", - "code":"208" + "p_code":"154", + "code":"231" }, { "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", @@ -1877,8 +2084,8 @@ "title":"Obtaining the Result of a Data Processing Task Version", "uri":"ListProcessorTaskVersionResults.html", "doc_type":"api", - "p_code":"131", - "code":"209" + "p_code":"154", + "code":"232" }, { "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", @@ -1886,8 +2093,8 @@ "title":"Stopping the Version of a Data Processing Task", "uri":"StopProcessorTaskVersion.html", "doc_type":"api", - "p_code":"131", - "code":"210" + "p_code":"154", + "code":"233" }, { "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.", @@ -1895,8 +2102,8 @@ "title":"DevEnviron (Old Version)", "uri":"modelarts_03_0108.html", "doc_type":"api", - "p_code":"130", - "code":"211" + "p_code":"153", + "code":"234" }, { "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", @@ -1904,8 +2111,8 @@ "title":"Creating a Development Environment Instance", "uri":"modelarts_03_0110.html", "doc_type":"api", - "p_code":"211", - "code":"212" + "p_code":"234", + "code":"235" }, { "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={", @@ -1913,8 +2120,8 @@ "title":"Obtaining Development Environment Instances", "uri":"modelarts_03_0111.html", "doc_type":"api", - "p_code":"211", - "code":"213" + "p_code":"234", + "code":"236" }, { "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", @@ -1922,8 +2129,8 @@ "title":"Obtaining Details About a Development Environment Instance", "uri":"modelarts_03_0112.html", "doc_type":"api", - "p_code":"211", - "code":"214" + "p_code":"234", + "code":"237" }, { "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", @@ -1931,8 +2138,8 @@ "title":"Modifying the Description of a Development Environment Instance", "uri":"modelarts_03_0113.html", "doc_type":"api", - "p_code":"211", - "code":"215" + "p_code":"234", + "code":"238" }, { "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", @@ -1940,8 +2147,8 @@ "title":"Deleting a Development Environment Instance", "uri":"modelarts_03_0114.html", "doc_type":"api", - "p_code":"211", - "code":"216" + "p_code":"234", + "code":"239" }, { "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", @@ -1949,8 +2156,8 @@ "title":"Managing a Development Environment Instance", "uri":"modelarts_03_0115.html", "doc_type":"api", - "p_code":"211", - "code":"217" + "p_code":"234", + "code":"240" }, { "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.", @@ -1958,8 +2165,8 @@ "title":"Training Management (Old Version)", "uri":"modelarts_03_0043.html", "doc_type":"api", - "p_code":"130", - "code":"218" + "p_code":"153", + "code":"241" }, { "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.", @@ -1967,8 +2174,8 @@ "title":"Training Jobs", "uri":"modelarts_03_0044.html", "doc_type":"api", - "p_code":"218", - "code":"219" + "p_code":"241", + "code":"242" }, { "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", @@ -1976,8 +2183,8 @@ "title":"Creating a Training Job", "uri":"modelarts_03_0045.html", "doc_type":"api", - "p_code":"219", - "code":"220" + "p_code":"242", + "code":"243" }, { "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", @@ -1985,8 +2192,8 @@ "title":"Querying a Training Job List", "uri":"modelarts_03_0046.html", "doc_type":"api", - "p_code":"219", - "code":"221" + "p_code":"242", + "code":"244" }, { "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", @@ -1994,8 +2201,8 @@ "title":"Querying the Details About a Training Job Version", "uri":"modelarts_03_0047.html", "doc_type":"api", - "p_code":"219", - "code":"222" + "p_code":"242", + "code":"245" }, { "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", @@ -2003,8 +2210,8 @@ "title":"Deleting a Version of a Training Job", "uri":"modelarts_03_0048.html", "doc_type":"api", - "p_code":"219", - "code":"223" + "p_code":"242", + "code":"246" }, { "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 ", @@ -2012,8 +2219,8 @@ "title":"Obtaining Training Job Versions", "uri":"modelarts_03_0049.html", "doc_type":"api", - "p_code":"219", - "code":"224" + "p_code":"242", + "code":"247" }, { "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", @@ -2021,8 +2228,8 @@ "title":"Creating a Version of a Training Job", "uri":"modelarts_03_0050.html", "doc_type":"api", - "p_code":"219", - "code":"225" + "p_code":"242", + "code":"248" }, { "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", @@ -2030,8 +2237,8 @@ "title":"Stopping a Training Job", "uri":"modelarts_03_0051.html", "doc_type":"api", - "p_code":"219", - "code":"226" + "p_code":"242", + "code":"249" }, { "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", @@ -2039,8 +2246,8 @@ "title":"Modifying the Description of a Training Job", "uri":"modelarts_03_0052.html", "doc_type":"api", - "p_code":"219", - "code":"227" + "p_code":"242", + "code":"250" }, { "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", @@ -2048,8 +2255,8 @@ "title":"Deleting a Training Job", "uri":"modelarts_03_0053.html", "doc_type":"api", - "p_code":"219", - "code":"228" + "p_code":"242", + "code":"251" }, { "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", @@ -2057,8 +2264,8 @@ "title":"Obtaining the Name of a Training Job Log File", "uri":"modelarts_03_0054.html", "doc_type":"api", - "p_code":"219", - "code":"229" + "p_code":"242", + "code":"252" }, { "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", @@ -2066,8 +2273,8 @@ "title":"Querying a Built-in Algorithm", "uri":"modelarts_03_0056.html", "doc_type":"api", - "p_code":"219", - "code":"230" + "p_code":"242", + "code":"253" }, { "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 ", @@ -2075,8 +2282,8 @@ "title":"Querying Training Job Logs", "uri":"modelarts_03_0149.html", "doc_type":"api", - "p_code":"219", - "code":"231" + "p_code":"242", + "code":"254" }, { "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.", @@ -2084,8 +2291,8 @@ "title":"Training Job Parameter Configuration", "uri":"modelarts_03_0057.html", "doc_type":"api", - "p_code":"218", - "code":"232" + "p_code":"241", + "code":"255" }, { "desc":"This API is used to create a training job configuration.POST /v1/{project_id}/training-job-configsTable 1 describes the required parameters.ParametersParameterMandatoryTy", @@ -2093,8 +2300,8 @@ "title":"Creating a Training Job Configuration", "uri":"modelarts_03_0058.html", "doc_type":"api", - "p_code":"232", - "code":"233" + "p_code":"255", + "code":"256" }, { "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", @@ -2102,8 +2309,8 @@ "title":"Querying a List of Training Job Configurations", "uri":"modelarts_03_0059.html", "doc_type":"api", - "p_code":"232", - "code":"234" + "p_code":"255", + "code":"257" }, { "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", @@ -2111,8 +2318,8 @@ "title":"Modifying a Training Job Configuration", "uri":"modelarts_03_0060.html", "doc_type":"api", - "p_code":"232", - "code":"235" + "p_code":"255", + "code":"258" }, { "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", @@ -2120,8 +2327,8 @@ "title":"Deleting a Training Job Configuration", "uri":"modelarts_03_0061.html", "doc_type":"api", - "p_code":"232", - "code":"236" + "p_code":"255", + "code":"259" }, { "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 ", @@ -2129,8 +2336,8 @@ "title":"Querying the Details About a Training Job Configuration", "uri":"modelarts_03_0062.html", "doc_type":"api", - "p_code":"232", - "code":"237" + "p_code":"255", + "code":"260" }, { "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.", @@ -2138,8 +2345,8 @@ "title":"Visualization Jobs", "uri":"modelarts_03_0063.html", "doc_type":"api", - "p_code":"218", - "code":"238" + "p_code":"241", + "code":"261" }, { "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", @@ -2147,8 +2354,8 @@ "title":"Creating a Visualization Job", "uri":"modelarts_03_0064.html", "doc_type":"api", - "p_code":"238", - "code":"239" + "p_code":"261", + "code":"262" }, { "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", @@ -2156,8 +2363,8 @@ "title":"Querying a Visualization Job List", "uri":"modelarts_03_0065.html", "doc_type":"api", - "p_code":"238", - "code":"240" + "p_code":"261", + "code":"263" }, { "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", @@ -2165,8 +2372,8 @@ "title":"Querying the Details About a Visualization Job", "uri":"modelarts_03_0066.html", "doc_type":"api", - "p_code":"238", - "code":"241" + "p_code":"261", + "code":"264" }, { "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", @@ -2174,8 +2381,8 @@ "title":"Modifying the Description of a Visualization Job", "uri":"modelarts_03_0067.html", "doc_type":"api", - "p_code":"238", - "code":"242" + "p_code":"261", + "code":"265" }, { "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 ", @@ -2183,8 +2390,8 @@ "title":"Deleting a Visualization Job", "uri":"modelarts_03_0068.html", "doc_type":"api", - "p_code":"238", - "code":"243" + "p_code":"261", + "code":"266" }, { "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", @@ -2192,8 +2399,8 @@ "title":"Stopping a Visualization Job", "uri":"modelarts_03_0069.html", "doc_type":"api", - "p_code":"238", - "code":"244" + "p_code":"261", + "code":"267" }, { "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", @@ -2201,8 +2408,8 @@ "title":"Restarting a Visualization Job", "uri":"modelarts_03_0070.html", "doc_type":"api", - "p_code":"238", - "code":"245" + "p_code":"261", + "code":"268" }, { "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.", @@ -2210,8 +2417,8 @@ "title":"Resource and Engine Specifications", "uri":"modelarts_03_0071.html", "doc_type":"api", - "p_code":"218", - "code":"246" + "p_code":"241", + "code":"269" }, { "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", @@ -2219,8 +2426,8 @@ "title":"Querying Job Resource Specifications", "uri":"modelarts_03_0072.html", "doc_type":"api", - "p_code":"246", - "code":"247" + "p_code":"269", + "code":"270" }, { "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 ", @@ -2228,8 +2435,8 @@ "title":"Querying Job Engine Specifications", "uri":"modelarts_03_0073.html", "doc_type":"api", - "p_code":"246", - "code":"248" + "p_code":"269", + "code":"271" }, { "desc":"Table 1 describes the job statuses.", @@ -2237,7 +2444,7 @@ "title":"Job Statuses", "uri":"modelarts_03_0074.html", "doc_type":"api", - "p_code":"218", - "code":"249" + "p_code":"241", + "code":"272" } ] \ No newline at end of file diff --git a/docs/modelarts/api-ref/CancelObs.html b/docs/modelarts/api-ref/CancelObs.html index f43cfcd9f..8d76e1812 100644 --- a/docs/modelarts/api-ref/CancelObs.html +++ b/docs/modelarts/api-ref/CancelObs.html @@ -1,11 +1,11 @@ - +

Unmounting OBS Storage from a Notebook Instance

Function

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 container.

Constraints

None

-

URI

DELETE /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

+

URI

DELETE /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id}

@@ -52,7 +52,7 @@

Response Parameters

Status code: 200

-
Table 1 Path Parameters

Parameter

Table 2 Response body parameters

Parameter

+
@@ -119,7 +119,7 @@ }

Status Codes

-
Table 2 Response body parameters

Parameter

Type

Status Code

+
diff --git a/docs/modelarts/api-ref/ChangeAlgorithm.html b/docs/modelarts/api-ref/ChangeAlgorithm.html index d4f5012f9..3faa19f59 100644 --- a/docs/modelarts/api-ref/ChangeAlgorithm.html +++ b/docs/modelarts/api-ref/ChangeAlgorithm.html @@ -1,88 +1,88 @@ - +

Modifying an Algorithm

-

Function

This API is used to modify an algorithm.

+

Function

This API is used to modify an algorithm.

-

URI

PUT /v2/{project_id}/algorithms/{algorithm_id}

+

URI

PUT /v2/{project_id}/algorithms/{algorithm_id}

-

Status Code

Description

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details, see Obtaining a Project ID and Name.

+

Project ID. For details, see Obtaining a Project ID and Name.

algorithm_id

+

algorithm_id

Yes

+

Yes

String

+

String

Algorithm ID.

+

Algorithm ID.

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

+
- - - - - - - - - - - - - - - - - - - @@ -90,380 +90,380 @@
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

metadata

+

metadata

No

+

No

AlgorithmMetadata object

+

AlgorithmMetadata object

Algorithm metadata, which describes basic algorithm information.

+

Algorithm metadata, which describes basic algorithm information.

job_config

+

job_config

No

+

No

AlgorithmJobConfig object

+

AlgorithmJobConfig object

Algorithm configuration, such as the boot file.

+

Algorithm configuration, such as the boot file.

resource_requirements

+

resource_requirements

No

+

No

Array of ResourceRequirement objects

+

Array of ResourceRequirement objects

Algorithm resource constraints. This parameter is optional. After this parameter is set, the console filters available public resource pools when the algorithm is used in training jobs.

+

Algorithm resource constraints. This parameter is optional. After this parameter is set, the console filters available public resource pools when the algorithm is used in training jobs.

advanced_config

+

advanced_config

No

+

No

AlgorithmAdvancedConfig object

+

AlgorithmAdvancedConfig object

Advanced algorithm policy:

-
  • auto_search

    +

Advanced algorithm policy:

+
  • auto_search

-
Table 3 AlgorithmMetadata

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 3 AlgorithmMetadata

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

id

+

id

No

+

No

Integer

+

Integer

Algorithm UUID. You do not need to set this parameter when creating an algorithm.

+

Algorithm UUID. You do not need to set this parameter when creating an algorithm.

name

+

name

Yes

+

Yes

String

+

String

Algorithm name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

+

Algorithm name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

description

+

description

No

+

No

String

+

String

Algorithm description, which consists of 0 to 256 characters. The default value is NULL.

+

Algorithm description, which consists of 0 to 256 characters. The default value is NULL.

workspace_id

+

workspace_id

No

+

No

String

+

String

Workspace where a specified algorithm is located. The default value is 0, indicating the default workspace.

+

Workspace where a specified algorithm is located. The default value is 0, indicating the default workspace.

ai_project

+

ai_project

No

+

No

String

+

String

AI project to which a specified algorithm belongs. The default value is default-ai-project. The AI project has been brought offline. Ignore it.

+

AI project to which a specified algorithm belongs. The default value is default-ai-project. The AI project has been brought offline. Ignore it.

-
Table 4 AlgorithmJobConfig

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 AlgorithmJobConfig

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

code_dir

+

code_dir

No

+

No

String

+

String

Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.

+

Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.

boot_file

+

boot_file

No

+

No

String

+

String

Code boot file of the algorithm, which must be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used with code_dir.

+

Code boot file of the algorithm, which must be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used with code_dir.

command

+

command

No

+

No

String

+

String

Container boot command of a custom image algorithm.

+

Container boot command of a custom image algorithm.

parameters

+

parameters

No

+

No

Array of Parameters objects

+

Array of Parameters objects

Running parameter of an algorithm.

+

Running parameter of an algorithm.

inputs

+

inputs

No

+

No

Array of AlgorithmCreateInput objects

+

Array of AlgorithmCreateInput objects

Data input of an algorithm.

+

Data input of an algorithm.

outputs

+

outputs

No

+

No

Array of AlgorithmCreateOutput objects

+

Array of AlgorithmCreateOutput objects

Data output of an algorithm.

+

Data output of an algorithm.

engine

+

engine

No

+

No

AlgorithmCreateEngine object

+

AlgorithmCreateEngine object

Algorithm engine.

+

Algorithm engine.

parameters_customization

+

parameters_customization

No

+

No

Boolean

+

Boolean

Whether the algorithm allows hyperparameter customization during training job creation.

+

Whether the algorithm allows hyperparameter customization during training job creation.

-
Table 5 Parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - -
Table 5 Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

Parameter name.

+

Parameter name.

value

+

value

No

+

No

String

+

String

Parameter value.

+

Parameter value.

description

+

description

No

+

No

String

+

String

Parameter description.

+

Parameter description.

constraint

+

constraint

No

+

No

ParametersConstraint object

+

ParametersConstraint object

Parameter constraint.

+

Parameter constraint.

i18n_description

+

i18n_description

No

+

No

I18nDescription object

+

I18nDescription object

Internationalization description.

+

Internationalization description.

-
Table 6 ParametersConstraint

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 ParametersConstraint

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

type

+

type

No

+

No

String

+

String

Parameter type.

+

Parameter type.

editable

+

editable

No

+

No

Boolean

+

Boolean

Whether the parameter is editable.

+

Whether the parameter is editable.

required

+

required

No

+

No

Boolean

+

Boolean

Whether the parameter is mandatory.

+

Whether the parameter is mandatory.

sensitive

+

sensitive

No

+

No

Boolean

+

Boolean

Whether the parameter is sensitive. This function is not implemented currently.

+

Whether the parameter is sensitive. This function is not implemented currently.

valid_type

+

valid_type

No

+

No

String

+

String

Valid type.

+

Valid type.

valid_range

+

valid_range

No

+

No

Array of strings

+

Array of strings

Valid range.

+

Valid range.

-
Table 7 I18nDescription

Parameter

+
- - - - - - - - - - -
Table 7 I18nDescription

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

language

+

language

No

+

No

String

+

String

Internationalization language.

+

Internationalization language.

description

+

description

No

+

No

String

+

String

Description.

+

Description.

-
Table 8 AlgorithmCreateInput

Parameter

+
- - - - - - - - - - - - - - -
Table 8 AlgorithmCreateInput

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

Name of the data input channel.

+

Name of the data input channel.

description

+

description

No

+

No

String

+

String

Description of the data input channel.

+

Description of the data input channel.

remote_constraints

+

remote_constraints

No

+

No

Array of RemoteConstraint objects

+

Array of RemoteConstraint objects

Data input constraint.

+

Data input constraint.

-
Table 9 RemoteConstraint

Parameter

+
- - - - - - - - - - - @@ -471,425 +471,425 @@
Table 9 RemoteConstraint

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

data_type

+

data_type

No

+

No

String

+

String

Data input type. The data storage location (OBS) and ModelArts dataset are supported.

+

Data input type. The data storage location (OBS) and ModelArts dataset are supported.

attributes

+

attributes

No

+

No

Array of Map<String,String> objects

+

Array of Map<String,String> objects

Attributes when the data input type is a dataset. Enumerated values:

-
  • data_format: data format

    -
  • data_segmentation: data segmentation

    -
  • dataset_type: data labeling

    +

Attributes when the data input type is a dataset. Enumerated values:

+
  • data_format: data format

    +
  • data_segmentation: data segmentation

    +
  • dataset_type: data labeling

-
Table 10 AlgorithmCreateOutput

Parameter

+
- - - - - - - - - - -
Table 10 AlgorithmCreateOutput

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

Yes

+

Yes

String

+

String

Name of the data output channel.

+

Name of the data output channel.

description

+

description

No

+

No

String

+

String

Description of the data output channel.

+

Description of the data output channel.

-
Table 11 AlgorithmCreateEngine

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 11 AlgorithmCreateEngine

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

engine_id

+

engine_id

No

+

No

String

+

String

Engine ID selected for an algorithm.

+

Engine ID selected for an algorithm.

engine_name

+

engine_name

No

+

No

String

+

String

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

+

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

engine_version

+

engine_version

No

+

No

String

+

String

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

+

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

image_url

+

image_url

No

+

No

String

+

String

Custom image URL selected for an algorithm.

+

Custom image URL selected for an algorithm.

-
Table 12 ResourceRequirement

Parameter

+
- - - - - - - - - - - - - - -
Table 12 ResourceRequirement

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

No

+

No

String

+

String

Resource constraint. The options are as follows:

-
  • flavor_type: flavor type, which can be CPU or GPU.

    -
  • device_distributed_mode: whether to support multi-card training. The value can be multiple (supported) or singular (not supported).

    -
  • host_distributed_mode: whether to support distributed training. The value can be multiple (supported) or singular (not supported).

    +

Resource constraint. The options are as follows:

+
  • flavor_type: flavor type, which can be CPU or GPU.

    +
  • device_distributed_mode: whether to support multi-card training. The value can be multiple (supported) or singular (not supported).

    +
  • host_distributed_mode: whether to support distributed training. The value can be multiple (supported) or singular (not supported).

values

+

values

No

+

No

Array of strings

+

Array of strings

Value of the resource constraint key.

+

Value of the resource constraint key.

operator

+

operator

No

+

No

String

+

String

Relationship between keys and values. Currently, only in is supported. For example, flavor_type in [CPU,GPU].

+

Relationship between keys and values. Currently, only in is supported. For example, flavor_type in [CPU,GPU].

-
Table 13 AlgorithmAdvancedConfig

Parameter

+
- - - - - - -
Table 13 AlgorithmAdvancedConfig

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

auto_search

+

auto_search

No

+

No

AutoSearch object

+

AutoSearch object

Hyperparameter search policy.

+

Hyperparameter search policy.

-
Table 14 AutoSearch

Parameter

+
- - - - - - - - - - - - - - - - - - -
Table 14 AutoSearch

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

skip_search_params

+

skip_search_params

No

+

No

String

+

String

Hyperparameter parameters that need to be skipped.

+

Hyperparameter parameters that need to be skipped.

reward_attrs

+

reward_attrs

No

+

No

Array of RewardAttrs objects

+

Array of RewardAttrs objects

Search metrics.

+

Search metrics.

search_params

+

search_params

No

+

No

Array of SearchParams objects

+

Array of SearchParams objects

Search parameters.

+

Search parameters.

algo_configs

+

algo_configs

No

+

No

Array of AlgoConfigs objects

+

Array of AlgoConfigs objects

Search algorithm configurations.

+

Search algorithm configurations.

-
Table 15 RewardAttrs

Parameter

+
- - - - - - - - - - - - - - -
Table 15 RewardAttrs

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

Metric name.

+

Metric name.

mode

+

mode

No

+

No

String

+

String

Search mode. - If max is specified, the larger the metric value, the better. - If min is specified, the smaller the metric value, the better.

+

Search mode. - If max is specified, the larger the metric value, the better. - If min is specified, the smaller the metric value, the better.

regex

+

regex

No

+

No

String

+

String

Regular expression of a metric.

+

Regular expression of a metric.

-
Table 16 SearchParams

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 16 SearchParams

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

Hyperparameter name.

+

Hyperparameter name.

param_type

+

param_type

No

+

No

String

+

String

Parameter type. - continuous: The hyperparameter is of the continuous type. When an algorithm is used in a training job, continuous hyperparameters are displayed as text boxes on the console. - discrete: The hyperparameter is of the discrete type. When an algorithm is used in a training job, discrete hyperparameters are displayed as drop-down lists on the console.

+

Parameter type. - continuous: The hyperparameter is of the continuous type. When an algorithm is used in a training job, continuous hyperparameters are displayed as text boxes on the console. - discrete: The hyperparameter is of the discrete type. When an algorithm is used in a training job, discrete hyperparameters are displayed as drop-down lists on the console.

lower_bound

+

lower_bound

No

+

No

String

+

String

Lower bound of the hyperparameter.

+

Lower bound of the hyperparameter.

upper_bound

+

upper_bound

No

+

No

String

+

String

Upper bound of the hyperparameter.

+

Upper bound of the hyperparameter.

discrete_points_num

+

discrete_points_num

No

+

No

String

+

String

Number of discrete points of a hyperparameter with continuous values.

+

Number of discrete points of a hyperparameter with continuous values.

discrete_values

+

discrete_values

No

+

No

Array of strings

+

Array of strings

Discrete hyperparameter values.

+

Discrete hyperparameter values.

-
Table 17 AlgoConfigs

Parameter

+
- - - - - - - - - - -
Table 17 AlgoConfigs

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

No

+

No

String

+

String

Name of the search algorithm.

+

Name of the search algorithm.

params

+

params

No

+

No

Array of AutoSearchAlgoConfigParameter objects

+

Array of AutoSearchAlgoConfigParameter objects

Search algorithm parameters.

+

Search algorithm parameters.

-
Table 18 AutoSearchAlgoConfigParameter

Parameter

+
- - - - - - - - - - - - - - -
Table 18 AutoSearchAlgoConfigParameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

No

+

No

String

+

String

Parameter key.

+

Parameter key.

value

+

value

No

+

No

String

+

String

Parameter value.

+

Parameter value.

type

+

type

No

+

No

String

+

String

Parameter type.

+

Parameter type.

-

Response Parameters

Status code: 201

+

Response Parameters

Status code: 201

-
Table 19 Response body parameters

Parameter

+
- - - - - - - - - - - - - - @@ -897,395 +897,395 @@
Table 19 Response body parameters

Parameter

Type

+

Type

Description

+

Description

metadata

+

metadata

metadata object

+

metadata object

Algorithm metadata, which describes basic algorithm information.

+

Algorithm metadata, which describes basic algorithm information.

job_config

+

job_config

job_config object

+

job_config object

Algorithm configuration, such as the boot file.

+

Algorithm configuration, such as the boot file.

resource_requirements

+

resource_requirements

Array of resource_requirements objects

+

Array of resource_requirements objects

Algorithm resource constraint. This parameter is optional. After this parameter is set, the console filters available public resource pools when the algorithm is used in training jobs.

+

Algorithm resource constraint. This parameter is optional. After this parameter is set, the console filters available public resource pools when the algorithm is used in training jobs.

advanced_config

+

advanced_config

advanced_config object

+

advanced_config object

Advanced algorithm policy:

-
  • auto_search

    +

Advanced algorithm policy:

+
  • auto_search

-
Table 20 metadata

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 20 metadata

Parameter

Type

+

Type

Description

+

Description

id

+

id

Integer

+

Integer

Algorithm UUID. You do not need to set this parameter when creating an algorithm.

+

Algorithm UUID. You do not need to set this parameter when creating an algorithm.

name

+

name

String

+

String

Algorithm name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

+

Algorithm name. The value must contain 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-).

description

+

description

String

+

String

Description of the algorithm. The value is a string of [0, 256] characters. The default value is NULL.

+

Description of the algorithm. The value is a string of [0, 256] characters. The default value is NULL.

workspace_id

+

workspace_id

String

+

String

Workspace where a specified algorithm is located. The default value is 0. The value 0 indicates the default workspace.

+

Workspace where a specified algorithm is located. The default value is 0. The value 0 indicates the default workspace.

ai_project

+

ai_project

String

+

String

AI project to which a specified algorithm belongs. The default value is default-ai-project. The AI project has been brought offline. Ignore it.

+

AI project to which a specified algorithm belongs. The default value is default-ai-project. The AI project has been brought offline. Ignore it.

user_name

+

user_name

String

+

String

Username.

+

Username.

domain_id

+

domain_id

String

+

String

Domain ID of a user.

+

Domain ID of a user.

source

+

source

String

+

String

Algorithm source.

+

Algorithm source.

api_version

+

api_version

String

+

String

Algorithm API version, which identifies the old and new ones.

+

Algorithm API version, which identifies the old and new ones.

is_valid

+

is_valid

String

+

String

Algorithm availability.

+

Algorithm availability.

state

+

state

String

+

String

Algorithm state.

+

Algorithm state.

tags

+

tags

Array of Map<String,String> objects

+

Array of Map<String,String> objects

Algorithm tags.

+

Algorithm tags.

attr_list

+

attr_list

Array of strings

+

Array of strings

Algorithm attribute list.

+

Algorithm attribute list.

version_num

+

version_num

Integer

+

Integer

Number of algorithm versions. The default value is 0.

+

Number of algorithm versions. The default value is 0.

size

+

size

Integer

+

Integer

Algorithm size.

+

Algorithm size.

create_time

+

create_time

Long

+

Long

Timestamp when the algorithm is created.

+

Timestamp when the algorithm is created.

update_time

+

update_time

Long

+

Long

Timestamp when the algorithm is updated.

+

Timestamp when the algorithm is updated.

-
Table 21 job_config

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 21 job_config

Parameter

Type

+

Type

Description

+

Description

code_dir

+

code_dir

String

+

String

Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.

+

Algorithm code directory, for example, /usr/app/. This parameter must be used together with boot_file.

boot_file

+

boot_file

String

+

String

Code boot file of the algorithm, which must be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used with code_dir.

+

Code boot file of the algorithm, which must be stored in the code directory, for example, /usr/app/boot.py. This parameter must be used with code_dir.

command

+

command

String

+

String

Container startup command of a custom image algorithm.

+

Container startup command of a custom image algorithm.

parameters

+

parameters

Array of Parameter objects

+

Array of Parameter objects

Running parameter of an algorithm.

+

Running parameter of an algorithm.

inputs

+

inputs

Array of inputs objects

+

Array of inputs objects

Data input of an algorithm.

+

Data input of an algorithm.

outputs

+

outputs

Array of outputs objects

+

Array of outputs objects

Data output of an algorithm.

+

Data output of an algorithm.

engine

+

engine

engine object

+

engine object

Algorithm engine.

+

Algorithm engine.

code_tree

+

code_tree

Array of code_tree objects

+

Array of code_tree objects

Algorithm directory tree

+

Algorithm directory tree

parameters_customization

+

parameters_customization

Boolean

+

Boolean

Whether the algorithm allows hyperparameter customization during training job creation.

+

Whether the algorithm allows hyperparameter customization during training job creation.

-
Table 22 Parameter

Parameter

+
- - - - - - - - - - - - - - - - -
Table 22 Parameter

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Parameter name.

+

Parameter name.

value

+

value

String

+

String

Parameter value.

+

Parameter value.

description

+

description

String

+

String

Parameter description.

+

Parameter description.

constraint

+

constraint

constraint object

+

constraint object

Parameter constraint.

+

Parameter constraint.

i18n_description

+

i18n_description

i18n_description object

+

i18n_description object

Internationalization description.

+

Internationalization description.

-
Table 23 constraint

Parameter

+
- - - - - - - - - - - - - - - - - - - -
Table 23 constraint

Parameter

Type

+

Type

Description

+

Description

type

+

type

String

+

String

Parameter type.

+

Parameter type.

editable

+

editable

Boolean

+

Boolean

Whether the parameter is editable.

+

Whether the parameter is editable.

required

+

required

Boolean

+

Boolean

Whether the parameter is mandatory.

+

Whether the parameter is mandatory.

sensitive

+

sensitive

Boolean

+

Boolean

Whether the parameter is sensitive This function is not implemented currently.

+

Whether the parameter is sensitive This function is not implemented currently.

valid_type

+

valid_type

String

+

String

Valid type.

+

Valid type.

valid_range

+

valid_range

Array of strings

+

Array of strings

Valid range.

+

Valid range.

-
Table 24 i18n_description

Parameter

+
- - - - - - - -
Table 24 i18n_description

Parameter

Type

+

Type

Description

+

Description

language

+

language

String

+

String

International language.

+

International language.

description

+

description

String

+

String

Description of an international language.

+

Description of an international language.

-
Table 25 inputs

Parameter

+
- - - - - - - - - - -
Table 25 inputs

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Name of the data input channel.

+

Name of the data input channel.

description

+

description

String

+

String

Description of the data input channel.

+

Description of the data input channel.

remote_constraints

+

remote_constraints

Array of remote_constraints objects

+

Array of remote_constraints objects

Data input constraint.

+

Data input constraint.

-
Table 26 remote_constraints

Parameter

+
- - - - - - - - @@ -1293,348 +1293,348 @@
Table 26 remote_constraints

Parameter

Type

+

Type

Description

+

Description

data_type

+

data_type

String

+

String

Data input type, including the data storage location and dataset.

+

Data input type, including the data storage location and dataset.

attributes

+

attributes

Array of Map<String,String> objects

+

Array of Map<String,String> objects

Attributes when the data input type is a dataset. Enums:

-
  • data_format: data format

    -
  • data_segmentation: data segmentation

    -
  • dataset_type: data labeling

    +

Attributes when the data input type is a dataset. Enums:

+
  • data_format: data format

    +
  • data_segmentation: data segmentation

    +
  • dataset_type: data labeling

-
Table 27 outputs

Parameter

+
- - - - - - - -
Table 27 outputs

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Name of the data output channel.

+

Name of the data output channel.

description

+

description

String

+

String

Description of the data output channel.

+

Description of the data output channel.

-
Table 28 engine

Parameter

+
- - - - - - - - - - - - - -
Table 28 engine

Parameter

Type

+

Type

Description

+

Description

engine_id

+

engine_id

String

+

String

Engine ID selected for an algorithm.

+

Engine ID selected for an algorithm.

engine_name

+

engine_name

String

+

String

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

+

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

engine_version

+

engine_version

String

+

String

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

+

Engine version name selected for an algorithm. If engine_id is specified, leave this parameter blank.

image_url

+

image_url

String

+

String

Custom image URL selected by an algorithm.

+

Custom image URL selected by an algorithm.

-
Table 29 code_tree

Parameter

+
- - - - - - - -
Table 29 code_tree

Parameter

Type

+

Type

Description

+

Description

name

+

name

String

+

String

Name of the current directory in the algorithm directory tree.

+

Name of the current directory in the algorithm directory tree.

children

+

children

Object

+

Object

Subfiles and subdirectories in the current directory of the algorithm directory tree.

+

Subfiles and subdirectories in the current directory of the algorithm directory tree.

-
Table 30 resource_requirements

Parameter

+
- - - - - - - - - - -
Table 30 resource_requirements

Parameter

Type

+

Type

Description

+

Description

key

+

key

String

+

String

Resource constraint. The options are as follows:

-
  • flavor_type: flavor type, which can be CPU or GPU.

    -
  • device_distributed_mode: whether to support multi-card training. The value can be multiple (supported) or singular (not supported).

    -
  • host_distributed_mode: whether to support distributed training. The value can be multiple (supported) or singular (not supported).

    +

Resource constraint. The options are as follows:

+
  • flavor_type: flavor type, which can be CPU or GPU.

    +
  • device_distributed_mode: whether to support multi-card training. The value can be multiple (supported) or singular (not supported).

    +
  • host_distributed_mode: whether to support distributed training. The value can be multiple (supported) or singular (not supported).

value

+

value

Array of strings

+

Array of strings

Value of the resource constraint key.

+

Value of the resource constraint key.

operator

+

operator

String

+

String

Relationship between keys and values. Currently, only in is supported. For example, flavor_type in [CPU,GPU].

+

Relationship between keys and values. Currently, only in is supported. For example, flavor_type in [CPU,GPU].

-
Table 31 advanced_config

Parameter

+
- - - - -
Table 31 advanced_config

Parameter

Type

+

Type

Description

+

Description

auto_search

+

auto_search

auto_search object

+

auto_search object

Hyperparameter search policy.

+

Hyperparameter search policy.

-