API OVERVIEW

Querying Notebook Instances

This API is used to obtain information about notebook instances that meet specific conditions.

Creating a Notebook Instance

This API is used to create a notebook instance based on specified parameters.

Querying All Notebook Instances

This API is used to obtain information about all created notebook instances.

Querying Details of a Notebook Instance

This API is used to obtain the details of a specified notebook instance.

Updating a Notebook Instance

This API is used to modify the instance configurations, including its name, description, specifications, and image.

Deleting a Notebook Instance

This API is used to delete a created notebook instance and its related resources.

Saving a Running Instance as a Container Image

This API is used to save a running instance as a container image.

Querying the List of Valid Specifications Supported by Notebook Instances

This API is used to obtain the available specifications supported by notebook instances. This API applies to the following scenario: When you want to know the configuration options supported by a notebook instance, you can use this API to query the list of available specifications. Before using this API, ensure that you have logged in to the system and have the permission to access the target notebook instance. After this API is called, the system returns the valid specifications supported by the notebook instance. For example, the memory and CPU. If you do not have the permission to access the specified notebook instance or the notebook instance is not running, the API will return an error message.

Querying the List of Switchable Specifications Supported by Notebook Instances

This API is used to obtain the available specifications that can be switched during notebook instance creation.

Querying the Available Duration of a Running Notebook Instance

This API is used to obtain the available duration of a running notebook instance.

Prolonging a Notebook Instance

This API is used to prolong the running time of a running notebook instance. This API applies to the following scenarios: When you need to prolong the running time of a notebook instance to complete long-time tasks, you can call this API to do so. Before using this API, ensure that you have logged in to the system and have the permission to perform operations on the target notebook instance. In addition, the notebook instance must be running. After this API is called, the system prolongs the running time of the specified notebook instance, so that you can continue to use it. If you do not have the permission to perform operations on the specified notebook instance or the notebook instance is not running, the API will return an error message.

Starting a Notebook Instance

This API is used to start a created notebook instance.

Stopping a Notebook Instance

This API is used to stop a notebook instance that is running.

Obtaining Details About All Notebook Resource Pool Instances

This API is used to obtain details about all notebook resource pool instances associated with a user. This API is used when you need to select a resource pool when creating a notebook instance. Before using this API, ensure that you have registered and logged in to the system and have the permission to view resource pool instances. After the API is called, the API returns a list of detailed information about all resource pool instances, including the instance name, status, and node specifications. If you have not logged in to the system, do not have the required permission to access the resource pool, or an internal error occurs in the system, the API returns an error message, for example, unauthorized access, service unavailable, or internal error.

Obtaining Details About a Notebook Resource Pool

This API is used to obtain details about a notebook resource pool. This API is used when you need to query details about a specified cluster when creating a notebook instance job. Before using this API, ensure that the cluster has been managed and you have the required permission. After this API is called, the system returns the instance ID, name, flavor, instance status, and URL for accessing the cluster. If the cluster does not exist, is not managed, or you do not have the access permission, the API will return an error message.

Querying the Switch and Quota of a Specified Feature of the Current User

This API is used to query the switch status and quota information of a specified feature of the current user. This API is used when you need to know whether a specific feature is enabled, check the quota limit, or monitor the used resources. Before using this API, ensure that you have logged in and have the query permission, and the specified feature must exist. After this API is called, the system returns the details, such as whether the feature is enabled, total quota, and used resources. If you do not have the required permission, the feature does not exist, or the system is abnormal, the API will return an error message.

Obtaining the Notebook Instances with OBS Storage Mounted

This API is used to obtain the OBS parallel file system that can be mounted to a running notebook instance.

OBS Storage Mounting

This API is used to mount an OBS parallel file system to a specified file directory of a running notebook instance.

Obtaining Details About a Notebook Instance with OBS Storage Mounted

This API is used to obtain the details of the OBS parallel file system that has been mounted to a running notebook instance.

Unmounting OBS Storage from a Notebook Instance

This API is used to unmount an OBS parallel file system from a running notebook instance.

Querying Supported Images

This API is used to query all images by page based on specified conditions.

Registering a Custom Image

This API is used to register a custom image with ModelArts image management.

Querying the User Image List

This API is used to obtain the overview of user image information. Image names are used for aggregation.

Obtaining Details of an Image

This API is used to query image details.

Deleting an Image

This API is used to delete an image object. For a private image, you can also delete its SWR image content using parameters.

Synchronizing the Image Status

This API is used to correct the abnormal image status. This API is used when you need to synchronize the latest image status when the image status is abnormal due to misoperations, network problems, or system faults. Before using this API, ensure that the image exists and you have the required permission. After the synchronization, the image status is updated to the latest correct status, and related resources and configurations are synchronized. If the image does not exist, you do not have the operation permission, or an error occurs during the synchronization, the API will return an error message.

Creating an Algorithm

This API is used to create an algorithm on ModelArts.

Querying the Algorithm List

This API is used to obtain the list of all algorithms on ModelArts.

Querying Algorithm Details

This API is used to obtain the details of a specified algorithm on ModelArts.

Modifying an Algorithm

This API is used to modify the information of an existing algorithm.

Deleting an Algorithm

This API is used to remove a registered algorithm from ModelArts.

Creating a Training Job

This API is used to create a training job on ModelArts.

Querying the Details About a Training Job

This API is used to query the details about a training job on ModelArts.

Modifying the Description of a Training Job

This API is used to modify the description of an existing training job.

Deleting a Training Job

This API is used to delete a training job from ModelArts.

Terminating a Training Job

This API is used to terminate a training job on ModelArts. Only jobs in the creating, awaiting, or running state can be terminated.

Querying the Logs of a Specified Task in a Given Training Job (Preview)

This API is used to query the logs of a specified task in a given training job on ModelArts (preview).

Querying the Logs of a Specified Task in a Training Job (OBS Link)

This API is used to obtain the OBS link where the log files of a specified training job are stored.

Querying the Running Metrics of a Specified Task in a Training Job

This API is used to query the running metrics of a specified task in a training job on ModelArts.

Querying a Training Job List

This API is used to obtain the list of all training jobs on ModelArts.

Obtaining the Events of a Training Job

This API is used to obtain the events of a training job on ModelArts.

Obtaining the General Specifications Supported by a Training Job

This API is used to obtain the supported resource specifications of training jobs on ModelArts.

Obtaining the Preset AI Frameworks Supported by a Training Job

This API is used to query the list of preset AI frameworks supported by the current system.

Obtaining the Model Runtime

This API is used to obtain the AI engine and runtime of models.

Querying the AI Application List

This API is used to query the AI application list based on different search parameters.

Creating an AI Application

Import a meta model to create an AI application.

Obtaining Details About an AI Application

This API is used to query details about an AI application based on the AI application ID.

Deleting an AI application

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 other AI applications with the same name but different versions as the specified AI application are deleted. By default, only the AI application corresponding to the current AI application ID is deleted.

Obtaining the App List

This API is used to obtain the basic information about APIG apps. You can obtain only the information about the apps created by yourself.

Creating Apps

This API is used to create API Gateway applications (apps for short). Each user can create a maximum of five apps. You can apply for increasing the quota as required.

Obtaining App Details

This API is used to obtain details about a specified app.

Deleting an App

This API is used to delete a specified app. Only the user who creates the app can delete it, and the app is not bound to any API.

Adding an App Code

This API is used to create an app code for a specified API Gateway app. Only the user who creates the app can create an app code, and only apps of the shared or dedicated API Gateway can have app codes.

Resetting an App Code

This API is used to reset a specified app code of an API Gateway app. Only the user who creates the app can reset it, and only apps of the shared or dedicated API Gateway can have app codes.

Deleting an App Code

This API is used to delete a specified app code of an API Gateway app. Only the user who creates the app can delete it, and only apps of the shared or dedicated API Gateway can have app codes.

Resetting an AppSecret

This API is used to reset the AppSecret of a specified API Gateway app. Only the user who creates the app can reset the AppSecret.

Obtaining the List of APIs Bound to an App

This API is used to obtain the list of APIs bound to an app.

Registering an API and Authorizing the API to an App

This API is used to register an API and authorize the API to an App. Only Huawei Cloud users who have the permission to update the service can call this API.

Deleting an API

This API is used to delete a specified API. Only users who have the permission to delete the service to which the API belongs can delete the API.

Authorizing an API to an App

This API is used to authorize a specified API to an App. The API authentication mode must be App authentication. The user who creates an App must be the creator of the service to which the API belongs, and the request user must have the update permission on the service to which the API belongs.

Updating API Authorization

This API is used to update the authorization relationship of an API. The API authentication mode must be App authentication. The user who creates an App must be the creator of the service to which the API belongs, and the request user must have the update permission on the service to which the API belongs.

Canceling the Authorization of an API to an App

This API is used to cancel the authorization of a specified API to an app. The request user must have the update permission on the service to which the API belongs. Same as the URL: /v1/{project_id}/app-auth/{service_id}/apis/{api_id}/auths

Obtaining API Authorization Relationships

This API is used to obtain the authorization relationships between specified APIs and Apps. The API authentication mode must be App authentication. Administrators can obtain authorization information about all APIs. Common users can obtain only authorization information about APIs of services on which they have access permissions.

Creates an API.

An API is created, but the API is not authorized to the app.

API query

This API is used to query details about a specified API.

Querying APIs and Apps

This API is used to query information about APIs and apps authorized by a service.

Check whether the app exists.

Check whether the app exists.

Obtaining Service Monitoring

This API is used to obtain service monitoring information.

Obtaining Services

This API is used to obtain model services.

Deploying Services

This API is used to deploy a model as a service.

Obtaining Supported Service Deployment Specifications

This API is used to obtain supported service deployment specifications.

Obtaining Service Details

This API is used to obtain the details about a model service based on the service ID.

Updating Service Configurations

This API is used to update configurations of a model service. It can also be used to start or stop a service.

Updating the Service Through the Patch Operation

This API is used to update the service through the patch operation. For details about the patch format, see json patch.

Deleting a Service

This API is used to delete a model service. You can delete your own services only.

Updating a Single Property of a Model Service

This API is used to update a single property of a model service. Currently, only instance_count (number of instances of the model service) is supported. This operation can be performed only for real-time services in the running, alarm, or abnormal state.

Obtaining Service Event Logs

This API is used to obtain service event logs, including service operation records, key actions during deployment, and deployment failure causes.

Obtaining Service Update Logs

This API is used to obtain the update logs of a real-time service.

Adding a Resource Tag

This API is used to add tags to specified real-time services. If a tag to be added has the same key as an existing tag, the tag will overwrite the existing one.

Deleting Resource Tags

This API is used to delete tags of a real-time service. Tags can be deleted in batches.

Obtaining Inference Service Tags

This API is used to obtain inference service tags in the current project. Tags in all workspaces are obtained by default. If you do not have the permission, no tag is returned.

Obtaining an Inference VPC Access Channel

This API is used to obtain an inference VPC access channel.

Querying OS Configuration Parameters

This API is used to obtain the configuration parameters of ModelArts OS, such as network CIIDR and user resource quota. This API is used when you need to query the network configuration, resource allocation, or system management of ModelArts OS. Before using this API, ensure that you have the permission to access ModelArts OS and the service is running properly. After the query, the configuration parameters are returned for future resource planning and system optimization. If you do not have the required permission, the service is unavailable, or the request parameter is invalid, the API will return an error message.

Querying a Plug-in Template

This API is used to obtain details about a specified plug-in template. This API is used when you need to query the configuration, functions, or usage of a specific plug-in template. Before using this API, ensure that the plug-in template exists and you have the required permission. After the query, the details of the specified plug-in template are returned, including the configuration parameters and function description of the template, helping you develop and manage plug-ins. If the plug-in template does not exist or you do not have the access permission, the API will return an error message.

Obtaining Nodes in a Resource Pool

This API is used to obtain the node list of a specified resource pool. This API is used when you need to obtain the details about a resource pool, such as the node distribution, status, or resource usage. Before using this API, ensure that the resource pool has been created and is available, and you have the required permission. After the query, the system returns the detailed information about the nodes in the resource pool, including the node ID, status, and resource usage, helping you manage and optimize resources. If the resource pool does not exist, you do not have the permission to access the resource pool, or the request parameters are invalid, the API will return an error message.

Deleting nodes in batches

This API is used to delete nodes from a specified resource pool in batches. This API is used when you need to delete redundant nodes, re-allocate resources, or remove faulty nodes from a resource pool. Before using this API, ensure that the resource pool has been created and is available, you have the required permission, and at least one node is retained in the resource pool. After the deletion, the specified nodes are permanently removed, and the remaining nodes in the resource pool continue to work. If the resource pool does not exist, the node does not exist, you do not have the permission to perform the operation, or the number of nodes in the resource pool is insufficient, the API will return an error message.

Querying a Trace List

This API is used to obtain the event information recorded in the system. This API is used when you need to query the event records recorded in the system when monitoring the system status, locating faults, or auditing. Before using this API, ensure that you have the required permission and the event records exist in the system. After the query, the API returns the event list, including the event ID, type, time, and description. If you do not have the required permission, the event record does not exist, or the query parameter is incorrect, the API will return an error message.

Creating Network Resources

This API is used to create network resources in a system. This API is used when you need to create network resources, such as virtual networks, subnets, or routes, when you need to expand services, plan resources, or adjust the network architecture. Before using this API, ensure that you have the administrator permission and the system has sufficient resources to create network resources. After the creation, the network resources will be added to the system for future service configurations. If you do not have the required permission, the resources are insufficient, or the input parameter is incorrect, the API will return an error message.

Obtaining Network Resources

This API is used to obtain information about created network resources in the system. This API is used when you need to query the network resource list recorded in the system when monitoring network status, planning resources, locating network faults, or auditing. Before using this API, ensure that you have the required permission and the network resources exist in the system. After the query, the API returns the network resource list, including the resource ID, type, status, and creation time. If you do not have the required permission, the network resources do not exist in the system, or the query parameter is incorrect, the API will return an error message.

Obtaining a Network Resource

This API is used to obtain the details of a specified network resource. This API is used when you need to query details about a specified network resource, such as its configuration, status, or attributes. Before using this API, ensure that you have the required permission and the specified network resource exists in the system. After the query, the API returns the details of the specified network resource, including the resource ID, type, status, and configuration parameters. If the specified network resource does not exist, you do not have the operation permission, or the input parameters are incorrect, the API will return an error message.

Deleting a Network Resource

This API is used to remove specified network resources. This API is used when you need to delete a specified network resource when the network resource is no longer required, the configuration is incorrect, or resources need to be cleared. Before using this API, ensure that the network resource exists and you have the administrator permissions. After the deletion, the specified network resource is permanently removed, and related configurations and associations are cleared. If the specified network resource does not exist, you do not have the operation permission, or the resource is depended on by other resources, the API will return an error message.

Updating a Network Resource

This API is used to update the configuration information of a specified network resource. This API is used when you need to update the details of a specified network resource, such as adjusting attributes, fixing configuration errors, or optimizing resource settings. Before using this API, ensure that the network resource exists and you have the administrator permissions. After the update, the configuration information of the specified network resource is modified, and the latest resource status and attributes are displayed. If the specified network resource does not exist, you do not have the operation permission, or the input parameters are incorrect, the API will return an error message.

Querying the Real-Time Resource Usage

This API is used to obtain the real-time usage of all resource pools in the current project. This API is used when you need to query the real-time usage of resource pools when monitoring resource usage, optimizing resources, planning capacity, or troubleshooting faults. The resource usage includes the usage of CPU, memory, and storage resources. Before using this API, ensure that you have the required permission and there is a running resource pool. After the query, the API returns the real-time usage data of the resource pool, including the usage percentage, resource type, and timestamp. If you do not have the required permission, the resource pool does not exist, or the system cannot obtain the real-time data, the API will return an error message.

Creating Resource Pools

This API is used to create a resource pool in the system. This API is used when you need to allocate resources for new services, optimize resource management, or isolate resources. You can use this API to create a resource pool to manage compute, storage, and network resources. Before using this API, ensure that you have the administrator permission and the system has sufficient resources to create resource pools. After the creation, the resource pool will be added to the system and be available for future resource allocation and management. If you do not have the required permission, the system resources are insufficient, or the input parameter is incorrect, the API will return an error message.

Obtaining Resource Pools

This API is used to obtain information about resource pools created in the system. This API is used when you need to query the resource pool list recorded in the system when monitoring resource pool status, planning resources, managing resource allocation, or auditing. Before using this API, ensure that you have the required permission and the resource pool exists in the system. After the query, the API returns the resource pool list, including the resource pool ID, name, type, status, and resource quota. If you do not have the required permission, the resource pools do not exist in the system, or the query parameter is incorrect, the API will return an error message.

Obtaining a Resource Pool

This API is used to obtain the details of a specified resource pool. This API is used when you need to query details about a specified resource pool, such as its configuration, status, resource usage, or resource management. Before using this API, ensure that you have the required permission and the specified resource pool exists in the system. After the query, the API returns the resource pool details, including the resource pool ID, name, type, status, resource quota, and usage. If the specified resource pool does not exist, the user does not have the permission to perform the operation, or the input parameters are incorrect, the API will return an error message.

Deleting a Resource Pool

This API is used to delete a specified resource pool. This API is used when you need to delete a specified resource pool when the resource pool is no longer required, the configuration is incorrect, or resources need to be cleared. Before using this API, ensure that the resource pool exists and you have the administrator permissions. After the deletion, the specified resource pool is permanently removed, and related resources and configurations are cleared. If the resource pool does not exist, you do not have the operation permission, or the resource pool is depended on by other resources, the API will return an error message.

Updating a Resource Pool

This API is used to update the configuration and capacity of a specified resource pool. This API is used when you need to update the information about a resource pool when the resource pool capacity needs to be expanded, the configuration needs to be adjusted, or the performance needs to be optimized. Before using this API, ensure that the resource pool exists and you have the administrator permissions. After the update, the configuration and capacity of the resource pool will be updated, and the related resources and configurations will be adjusted. If the resource pool does not exist, the user does not have the permission to perform the operation, or the resource pool cannot be updated, the API will return an error message.

Monitoring a Resource Pool

This API is used to obtain the real-time or historical monitoring information about a specified resource pool. This API is used when you need to obtain the monitoring data of a resource pool in real time, such as resource usage, performance status, or historical data. Before using this API, ensure that the resource pool exists and you have the administrator permissions. After the API is called, the system returns the monitoring information of the resource pool, including the resource usage, performance metrics, and historical trends. If the resource pool does not exist, the user does not have the permission to perform the operation, or the resource pool is unavailable, the API will return an error message.

Resource Pool Statistics

This API is used to obtain the statistics of a specified resource pool. This API is used when you need to obtain the resource usage, allocation, or usage of a resource pool. Before using this API, ensure that the resource pool exists and you have the administrator permissions. After the API is called, the system returns the statistics of the resource pool, including the total resource usage, allocated resources, usage, and resource allocation trend. If the resource pool does not exist, the user does not have the permission to perform the operation, or the resource pool is unavailable, the API will return an error message.

Obtaining Resource Specifications

This API is used to obtain available resource specifications. This API is used when you need to view or select resource specifications to create resource pools, allocate resources, or learn available resource specifications. Before using this API, ensure that you have the required permissions (such as administrator permissions or resource management permissions). After the API is called, the system returns the resource specifications, including the specification ID, name, number of CPUs, memory size, and storage capacity. If you do not have the required permission or the resource specifications are not configured, the API will return an error message.

Obtain Jobs in a Resource Pool

This API is used to obtain the job list in a specified dedicated resource pool. This API is used when you need to obtain details about a dedicated resource pool, such as resource usage, job status, or resource allocation. Before using this API, ensure that the dedicated resource pool exists and you have the required permissions (such as administrator permissions or resource management permissions). After the API is called, the system returns the job list of the dedicated resource pool, including the job ID, name, status, and resource usage. If the dedicated resource pool does not exist, the user does not have the operation permission, or the resource pool is unavailable, the API will return an error message.

Querying dedicated resource pool Job Statistics

This API is used to obtain job statistics of a dedicated resource pool. This API is used when you need to obtain the job running information, resource usage, or job status distribution of a dedicated resource pool. Before using this API, ensure that the dedicated resource pool exists and you have the required permissions (such as administrator permissions or resource management permissions). After the API is called, the system returns the job statistics of the dedicated resource pool, including the total number of jobs, number of running jobs, number of completed jobs, and resource usage. If the dedicated resource pool does not exist, the user does not have the operation permission, or the resource pool is unavailable, the API returns an error message.

Obtaining All DevServer Instances of a User

This API is used to obtain all DevServer instances of a user.

Creating a DevServer Instance

This API is used to create a Lite Server, ECS, BMS, and supernode server.

Obtaining DevServer Instance Details

This API is used to obtain DevServer instance details.

Deleting DevServer Instances

This API is used to delete DevServer instances.

Synchronizing the Status of All DevServer Instances of a User in Real Time

This API is used to synchronize the status of all DevServer instances of a user in real time.

Starting DevServer Instances

This API is used to start DevServer instances.

Stopping DevServer Instances

This API is used to stop DevServer instances.

Creating DevServer Supernode Tags

This API is used to create the DevServer supernode tags.

Deleting DevServer Supernode Tags

This API is used to delete the DevServer supernode tags.

Obtaining the DevServer Supernode Tags

This API is used to obtain the DevServer supernode tags.

Reinstalling the OS Image of the DevServer Server

This API is used to reinstall the OS image of the DevServer server.

Changing the OS Image of the DevServer Server

This API is used to change the OS image of the DevServer server.

Changing the OS Image of the DevServer Supernode Server

This API is used to change the OS image of the DevServer supernode server.

Obtaining Details About All Supernode Instances of a User

This API is used to obtain details about all supernode instances of a user.

Obtaining Details About a Specified Supernode Instance

This API is used to obtain details about a specified supernode instance.

Deleting a DevServer Supernode Instance

This API is used to delete the DevServer supernode instance in the ERROR state.

Restarting a DevServer Instance

This API is used to restart a DevServer instance.

Starting a DevServer Supernode Server

This API is used to start a DevServer supernode server.

Stopping a DevServer Supernode Server

This API is used to stop a DevServer supernode server.

Mounting Disks to the DevServer

This API is used to Mounting Disks to the DevServer.

Bind EIPs to a DevServer

EIPs bound to a DevServer.

Query Bound EIPs

Query bound EIPs.

Obtaining the Resource Flavor List

This API is used to obtain the resource flavor list.

Querying the Specification List

This API is used to query the specification list.

Querying the List of Supported DevServer Scaling Specifications and Capacity Calculation

This API is used to query the specifications supported by DevServer supernode scaling and calculate the capacity.

Obtaining the Hyper Cluster Details List

This API is used to obtain the hyper cluster details list.

Creating a Hyper Cluster

This API is used to create a hyper cluster.

Querying Hyper Cluster Instance Details

This API is used to query details about a hyper cluster instance.

Deleting a Hyper Cluster Instance

This API is used to delete a hyper cluster instance.

Performing Operations on DevServer Instances in Batches

This API is used to perform operations on DevServer instances in batches.

Obtaining Details About a DevServer Job

This API is used to query details about a DevServer job.

Obtaining the DevServer Job List

This API is used to obtain the DevServer job list. The jobs can be filtered by status, ID, or other fields.

Deleting DevServer Jobs in Batches

Delete DevServer jobs in batches.

Creating a DevServer Job

This API is used to create a DevServer job.

Obtaining the DevServer Job Template List

This API is used to obtain the DevServer job template list.

Obtaining Details About a DevServer Job Template

This API is used to obtain details about a DevServer job template.

Obtaining the DevServer Plug-in List

This API is used to obtain the DevServer plug-in list.

Obtaining Software Information

This API is used to obtain the supported software information. The flavor_type and name parameters are supported.

Viewing an Authorization List

This API is used to view the authorization information.

Configuring Authorization

This API is used to configure ModelArts authorization.

Deleting Authorization

This API is used to delete the authorization of a specified user or all users.

Creating a ModelArts Agency

This API is used to create a ModelArts agency for ModelArts-dependent services, such as Object Storage Service (OBS), Software Repository for Container (SWR), and Intelligent EdgeFabric (IEF).

Querying Details About a Workspace

This API is used to query the details about a workspace.

Modifying a Workspace

This API is used to update the configuration information of a specified workspace.

Deleting a Workspace

This API is used to delete a created workspace.

Querying a Workspace Quota

This API is used to obtain the resource quota of a specified workspace.

Modifying a Workspace Quota

This API is used to update the resource quota of a specified workspace.

Querying a Workspace List

This API is used to obtain the details of all created workspaces.

Creating a Workspace

This API is used to create a workspace. The name of the created workspace cannot be default, which is the name of the default workspace reserved by the system.

Querying the Authorization Mode

This API is used to obtain the authorization mode and permission configuration information of a specified resource or function. This API is used when system administrators can use this API to view the access permission settings of resources. Developers can use this API to verify whether authorization policies are correctly configured. Security auditors can use this API to check whether authorization configurations comply with security specifications. Before using this API, ensure that you have the query permission and the authorization mode of the target resource or function has been configured. After the API is called, the API returns details about the authorization mode, including the authorization mode type, rules, and permission scope. If you do not have the permission to access this API or the authorization mode of the target resource is not configured, the API will return an error message.

Updating the Authorization Mode

This API is used to modify the authorization mode and permission configuration information of a specified resource or function. This API is used when system administrators can use this API to adjust the access permission of resources. Developers can use this API to update authorization policies to meet new service requirements. Security auditors can use this API to modify authorization configurations to comply with new security specifications. Before using this API, ensure that you have the update permission and the authorization mode of the target resource or function exists. After the API is called, the API updates the authorization mode of the target resource and returns the updated authorization mode information. If you do not have the permission to access this API or the authorization mode of the target resource does not exist, the API will return an error message.

Authenticating Whether the Current Workspace Can Be Used

This API is used to check whether a user has the permission to access and use resources in the current workspace. This API is used when you try to access or operate resources in the workspace, and the system needs to check whether you have the required permission. Before using this API, ensure that you have logged in and the workspace exists. If the authentication is successful, the user can access and use resources in the workspace. If the authentication fails, the API returns an error message, for example, insufficient permissions or the workspace does not exist.

Querying the User Role Information

This API is used to obtain the role information of a specified user in the system. This API is used when you need to know the permissions and roles of a user in the system. The administrator or system can use this API to query the role information of the user. Before using this API, ensure that the user exists and the role information is defined in the system. After the query, the API returns the role list of the user. If the user does not exist or the role information is not defined in the system, the API returns an error message.

Obtaining the User List

This API is used to obtain the user list in the system. This API is used when you need to view all users in the system or filter users based on specific conditions. The administrator or system can use this API to query the user list. Before using this API, ensure that the user exists and the query permission is granted. After the query, the API returns the list of users that meet the query conditions. If no user exists in the system or the query user does not have the required permission, the API returns an error message.

Obtaining OS Quotas

This API is used to obtain the quotas of some ModelArts OS resources, such as resource pool quotas and network quotas. This API is used when you need to know the usage limits of resource pools or network resources, plan resource allocation, or monitor resource usage. Before using this API, ensure that ModelArts OS is deployed and you have the required permissions (such as administrator permissions or resource management permissions). After the API is called, the system returns details about resource pool quotas and network quotas, helping you better plan and manage resources. If you do not have the required permission, the service is unavailable, or the quota information is not configured, the API will return an error message.

Obtaining All Tags of Resource Pools

This API is used to obtain all tags of resource pools in the current project. By default, all workspaces are queried, but tag data is not returned for workspaces to which you do not have permissions. This API is used when you need to manage, classify, or collect statistics on resource pool tags. Before using this API, ensure that you have the required permission and the resource pool exists. After the API is called, the system returns the resource pool tags of all accessible workspaces in the current project. If you do not have the required permission, the resource pool does not exist, or the project is not created, the API will return an error message.

Obtaining Tags of a Resource Pool

This API is used to obtain the tag information of a specified resource pool. This API is used when you need to view, manage, or collect statistics on resource pool tags. Before using this API, ensure that the resource pool exists and you have the required permission. After the API is called, the system returns the tag information of the specified resource pool, including the tag key and tag value. If the resource pool does not exist, you do not have the access permission, or the resource pool is not configured with tags, the API will return an error message.

Obtaining Node Pools

This API is used to obtain the list of a specified node pool. This API is used when you need to obtain the details about a node pool, such as the configuration, status, or resource management. Before using this API, ensure that the node pool exists and you have the administrator permissions. After the API is called, the system returns the node pool list, including the node pool ID, name, number of nodes, and status. If the node pool does not exist, the user does not have the permission to perform the operation, or the node pool is unavailable, the API will return an error message.

Creating a Node Pool

This API is used to create a node pool. This API is used when you need to create a node pool with specified configurations when you need to expand compute resources, optimize resource allocation, or deploy new services. Before using this API, ensure that you have the administrator permission and the node pool parameters (such as the number of nodes, specifications, and network configurations) are correctly set. After the creation, the node pool will be created and be available, and the related node information will be recorded. If you do not have the required permission, the parameter settings are incorrect, or system resources are insufficient, the API will return an error message.

Obtaining Details About a Specified Node Pool

This API is used to obtain the details of a specified node pool. This API is used when you need to obtain the details about a node pool, such as the configuration, status, resource usage, or resource management. Before using this API, ensure that the node pool exists and you have the permission to access the node pool. After the API is called, the system returns the details about the node pool, including the node pool ID, name, number of nodes, status, creation time, and configuration parameters. If the node pool does not exist, the user does not have the permission to access the node pool, or the node pool is unavailable, the API will return an error message.

Updating a Node Pool

This API is used to update the configurations of a specified node pool. This API is used when you need to expand the capacity of a node pool, adjust node specifications, optimize resource allocation, or repair node pool configurations. Before using this API, ensure that the node pool exists and you have the administrator permissions. After the update, the configurations of the node pool will be updated, including the number of nodes, node specifications, and network configurations. If the node pool does not exist, the user does not have the permission to operate the node pool, or the configuration parameters are incorrect, the API will return an error message.

Deleting a Node Pool

This API is used to remove a created node pool. This function is not supported for yearly/monthly resource pools. This API is used when you need to delete a specified node pool when the tasks in the node pool are complete, the configuration is incorrect, or resources need to be cleared. Before using this API, ensure that the node pool exists and you have the administrator permissions. After the deletion, the node pool is permanently removed, and related resources and configurations are cleared. If the node pool does not exist, the user does not have the permission to perform the operation, or the node pool cannot be deleted, for example, it is a yearly/monthly resource pool or the node pool is in use, the API will return an error message.

Obtaining Nodes in a Node Pool

This API is used to obtain details about all nodes in a specified node pool. This API is used when you need to obtain the details about a node pool, such as the node status, resource usage, or resource management. Before using this API, ensure that the node pool exists and you have the permission to access the node pool. After the API is called, the system returns the node list of the node pool, including the node ID, name, status, IP address, and resource usage. If the node pool does not exist, the user does not have the permission to access the node pool, or the node pool is unavailable, the API will return an error message.

Querying Order Details

This API is used to query order details.

Creating a Plugin

This API is used to create plugin instances.

Querying the Plugin List

This API is used to list plugin instances.

Querying Tasks

This API is used to obtain the jobs of the current user.