# Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… API

> Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… API on Apizie: 44 endpoints (Creates a job to run in a cluster. You can specify the datasource config, code source configuration, startup…, Creates a task template, Creates a RayHistoryServer, Sends a signal to the pods of a specified job and retrieves the signal ID, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-pai-dlc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-pai-dlc`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/pai-dlc
- Page: https://apizie.tech/api/cloud/aliyun-pai-dlc
- OpenAPI: https://apizie.tech/api/cloud/aliyun-pai-dlc/openapi.json

Alibaba Cloud OpenAPI for Platform for Artificial Intelligence PAI - Deep Learning Containers (DLC) (pai-dlc, version 2020-12-03). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a job to run in a cluster. You can specify the datasource config, code source configuration, startup…
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accessibility | string | no | The visibility of the job. Valid values: PUBLIC: Visible to all users in the workspace. PRIVATE: Visible only to you and administrators in… |
| CodeSource | object | no | The code source used by the job. Before the nodes of the job start, DLC automatically downloads the code configured in the code source and… |
| CredentialConfig | object | no | The access credential configuration |
| CustomEnvs | array | no | The list of custom environment variables |
| DataSources | array | no | The list of data sources used to run the job |
| DebuggerConfigContent | string | no | This parameter is not supported. Ignore this parameter |
| Description | string | no | The description of the job |
| DisplayName | string | yes | The name of the job. The name must meet the following requirements: The name can be up to 256 characters in length. The name can contain… |
| ElasticSpec | object | no | This parameter is not supported. Ignore this parameter |
| Envs | object | no | The environment variable configuration |
| JobMaxRunningTimeMinutes | integer | no | The maximum running duration of the job, in minutes |
| JobSpecs | array | yes | JobSpecs describes various configurations when the job runs, such as the image address, startup command, node resource declaration, and… |
| JobType | string | yes | The type of the job. This parameter is case-sensitive. Valid values: TFJob PyTorchJob MPIJob XGBoostJob OneFlowJob ElasticBatchJob… |
| Options | string | no | The additional configurations of the job. You can use this parameter to adjust the behavior of mounted data sources. For example, if the… |
| Priority | integer | no | The priority of the job. This parameter is optional. Default value: 1. Valid values: 1 to 9. 1: The lowest priority. 9: The highest priority |
| ResourceId | string | no | The ID of the resource group. This parameter is optional. If this parameter is left empty, the job is submitted to a public resource… |
| SchedulingStrategy | string | no | The scheduling policy |
| Settings | object | no | The additional parameter settings of the job |
| SuccessPolicy | string | no | The success policy for distributed multi-node jobs. Currently, only multi-node TensorFlow jobs are supported. Valid values: ChiefWorker:… |
| TemplateId | string | no | The ID of the job template |
| TemplateVersion | integer | no | The version of the job template |
| ThirdpartyLibDir | string | no | The name of the folder where the Python third-party library (requirements.txt) file is located. Before each node runs the specified… |
| ThirdpartyLibs | array | no | The list of Python third-party libraries to be installed |
| UserCommand | string | yes | The startup command for all nodes of the job |
| UserVpc | object | no | The user VPC configuration |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |

### Creates a task template
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-job-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Constraints | object | no | The field constraint rules. The key is a JSONPath expression, and the value is the constraint type: locked (locked and cannot be… |
| Content | string | yes | The configuration content of the task template, which contains job configuration parameters. Pass the value in JSON string format |
| Description | string | no | The description of the task template |
| Metadata | object | no | The custom key-value pair metadata |
| TemplateName | string | yes | The name of the task template |
| WorkspaceId | string | yes | The ID of the workspace to which the template belongs |

### Creates a RayHistoryServer
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-ray-history-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accessibility | string | no | The visibility of the job. Valid values: PUBLIC: Visible to all users in the workspace. PRIVATE: Visible only to you and administrators in… |
| DisplayName | string | yes | The display name of the node |
| EcsSpec | string | no | The hardware specifications of the public resource group. To access a detailed list of specifications, see… |
| MaxRuntimeMinutes | integer | no | The maximum runtime in minutes |
| ResourceId | string | no | The resource group ID. This parameter is optional. If this parameter is left empty, the job is committed to the public resource group. If… |
| StoragePath | string | yes | The storage path for Ray logs |
| WorkspaceId | string | yes | The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html. |

### Sends a signal to the pods of a specified job and retrieves the signal ID
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-signal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID |
| Signal | string | no | The signal code |
| Target | object | no | The signal delivery scope |

### Creates a TensorBoard instance by using a node or a specified datasource config
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-tensorboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Accessibility | string | no | The visibility of the job. Valid values: PUBLIC: The job is visible to all users in the workspace. PRIVATE: The job is visible only to you… |
| Cpu | integer | no | The number of CPU cores |
| DataSourceId | string | no | The dataset ID. For more information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html. |
| DataSourceType | string | no | The dataset type. Valid values: OSS NAS |
| DataSources | array | no | The datasource config |
| DisplayName | string | no | The name of the TensorBoard instance |
| JobId | string | no | The job ID. For more information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html |
| MaxRunningTimeMinutes | integer | no | The maximum running duration. Unit: minutes |
| Memory | integer | no | The memory size. Unit: GB |
| Options | string | no | The extension field of custom dataset, in JSON format. Currently, only MountPath is supported, which specifies the custom mount path of… |
| Priority | string | no | The priority of the job. This parameter is optional. Default value: 1. Valid values: 1 to 9. 1: the lowest priority. 9: the highest priority |
| QuotaId | string | no | The resource quota ID. This parameter is required when you create a TensorBoard job by using resources from a resource quota. For more… |
| SourceId | string | no | The source ID |
| SourceType | string | no | The source type |
| SummaryPath | string | no | The summary directory |
| SummaryRelativePath | string | no | The relative path of the summary directory |
| TensorboardDataSources | array | no | The list of dataset configurations mounted to the TensorBoard job |
| TensorboardSpec | object | no | The pay-as-you-go configuration information of the TensorBoard instance, which is used to create a TensorBoard job that uses pay-as-you-go… |
| Uri | string | no | The URI of the dataset: If DataSourceType is set to OSS, the format is `oss://[oss-bucket].[endpoint]/[path]`. If DataSourceType is set to… |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |

### Deletes a job that has completed or been stopped
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/delete-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. For information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html |

### Deletes an unused task template. If the template is already in use by a node, it cannot be deleted
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/delete-job-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TemplateId | string | yes | The template ID |

### Deletes a Ray History Server
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/delete-ray-history-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RayHistoryServerId | string | yes | The ID of the Ray History Server to delete |

### Deletes a stopped TensorBoard
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/delete-tensorboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |
| TensorboardId | string | yes | The TensorBoard ID. For more information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html |

### Retrieves the dashboard URL of a DLC job, if available
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | The job ID |
| isShared | string | no | Specifies whether the link is a shared link. If set to true, the token parameter is also required |
| token | string | no | The token obtained from the GetToken operation |

### Retrieves the detailed configuration and runtime information of a job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. For information about how to obtain a job ID, see https://help.aliyun.com/document_detail/459676.html |
| NeedDetail | string | no | Specifies whether to return the detailed information of the job. Default value: true |

### Retrieves system events for a job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-job-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. To obtain the job ID, refer to https://help.aliyun.com/document_detail/459676.html |
| MaxEventsNum | integer | no | The maximum number of events to retrieve. Default value: 2000 |
| StartTime | string | no | The start time (UTC) of the event query interval. Default value: 7 days ago |
| EndTime | string | no | The end time (UTC) of the event query interval. Default value: current time |

### Retrieves the monitoring data of a node, including the CPU, GPU, and memory usage, as well as the network…
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-job-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. You can call the https://help.aliyun.com/document_detail/459676.html operation to obtain the IDs of all jobs |
| StartTime | string | no | The start time of the time range for querying monitoring data, in UTC. Default value: 1 hour ago |
| EndTime | string | no | The end time of the time range for querying monitoring data, in UTC. Default value: the current time |
| TimeStep | string | no | The time interval at which monitoring data is returned. Default value: 5 minutes |
| MetricType | string | yes | The metric type of the monitoring data to query. Valid values: GpuCoreUsage: the GPU usage GpuMemoryUsage: the GPU memory usage… |
| Token | string | no | The temporary token used for authentication |

### Retrieves a specific computing power health check result for a DLC job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-job-sanity-check-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. For information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html |
| SanityCheckNumber | integer | yes | The sequence number of the computing power health check for the job |
| SanityCheckPhase | string | no | The phase of the computing power health check. Valid values: CheckInit: environment preparation. DeviceCheck: single-device computing… |
| Token | string | no | The token information in the job sharing token. For information about how to obtain the token, see… |

### Retrieves the details of a task template
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-job-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TemplateId | string | yes | The unique identifier of the task template |
| Version | string | no | If this parameter is not specified, the default version is returned. If a specific number is specified, the corresponding version is… |

### Retrieves metrics data
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Namespace | string | no | The data namespace of the cloud service. For information about the data namespaces of cloud services, see cloud service monitoring items |
| JobId | string | no | The job ID |
| Dimensions | string | no | (Required) The request parameters |
| Length | string | no | The number of entries per query. This parameter is used for paged query with paging. Default value: 1000 |
| EndTime | string | no | The end time of the query. Default value: the current time |
| Period | string | no | The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600 |
| NextToken | string | no | The pagination token. If you do not set this parameter, data on the first page is returned. If a value is returned for this parameter,… |
| MetricName | string | no | The metric name. Not populated. Not in use |
| StartTime | string | no | The start time (UTC) of the time range for querying monitoring data. Default value: one hour before the current time |
| Token | string | no | The temporary token used for authentication |

### Retrieves system events for a specific node in a job to locate and troubleshoot issues
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-pod-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. You can call https://help.aliyun.com/document_detail/459676.html to obtain the job ID |
| PodId | string | yes | The node ID. You can call https://help.aliyun.com/document_detail/459677.html to obtain the node ID |
| PodUid | string | no | The node UID. You can call https://help.aliyun.com/document_detail/459677.html to obtain the node UID |
| MaxEventsNum | integer | no | The maximum number of events to return |
| StartTime | string | no | The start time in UTC |
| EndTime | string | no | The end time in UTC |

### Retrieves or downloads the log of a specific node in a job. The log is collected from stdout and stderr of…
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-pod-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. To obtain the job ID, see https://help.aliyun.com/document_detail/459676.html |
| PodId | string | yes | The node ID. To obtain the node ID, see https://help.aliyun.com/document_detail/459677.html |
| PodUid | string | no | The node UID. To obtain the node UID, see https://help.aliyun.com/document_detail/459677.html |
| MaxLines | integer | no | The maximum number of log lines to return. Default value: 2000 |
| StartTime | string | no | The start time of the query. Default value: 7 days ago |
| EndTime | string | no | The end time of the query. Default value: current time |
| DownloadToFile | string | no | Specifies whether to download the log file. Valid values: false (default): The log file is not downloaded. true: The log file is downloaded |
| Containers | string | no | Filters logs by specified containers. Separate multiple container names with commas (,) |

### Retrieves the Ray Dashboard URL
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-ray-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| jobId | string | yes | The ID of the DLC job |
| isShared | string | no | Specifies whether the link is a shared link. If set to true, the token parameter is also required |
| token | string | no | The token obtained from the GetToken operation |

### Queries a RayHistoryServer
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-ray-history-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RayHistoryServerId | string | yes | The ID of the RayHistoryServer |

### Queries the details of a specific signal in a specified job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-signal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID |
| SignalId | string | yes | The signal ID |
| Token | string | no | The temporary token used for authentication |

### Retrieves the details of a TensorBoard
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-tensorboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID. See https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID. |
| TensorboardId | string | yes | The TensorBoard ID. See https://help.aliyun.com/document_detail/459689.html to obtain the TensorBoard ID |
| JodId | string | no | The job ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID |
| Token | string | no | The sharing token. Specify this parameter to use the sharing token to obtain the permissions to view a specific TensorBoard job. You can… |

### Retrieves the sharing link for a TensorBoard task. The link contains a digital token. You can use the…
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-tensorboard-shared-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TensorboardId | string | yes | The ID of the TensorBoard task |
| ExpireTimeSeconds | string | no | The validity period of the sharing link, in seconds. The maximum value is 604800 |

### Retrieves the sharing token for a DLC job to view information about the shared job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TargetType | string | no | The type of the shared job. Valid values: job and tensorboard |
| TargetId | string | no | The ID of the job to be shared |
| ExpireTime | integer | no | The expiration time of the sharing link. Default value: 604800 seconds. Minimum value: 0 |
| TokenSettings | string | no | The permission settings of the sharing token, which controls log download and cross-account access (JSON-encoded) |

### Provides the method and steps to obtain an HTTP link for accessing a container
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/get-web-terminal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID |
| PodId | string | yes | The pod ID of the job |
| PodUid | string | no | Pod UID |
| IsShared | string | no | Specifies whether to create a shared link for accessing the container. Valid values: true: Returns a shared link for accessing the… |

### Queries the list of supported machine resource configurations
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-ecs-specs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AcceleratorType | string | no | The accelerator type. Valid values: CPU GPU |
| SortBy | string | no | The field by which to sort the returned results. Valid values: CPU GPU Memory GmtCreateTime |
| Order | string | no | The sort order. Valid values: desc: Descending order. asc: Ascending order |
| PageNumber | integer | no | The page number. Minimum value: 1 |
| PageSize | integer | no | The number of entries to return per page in a paging query |
| InstanceTypes | string | no | The instance types to query. Separate multiple instance types with commas (,) |
| ResourceType | string | no | The resource type. Valid values: ECS Lingjun |

### Retrieves all computing power health check results for a DLC job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-job-sanity-check-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The ID of the job. You can call the https://help.aliyun.com/document_detail/459676.html operation to obtain the ID |
| Order | string | no | The sort order. Valid values: desc: Descending order. asc: Ascending order |

### Lists task templates by workspace with support for pagination and sorting. You can filter results by…
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-job-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | yes | The workspace ID |
| UserId | string | no | The user ID |
| TemplateId | string | no | Filters the list by an exact match of the template ID |
| TemplateName | string | no | Filters the list by a fuzzy match of the template name |
| Description | string | no | Filters the list by a fuzzy match of the template description |
| SortBy | string | no | The field by which to sort the results |
| Order | string | no | The sort order |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Retrieves a list of jobs with support for pagination, sorting, and conditional filtering
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DisplayName | string | no | The name of the job. Fuzzy match is supported. The match is case-insensitive and does not support wildcards. For example, if you enter… |
| JobType | string | no | The type of the job. Default value: empty, which indicates all types. Valid values: TFJob PyTorchJob XGBoostJob OneFlowJob ElasticBatchJob |
| Status | string | no | The running status of the job. Valid values: Creating Queuing Bidding (currently only for Lingjun spot jobs) EnvPreparing SanityChecking… |
| StartTime | string | no | The start time of the query interval. The creation time of the job is used for filtering. Default value: the current time minus 7 days. If… |
| EndTime | string | no | The end time of the query interval. The creation time of the job is used for filtering. Default value: the current time |
| PageNumber | integer | no | The page number to return for paging in a paged query. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The number of jobs to return on each page |
| SortBy | string | no | The field used for sorting. Valid values: DisplayName JobType Status GmtCreateTime GmtFinishTime |
| Order | string | no | The sort order. Valid values: desc: descending order. This is the default value. asc: ascending order |
| ShowOwn | string | no | Specifies whether to query only the jobs submitted by the current user |
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |
| ResourceId | string | no | The resource group ID. For more information about how to query the ID of a dedicated resource group, see… |
| BusinessUserId | string | no | The ID of the user associated with the job |
| Caller | string | no | The caller |
| Tags | string | no | The tags used for filtering (JSON-encoded) |
| PipelineId | string | no | The pipeline ID used to filter jobs created by the specified pipeline |
| FromAllWorkspaces | string | no | Specifies whether to retrieve the job list across workspaces. This parameter must be used together with the `ShowOwn=true` parameter to… |
| JobId | string | no | The job ID. Fuzzy match is not supported. The match is case-insensitive and does not support wildcards. Default value: empty, which… |
| UserIdForFilter | string | no | The user ID of the job submitter used to filter the job list |
| Username | string | no | The username of the job submitter used to filter the job list. Fuzzy match is supported, but wildcards are not supported. Default value:… |
| ResourceQuotaName | string | no | The name of the resource quota used to filter the job list. Fuzzy match is supported, but wildcards are not supported. Default value:… |
| Accessibility | string | no | The visibility of the job. Valid values: PUBLIC: visible to all users in the workspace. PRIVATE: visible only to you and administrators in… |
| OversoldInfo | string | no | The information about idle resources. Valid values: ForbiddenQuotaOverSold ForceQuotaOverSold AcceptQuotaOverSold-true: true indicates… |
| PaymentType | string | no | The resource type. Valid values: PrePaid: resource quota Spot: preemptible resources PostPaid: public resources |
| JobIds | string | no | The list of job IDs. Separate multiple IDs with commas (,). If both JobIds and JobId are specified, JobId takes precedence |
| DisplayNameSearchMode | string | no | The search mode for DisplayName. Default value: wildcard match |
| ReasonSearch | string | no | Retrieves data by using the full-text index in the reason field of the failed node. Chinese and English tokenization are supported |
| UserCommandSearch | string | no | Retrieves data by using the full-text index in the user_command field of the node. Chinese and English tokenization are supported |
| ImageSearch | string | no | Retrieves data by using the full-text index in the images field of the node. Chinese and English tokenization are supported |
| TimeRangeField | string | no | The time field used for StartTime and EndTime filtering. Default value: the creation time |
| NumericRangeField | string | no | The name of the field used for numeric range filtering. This parameter must be used together with NumericRangeMin and NumericRangeMax |
| NumericRangeMin | integer | no | The minimum value (inclusive) for numeric range filtering. This parameter must be used together with NumericRangeField |
| NumericRangeMax | integer | no | The maximum value (inclusive) for numeric range filtering. This parameter must be used together with NumericRangeField |
| EnableAssignNode | string | no | Specifies whether to filter jobs that run on specified nodes |
| TemplateId | string | no | The template ID used to filter jobs created by the specified template |
| Description | string | no | The keyword used for full text search in the node description |
| ResourceIds | string | no | The ResourceIds |

### Lists RayHistoryServer resources
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-ray-history-servers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID. To obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |
| DisplayName | string | no | The display name of the node |
| Status | string | no | The status of the RayHistoryServer. Valid values: Creating: The RayHistoryServer is being created. Queuing: The RayHistoryServer is… |
| PageNumber | integer | no | The page number for a paging query. Paging starts from page 1 |
| PageSize | integer | no | The number of RayHistoryServers to return per page in a paging query |
| SortBy | string | no | The field by which to sort the results. Valid values: DisplayName GmtCreateTime UserId ResourceId Status GmtModifyTime |
| Order | string | no | The sort order. Valid values: desc: descending order asc: ascending order |
| ShowOwn | string | no | Specifies whether to return only the RayHistoryServers created by the current user |
| StartTime | string | no | The start time |
| EndTime | string | no | The end time of the query range. The node creation time is used for filtering |
| ModifiedAfter | string | no | Filters results by the time after which the resource was last modified |
| ResourceId | string | no | The resource group ID. To query the ID of a dedicated resource group, see https://help.aliyun.com/document_detail/2651299.html |
| PaymentType | string | no | The payment method. Valid values: PrePaid PostPaid |
| IdPrefix | string | no | The ID prefix |
| UserIdForFilter | string | no | Filters results by user ID |
| Username | string | no | Filters results by username |
| StoragePath | string | no | The storage path for Ray logs |

### Queries all signal records of a specified job
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-signals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID |
| Status | string | no | The signal status |
| SortBy | string | no | The field used for sorting |
| Order | string | no | The sort order |
| PageNumber | string | no | The current page number |
| PageSize | string | no | The page size |
| Token | string | no | The temporary token used for authentication |

### Queries the list of created TensorBoards
`GET https://apizie.tech/v1/cloud:aliyun-pai-dlc/list-tensorboards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Verbose | string | no | Specifies whether to display details. Valid values: true: Displays details. false: Does not display details |
| WorkspaceId | string | no | The workspace ID. Retrieves the TensorBoard list based on the workspace ID. See https://help.aliyun.com/document_detail/449124.html to… |
| SourceType | string | no | The data source. Currently, only DLC training jobs are supported |
| SourceId | string | no | The data source ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID |
| DisplayName | string | no | The display name of the TensorBoard |
| Status | string | no | The TensorBoard status. Valid values: Creating: The TensorBoard is being created. Running: The TensorBoard is running. Stopped: The… |
| StartTime | string | no | The start time of the query interval. Filters TensorBoards by their creation time in UTC. If this parameter is left empty, the default… |
| EndTime | string | no | The end time of the query interval. Filters TensorBoards by their creation time in UTC. If this parameter is left empty, the default value… |
| SortBy | string | no | The field by which to sort the returned results. Valid values: DisplayName: the job name. GmtCreateTime: the job creation time |
| PageNumber | integer | no | The page number to return for paging. The starting value is 1 |
| PageSize | integer | no | The number of TensorBoards to return on each page for paging |
| Order | string | no | The sort order. Valid values: desc: descending order. asc: ascending order |
| JobId | string | no | Filters TensorBoard jobs by DLC job ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID |
| TensorboardId | string | no | Filters the TensorBoard list by TensorBoard ID |
| ShowOwn | string | no | Specifies whether to return only the TensorBoards created by the current logged-on user |
| PaymentType | string | no | The billing method of the TensorBoard job. Valid values: Free: The TensorBoard job uses free resources. Postpaid: The TensorBoard job uses… |
| UserId | string | no | The user ID |
| Username | string | no | The username |
| QuotaId | string | no | The resource quota ID. Currently, only whitelisted users can use resource quotas to create TensorBoard jobs. To use this feature, contact… |
| Accessibility | string | no | The visibility of the job. Valid values: PUBLIC: The job is visible to all users in the workspace. PRIVATE: The job is visible only to you… |

### Sets the default version of a job template
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/set-job-template-default-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TemplateId | string | yes | The template ID |
| Version | integer | yes | The version number to set as the default |

### Starts a Ray History Server
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/start-ray-history-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RayHistoryServerId | string | yes | The ID of the Ray History Server |

### Starts a TensorBoard
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/start-tensorboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |
| TensorboardId | string | yes | The TensorBoard ID. For more information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html |

### Stops a running job
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/stop-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. To obtain the job ID, see https://help.aliyun.com/document_detail/459676.html |

### Stops a Ray History Server
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/stop-ray-history-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RayHistoryServerId | string | yes | The ID of the Ray History Server |

### Stops a TensorBoard
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/stop-tensorboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |
| TensorboardId | string | yes | The TensorBoard ID. For information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html |

### Creates and attaches tags to specified resources
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| ResourceId | array | yes | The resource IDs. A maximum of 50 items can be specified |
| ResourceType | string | yes | The resource type. Valid values: Job |
| Tag | array | no | The tags to be created and attached. A maximum of 20 items can be specified |

### Unbinds tags from a specified list of resources
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceType | string | yes | The resource type |
| ResourceId | string | yes | The resource ID. You can specify up to 50 resource IDs (JSON-encoded) |
| TagKey | string | no | The list of tag keys. You can specify up to 20 tag keys (JSON-encoded) |
| All | string | no | Specifies whether to unbind all tags from the instance. Valid values: true: Unbinds all tags from the instance. false: Does not unbind all… |

### Updates the configuration of a job, such as modifying the priority of a queued job
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/update-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| JobId | string | yes | The job ID. For information about how to obtain a job ID, see https://help.aliyun.com/document_detail/459676.html |
| Accessibility | string | no | The visibility of the job can only be increased, not decreased. Valid values: PUBLIC: The job is visible to all users in the workspace |
| Description | string | no | The description of the job |
| JobSpecs | array | no | The job specifications |
| Priority | integer | no | The priority of the job. Valid values: 1 to 9. 1: The lowest priority. 9: The highest priority |
| UserCommand | string | no | The user command |

### Updates a task template
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/update-job-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TemplateId | string | yes | The unique identifier of the task template |
| Constraints | object | no | The field constraint rules. The key is a JSONPath expression and the value is the constraint type: locked (cannot be overridden),… |
| Content | string | no | The configuration content of the task template. Supports all parameter fields of the CreateJob operation, passed in JSON format. Providing… |
| Description | string | no | The description of the task template |
| Metadata | object | no | The user-defined key-value pair metadata |
| SetAsDefault | string | no | Specifies whether to set the new version as the default version when a new version is created |
| TemplateName | string | no | The name of the task template |
| version | integer | no | Invalid field |

### Updates a TensorBoard
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/update-tensorboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html. |
| TensorboardId | string | yes | The TensorBoard ID. For more information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html |
| MaxRunningTimeMinutes | integer | no | The maximum running duration in minutes |
| Accessibility | string | no | The visibility of the task. Valid values: PUBLIC: The task is visible to all users in the workspace. PRIVATE: The task is visible only to… |
| Priority | string | no | The scheduling priority of the TensorBoard task. Valid values: 1 to 9. A value of 1 indicates the lowest priority, and a value of 9… |

### version
`POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/version` (byok)

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-job" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-pai-dlc/create-job with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-pai-dlc.

### What is the status of the Alibaba Cloud Platform for Artificial Intelligence PAI - Deep… API?
Needs your own provider key (bring your own key)