Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ ModelArts/ API Reference/ Resource Management/ Querying the dedicated resource pool Job List

Querying the dedicated resource pool Job List

Updated on 2024-05-30 GMT+08:00

Function

This API is used to query the dedicated resource pool job list.

Debugging

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

URI

GET /v2/{project_id}/pools/{pool_name}/workloads

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

Namespace to which a job belongs.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

No

String

Service to which a job belongs. The options are as follows:

  • train: training job

  • infer: inference service

  • notebook: notebook job

status

No

String

Job status. The options are as follows:

  • Queue: queuing

  • Pending: waiting

  • Abnormal: abnormal

  • Terminating: The task is being terminated.

  • Creating: The gateway is being created.

  • Running

  • Completed: completed

  • Terminated: terminated

  • Failed: The task fails to be executed.

sort

No

String

Sorting basis field. The options are as follows:

  • create_time: Jobs are sorted by creation time.

ascend

No

Boolean

Indicates whether to sort data in ascending order.

offset

No

String

Start position of pagination query.

limit

No

Integer

Maximum number of records displayed on a page. If the value is empty or 0, the default value 500 is used. The maximum value is 500.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

apiVersion

String

API version. The options are as follows:

  • v1

kind

String

Resource type. The options are as follows:

  • WorkloadList: job list

items

Array of Workload objects

Job list.

Table 4 Workload

Parameter

Type

Description

apiVersion

String

Resource version. The options are as follows:

  • v1

kind

String

Resource type. The options are as follows:

  • Workload

type

String

Service type of a job. The options are as follows:

  • train: training job

namespace

String

Name of the resource pool to which a job belongs.

name

String

Job name.

jobName

String

Upper-layer service job name.

uid

String

Job UID.

jobUUID

String

Upper-layer service job ID.

flavor

String

Job specifications.

status

String

Job status.

resourceRequirement

resourceRequirement object

Number of resource requests for running jobs.

priority

String

Job priority

runningDuration

Integer

Running duration of a job.

pendingDuration

Integer

Queuing duration of a job.

pendingPosition

Integer

Job queue position.

createTime

Integer

Indicates the time when a job is created.

gvk

String

Kubernetes resource type, group, and version of a job.

hostIps

String

List of IP addresses of the nodes where the job is running. Separate the IP addresses with commas (,).

Table 5 resourceRequirement

Parameter

Type

Description

cpu

String

CPU usage

memory

String

Memory usage

nvidia.com/gpu

String

GPU resource usage.

huawei.com/ascend-snt3

String

Ascend resource usage

huawei.com/ascend-snt9

String

Ascend resource usage

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/workloads

Example Responses

Status code: 400

Bad Request.

{
  "error_code" : "ModelArts.50004000",
  "error_msg" : "Bad request."
}

Status code: 404

Not Found.

{
  "error_code" : "ModelArts.50015001",
  "error_msg" : "Pool {name} not found."
}

Status Codes

Status Code

Description

200

OK.

400

Bad Request.

404

Not Found.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback