ListTensorboards - Platform For AI - Alibaba Cloud Documentation Center

Queries a list of TensorBoard instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
paidlc:ListTensorboards	get	All Resources ``	none	none

Request syntax

GET /api/v1/tensorboards HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Verbose	boolean	No	Specifies whether to return the information about the TensorBoard instance. true false	true
WorkspaceId	string	No	The workspace ID. Obtain a list of TensorBoard instances based on the workspace ID.	380
SourceType	string	No	The data source associated with the TensorBoard instance. This parameter is no longer used. Only Deep Learning Containers (DLC) training jobs are supported.	job
SourceId	string	No	The data source ID. For more information about how to obtain the ID of a job, see ListJobs .	dlc-xxxxxx
DisplayName	string	No	The TensorBoard instance name.	TestTensorboard
Status	string	No	The TensorBoard instance status. Valid values: Creating Running Stopped Succeeded Failed	Running
StartTime	string	No	The start time of the query. Use the UTC time when the TensorBoard instance is created to filter data. If you leave this parameter empty, the default value is seven days before the current time.	2020-11-08T16:00:00Z
EndTime	string	No	The end time of the query. Use the UTC time when the TensorBoard instance is created to filter data. If you leave this parameter empty, the default value is the current time.	2020-11-09T14:45:00Z
SortBy	string	No	The returned field used to sort TensorBoard instances. DisplayName: the name of the TensorBoard instance. GmtCreateTime: the time when the TensorBoard instance is created.	GmtCreateTime
PageNumber	integer	No	The page number. Minimum value: 1.	1
PageSize	integer	No	The number of TensorBoard instances per page.	50
Order	string	No	The sorting order. desc asc	desc
JobId	string	No	The job ID used to filter TensorBoard instances. For more information about how to obtain the ID of a job, see ListJobs .	dlc-xxx
TensorboardId	string	No	The TensorBoard instance ID used to filter TensorBoard instances.	tensorboard-xxx
ShowOwn	boolean	No	Specifies whether to return only the TensorBoard instances created by the current logon account.	false
PaymentType	string	No	The billing method of TensorBoard instances. Free: the TensorBoard instance that uses free resources. Postpaid: the TensorBoard instance that 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 Only whitelisted users can use resource quotas to create TensorBoard instances. If you want to use this feature, contact us. This parameter takes effect only when TensorBoard instances use resource quotas.	quota12***
Accessibility	string	No	The instance visibility. PUBLIC: TensorBoard instances are visible to all members in the workspace. PRIVATE: TensorBoard instances are visible only to you and the administrator of the workspace.	PRIVATE

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
Tensorboards	array	The TensorBoard instances.
Tensorboards	Tensorboard	The information about the TensorBoard instance.
TotalCount	long	The total number of data sources that meet the conditions.	100
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "Tensorboards": [
    {
      "TensorboardId": "tensorboard-xxx",
      "TensorboardUrl": "http://xxxxxx",
      "Status": "running",
      "Duration": "1234567",
      "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": "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"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-11	The request parameters of the API has changed	View Change Details
2024-06-06	The request parameters of the API has changed	View Change Details
2024-03-28	The request parameters of the API has changed	View Change Details
2023-08-03	The request parameters of the API has changed	View Change Details