查询已创建的Tensorboard列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| paidlc:ListTensorboards | get | *全部资源 * |
| 无 |
请求语法
GET /api/v1/tensorboards HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Verbose | boolean | 否 | 是否显示详情。取值如下：
| true |
| WorkspaceId | string | 否 | 工作空间 ID。根据工作空间 ID 来获取 Tensorboard 列表。如何获取工作空间 ID，请参见 ListWorkspaces 。 | 380 |
| SourceType | string | 否 | 数据来源。目前仅支持 DLC 训练任务，即 job。 | job |
| SourceId | string | 否 | 数据来源 ID。如何获取任务 ID，请参见 ListJobs 。 | dlc-xxxxxx |
| DisplayName | string | 否 | Tensorboard 展示名称。 | TestTensorboard |
| Status | string | 否 | Tensorboard 状态，取值如下：
| Running |
| StartTime | string | 否 | 查询区间的起始时间。使用 Tensorboard 的创建 UTC 时间来过滤。若为空，则默认为当前时间的 7 天之前。 | 2020-11-08T16:00:00Z |
| EndTime | string | 否 | 查询区间的截止时间。使用 Tensorboard 的创建 UTC 时间来过滤。若为空，则默认为当前时间。 | 2020-11-09T14:45:00Z |
| SortBy | string | 否 | 按返回的以下字段排序。
| GmtCreateTime |
| PageNumber | integer | 否 | 分页查询，指定当前需要返回的页码，起始值为 1。 | 1 |
| PageSize | integer | 否 | 分页查询中，指定每页返回的 Tensorboard 数量。 | 50 |
| Order | string | 否 | 排序顺序。取值如下：
| desc |
| JobId | string | 否 | 根据 DLC 任务 ID 来过滤 Tensorboard 任务。如何获取任务 ID，请参见 ListJobs 。 | dlc-xxx |
| TensorboardId | string | 否 | 根据 Tensorboard ID，来过滤 Tensorboard 列表。 | tensorboard-xxx |
| ShowOwn | boolean | 否 | 是否只返回当前登录者所创建的 Tensorboard | false |
| PaymentType | string | 否 | Tensorboard 任务的付费类型。Free 代表使用了免费资源的 Tensorboard 任务。Postpaid 代表使用了后付费资源的 Tensorboard 任务。 | Postpaid |
| UserId | string | 否 | 用户 ID。 | 161****3000 |
| Username | string | 否 | 用户名。 | she****mo |
| QuotaId | string | 否 | 资源配额 ID。当前仅当 Tensorboard 任务使用资源配额的资源时，该值有效。当前仅白名单用户可以使用资源配额资源创建 Tensorboard 任务，若需要使用该功能，请和我们联系 | quota12345 |
| Accessibility | string | 否 | 任务的可见性，取值如下：
| PRIVATE |
返回参数
示例
正常返回示例
JSON格式
{
"Tensorboards": [
{
"TensorboardId": "tensorboard-xxx",
"TensorboardUrl": "http://xxxxxx",
"Status": "running",
"Duration": "1234567",
"GmtCreateTime": "2021-01-12T14:35:00Z",
"GmtModifyTime": "2021-01-12T14:36:00Z",
"GmtFinishTime": "2021-01-12T14:36:00Z",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"DisplayName": "test",
"DataSourceId": "datasource-test",
"SummaryPath": "/root/data",
"UserId": "lycxxxxx",
"Username": "tensorboard.pai",
"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"
},
"QuotaId": "quota12***",
"Priority": "1",
"QuotaName": "dlc-quota",
"Accessibility": "PRIVATE",
"Cpu": 1,
"SummaryRelativePath": "/summary/",
"MaxRunningTimeMinutes": 240,
"WorkspaceId": "123***",
"DataSourceType": "OSS",
"Options": "{\"mountpath\":\"/root/data/\"}",
"Memory": 1000,
"Token": ""
}
],
"TotalCount": 100,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-11 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-06-06 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-03-28 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-08-03 | OpenAPI 入参发生变更 | 查看变更详情 |