文档

ListTensorboards - 查询Tensorboard列表

更新时间:

查询已创建的Tensorboard列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/tensorboards

请求参数

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

是否显示详情。取值如下:

  • true:显示详情。
  • false:不显示详情。
true
WorkspaceIdstring

工作空间 ID。根据工作空间 ID 来获取 Tensorboard 列表。如何获取工作空间 ID,请参见 ListWorkspaces

380
SourceTypestring

数据来源。目前仅支持 DLC 训练任务,即 job。

job
SourceIdstring

数据来源 ID。如何获取任务 ID,请参见 ListJobs

dlc-xxxxxx
DisplayNamestring

Tensorboard 展示名称。

TestTensorboard
Statusstring

Tensorboard 状态,取值如下:

  • Creating:创建中。
  • Running:运行中。
  • Stopped:已停止。
  • Succeeded:已成功。
  • Failed:已失败。
Running
StartTimestring

查询区间的起始时间。使用 Tensorboard 的创建 UTC 时间来过滤。若为空,则默认为当前时间的 7 天之前。

2020-11-08T16:00:00Z
EndTimestring

查询区间的截止时间。使用 Tensorboard 的创建 UTC 时间来过滤。若为空,则默认为当前时间。

2020-11-09T14:45:00Z
SortBystring

按返回的以下字段排序。

  • DisplayName:任务名称。
  • GmtCreateTime:任务创建时间。
GmtCreateTime
PageNumberinteger

分页查询,指定当前需要返回的页码,起始值为 1。

1
PageSizeinteger

分页查询中,指定每页返回的 Tensorboard 数量。

50
Orderstring

排序顺序。取值如下:

  • desc:降序。
  • asc:升序。
desc
JobIdstring

根据 DLC 任务 ID 来过滤 Tensorboard 任务。如何获取任务 ID,请参见 ListJobs

dlc-xxx
TensorboardIdstring

根据 Tensorboard ID,来过滤 Tensorboard 列表。

tensorboard-xxx
ShowOwnboolean

是否只返回当前登录者所创建的 Tensorboard

false
PaymentTypestring

Tensorboard 任务的付费类型。Free 代表使用了免费资源的 Tensorboard 任务。Postpaid 代表使用了后付费资源的 Tensorboard 任务。

Postpaid

返回参数

名称类型描述示例值
object
Tensorboardsarray

Tensorboard 列表。

Tensorboard

Tensorboard 详情。

TotalCountlong

符合条件的数据源总数量。

100
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "Tensorboards": [
    {
      "TensorboardId": "tensorboard-xxx",
      "TensorboardUrl": "http://xxxxxx",
      "Status": "running",
      "Duration": "1234567",
      "GmtCreateTime": "2021-01-12T14:35:00Z",
      "GmtModifyTime": "2021-01-12T14:36:00Z",
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
      "DisplayName": "test",
      "DataSourceId": "datasource-test",
      "SummaryPath": "/root/data",
      "UserId": "lycxxxxx",
      "ReasonCode": "Delete by user",
      "ReasonMessage": "Tensorboard is deleted",
      "JobId": "dlc-20210114104214-vf9lowjt3pso",
      "TensorboardDataSources": [
        {
          "DirectoryName": "dlcJobName",
          "Name": "dlcJobName",
          "Id": "d-vf2fdhxxxxxx",
          "DataSourceType": "OSS",
          "Uri": "oss://.oss-cn-shanghai-finance-1.aliyuncs.com/",
          "SourceType": "datasource",
          "SummaryPath": "/tensorboard/run1",
          "FullSummaryPath": "oss://xxxxx/tensorboard/run1"
        }
      ],
      "TensorboardSpec": {
        "VpcId": "vpc-xxxx",
        "EcsType": "ecs.g6.large",
        "SecurityGroupId": "sg-xxxxx",
        "SwitchId": "vsw-xxxx"
      }
    }
  ],
  "TotalCount": 100,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-28OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PaymentType
2023-08-03OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ShowOwn
  • 本页导读 (1)