すべてのプロダクト
Search

このプロダクト

    Platform For AI:ListTensorboards

    ドキュメントセンター

    Platform For AI:ListTensorboards

    最終更新日:Jul 04, 2026

    作成済みの TensorBoard インスタンスのリストをクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    paidlc:ListTensorboards

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/tensorboards HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Verbose

    boolean

    任意

    詳細を表示するかどうかを指定します。

    • true ：詳細を表示します。

    • false ：詳細を表示しません。

    true
    WorkspaceId

    string

    任意

    ワークスペース ID。TensorBoard インスタンスはワークスペース ID によってフィルタリングされます。

    380
    SourceType

    string

    任意

    データソースのタイプ。現在サポートされているのは DLC トレーニングジョブのみです。値は job です。

    job
    SourceId

    string

    任意

    データソース ID。ListJobs を呼び出してジョブ ID を取得します。

    dlc-xxxxxx
    DisplayName

    string

    任意

    TensorBoard インスタンスの表示名。

    TestTensorboard
    Status

    string

    任意

    TensorBoard のステータス。有効な値：

    • Creating ：作成中です。

    • Running ：実行中です。

    • Stopped ：停止済みです。

    • Succeeded ：成功しました。

    • Failed ：失敗しました。

    Running
    StartTime

    string

    任意

    クエリ範囲の開始時刻。TensorBoard インスタンスは、UTC での作成時間によってフィルタリングされます。このパラメーターを省略した場合、デフォルト値は現在時刻の 7 日前になります。

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

    string

    任意

    クエリ範囲の終了時刻。TensorBoard インスタンスは、UTC での作成時間によってフィルタリングされます。このパラメーターを省略した場合、デフォルト値は現在時刻になります。

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

    string

    任意

    結果のソートに使用されるフィールド。有効な値：

    • DisplayName ：表示名。

    • GmtCreateTime ：作成時間。

    GmtCreateTime
    PageNumber

    integer

    任意

    ページ番号。値は 1 から始まります。

    1
    PageSize

    integer

    任意

    1 ページあたりに返す TensorBoard インスタンスの数。

    50
    Order

    string

    任意

    ソート順。有効な値：

    • desc ：降順。

    • asc ：昇順。

    desc
    JobId

    string

    任意

    TensorBoard インスタンスのフィルタリングに使用される DLC ジョブ ID。ListJobs を呼び出してジョブ ID を取得します。

    dlc-xxx
    TensorboardId

    string

    任意

    TensorBoard リストのフィルタリングに使用される TensorBoard ID。

    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 インスタンスがリソースクォータを使用する場合にのみ有効になります。

    quota12***

    Accessibility

    string

    任意

    TensorBoard インスタンスの可視性。有効な値：

    • PUBLIC ：ワークスペース内のすべてのメンバーに表示されます。

    • PRIVATE ：ワークスペース内の自分と管理者だけが表示できます。

    PRIVATE

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    Tensorboards

    array

    TensorBoard インスタンスのリスト。

    Tensorboard

    TensorBoard の詳細。

    TotalCount

    integer

    指定された条件に一致する TensorBoard インスタンスの総数。

    100
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    例

    成功レスポンス

    JSONJSON

    {
  "Tensorboards": [
    {
      "TensorboardId": "tensorboard-xxx",
      "TensorboardUrl": "http://xxxxxx",
      "Status": "running",
      "Duration": "60",
      "GmtCreateTime": "2021-01-12T14:35:00Z",
      "GmtModifyTime": "2021-01-12T14:36:00Z",
      "GmtFinishTime": "null",
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
      "DisplayName": "test",
      "DataSourceId": "datasource-test",
      "SummaryPath": "/root/data",
      "UserId": "lycxxxxx",
      "Username": "tensorboard.pai",
      "ReasonCode": "\"\"",
      "ReasonMessage": "\"\"",
      "JobId": "dlc-20210114104214-vf9lowjt3pso",
      "TensorboardDataSources": [
        {
          "DirectoryName": "dlcJobName",
          "Name": "dlcJobName",
          "Id": "d-vf2fdhxxxxxx",
          "DataSourceType": "OSS",
          "Uri": "oss://examplebucket.oss-cn-shanghai-internal.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"
    }
  ],
  "TotalCount": 100,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。