client

func (*JdaipClient) AddQueues ¶

func (c *JdaipClient) AddQueues(request *jdaip.AddQueuesRequest) (*jdaip.AddQueuesResponse, error)

关联队列。

func (*JdaipClient) AdminDescribeAccountMembers ¶

func (c *JdaipClient) AdminDescribeAccountMembers(request *jdaip.AdminDescribeAccountMembersRequest) (*jdaip.AdminDescribeAccountMembersResponse, error)

管理段-查询主账号下所有绑定空间的子账号

func (*JdaipClient) AdminDescribeDistillTasks ¶

func (c *JdaipClient) AdminDescribeDistillTasks(request *jdaip.AdminDescribeDistillTasksRequest) (*jdaip.AdminDescribeDistillTasksResponse, error)

查询pin下有权限的工作空间下的蒸馏任务列表。

func (*JdaipClient) AdminDescribeInferenceCount ¶

func (c *JdaipClient) AdminDescribeInferenceCount(request *jdaip.AdminDescribeInferenceCountRequest) (*jdaip.AdminDescribeInferenceCountResponse, error)

查询pin下所有的资源，按inference状态统计数量。

func (*JdaipClient) AdminDescribeInferences ¶

func (c *JdaipClient) AdminDescribeInferences(request *jdaip.AdminDescribeInferencesRequest) (*jdaip.AdminDescribeInferencesResponse, error)

查询pin下有权限的工作空间下的inference列表。

func (*JdaipClient) AdminDescribeJobList ¶

func (c *JdaipClient) AdminDescribeJobList(request *jdaip.AdminDescribeJobListRequest) (*jdaip.AdminDescribeJobListResponse, error)

查询当前主账号下所有的训练任务列表。

管理员接口，可跨工作空间查询主账号下所有训练任务。

## 过滤条件

- `jobId`：任务ID，精确匹配，支持多个 - `permission`：权限类型，精确匹配 - `ownerUserPin`：所有者pin，精确匹配 - `ownerUser`：所有者名称，模糊匹配

func (*JdaipClient) AdminDescribeJobs ¶

func (c *JdaipClient) AdminDescribeJobs(request *jdaip.AdminDescribeJobsRequest) (*jdaip.AdminDescribeJobsResponse, error)

查询 pin 下有权限的工作空间下的训练任务列表。

管理员接口，可跨工作空间查询训练任务列表。

## 过滤条件

- `jobId`：任务ID，精确匹配，支持多个 - `state`：任务状态，精确匹配，支持多个 - `workspaceId`：工作空间ID，精确匹配，支持多个 - `permission`：权限类型，精确匹配 - `ownerUserPin`：所有者pin，精确匹配 - `ownerUser`：所有者名称，模糊匹配

func (*JdaipClient) AdminDescribeJobsCount ¶

func (c *JdaipClient) AdminDescribeJobsCount(request *jdaip.AdminDescribeJobsCountRequest) (*jdaip.AdminDescribeJobsCountResponse, error)

查询 pin 下所有的资源，按训练任务状态统计数量。

管理员接口，用于快速了解当前账号下各状态的资源数量分布。

## 使用场景

- 资源概览监控 - 任务状态分布分析 - 资源使用统计

## 过滤条件

- `workspaceId`：工作空间ID，精确匹配 - `state`：任务状态，精确匹配，支持多个 - `permission`：权限类型，精确匹配 - `ownerUserPin`：所有者pin，精确匹配 - `ownerUser`：所有者名称，模糊匹配

func (*JdaipClient) AdminDescribeNotebookCount ¶

func (c *JdaipClient) AdminDescribeNotebookCount(request *jdaip.AdminDescribeNotebookCountRequest) (*jdaip.AdminDescribeNotebookCountResponse, error)

管理员统计查询账号下所有Notebook按状态分类的数量，支持跨工作空间。

## 接口说明 - 需要管理员权限才能调用此接口。 - 按Notebook状态统计数量，返回各状态的实例数量。 - 支持通过filters参数过滤统计范围。

## 支持的过滤条件 - queueId: 队列ID，精确匹配，支持单个 - workspaceId: 工作空间ID，精确匹配，支持单个 - createUser: 创建人名称，模糊匹配，支持单个 - createUserPin: 创建人pin，精确匹配，支持多个 - ownerUser: 所有者名称，模糊匹配，支持单个 - ownerUserPin: 所有者pin，精确匹配，支持多个

## 状态说明 - queuing: 排队中 - pending: 启动中 - failed: 失败 - running: 运行中 - stopping: 停止中 - stopped: 已停止 - deleting: 删除中 - saving: 镜像保存中 - rolling-back: 回滚中 - rolled-back: 已回滚

func (*JdaipClient) AdminDescribeNotebooks ¶

func (c *JdaipClient) AdminDescribeNotebooks(request *jdaip.AdminDescribeNotebooksRequest) (*jdaip.AdminDescribeNotebooksResponse, error)

管理员查询子账号下有权限的所有Notebook实例，支持跨工作空间查询。

## 接口说明 - 需要管理员权限才能调用此接口。 - 返回当前账号下所有工作空间的Notebook实例。 - 支持通过filters参数进行多条件过滤查询。 - 支持按用户标签(userTags)和资源组(resourceGroupIds)筛选资源。

## 支持的过滤条件 - notebookId: 资源ID，精确匹配，支持多个 - name: 名称，模糊匹配，支持单个 - state: 状态，精确匹配，支持多个 - createUser: 创建人名称，模糊匹配，支持单个 - createUserPin: 创建人pin，精确匹配，支持多个 - appType: 应用类型，精确匹配，支持单个 - queue: 队列ID，精确匹配，支持单个 - workspaceId: 工作空间ID，精确匹配，支持单个

func (*JdaipClient) AdminDescribeRunList ¶

func (c *JdaipClient) AdminDescribeRunList(request *jdaip.AdminDescribeRunListRequest) (*jdaip.AdminDescribeRunListResponse, error)

查询当前主账号下所有的微调运行列表。

管理员接口，可跨工作空间查询主账号下所有微调运行。

## 过滤条件

- `runId`：运行ID，精确匹配，支持多个

func (*JdaipClient) AdminDescribeRuns ¶

func (c *JdaipClient) AdminDescribeRuns(request *jdaip.AdminDescribeRunsRequest) (*jdaip.AdminDescribeRunsResponse, error)

查询 pin 下有权限的工作空间下的微调运行列表。

管理员接口，可跨工作空间查询微调运行列表。

## 过滤条件

- `runId`：运行ID，精确匹配，支持多个 - `state`：运行状态，精确匹配，支持多个

func (*JdaipClient) AdminDescribeRunsCount ¶

func (c *JdaipClient) AdminDescribeRunsCount(request *jdaip.AdminDescribeRunsCountRequest) (*jdaip.AdminDescribeRunsCountResponse, error)

查询 pin 下所有的资源，按微调运行状态统计数量。

管理员接口，用于快速了解当前账号下各状态的资源数量分布。

## 使用场景

- 资源概览监控 - 运行状态分布分析 - 资源使用统计

## 过滤条件

- `workspaceId`：工作空间ID，精确匹配 - `state`：运行状态，精确匹配，支持多个

func (*JdaipClient) CreateCodeRepoConfig ¶

func (c *JdaipClient) CreateCodeRepoConfig(request *jdaip.CreateCodeRepoConfigRequest) (*jdaip.CreateCodeRepoConfigResponse, error)

添加代码仓配置

func (*JdaipClient) CreateDataset ¶

func (c *JdaipClient) CreateDataset(request *jdaip.CreateDatasetRequest) (*jdaip.CreateDatasetResponse, error)

创建数据集/新版本

func (*JdaipClient) CreateExperiment ¶

func (c *JdaipClient) CreateExperiment(request *jdaip.CreateExperimentRequest) (*jdaip.CreateExperimentResponse, error)

创建微调实验。

创建一个新的微调实验，指定基础模型、模型系列和模板等参数。

## 核心配置

- **基本信息**：实验名称、描述 - **模型配置**：模型系列、模型模板、基础模型ID和版本 - **权限配置**：工作空间中的资源归属权限

## 创建成功后

- 返回唯一的微调实验ID（experimentId） - 可以在该实验下创建多个微调运行 - 可通过查询接口查看实验详情

func (*JdaipClient) CreateImage ¶

func (c *JdaipClient) CreateImage(request *jdaip.CreateImageRequest) (*jdaip.CreateImageResponse, error)

创建镜像

func (*JdaipClient) CreateInference ¶

func (c *JdaipClient) CreateInference(request *jdaip.CreateInferenceRequest) (*jdaip.CreateInferenceResponse, error)

创建推理服务

func (*JdaipClient) CreateInferenceScale ¶

func (c *JdaipClient) CreateInferenceScale(request *jdaip.CreateInferenceScaleRequest) (*jdaip.CreateInferenceScaleResponse, error)

为指定的推理服务创建自动扩缩容规则，包括基于资源使用率的自动扩缩容和基于时间的定时扩缩容

func (*JdaipClient) CreateJob ¶

func (c *JdaipClient) CreateJob(request *jdaip.CreateJobRequest) (*jdaip.CreateJobResponse, error)

创建训练任务。

创建一个新的训练任务，用于执行机器学习模型的训练工作。支持多种数据源、模型和计算资源配置。

## 核心配置项

- **基本信息**：任务名称、描述、框架类型 - **镜像配置**：镜像可见性、镜像ID、镜像地址 - **启动命令**：训练脚本执行命令和环境变量 - **资源配置**：队列、GPU/CPU/内存、节点数量 - **存储配置**：OSS/CFS/JPFS 存储挂载 - **数据与模型**：数据集、模型、代码仓库配置 - **高级配置**：重启策略（仅异构节点池+PyTorch）、健康检测

## 创建流程

1. 提交创建请求，系统进行参数校验 2. 返回任务ID，任务进入 **排队中(queuing)** 状态 3. 资源就绪后自动进入 **启动中(pending)** 状态 4. 启动成功后进入 **运行中(running)** 状态开始训练

## 注意事项

- `resource` 参数已废弃 - Ray 任务必须使用 `roleResource` 配置 Head 和 Worker 角色 - **重启策略仅适用于异构节点池的 PyTorch 任务**，云主机资源池和 Ray 任务不支持

func (*JdaipClient) CreateModel ¶

func (c *JdaipClient) CreateModel(request *jdaip.CreateModelRequest) (*jdaip.CreateModelResponse, error)

创建新模型/新版本。

func (*JdaipClient) CreateNotebook ¶

func (c *JdaipClient) CreateNotebook(request *jdaip.CreateNotebookRequest) (*jdaip.CreateNotebookResponse, error)

在工作空间下创建一个Notebook实例，Notebook是基于Kubernetes的交互式开发环境，支持JupyterLab应用。

## 接口说明 - **资源队列**: 必须选择一个队列，使用公共资源池时必须指定规格，使用私有资源池时必须指定CPU和内存，是否使用GPU可以按需选择。公共资源池队列ID固定为`joybuilder-public-queue`。 - **镜像配置**: 支持公共镜像和自定义镜像，需要指定镜像来源(public/self)、镜像名称、镜像URL等信息。 - **存储空间**: 使用用户个人存储，第一块存储默认作为工作目录，挂载到Notebook实例中`/mnt/workspace`目录下。支持cfs、oss、jpfs三种存储类型。`cfs`和`jpfs`类型存储只能选择与队列同vpc下的资源，使用私有资源池时跨vpc需要打通(vpcPeering)对等连接。 - **数据集**: 可选择公共数据集或个人数据集。`cfs`和`jpfs`类型的数据集只能选择与队列同vpc下的数据集，使用私有资源池时跨vpc需要打通(vpcPeering)对等连接。 - **模型**: 可选择公共模型或个人模型。`cfs`和`jpfs`类型的模型只能选择与队列同vpc下的模型，使用私有资源池时跨vpc需要打通(vpcPeering)对等连接。 - **SSH连接**: 开启后需要选择一个与队列同vpc下的负载均衡(LB)，并设置一个未占用的监听端口，实例运行后可以通过LB的公网IP和端口进行SSH访问，使用私有资源池时跨vpc需要打通(vpcPeering)对等连接。 - **计费配置**: 在私有资源池中创建Notebook时不计费，在公共资源池中创建Notebook时默认为按规格配置计费。 - **资源权限**: 支持设置工作空间中的资源归属权限(public/private)，管理员可查看工作空间中全部资源，其他用户只能查看归属自己的private权限的资源或public权限的资源。

## Notebook环境说明 - Notebook通过(/home/.notebook_utils/notebook_start.sh)脚本启动，启动脚本不可更改。 - 系统通过探测Notebook容器内的8888端口探活。 - 平台默认使用conda配置(/opt/conda/.condarc), conda环境目录以及conda管理的pip存储都会配置为使用用户个人存储, 以便数据不会在下次启动时丢失。 - 平台默认配置pip配置文件/conf/pip/$BASE_ENV_NAME.conf，由conda激活时接管。 - 如果用户需要自定义配置，只需要在个人存储中编写脚本(/mnt/workspace/.custom/custom_config.sh)，之后再次启动时平台将不会做任何(conda和pip)配置。

func (*JdaipClient) CreateNotebookLogCollectConfig ¶

func (c *JdaipClient) CreateNotebookLogCollectConfig(request *jdaip.CreateNotebookLogCollectConfigRequest) (*jdaip.CreateNotebookLogCollectConfigResponse, error)

配置Notebook实例的日志采集规则，将容器日志采集到日志服务。

## 日志采集配置说明 - **日志集ID**: 指定日志采集的目标日志集。 - **日志主题ID**: 指定日志采集的目标日志主题。 - **标准日志配置**: 配置是否采集容器的标准输出(stdout/stderr)。 - **自定义日志配置**: 配置采集容器内的自定义日志文件路径，支持通配符。

func (*JdaipClient) CreateRun ¶

func (c *JdaipClient) CreateRun(request *jdaip.CreateRunRequest) (*jdaip.CreateRunResponse, error)

创建微调运行。

在指定的微调实验下创建一个新的微调运行任务。

## 核心配置

- **基本信息**：运行名称、描述 - **微调配置**：训练阶段、微调方法、训练参数 - **数据集配置**：训练数据集、验证数据集 - **资源配置**：队列、GPU/CPU/内存 - **存储配置**：保存模型和训练输出

## 创建流程

1. 提交创建请求，系统进行参数校验 2. 返回运行ID，运行进入 **排队中(queuing)** 状态 3. 资源就绪后自动进入 **启动中(pending)** 状态 4. 启动成功后进入 **运行中(running)** 状态开始训练

## 注意事项

- 训练数据集为必填项 - 验证数据集可通过拆分训练集或单独指定 - 存储空间用于保存训练后的模型文件

func (*JdaipClient) CreateWorkspace ¶

func (c *JdaipClient) CreateWorkspace(request *jdaip.CreateWorkspaceRequest) (*jdaip.CreateWorkspaceResponse, error)

创建工作空间。

func (*JdaipClient) DeleteCodeRepoConfig ¶

func (c *JdaipClient) DeleteCodeRepoConfig(request *jdaip.DeleteCodeRepoConfigRequest) (*jdaip.DeleteCodeRepoConfigResponse, error)

删除代码仓配置

func (*JdaipClient) DeleteDataset ¶

func (c *JdaipClient) DeleteDataset(request *jdaip.DeleteDatasetRequest) (*jdaip.DeleteDatasetResponse, error)

根据数据集ID删除数据集

func (*JdaipClient) DeleteDatasetVersion ¶

func (c *JdaipClient) DeleteDatasetVersion(request *jdaip.DeleteDatasetVersionRequest) (*jdaip.DeleteDatasetVersionResponse, error)

删除数据集版本

func (*JdaipClient) DeleteExperiment ¶

func (c *JdaipClient) DeleteExperiment(request *jdaip.DeleteExperimentRequest) (*jdaip.DeleteExperimentResponse, error)

删除微调实验。

删除微调实验将级联删除该实验下的所有微调运行，请谨慎操作。

## 注意事项

- **私有队列**：直接删除该实验下的所有运行 - **公共队列**：会检查运行状态是否满足删除条件，不满足则返回错误 - 删除操作不可恢复，请确保已备份重要数据

func (*JdaipClient) DeleteImage ¶

func (c *JdaipClient) DeleteImage(request *jdaip.DeleteImageRequest) (*jdaip.DeleteImageResponse, error)

根据镜像ID删除镜像

func (*JdaipClient) DeleteImageTask ¶

func (c *JdaipClient) DeleteImageTask(request *jdaip.DeleteImageTaskRequest) (*jdaip.DeleteImageTaskResponse, error)

删除镜像保存任务记录。

## 接口说明 - 只能删除已完成(成功或失败)的任务记录。 - 删除任务记录不会影响已保存成功的镜像。

func (*JdaipClient) DeleteInference ¶

func (c *JdaipClient) DeleteInference(request *jdaip.DeleteInferenceRequest) (*jdaip.DeleteInferenceResponse, error)

删除推理服务

func (*JdaipClient) DeleteInferenceScale ¶

func (c *JdaipClient) DeleteInferenceScale(request *jdaip.DeleteInferenceScaleRequest) (*jdaip.DeleteInferenceScaleResponse, error)

删除指定推理服务的自动扩缩容规则，停止自动扩缩容功能

func (*JdaipClient) DeleteJob ¶

func (c *JdaipClient) DeleteJob(request *jdaip.DeleteJobRequest) (*jdaip.DeleteJobResponse, error)

删除训练任务。

删除训练任务将释放所有相关资源，删除后无法恢复。

## 可删除的任务状态

- ✅ queuing、pending、running、success、failed、stopped - ❌ stopping、deleting、rolling-back（需等待操作完成）

## 注意事项

- 删除操作不可恢复，请确保已备份重要数据 - 删除任务不会删除关联的存储数据、数据集和模型

func (*JdaipClient) DeleteModel ¶

func (c *JdaipClient) DeleteModel(request *jdaip.DeleteModelRequest) (*jdaip.DeleteModelResponse, error)

根据模型ID删除模型

func (*JdaipClient) DeleteModelVersion ¶

func (c *JdaipClient) DeleteModelVersion(request *jdaip.DeleteModelVersionRequest) (*jdaip.DeleteModelVersionResponse, error)

删除模型版本

func (*JdaipClient) DeleteNotebook ¶

func (c *JdaipClient) DeleteNotebook(request *jdaip.DeleteNotebookRequest) (*jdaip.DeleteNotebookResponse, error)

删除Notebook实例。

## 接口说明 - 如果Notebook已经不存在了，则不会做任何操作。 - 其它状态都允许删除操作。 - 删除后数据保留在用户个人存储中，不会被清除。 - 删除操作不可恢复，请谨慎操作。

func (*JdaipClient) DeleteNotebookLogCollectConfig ¶

func (c *JdaipClient) DeleteNotebookLogCollectConfig(request *jdaip.DeleteNotebookLogCollectConfigRequest) (*jdaip.DeleteNotebookLogCollectConfigResponse, error)

删除Notebook实例的日志采集配置。

## 接口说明 - 删除后停止采集该Notebook的日志。 - 已采集的历史日志不受影响，仍可在日志服务中查看。

func (*JdaipClient) DeleteRun ¶

func (c *JdaipClient) DeleteRun(request *jdaip.DeleteRunRequest) (*jdaip.DeleteRunResponse, error)

删除微调运行。

删除微调运行将释放相关资源，删除后无法恢复。

## 可删除条件

- **私有队列**：任何状态都可以删除 - **公共队列**：仅 queuing、pending、success、failed、stopped 状态可删除

## 注意事项

- 删除操作不可恢复 - 训练中的运行需要先停止再删除

func (*JdaipClient) DeleteService ¶

func (c *JdaipClient) DeleteService(request *jdaip.DeleteServiceRequest) (*jdaip.DeleteServiceResponse, error)

删除推理服务

func (*JdaipClient) DescribeAdminPublicModels ¶

func (c *JdaipClient) DescribeAdminPublicModels(request *jdaip.DescribeAdminPublicModelsRequest) (*jdaip.DescribeAdminPublicModelsResponse, error)

管理端查询公共模型列表

func (*JdaipClient) DescribeCodeRepoConfig ¶

func (c *JdaipClient) DescribeCodeRepoConfig(request *jdaip.DescribeCodeRepoConfigRequest) (*jdaip.DescribeCodeRepoConfigResponse, error)

获取代码仓配置详情

func (*JdaipClient) DescribeCodeRepoConfigs ¶

func (c *JdaipClient) DescribeCodeRepoConfigs(request *jdaip.DescribeCodeRepoConfigsRequest) (*jdaip.DescribeCodeRepoConfigsResponse, error)

获取代码仓配置列表

func (*JdaipClient) DescribeDataset ¶

func (c *JdaipClient) DescribeDataset(request *jdaip.DescribeDatasetRequest) (*jdaip.DescribeDatasetResponse, error)

获取数据集详情

func (*JdaipClient) DescribeDatasetVersion ¶

func (c *JdaipClient) DescribeDatasetVersion(request *jdaip.DescribeDatasetVersionRequest) (*jdaip.DescribeDatasetVersionResponse, error)

获取数据集版本详情

func (*JdaipClient) DescribeDatasetVersions ¶

func (c *JdaipClient) DescribeDatasetVersions(request *jdaip.DescribeDatasetVersionsRequest) (*jdaip.DescribeDatasetVersionsResponse, error)

获取数据集的版本列表

func (*JdaipClient) DescribeDatasets ¶

func (c *JdaipClient) DescribeDatasets(request *jdaip.DescribeDatasetsRequest) (*jdaip.DescribeDatasetsResponse, error)

获取数据集列表

func (*JdaipClient) DescribeExperiment ¶

func (c *JdaipClient) DescribeExperiment(request *jdaip.DescribeExperimentRequest) (*jdaip.DescribeExperimentResponse, error)

查询微调实验详情。

获取微调实验的完整信息，包括模型配置、权限设置、创建信息等。

func (*JdaipClient) DescribeExperiments ¶

func (c *JdaipClient) DescribeExperiments(request *jdaip.DescribeExperimentsRequest) (*jdaip.DescribeExperimentsResponse, error)

查询微调实验列表。

分页查询工作空间下的微调实验列表，支持多种过滤条件。

## 过滤条件

支持 `filters` 参数进行过滤： - `experimentId`：实验ID，精确匹配，支持多个 - `name`：实验名称，模糊匹配，支持单个 - `modelSeries`：模型系列，精确匹配，支持多个 - `createUser`：创建人，模糊匹配 - `permission`：权限类型，精确匹配（public/private） - `ownerUserPin`：所有者pin，精确匹配 - `ownerUser`：所有者名称，模糊匹配

func (*JdaipClient) DescribeImage ¶

func (c *JdaipClient) DescribeImage(request *jdaip.DescribeImageRequest) (*jdaip.DescribeImageResponse, error)

获取镜像详情

func (*JdaipClient) DescribeImageTasks ¶

func (c *JdaipClient) DescribeImageTasks(request *jdaip.DescribeImageTasksRequest) (*jdaip.DescribeImageTasksResponse, error)

查询Notebook的镜像保存任务列表，支持分页和过滤查询。

## 任务状态说明 - pending: 等待执行 - running: 正在执行 - success: 执行成功 - failed: 执行失败

## 支持的过滤条件 - taskId: 任务ID，精确匹配，支持多个 - imgName: 镜像名称，模糊匹配，支持单个 - state: 任务状态，精确匹配，支持多个 - createUser: 创建人名称，模糊匹配，支持单个

func (*JdaipClient) DescribeImages ¶

func (c *JdaipClient) DescribeImages(request *jdaip.DescribeImagesRequest) (*jdaip.DescribeImagesResponse, error)

获取镜像列表

func (*JdaipClient) DescribeInference ¶

func (c *JdaipClient) DescribeInference(request *jdaip.DescribeInferenceRequest) (*jdaip.DescribeInferenceResponse, error)

获取推理服务详情

func (*JdaipClient) DescribeInferenceEvents ¶

func (c *JdaipClient) DescribeInferenceEvents(request *jdaip.DescribeInferenceEventsRequest) (*jdaip.DescribeInferenceEventsResponse, error)

获取推理服务事件

func (*JdaipClient) DescribeInferencePods ¶

func (c *JdaipClient) DescribeInferencePods(request *jdaip.DescribeInferencePodsRequest) (*jdaip.DescribeInferencePodsResponse, error)

获取实例信息

func (*JdaipClient) DescribeInferenceRollouts ¶

func (c *JdaipClient) DescribeInferenceRollouts(request *jdaip.DescribeInferenceRolloutsRequest) (*jdaip.DescribeInferenceRolloutsResponse, error)

获取推理服务滚动更新记录

func (*JdaipClient) DescribeInferenceScale ¶

func (c *JdaipClient) DescribeInferenceScale(request *jdaip.DescribeInferenceScaleRequest) (*jdaip.DescribeInferenceScaleResponse, error)

获取指定推理服务的当前自动扩缩容规则配置

func (*JdaipClient) DescribeInferences ¶

func (c *JdaipClient) DescribeInferences(request *jdaip.DescribeInferencesRequest) (*jdaip.DescribeInferencesResponse, error)

获取推理服务列表

func (*JdaipClient) DescribeInstances ¶

func (c *JdaipClient) DescribeInstances(request *jdaip.DescribeInstancesRequest) (*jdaip.DescribeInstancesResponse, error)

查询训练任务实例列表。

获取训练任务下所有运行实例（Pod）的详细信息，包括状态、IP、运行时长等。

## 使用场景

- 查看各实例的运行状态 - 获取实例终端访问地址 - 排查分布式训练中的节点问题

func (*JdaipClient) DescribeJob ¶

func (c *JdaipClient) DescribeJob(request *jdaip.DescribeJobRequest) (*jdaip.DescribeJobResponse, error)

查询训练任务详情。

获取训练任务的完整配置信息和运行状态，包括基本信息、镜像配置、资源配置、存储配置、运行配置、Pod信息等。

## 使用场景

- 查看任务的完整配置信息 - 排查任务运行问题 - 获取 Pod 终端访问地址

func (*JdaipClient) DescribeJobTypes ¶

func (c *JdaipClient) DescribeJobTypes(request *jdaip.DescribeJobTypesRequest) (*jdaip.DescribeJobTypesResponse, error)

查询训练任务类型列表。

获取当前系统支持的所有训练任务类型。不同类型的训练任务对应不同的底层调度框架和资源管理方式。

**支持的训练任务类型：** - `pytorch`：PyTorch 框架，适用于深度学习训练、分布式训练 - `ray`：Ray 框架，适用于分布式计算、强化学习、超参调优

func (*JdaipClient) DescribeJobs ¶

func (c *JdaipClient) DescribeJobs(request *jdaip.DescribeJobsRequest) (*jdaip.DescribeJobsResponse, error)

查询训练任务列表。

分页查询工作空间下的训练任务列表，支持多种过滤条件。

func (*JdaipClient) DescribeModelVersion ¶

func (c *JdaipClient) DescribeModelVersion(request *jdaip.DescribeModelVersionRequest) (*jdaip.DescribeModelVersionResponse, error)

获取模型版本的详情

func (*JdaipClient) DescribeModelVersions ¶

func (c *JdaipClient) DescribeModelVersions(request *jdaip.DescribeModelVersionsRequest) (*jdaip.DescribeModelVersionsResponse, error)

获取模型的版本列表

func (*JdaipClient) DescribeNodeInstances ¶

func (c *JdaipClient) DescribeNodeInstances(request *jdaip.DescribeNodeInstancesRequest) (*jdaip.DescribeNodeInstancesResponse, error)

查询节点列表

func (*JdaipClient) DescribeNotebook ¶

func (c *JdaipClient) DescribeNotebook(request *jdaip.DescribeNotebookRequest) (*jdaip.DescribeNotebookResponse, error)

查询Notebook实例的详细信息，包括资源配置、存储配置、数据集配置、模型配置、计费信息等完整信息。

## 返回信息 - 基础信息: 名称、描述、状态、创建时间等 - 资源配置: CPU、内存、GPU、队列信息 - 存储配置: 挂载的存储列表及挂载路径 - 数据集配置: 挂载的数据集列表 - 模型配置: 挂载的模型列表 - 访问信息: 访问令牌、控制台地址、VSCode地址 - 计费信息: 公共资源池的计费详情(私有资源池无计费信息) - 关机策略: 自动关机策略配置

func (*JdaipClient) DescribeNotebookCount ¶

func (c *JdaipClient) DescribeNotebookCount(request *jdaip.DescribeNotebookCountRequest) (*jdaip.DescribeNotebookCountResponse, error)

统计查询工作空间下Notebook每种状态的数量。

func (*JdaipClient) DescribeNotebooks ¶

func (c *JdaipClient) DescribeNotebooks(request *jdaip.DescribeNotebooksRequest) (*jdaip.DescribeNotebooksResponse, error)

查询工作空间下的Notebook实例列表，支持分页、过滤和多条件查询。

## 接口说明 - 返回当前工作空间下用户有权限查看的Notebook实例列表。 - 支持通过filters参数进行多条件过滤查询。 - 支持通过userTags按自定义标签筛选资源。 - 支持通过resourceGroupIds按资源组筛选资源。

func (*JdaipClient) DescribePrivateModels ¶

func (c *JdaipClient) DescribePrivateModels(request *jdaip.DescribePrivateModelsRequest) (*jdaip.DescribePrivateModelsResponse, error)

查询私有模型列表

func (*JdaipClient) DescribePublicImages ¶

func (c *JdaipClient) DescribePublicImages(request *jdaip.DescribePublicImagesRequest) (*jdaip.DescribePublicImagesResponse, error)

获取公共镜像列表

func (*JdaipClient) DescribePublicModelVersion ¶

func (c *JdaipClient) DescribePublicModelVersion(request *jdaip.DescribePublicModelVersionRequest) (*jdaip.DescribePublicModelVersionResponse, error)

获取公共模型版本详情

func (*JdaipClient) DescribePublicModels ¶

func (c *JdaipClient) DescribePublicModels(request *jdaip.DescribePublicModelsRequest) (*jdaip.DescribePublicModelsResponse, error)

查询公共模型列表

func (*JdaipClient) DescribeRunConfigs ¶

func (c *JdaipClient) DescribeRunConfigs(request *jdaip.DescribeRunConfigsRequest) (*jdaip.DescribeRunConfigsResponse, error)

查询微调运行配置参数列表。

获取指定模型模板支持的训练配置参数，包括训练阶段、微调方法和详细参数列表。

## 使用场景

- 创建微调运行前获取支持的配置选项 - 了解各参数的默认值和取值范围 - 根据模型模板获取定制化的参数配置

## 返回内容

- `stage`：支持的训练阶段列表 - `finetuningType`：各阶段支持的微调方法 - `extras`：各微调方法支持的详细参数配置

func (*JdaipClient) DescribeRuns ¶

func (c *JdaipClient) DescribeRuns(request *jdaip.DescribeRunsRequest) (*jdaip.DescribeRunsResponse, error)

查询微调运行列表。

分页查询指定实验下的微调运行列表，支持多种过滤条件。

## 过滤条件

支持 `filters` 参数进行过滤： - `runId`：运行ID，精确匹配，支持多个 - `name`：运行名称，模糊匹配，支持单个 - `state`：运行状态，精确匹配，支持多个 - `createUser`：创建人，模糊匹配

func (*JdaipClient) DescribeService ¶

func (c *JdaipClient) DescribeService(request *jdaip.DescribeServiceRequest) (*jdaip.DescribeServiceResponse, error)

获取推理服务详情

func (*JdaipClient) DescribeServices ¶

func (c *JdaipClient) DescribeServices(request *jdaip.DescribeServicesRequest) (*jdaip.DescribeServicesResponse, error)

获取推理服务列表

func (*JdaipClient) DisableLogger ¶

func (c *JdaipClient) DisableLogger()

func (*JdaipClient) GetInstanceEvents ¶

func (c *JdaipClient) GetInstanceEvents(request *jdaip.GetInstanceEventsRequest) (*jdaip.GetInstanceEventsResponse, error)

获取训练任务实例事件。

查询单个训练实例（Pod）的事件记录，用于深入排查特定实例的问题。

## 使用场景

- 排查特定实例启动失败原因 - 分析实例异常行为 - 定位存储挂载问题 - 诊断资源不足问题

func (*JdaipClient) GetJobEvents ¶

func (c *JdaipClient) GetJobEvents(request *jdaip.GetJobEventsRequest) (*jdaip.GetJobEventsResponse, error)

获取训练任务事件。

查询训练任务执行过程中的各类事件记录，用于监控任务状态变化和问题排查。

## 常见事件

- `Scheduled`：Pod 已调度到节点 - `Pulled/Pulling`：镜像拉取 - `Started/Created`：容器启动 - `FailedScheduling`：调度失败（资源不足等） - `FailedMount`：存储挂载失败 - `BackOff`：容器启动失败重试中

func (*JdaipClient) GetJobRestartHistory ¶

func (c *JdaipClient) GetJobRestartHistory(request *jdaip.GetJobRestartHistoryRequest) (*jdaip.GetJobRestartHistoryResponse, error)

获取训练任务重启历史记录。

查询训练任务的所有重启记录，包括每次重启的触发条件、时间和原因。用于分析任务稳定性和问题排查。

func (*JdaipClient) GetNotebookEvents ¶

func (c *JdaipClient) GetNotebookEvents(request *jdaip.GetNotebookEventsRequest) (*jdaip.GetNotebookEventsResponse, error)

获取Notebook实例的事件列表，用于排查问题和查看实例状态变更历史。

## 事件类型 - 启动事件: 记录启动过程中的各个阶段 - 停止事件: 记录停止操作的原因和时间 - 错误事件: 记录异常情况和错误原因 - 资源变更事件: 记录资源配置的变更操作

func (*JdaipClient) GetNotebookPods ¶

func (c *JdaipClient) GetNotebookPods(request *jdaip.GetNotebookPodsRequest) (*jdaip.GetNotebookPodsResponse, error)

获取Notebook实例的Pod列表，用于查看底层Kubernetes资源的运行状态。

## Pod信息 - Pod名称、命名空间、IP地址 - Pod状态(Phase) - 容器数量和就绪容器数量 - 重启次数 - 状态异常时的原因和描述

func (*JdaipClient) GetPodLogs ¶

func (c *JdaipClient) GetPodLogs(request *jdaip.GetPodLogsRequest) (*jdaip.GetPodLogsResponse, error)

获取构建镜像的pod日志，采用SSE流式返回。

func (*JdaipClient) GetRunEvents ¶

func (c *JdaipClient) GetRunEvents(request *jdaip.GetRunEventsRequest) (*jdaip.GetRunEventsResponse, error)

获取微调运行事件。

查询微调运行执行过程中的各类事件记录，用于监控运行状态变化和问题排查。

## 使用场景

- 监控训练进度 - 排查启动失败问题 - 分析资源调度情况

func (*JdaipClient) ListMetrics ¶

func (c *JdaipClient) ListMetrics(request *jdaip.ListMetricsRequest) (*jdaip.ListMetricsResponse, error)

查询指定监控维度的列表

func (*JdaipClient) PauseRollout ¶

func (c *JdaipClient) PauseRollout(request *jdaip.PauseRolloutRequest) (*jdaip.PauseRolloutResponse, error)

暂停推理服务滚动更新

func (*JdaipClient) RemoveQueues ¶

func (c *JdaipClient) RemoveQueues(request *jdaip.RemoveQueuesRequest) (*jdaip.RemoveQueuesResponse, error)

解绑队列

func (*JdaipClient) RolloutInference ¶

func (c *JdaipClient) RolloutInference(request *jdaip.RolloutInferenceRequest) (*jdaip.RolloutInferenceResponse, error)

发起推理服务滚动更新

func (*JdaipClient) SaveImage ¶

func (c *JdaipClient) SaveImage(request *jdaip.SaveImageRequest) (*jdaip.SaveImageResponse, error)

将运行中的Notebook实例保存为自定义镜像，保存成功后自动注册到用户的镜像资产中。

## 接口说明 - 镜像以快照的方式进行保存，会保存当前工作目录的所有内容。 - 镜像保存过程中Notebook无法停止和删除，但不影响正常连接使用。 - 不建议在保存镜像过程中在Notebook里操作大量磁盘IO(比如下载大文件)类操作，可能影响镜像保存质量。 - 保存完成后会生成一个镜像任务，可通过查询镜像任务接口查看保存进度和结果。

## 镜像配置说明 - **镜像名称**: 用于注册到我的镜像仓库，需要符合命名规范。 - **镜像用途**: 指定镜像可用于哪些场景(training,notebook,inference)。 - **镜像架构**: 指定CPU或GPU类型。 - **目标仓库**: 指定推送到的镜像仓库地址。

func (*JdaipClient) SetConfig ¶

func (c *JdaipClient) SetConfig(config *core.Config)

func (*JdaipClient) SetLogger ¶

func (c *JdaipClient) SetLogger(logger core.Logger)

func (*JdaipClient) StartInference ¶

func (c *JdaipClient) StartInference(request *jdaip.StartInferenceRequest) (*jdaip.StartInferenceResponse, error)

启动推理服务

func (*JdaipClient) StartNotebook ¶

func (c *JdaipClient) StartNotebook(request *jdaip.StartNotebookRequest) (*jdaip.StartNotebookResponse, error)

启动Notebook实例。

## 接口说明 - 只允许停止状态(stopped)时操作。 - 如果Notebook已经是运行状态(running)，则不会做任何操作。 - 如果是其它状态，接口会返回错误。

## 资源配置变更 启动时支持更换资源配置(仅私有资源池): - 在公共资源池中的Notebook不允许变更资源配置，workloadSpec参数只能传null。 - 在私有资源池中的Notebook不允许变更为公共资源池，但允许更换私有资源池中的其它队列。 - 支持在启动时更换公网访问配置(LB)，或移除公网访问配置。

func (*JdaipClient) StopInference ¶

func (c *JdaipClient) StopInference(request *jdaip.StopInferenceRequest) (*jdaip.StopInferenceResponse, error)

停止推理服务

func (*JdaipClient) StopJob ¶

func (c *JdaipClient) StopJob(request *jdaip.StopJobRequest) (*jdaip.StopJobResponse, error)

停止训练任务。

手动停止正在运行或等待中的训练任务。停止后任务将释放所有计算资源，且无法再次启动。

## 可停止的任务状态

- ✅ queuing、pending、running - ❌ 已停止、已成功、已失败的任务无需停止

## 注意事项

- 停止操作**不可逆**，停止后无法恢复或重新启动任务 - 所有计算资源将被释放，存储数据不会被删除 - 如需保存训练进度，请确保代码支持检查点保存

func (*JdaipClient) StopNotebook ¶

func (c *JdaipClient) StopNotebook(request *jdaip.StopNotebookRequest) (*jdaip.StopNotebookResponse, error)

停止Notebook实例。

## 接口说明 - 如果Notebook已经是停止状态(stopped)，则不会做任何操作。 - 除了删除中(deleting)、保存镜像中(saving)状态，其它状态都允许操作。 - 停止后实例不再占用计算资源，但存储数据保留在用户个人存储中。 - 再次启动时可以从上次停止的状态恢复。

func (*JdaipClient) StopRun ¶

func (c *JdaipClient) StopRun(request *jdaip.StopRunRequest) (*jdaip.StopRunResponse, error)

停止微调运行。

手动停止正在运行或等待中的微调运行。停止后运行将释放计算资源，且无法再次启动。

## 可停止条件

- **私有队列**：任何状态都可以停止 - **公共队列**：仅 queuing、pending 状态可停止

## 注意事项

- 停止操作不可逆 - 如需保存训练进度，请确保代码支持检查点保存

func (*JdaipClient) UpdateCodeRepoConfig ¶

func (c *JdaipClient) UpdateCodeRepoConfig(request *jdaip.UpdateCodeRepoConfigRequest) (*jdaip.UpdateCodeRepoConfigResponse, error)

修改代码仓配置

func (*JdaipClient) UpdateDataset ¶

func (c *JdaipClient) UpdateDataset(request *jdaip.UpdateDatasetRequest) (*jdaip.UpdateDatasetResponse, error)

修改数据集信息

func (*JdaipClient) UpdateDatasetVersion ¶

func (c *JdaipClient) UpdateDatasetVersion(request *jdaip.UpdateDatasetVersionRequest) (*jdaip.UpdateDatasetVersionResponse, error)

修改数据集版本信息

func (*JdaipClient) UpdateExperiment ¶

func (c *JdaipClient) UpdateExperiment(request *jdaip.UpdateExperimentRequest) (*jdaip.UpdateExperimentResponse, error)

更新微调实验。

更新微调实验的元数据属性，不影响已有的微调运行。

## 使用场景

- 修改实验名称以便更好地识别和管理 - 更新实验描述信息 - 调整资源的可见性权限 - 转移实验归属给其他用户

func (*JdaipClient) UpdateImage ¶

func (c *JdaipClient) UpdateImage(request *jdaip.UpdateImageRequest) (*jdaip.UpdateImageResponse, error)

修改镜像信息

func (*JdaipClient) UpdateInference ¶

func (c *JdaipClient) UpdateInference(request *jdaip.UpdateInferenceRequest) (*jdaip.UpdateInferenceResponse, error)

更新推理服务描述

func (*JdaipClient) UpdateInferenceScale ¶

func (c *JdaipClient) UpdateInferenceScale(request *jdaip.UpdateInferenceScaleRequest) (*jdaip.UpdateInferenceScaleResponse, error)

更新指定推理服务的自动扩缩容规则配置

func (*JdaipClient) UpdateJob ¶

func (c *JdaipClient) UpdateJob(request *jdaip.UpdateJobRequest) (*jdaip.UpdateJobResponse, error)

更新训练任务属性信息。

仅支持更新任务的元数据属性（名称、描述、权限、归属），不影响正在运行的训练任务。

## 使用场景

- 修改任务名称以便更好地识别和管理 - 更新任务描述信息 - 调整资源的可见性权限 - 转移任务归属给其他用户

func (*JdaipClient) UpdateModel ¶

func (c *JdaipClient) UpdateModel(request *jdaip.UpdateModelRequest) (*jdaip.UpdateModelResponse, error)

修改模型信息

func (*JdaipClient) UpdateModelVersion ¶

func (c *JdaipClient) UpdateModelVersion(request *jdaip.UpdateModelVersionRequest) (*jdaip.UpdateModelVersionResponse, error)

修改模型版本信息

func (*JdaipClient) UpdateNotebook ¶

func (c *JdaipClient) UpdateNotebook(request *jdaip.UpdateNotebookRequest) (*jdaip.UpdateNotebookResponse, error)

更新Notebook实例的基础属性，不影响资源配置。

func (*JdaipClient) UpdateResourceProperties ¶

func (c *JdaipClient) UpdateResourceProperties(request *jdaip.UpdateResourcePropertiesRequest) (*jdaip.UpdateResourcePropertiesResponse, error)

更新Notebook的资源属性配置。

## 支持更新的属性 - **镜像配置**: 更换镜像来源和镜像ID - **工作负载配置**: 更换资源队列、CPU、内存、GPU配置 - **存储配置**: 更新存储空间挂载配置 - **数据集配置**: 更新数据集挂载配置 - **模型配置**: 更新模型挂载配置 - **公网访问配置**: 更新或移除负载均衡配置(仅私有资源池) - **代码配置**: 更新代码库挂载配置 - **节点亲和性配置**: 更新节点调度亲和性规则

## 接口说明 - 更新操作需要在Notebook停止状态下进行。 - 更新存储、数据集、模型配置时需要确保新配置与队列的网络连通性。 - 传null的字段表示不修改该属性。

func (*JdaipClient) UpdateService ¶

func (c *JdaipClient) UpdateService(request *jdaip.UpdateServiceRequest) (*jdaip.UpdateServiceResponse, error)

更新推理服务

func (*JdaipClient) UpdateServiceQPS ¶

func (c *JdaipClient) UpdateServiceQPS(request *jdaip.UpdateServiceQPSRequest) (*jdaip.UpdateServiceQPSResponse, error)

更新推理服务限流阈值

func (*JdaipClient) UpdateWorkspace ¶

func (c *JdaipClient) UpdateWorkspace(request *jdaip.UpdateWorkspaceRequest) (*jdaip.UpdateWorkspaceResponse, error)

更新工作空间。