Query a list of TensorBoard instances with ListTensorboards - Platform For AI - Alibaba Cloud - Platform For AI

Queries a list of created Tensorboard instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paidlc:ListTensorboards

get

*All Resource

*

None

Request syntax

GET /api/v1/tensorboards HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Verbose	boolean	No	Specifies whether to show details. Valid values: true: Show details. false: Do not show details.	true
WorkspaceId	string	No	The workspace ID. The Tensorboard list is retrieved based on the workspace ID.	380
SourceType	string	No	The data source type. Currently, only DLC training jobs are supported, which means the value is job.	job
SourceId	string	No	The data source ID. See ListJobs to obtain the job ID.	dlc-xxxxxx
DisplayName	string	No	The display name of the Tensorboard instance.	TestTensorboard
Status	string	No	The Tensorboard status. Valid values: Creating: Being created. Running: Running. Stopped: Stopped. Succeeded: Succeeded. Failed: Failed.	Running
StartTime	string	No	The start time of the query range. The creation time of the Tensorboard instance in UTC is used for filtering. If this parameter is left empty, the default value is 7 days before the current time.	2020-11-08T16:00:00Z
EndTime	string	No	The end time of the query range. The creation time of the Tensorboard instance in UTC is used for filtering. If this parameter is left empty, the default value is the current time.	2020-11-09T14:45:00Z
SortBy	string	No	Sorts the results by the following fields. Valid values: DisplayName: The job name. GmtCreateTime: The job creation time.	GmtCreateTime
PageNumber	integer	No	The page number of the page to return in a paged query. The value starts from 1.	1
PageSize	integer	No	The number of Tensorboard instances to return per page in a paged query.	50
Order	string	No	The sort order. Valid values: desc: Descending order. asc: Ascending order.	desc
JobId	string	No	Filters Tensorboard instances by DLC job ID. See ListJobs to obtain the job ID.	dlc-xxx
TensorboardId	string	No	Filters the Tensorboard list by Tensorboard ID.	tensorboard-xxx
ShowOwn	boolean	No	Specifies whether to return only Tensorboard instances created by the current user.	false
PaymentType	string	No	The billing type of the Tensorboard instance. Valid values: Free: The Tensorboard instance uses free resources. Postpaid: The Tensorboard instance uses pay-as-you-go resources.	Postpaid
UserId	string	No	The user ID.	161****3000
Username	string	No	The username.	she****mo
QuotaId	string	No	The resource quota ID. Note Currently, only whitelisted users can use resource quota resources to create Tensorboard instances. To use this feature, contact us. This value is valid only when the Tensorboard instance uses resource quota resources.	quota12***
Accessibility	string	No	The visibility of the job. Valid values: PUBLIC: Visible to all users in this workspace. PRIVATE: Visible only to you and administrators in this workspace.	PRIVATE

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Tensorboards	array	The list and details of Tensorboard instances.
	Tensorboard	The Tensorboard details.
TotalCount	integer	The total number of data sources that match the specified conditions.	100

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "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://.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"
    }
  ],
  "TotalCount": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.