查詢已創(chuàng)建的Tensorboard列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| paidlc:ListTensorboards | get |
|
| 無 |
請求語法
GET /api/v1/tensorboards
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Verbose | boolean | 否 | 是否顯示詳情。取值如下：
| true |
| WorkspaceId | string | 否 | 工作空間 ID。根據(jù)工作空間 ID 來獲取 Tensorboard 列表。如何獲取工作空間 ID，請參見 ListWorkspaces 。 | 380 |
| SourceType | string | 否 | 數(shù)據(jù)來源。目前僅支持 DLC 訓(xùn)練任務(wù)，即 job。 | job |
| SourceId | string | 否 | 數(shù)據(jù)來源 ID。如何獲取任務(wù) ID，請參見 ListJobs 。 | dlc-xxxxxx |
| DisplayName | string | 否 | Tensorboard 展示名稱。 | TestTensorboard |
| Status | string | 否 | Tensorboard 狀態(tài)，取值如下：
| Running |
| StartTime | string | 否 | 查詢區(qū)間的起始時間。使用 Tensorboard 的創(chuàng)建 UTC 時間來過濾。若為空，則默認(rèn)為當(dāng)前時間的 7 天之前。 | 2020-11-08T16:00:00Z |
| EndTime | string | 否 | 查詢區(qū)間的截止時間。使用 Tensorboard 的創(chuàng)建 UTC 時間來過濾。若為空，則默認(rèn)為當(dāng)前時間。 | 2020-11-09T14:45:00Z |
| SortBy | string | 否 | 按返回的以下字段排序。
| GmtCreateTime |
| PageNumber | integer | 否 | 分頁查詢，指定當(dāng)前需要返回的頁碼，起始值為 1。 | 1 |
| PageSize | integer | 否 | 分頁查詢中，指定每頁返回的 Tensorboard 數(shù)量。 | 50 |
| Order | string | 否 | 排序順序。取值如下：
| desc |
| JobId | string | 否 | 根據(jù) DLC 任務(wù) ID 來過濾 Tensorboard 任務(wù)。如何獲取任務(wù) ID，請參見 ListJobs 。 | dlc-xxx |
| TensorboardId | string | 否 | 根據(jù) Tensorboard ID，來過濾 Tensorboard 列表。 | tensorboard-xxx |
| ShowOwn | boolean | 否 | 是否只返回當(dāng)前登錄者所創(chuàng)建的 Tensorboard | false |
| PaymentType | string | 否 | Tensorboard 任務(wù)的付費(fèi)類型。Free 代表使用了免費(fèi)資源的 Tensorboard 任務(wù)。Postpaid 代表使用了后付費(fèi)資源的 Tensorboard 任務(wù)。 | Postpaid |
| UserId | string | 否 | 用戶 ID。 | 161****3000 |
| Username | string | 否 | 用戶名。 | she****mo |
| QuotaId | string | 否 | 資源配額 ID。當(dāng)前僅當(dāng) Tensorboard 任務(wù)使用資源配額的資源時，該值有效。當(dāng)前僅白名單用戶可以使用資源配額資源創(chuàng)建 Tensorboard 任務(wù)，若需要使用該功能，請和我們聯(lián)系 | quota12345 |
| Accessibility | string | 否 | 任務(wù)的可見性，取值如下：
| PRIVATE |
返回參數(shù)
示例
正常返回示例
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": "",
"Priority": "",
"QuotaName": "",
"Accessibility": ""
}
],
"TotalCount": 100,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-07-11 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-06-06 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-03-28 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-08-03 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |