全部产品
Search
文档中心

人工智能平台 PAI:CreateTensorboard - 创建Tensorboard

更新时间:Jan 12, 2026

创建一个Tensorboard,可以通过一个任务或者指定数据源配置来创建。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidlc:CreateTensorboardcreate
*全部资源
*

请求语法

POST /api/v1/tensorboards HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求参数。

WorkspaceIdstring

工作空间 ID。

123***
JobIdstring

任务 ID。如何获取任务 ID,请参见 ListJobs

dlc-20210126170216-mtl37ge7gkvdz
DataSourceIdstring

数据集 ID。

d-xxxxxxxx
DataSourceTypestring

数据集类型,取值如下:

  • OSS
  • NAS
OSS
Uristring

数据集的 URI:

  • 当 DataSourceType 为 OSS 时,格式为:oss://[oss-bucket].[endpoint]/[path]
  • 当 DataSourceType 为 NAS 时,格式为:nas://[nas-filesystem-id].[region]/[path]
oss://.oss-cn-shanghai-finance-1.aliyuncs.com/
Optionsstring

数据集的扩展字段为 JSON 格式,当前支持 MountPath:自定义数据集挂载的路径。

{"mountpath":"/root/data/"}
SummaryPathstring

Summary 目录。

/root/data/
SummaryRelativePathstring

Summary 相对目录。

/summary/
DisplayNamestring

Tensorboard 名称。

tensorboard
SourceTypestring

来源类型。

job
SourceIdstring

来源 ID。

dlc-xxxxxx
MaxRunningTimeMinuteslong

最长运行时长,单位为:分钟。

240
DataSourcesarray

数据源配置。

DataSourceItem

数据源信息。

Cpulong

CPU 核数。

1
Memorylong

内存大小,单位为:GB。

1000
TensorboardDataSourcesarray

Tensorboard 任务挂载的数据集配置列表。

TensorboardDataSourceSpec

Tensorboard 数据源配置信息,用于 Tensorboard 挂载多数据集功能。目前支持按数据集配置(datasource)和按任务配置(dlc)。当 Tensorboard 数据源配置信息不为空时,DataSourceId 配置,Uri, DataSourceType 等参数不生效

TensorboardSpecTensorboardSpec

Tensorboard 后付费配置信息,用于创建使用后付费资源的 Tensorboard 任务。

QuotaIdstring

资源配额 ID。使用资源配额的资源创建 Tensorboard 任务时的必填参数。

当前仅白名单用户可以使用资源配额资源创建 Tensorboard 任务,若需要使用该功能,请和我们联系

quota12345
Prioritystring

任务的优先级,可选参数,默认值 1,参数值的范围是 1~9。其中:

  • 1 为最低优先级。
  • 9 为最高优先级。
1
Accessibilitystring

任务的可见性,取值如下:

  • PUBLIC:在此工作空间中,对所有人可见。
  • PRIVATE:在此工作空间中,仅对您和管理员可见。
PRIVATE

返回参数

名称类型描述示例值
object
JobIdstring

任务 ID。

dlc-20210126170216-xxxxxxxx
DataSourceIdstring

数据集 ID。

ds-20210126170216-xxxxxxxx
TensorboardIdstring

Tensorboard ID。

tbxxxxxxxx
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "JobId": "dlc-20210126170216-xxxxxxxx",
  "DataSourceId": "ds-20210126170216-xxxxxxxx",
  "TensorboardId": "tbxxxxxxxx",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-11API 内部配置变更,不影响调用查看变更详情
2024-03-28API 内部配置变更,不影响调用查看变更详情