# Alibaba Cloud Platform for AI API

> Alibaba Cloud Platform for AI API on Apizie: 53 endpoints (Checks the connection to the instance container, Creates an algorithm, Creates a version of an algorithm, You can create a link to access the container of the instance, …) 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://zieapi.vercel.app/v1/cloud:aliyun-paistudio/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-paistudio`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/paistudio
- Page: https://zieapi.vercel.app/api/cloud/aliyun-paistudio
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-paistudio/openapi.json

Alibaba Cloud OpenAPI for Platform for AI (paistudio, version 2022-01-12). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Checks the connection to the instance container
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/check-instance-web-terminal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |
| InstanceId | string | yes | The ID of the instance |
| CheckInfo | string | no | The check information |

### Creates an algorithm
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/create-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The ID of the workspace |
| AlgorithmDescription | string | no | The description of the algorithm |
| AlgorithmName | string | no | The name of the algorithm |
| DisplayName | string | no | The display name of the algorithm |

### Creates a version of an algorithm
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/create-algorithm-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmId | string | yes | ID of the training algorithm |
| AlgorithmVersion | string | yes | Algorithm version |
| AlgorithmSpec | string | no | Algorithm configuration (JSON-encoded) |

### You can create a link to access the container of the instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/create-instance-web-terminal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |
| InstanceId | string | yes | The ID of the instance |

### Creates a resource quota by calling the CreateQuota operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/create-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AllocateStrategy | string | no | The quota allocation strategy. Currently, only ByNodeSpecs is supported |
| ClusterSpec | object | no | The specifications of the native cluster for the resource quota |
| Description | string | no | The quota description |
| Labels | array | no | The quota labels |
| Min | object | no | The minimum quota configuration. Valid options: ResourceAmount: specifies CPU, memory, or GPU details. NodeSpecs: specifies the instance… |
| ParentQuotaId | string | no | The parent QuotaId: If ParentQuotaId is empty, a root quota is created and machines are allocated from the dedicated resource group. If… |
| QueueStrategy | string | no | Four queuing policies are supported for quotas. PaiStrategyIntelligent: intelligent policies. PaiStrategyBalance: balanced policy.… |
| QuotaConfig | object | no | QuotaConfig configuration constraints: This configuration does not take effect when the ECS or Lingjun resource type is used. When the ACS… |
| QuotaName | string | no | The quota name |
| ResourceGroupIds | array | no | The list of dedicated resource groups. Constraints: Only root quotas (where ParentQuotaId is empty) can allocate machines from resource… |
| ResourceType | string | no | The quota resource type (Lingjun/ECS/ACS). Default value: ECS |

### Creates a ResourceGroup using CreateResourceGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/create-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ComputingResourceProvider | string | no | The compute resource type of the ResourceGroup |
| Description | string | no | The description of the ResourceGroup |
| Name | string | no | The name of the ResourceGroup |
| ResourceType | string | no | The resource type list. Valid values: Ecs: general computing resources Lingjun: Lingjun AI Compute resources |
| Tag | array | no | The list of tags to add, containing up to 20 entries |
| UserVpc | object | no | The VPC peering information of the ResourceGroup |
| Version | string | no | The resource group version. This parameter only takes effect when the resource type is ECS |

### Creates a training job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/create-training-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmName | string | no | The name of the algorithm |
| AlgorithmProvider | string | no | The provider of the algorithm |
| AlgorithmSpec | object | no | The algorithm configuration for the training job |
| AlgorithmVersion | string | no | The version of the algorithm |
| AssignNodeSpec | object | no | The specified node configuration |
| CodeDir | object | no | The code configuration for the training job |
| ComputeResource | object | no | The compute resource configuration |
| CredentialConfig | object | no | The credential configuration |
| Environments | object | no | The environment variables for the training job |
| ExperimentConfig | object | no | The associated experiment configuration for the training job |
| HyperParameters | array | no | The training hyperparameter settings |
| InputChannels | array | no | The input data configuration for training |
| Labels | array | no | The labels of the training job |
| OutputChannels | array | no | The output data configuration for training |
| Priority | integer | no | The priority of the training job |
| PythonRequirements | array | no | The Python package configuration for the training job |
| RoleArn | string | no | The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName |
| Scheduler | object | no | The scheduling configuration for the training job |
| Settings | object | no | The additional parameter settings for the training node |
| TrainingJobDescription | string | no | The description of the training job |
| TrainingJobName | string | yes | The name of the training job |
| UserVpc | object | no | The VPC configuration |
| WorkspaceId | string | yes | The ID of the workspace |

### Deletes an algorithm
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/delete-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmId | string | yes | The algorithm ID |

### Deletes an algorithm version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/delete-algorithm-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmId | string | yes | The algorithm ID |
| AlgorithmVersion | string | yes | The algorithm version |

### Deletes a resource quota
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/delete-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaId | string | yes | The identifier of the quota to delete |

### Deletes a resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/delete-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupID | string | yes | The ID of the resource group |

### Deletes a training task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/delete-training-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |

### Deletes the labels of a training task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/delete-training-job-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |
| Keys | string | yes | The keys of the labels |

### Retrieves the details of an algorithm
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmId | string | yes | The algorithm ID |

### Retrieves the details of an algorithm version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-algorithm-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmId | string | yes | The algorithm ID |
| AlgorithmVersion | string | yes | The algorithm version |

### Retrieves the details of a resource quota to understand current resource usage and facilitate resource…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaId | string | yes | The ID of the quota |
| Verbose | string | no | Specifies whether to display detailed information |
| WithNodeMeta | string | no | Specifies whether to return the metadata of nodes bound to the quota |

### Retrieves the details of a resource group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupID | string | yes | The ID of the resource group. Each resource group has a globally unique ID. You can use the resource group ID to retrieve information… |
| IsAIWorkspaceDataEnabled | string | no | Specifies whether to enable AI workspace data. This parameter is optional. Default value: true |
| Tag | string | no | The list of tags to be added. A maximum of 20 tags can be added (JSON-encoded) |

### Retrieves the details of a machine group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-resource-group-machine-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| MachineGroupID | string | yes | The ID of the machine group |
| ResourceGroupID | string | yes | The ID of the resource group. Each resource group has a globally unique ID. You can use the resource group ID to retrieve the information… |
| Tag | string | no | The list of tags to add. You can specify up to 20 tags (JSON-encoded) |

### You can call GetResourceGroupTotal to get the total resources of a Resource Group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-resource-group-total` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupID | string | no | The ID of the Resource Group |

### Retrieves the historical prices of spot instances
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-spot-price-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceType | string | yes | The instance type of the spot instance. ECS instance types and Lingjun instance types are supported |
| SpotDuration | integer | no | The protection period of the spot instance. Unit: hours. Note that only ECS instance types support Settings for the protection period of… |
| StartTime | string | no | The start time for querying the historical prices of spot instances. The maximum value cannot exceed 7 days before the specified end time.… |
| EndTime | string | no | The end time for querying the historical prices of spot instances. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ… |
| PageNumber | integer | no | The page number. Default value: *1*. This parameter takes effect only when you query the historical prices of Lingjun instance types |
| PageSize | integer | no | The number of entries per page. Default value: 10. This parameter takes effect only when you query the historical prices of Lingjun… |
| SortBy | string | no | The field used for sorting. Default value: GmtCreatedTime. Valid values: GmtCreatedTime This parameter takes effect only when you query… |
| Order | string | no | The sort order. Default value: asc. Valid values: desc: descending order. asc: ascending order. This parameter takes effect only when you… |

### Retrieves the sharing token for a training job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training job |
| ExpireTime | integer | no | The expiration duration of the sharing link, in seconds. Default value: 604800 seconds. Minimum value: 0 seconds |

### Retrieves the details of a training job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-training-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training job |

### Retrieves the runtime fault error message of a training node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-training-job-error-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The training job ID |

### Retrieves the latest metrics for a training task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/get-training-job-latest-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |
| Names | string | no | The name of the metric |

### Retrieves a list of algorithm version details
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-algorithm-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageSize | integer | no | The page size for pagination |
| PageNumber | integer | no | The current page number |
| AlgorithmId | string | yes | The algorithm ID |

### Retrieves a list of algorithm details
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-algorithms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageSize | integer | no | The page size |
| PageNumber | integer | no | The page number |
| AlgorithmName | string | no | The algorithm name |
| AlgorithmId | string | no | The algorithm ID |
| AlgorithmProvider | string | no | The algorithm provider |
| WorkspaceId | string | no | The workspace ID |

### Retrieves detailed information about all pods on a specified node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-node-pods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NodeId | string | yes | The node ID |
| ResourceGroupId | string | yes | The ID of the resource group to which the node belongs |
| OversoldTypes | string | no | The resource type used by the pod |
| GPUIndexes | string | no | The GPU index number |

### Lists the available node types
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-node-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupIds | string | no | A comma-separated list of resource group IDs. You must specify either this parameter or `QuotaId`. The `UserId` for the specified… |
| QuotaId | string | no | The quota ID. You must specify either this parameter or `ResourceGroupIds` |
| NodeTypes | string | no | A comma-separated list of node types. If omitted, all node types are returned |
| AcceleratorType | string | no | The accelerator type used to filter the results. Valid values: `CPU` and `GPU` |
| GPUType | string | no | The GPU type used to filter the results. Fuzzy matching is supported |

### Queries a list of resource nodes
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceGroupIds | string | no | The list of resource group IDs. Separate multiple IDs with commas. You must specify either this parameter or QuotaId. Constraints: The… |
| QuotaId | string | no | The ID of the resource quota to which the node belongs |
| NodeTypes | string | no | The list of resource node specifications. Separate multiple specifications with commas. If you do not specify this parameter, the system… |
| AcceleratorType | string | no | The accelerator type. Valid values: CPU GPU If this parameter is left empty, all types are queried |
| GPUType | string | no | The GPU card type. Fuzzy match is supported |
| NodeStatuses | string | no | The status of the node. Separate multiple statuses with commas. If you do not specify this parameter, the system returns a list of nodes… |
| OrderStatuses | string | no | The order status of the node |
| PageNumber | integer | no | The page number. Pages start from page 1 |
| PageSize | integer | no | The number of entries to return on each page in a paged query. This parameter is used for paging |
| SortBy | string | no | The field based on which the results are sorted |
| Order | string | no | The sort order. Valid values: desc: descending order. asc: ascending order |
| Verbose | string | no | Specifies whether to return resource usage information. This parameter takes effect only when QuotaId is specified |
| NodeNames | string | no | The names of the nodes to display. Separate multiple names with commas |
| HyperNode | string | no | The name of the hypernode |
| CliqueID | string | no | The clique ID |
| FilterByQuotaId | string | no | Used together with ResourceGroupIds to display nodes in the resource group that are bound to specific quotas |
| FilterByResourceGroupIds | string | no | Used together with QuotaId to display nodes in the quota that belong to specific resource groups |
| MachineGroupIds | string | no | The IDs of the machine groups to which the nodes belong |
| ReasonCodes | string | no | The reason codes for the current status of the nodes |
| HyperZone | string | no | The hyperzone where the nodes reside |
| AvailabilityZone | string | no | The zone where the nodes reside |
| PaymentType | string | no | The billing method of the node order |
| OrderInstanceIds | string | no | The order ID information |
| WorkspaceId | string | no | The ID of the workspace to which the nodes belong |
| HealthRate | string | no | The health rate of the nodes, which is the proportion of healthy nodes (JSON-encoded) |
| HealthCount | string | no | The number of healthy nodes (JSON-encoded) |
| LayoutMode | string | no | The layout mode |
| ResourceGroupName | string | no | The name of the resource group |
| DiskPL | string | no | The performance level (PL) of the cloud disk |
| WorkloadNum | integer | no | The number of workloads on the node |
| PodNum | integer | no | The number of pods on the node |

### Retrieves the list of users in the current resource quota and the resources that they use
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-quota-active-user-usages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaId | string | yes | The identifier of the quota for which you want to retrieve detailed information |
| SelfOnly | string | no | Specifies whether to view only the resource usage in the current quota |
| PageNumber | integer | no | The page number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries per page |
| SortBy | string | no | The name of the field by which to sort the response. Valid values: QuotaId SubmittedCPU SubmittedMemory SubmittedGPU UsedCPU UsedMemory… |
| Order | string | no | The sort order. Valid values: desc: Descending order. asc: Ascending order |
| UserId | string | no | The ID of the user whose resource usage you want to query |
| Username | string | no | The username of the user whose resource usage you want to query |
| WorkspaceId | string | no | The workspace ID |
| WorkloadCount | integer | no | The number of workloads |

### Retrieves a list of workloads for a quota
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-quota-workloads` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaId | string | yes | The quota ID |
| WorkspaceIds | string | no | The IDs of the workspaces for which to query the workload queue information |
| WorkloadType | string | no | The workload type used to query the queue information of instances for the specified sub-product |
| WorkloadIds | string | no | The IDs of the workloads to query for queue information |
| BeforeWorkloadId | string | no | The ID of the workload before which to query the queue information of instances in the queue |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page for paging in a paged query |
| SortBy | string | no | The field by which to sort the returned results |
| Order | string | no | The sort order |
| Status | string | no | The status of the workload in the queue |
| ShowOwn | string | no | Specifies whether to display only the workloads corresponding to this resource quota |
| SubQuotaIds | string | no | The list of sub-resource quota IDs |
| UserIds | string | no | The IDs of the users |
| NodeName | string | no | The name of the node on which to search for workloads |
| WorkloadCreatedTimeRange | string | no | The time range used for a range search on the workload creation time (JSON-encoded) |
| WorkloadStatuses | string | no | The workload statuses used to filter the results |
| GmtPositionModifiedTimeRange | string | no | The time range used for a range search on the time when the queue positions of the workloads changed (JSON-encoded) |
| GmtEnqueuedTimeRange | string | no | The time range used for a range search on the time when the workloads entered the queue (JSON-encoded) |
| GmtDequeuedTimeRange | string | no | The time range used for a range search on the time when the workloads were dequeued (JSON-encoded) |
| WithHistoricalData | string | no | Specifies whether to include historical data |
| WorkloadNames | string | no | The names of the workloads |
| Priority | integer | no | The priority of the workload |
| Position | integer | no | The position in the queue |
| UseOversoldResource | string | no | Specifies whether the workload uses oversold resources |
| InstanceId | string | no | The instance ID |

### Retrieves a list of resource quotas
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-quotas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaName | string | no | Filters the results by QuotaName. Fuzzy matching is supported |
| ResourceType | string | no | The resource type of the quota. Valid values: Lingjun, ECS, and ACS. Default value: ECS |
| LayoutMode | string | no | The display mode. Valid values: tree and list |
| ParentQuotaId | string | no | Filters the results by ParentQuotaId. If this parameter is not specified, all quotas under the tenant are listed, including root quotas… |
| QuotaIds | string | no | Filters the results by QuotaIds. Separate multiple IDs with commas (,). Only exact matching is supported. A maximum of 100 IDs can be… |
| WorkspaceIds | string | no | Filters the results by WorkspaceIds. Separate multiple IDs with commas (,). Only exact matching is supported. A maximum of 10 IDs can be… |
| Statuses | string | no | Filters the results by quota statuses. Separate multiple statuses with commas (,). Only exact matching is supported |
| PageNumber | integer | no | The number of the page to return. Minimum value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Minimum value: 1 |
| SortBy | string | no | The field by which to sort the returned results. Valid values: QuotaName Status CPU Memory GPU GmtCreatedTime GmtModifiedTime |
| Order | string | no | The sort order. Valid values: desc and asc |
| Labels | string | no | Filters the results by label keys and values. Separate multiple labels with commas (,) |
| Verbose | string | no | Specifies whether to display details. Valid values: true: Displays details. false: Does not display details |
| WorkspaceName | string | no | The name of the associated workspace |
| HasResource | string | no | Specifies whether the quota contains resources |
| Versions | string | no | Filters the results by version information |
| ClusterType | string | no | The cluster type |
| GPUType | string | no | The GPU type |

### Queries the machine groups in a specified resource group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-resource-group-machine-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | no | The name of the machine group |
| CreatorID | string | no | The user ID of the machine group creator |
| ResourceGroupID | string | yes | The ID of the resource group. Each resource group has a globally unique ID. You can use the resource group ID to retrieve resource group… |
| PaymentType | string | no | The billing method |
| PaymentDurationUnit | string | no | The billing duration unit of the machine group |
| PaymentDuration | string | no | The billing duration. If PaymentDurationUnit is set to Month, valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60 |
| EcsSpec | string | no | The ECS instance type |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| Order | string | no | The sort order. Valid values: Asc: Ascending order. Desc: Descending order |
| SortBy | string | no | The sort field |
| Status | string | no | The instance status. Valid values: Creating: The instance is being created. Ready: The instance is running. Expiring: The instance is… |
| OrderInstanceId | string | no | The purchased instance ID |
| MachineGroupIDs | string | no | The IDs of the machine groups. Separate multiple IDs with commas |
| DiskPL | string | no | The cloud disk performance level for filtering |

### Retrieves a list of resource groups for general compute resources or Lingjun AI compute resources
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-resource-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | string | no | The name of the resource group |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| Order | string | no | The sort order. Valid values: desc: descending order. asc: ascending order |
| SortBy | string | no | The name of the field used for sorting. Valid values: DisplayName, GmtCreated, GmtModified, RegionID, Duration, PricingCycle, and PayType |
| Status | string | no | The status of the resource group |
| ShowAll | string | no | Specifies whether to return all results |
| ComputingResourceProvider | string | no | The compute resource type of the resource group |
| ResourceType | string | no | The list of resource types. Valid values: ECS: general compute resources. Lingjun: Lingjun AI compute resources |
| ResourceGroupIDs | string | no | The list of resource group IDs |
| HasResource | string | no | Specifies whether the resource group contains resources |
| Versions | string | no | The version to search for |

### Tag query API
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | Region ID |
| ResourceType | string | yes | Resource type |
| ResourceId | string | no | Resource IDs. Maximum: 50 items (JSON-encoded) |
| Tag | string | no | Tags to filter by. Maximum: 20 items (JSON-encoded) |
| NextToken | string | no | Pagination token for the next page of results |

### Retrieve events for a specific training task to gain detailed insight into the training process
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-job-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | Training task ID |
| PageNumber | integer | no | Page number (default is 1) |
| PageSize | integer | no | Page size (default is 100) |
| StartTime | string | no | Start UTC time (ISO8601 format). If empty, it is the task start time |
| EndTime | string | no | End UTC time (ISO8601 format). If empty, it is the current time |

### Retrieve events for a training job instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-job-instance-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | ID of the training job |
| InstanceId | string | yes | ID of the instance |
| PageNumber | integer | no | Page number |
| PageSize | integer | no | Number of items per page |
| StartTime | string | no | Start time in UTC, in ISO 8601 format. If empty, defaults to the training job start time |
| EndTime | string | no | End time in UTC, in ISO 8601 format. If empty, defaults to the current time |

### Retrieves the monitoring metrics of a training job instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-job-instance-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The training job ID |
| MetricType | string | yes | The metric type. Valid values: GpuCoreUsage: POD GPU utilization. GpuMemoryUsage: POD GPU memory utilization. CpuCoreUsage: POD CPU… |
| TimeStep | string | no | The metric collection interval. Valid values: 1h, 30m, 5m, and 10s. h indicates hours, m indicates minutes, and s indicates seconds |
| InstanceId | string | no | The instance ID |
| StartTime | string | no | The start UTC time in ISO 8601 format. If left empty, the job start time is used |
| EndTime | string | no | The end UTC time in ISO 8601 format. If left empty, the current time is used |

### Retrieves the logs for a training task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-job-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |
| WorkerId | string | no | The instance ID of the training task. This parameter is deprecated. Use InstanceId instead |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| StartTime | string | no | The start UTC time in ISO 8601 format. If empty, the task start time is used |
| EndTime | string | no | The end UTC time in ISO 8601 format. If empty, the current time is used |
| InstanceId | string | no | The instance ID |

### Retrieves the monitoring data of a training job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-job-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training job |
| Name | string | no | The name of the metric |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |
| StartTime | string | no | The start time in UTC. The time must be in ISO 8601 format. If this parameter is left empty, the start time of the job is used |
| EndTime | string | no | The end time in UTC. The time must be in ISO 8601 format. If this parameter is left empty, the current time is used |
| Order | string | no | The time order of the returned metrics. Valid values: ASC and DESC |

### Retrieves information about the output models of a training job
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-job-output-models` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | Training job ID |

### Retrieves a list of training jobs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/list-training-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| WorkspaceId | string | no | The workspace ID |
| PageNumber | integer | no | The page number for the paging query |
| PageSize | integer | no | The page size |
| SortBy | string | no | The field by which to sort the results |
| Order | string | no | The sort order. Valid values: ASC: Ascending order. DESC: Descending order |
| TrainingJobName | string | no | The name of the training job |
| Status | string | no | The status of the training job |
| TrainingJobId | string | no | The ID of the training job |
| Labels | string | no | The labels of the training job (JSON-encoded) |
| StartTime | string | no | The start time of the creation time range used to query jobs. Default value: 7 days ago. The time is in ISO 8601 format and the UTC time… |
| EndTime | string | no | The end time of the creation time range used to query jobs. Default value: the current time. The time is in ISO 8601 format and the UTC… |
| AlgorithmProvider | string | no | The algorithm provider |
| AlgorithmName | string | no | The name of the algorithm |
| IsTempAlgo | string | no | Specifies whether the algorithm is temporary |

### Performs operations on a node using OperateNode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/operate-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NodeId | string | yes | The node ID |
| Operation | string | yes | The operation to perform. Valid values: Cordon: disables scheduling Uncordon: enables scheduling Drain: evicts pods |
| OperationParameters | object | no | The node operation parameter settings |
| ResourceGroupId | string | no | The ID of the resource group to which the resource node belongs |

### Use ScaleQuota to scale resource quotas
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/scale-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaId | string | yes | Quota ID |
| Min | object | no | Scaling Min Quota. NodeSpecs specifies the post-scaling specifications and quantity. If the Count in NodeSpecs is less than the current… |
| ResourceGroupIds | array | no | Resource group IDs |

### Stops a training task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/stop-training-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| TrainingJobId | string | yes | The ID of the training task |

### Attaches tags to resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | no | The region |
| ResourceId | array | no | The resource IDs. You can specify up to 50 resource IDs |
| ResourceType | string | no | The resource type |
| Tag | array | no | The tags to add. You can specify up to 20 tags |

### Detach tags from a list of specified resources. If a tag is no longer attached to any resource after…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | Region |
| ResourceType | string | yes | Resource type |
| ResourceId | string | yes | Resource IDs. Maximum: 50 items (JSON-encoded) |
| TagKey | string | no | List of tag keys. Maximum: 20 items (JSON-encoded) |
| All | string | no | Whether to detach all tags from the resource. Valid values: true: Detach all tags from the resource. false: Do not detach all tags from… |

### Updates an algorithm
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/update-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmDescription | string | no | The algorithm description |
| DisplayName | string | no | The display name of the algorithm |
| AlgorithmId | string | yes | The algorithm ID |

### Updates an algorithm version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/update-algorithm-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AlgorithmId | string | yes | The algorithm ID |
| AlgorithmVersion | string | yes | The algorithm version |
| AlgorithmSpec | string | no | The details of the algorithm (JSON-encoded) |

### Updates a resource quota using UpdateQuota
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/update-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| QuotaId | string | yes | Quota ID |
| Description | string | no | The description of the resource quota |
| Labels | array | no | The list of user-defined labels. This is a full update |
| PropagateDefaultGPUDriver | string | no | Specifies whether to propagate the default GPU driver configuration to child quotas |
| QueueStrategy | string | no | The queuing policy for nodes on the quota |
| QuotaConfig | object | no | The resource quota configuration |
| QuotaName | string | no | The name of the resource quota |

### Use UpdateResourceGroup to update resource group information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/update-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Description | string | no | The description of the resource group |
| Name | string | no | The name of the resource group |
| Unbind | string | no | Whether to detach the resource group from the currently connected VPC |
| UserVpc | object | no | Information about the VPC connected to the resource group |
| ResourceGroupID | string | yes | The ID of the resource group |

### Updates the labels of a training task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/update-training-job-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Labels | array | no | The list of labels |
| TrainingJobId | string | yes | The ID of the training task |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/version` (byok)

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/check-instance-web-terminal" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Platform for AI API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-paistudio/check-instance-web-terminal with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Platform for AI 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 AI itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Platform for AI API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-paistudio.

### What is the status of the Alibaba Cloud Platform for AI API?
Needs your own provider key (bring your own key)