更新时间：2026-07-13 GMT+08:00

API概览

AI DataLake提供的符合RESTful API设计规范的接口，如表1所示。

表1 AI DataLake接口
类型	子类型	说明
Aura引擎接口	AuraJobV2作业管理	AuraJobV2作业管理的接口，包括创建、获取、查询、关闭session的接口，执行SQL和获取SQL执行记录接口，获取Statement结果、执行状态和取消Statement执行接口，查询语句监控详情接口，查询SQL执行算子监控记录接口等。通过这些接口，您可以创建、获取、查询、关闭session，执行SQL和获取SQL执行记录，获取Statement结果、执行状态，取消Statement执行，查询语句监控详情，查询SQL执行算子监控记录。
Ray引擎接口	RayJob管理	RayJob管理的接口，包括作业的查询、运行和取消。
Spark引擎接口	Spark作业管理	Spark作业管理的接口，包括Spark作业的查询、启动、取消等。
	SparkSql作业管理	SparkSql作业管理的接口，包括SparkSql作业的查询、执行、取消、重启等。
	SparkOperators操作管理	SparkOperators操作管理的接口，包括查询Spark异步操作状态。
用户协议管理		用户协议管理的接口，包括查询、签署和删除协议等。
委托管理		服务委托管理的接口，包括创建、查询、删除服务委托等。
工作空间管理		工作空间管理的接口，包括工作空间的创建、更新、查询和删除。
计算资源		计算资源的接口，包括计算资源的创建、更新、查询、删除等操作。
端点管理		端点管理的接口，包括端点的创建、更新、查询、删除等操作。
镜像管理		镜像管理的接口，包括镜像的注册、添加、更新、查看、删除等。

AuraJobV2作业管理

AuraJobV2业务接口，包括创建、获取、查询、关闭session的接口，执行SQL和获取SQL执行记录接口，获取Statement结果、执行状态和取消Statement执行接口，查询语句监控详情接口，查询SQL执行算子监控记录接口等。

通过这些接口，您可以创建、获取、查询、关闭session，执行SQL和获取SQL执行记录，获取Statement结果、执行状态，取消Statement执行，查询语句监控详情，查询SQL执行算子监控记录。

表2 AuraJobV2业务接口
API	说明
创建Session - CreateAuraV2SqlSession	创建SQL Session。
查看Session列表 - ListAuraV2SqlSessions	查询SQL Session列表。
查看Session详情 - ShowAuraV2SqlSession	查询SQL Session信息。
关闭Session - CloseAuraV2SqlSession	关闭SQL Session。
在指定Session中执行SQL - ExecuteAuraV2SqlStatement	在指定的Session下执行SQL语句。
查看SQL执行结果 - ShowAuraV2SqlStatementResult	查询SQL语句执行结果。
取消SQL执行 - CancelAuraV2SqlStatement	取消SQL语句执行。
查看SQL执行记录 - ListAuraV2StatementRecords	查询SQL执行记录。
查看语句监控详情 - ShowAuraV2StatementQueryMetrics	查询语句监控详情信息。
查看指定Session下的SQL执行记录 - ListAuraV2SessionStatementRecords	查询指定Session下的SQL执行记录。
查看SQL执行算子监控记录 - ShowAuraV2StatementOperatorMetrics	查看SQL执行算子监控记录。

RayJob管理

RayJob管理接口，包括作业的查询、运行和取消。通过这些接口，您可以查询、运行和取消RayJob作业。

表3 RayJob管理接口
API	说明
运行作业 - RunRayJob	运行作业。支持Ray作业，接口返回作业运行ID。
查询Ray作业列表 - ListRayJobs	列举所有的Ray作业。列举工作空间下的作业，分页返回。
查询作业详情 - ShowRayJob	查看Ray作业详情。
取消作业运行 - CancelRayJob	取消作业运行。主要使用于取消运行Ray Job场景。

Spark作业管理

Spark作业管理接口，包括Spark作业的查询、启动、取消等。通过这些接口，您可以查询、启动、取消Spark作业。

表4 Spark作业管理接口
API	说明
查询Spark作业的状态 - ShowSparkJobState	查询Spark作业的状态。
启动Spark作业 - RunSparkJob	启动Spark作业。
查询Spark作业列表 - ListSparkJobs	查询工作空间下Spark作业列表。
查看Spark作业详情 - ShowSparkJob	查看指定Spark作业的详细信息。
取消Spark作业执行 - CancelSparkJob	取消正在执行的Spark作业。
查看Spark作业提交日志 - ShowSparkJobSubmitLog	查看Spark作业的提交日志信息。

SparkSql作业管理

SparkSql作业管理接口，包括SparkSql作业的查询、执行、取消、重启等。通过这些接口，您可以查询、执行、取消、重启SparkSql作业。

表5 SparkSql作业管理接口
API	说明
查询SparkSql作业的状态 - ShowSparkSqlState	查询SparkSql作业的状态。
查询SparkSql作业列表 - ListSparkSqls	查询工作空间下SparkSql作业列表。
查看SparkSql作业详情 - ShowSparkSql	查看SparkSql作业的详细信息。
取消SparkSql作业执行 - CancelSparkSql	取消正在运行或排队中的SparkSql作业。
执行SparkSql作业 - RunSparkSql	执行SparkSql作业。
预览SparkSql作业查询结果 - PreviewSparkSqlResult	预览SparkSql作业的查询结果。
重启SparkSql集群 - RestartSparkSqlCluster	重启SparkSql集群。

SparkOperators操作管理

SparkOperators操作管理接口，包括查询Spark异步操作状态。通过这些接口，您可以查询Spark异步操作状态。

表6 SparkOperators操作管理接口
API	说明
查询Spark异步操作状态 - ShowSparkOperatorState	查询Spark异步操作的执行状态。

用户协议管理

用户协议管理接口，包括查询、签署和删除协议等。通过这些接口，您可以查询、签署、删除用户的各种协议。

表7 用户协议管理接口
API	说明
查询系统协议 - ListV2AgreementRule	查询系统内置的租户协议内容列表。
签署租户协议 - SignV2Agreement	用户通过该接口签署租户协议。
查询用户是否签署协议 - ShowV2Agreement	查询用户是否签署协议。
删除用户签署协议 - DeleteV2Agreement	删除用户签署的协议。

委托管理

委托管理接口，包括创建、查询、删除服务委托等。通过这些接口，您可以创建、查询、删除服务委托。

表8 委托管理接口
API	说明
创建服务委托 - CreateV2Agency	创建服务委托，将指定权限策略授权给AI DataLake服务。
删除服务委托 - DeleteV2Agency	取消授权给AI DataLake服务的委托。
查询服务委托 - ShowV2Agency	查询授权给AI DataLake服务的委托。
附加策略 - AttachV2AgencyPolicy	为委托附加策略。
移除策略 - DetachV2AgencyPolicy	为委托移除关联策略。

工作空间管理

V2工作空间管理接口，包括V2工作空间的创建、更新、查询和删除。通过这些接口，您可以创建、更新、查询和删除V2工作空间。

表9 V2工作空间管理接口
API	说明
查询工作空间列表 - ListV2Workspaces	用户可通过该接口获取符合过滤条件的工作空间列表。
查询工作空间详细信息 - ShowV2Workspace	用户可通过该接口查询某工作空间详情。
更新工作空间 - UpdateV2Workspace	用户可通过该接口更新工作空间。
创建工作空间 - CreateV2Workspace	用户可通过该接口创建工作空间。
删除工作空间 - DeleteV2Workspace	删除工作空间。

计算资源

计算资源接口，包括计算资源的创建、更新、查询、删除等操作。通过这些接口，您可以创建、更新、查询、删除计算资源。

**表10** 计算资源接口
API	说明
查询计算资源列表 - ListV2Computes	查询工作空间下的计算资源列表。
查看计算资源详情 - ShowV2Compute	查看指定计算资源的详细信息。
创建计算资源 - CreateV2Compute	创建计算资源。
更新计算资源 - UpdateV2Compute	更新计算资源。
查询资源池监控 - ShowV2ComputesMetrics	查询资源池监控CPU、MEM、NPU、GPU数据。
删除计算资源 - DeleteV2Compute	删除计算资源。
查询计算资源操作记录列表 - ListV2ComputeVersions	查询计算资源操作记录列表。

端点管理

端点管理接口，包括端点的创建、更新、查询、删除等操作。通过这些接口，您可以创建、更新、查询、删除端点。

**表11** 端点管理接口
API	说明
查询所有端点列表 - ListV2AllEndpoints	用户可使用该接口列举该租户端点列表。
查询端点列表 - ListV2Endpoints	用户可使用该接口列举指定工作空间下的端点列表。
查询端点配置限制 - ShowV2EndpointResourceLimit	用户可通过该接口查询计算资源池各规格资源大小和资源剩余量，各规格下端点可配置的CPU，MEM，卡数列表。
创建端点 - CreateV2Endpoint	用户可使用该接口在指定的工作空间下创建端点。
查询端点详情 - ShowV2Endpoint	用户可通过该接口查询某端点详情。
查询端点监控 - ShowV2EndpointsMetrics	查询端点CPU、MEM、NPU、GPU监控数据。
更新端点 - UpdateV2Endpoint	用户可通过该接口更新端点的名称、描述、引擎配置、容量、监控配置等。
删除端点 - DeleteV2Endpoint	用户可通过该接口删除指定工作空间下的端点。

镜像管理

镜像管理接口，包括镜像的注册、添加、更新、查看、删除等。通过这些接口，您可以注册、添加、更新、查看、删除镜像。

**表12** 镜像管理接口
API	说明
注册自定义镜像 - RegisterV2Image	用户通过该接口将外部镜像仓库中的镜像注册到工作空间中，以便后续使用。
查看自定义镜像列表 - ListV2Images	用户可查询已创建的自定义镜像列表。
添加自定义镜像版本 - AddV2ImageVersion	用户通过该接口为已注册的镜像添加新的版本。
查看自定义镜像版本 - ShowV2ImageVersion	用户可查询指定镜像版本的详细信息。
删除指定镜像版本 - DeleteV2ImageVersion	用户可通过该接口删除指定镜像的某个不再使用的版本。
删除镜像下所有版本 - DeleteV2Image	用户可通过该接口删除不再需要的镜像及其所有版本。
查询镜像详情 - ShowV2Image	用户可通过该接口获取单个镜像的完整配置和元数据。
查看自定义镜像版本列表 - ListV2ImageVersions	用户可查询指定镜像下的所有版本信息。
更新自定义镜像版本 - UpdateV2ImageVersion	用户通过该接口更新指定镜像版本的描述、架构、容器软件、分类等信息。