调用GetTensorboard获取Tensorboard详情_人工智能平台 PAI(PAI)-阿里云帮助中心

获取一个Tensorboard的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paidlc:GetTensorboard	get	全部资源 ``	无	无

请求语法

GET /api/v1/tensorboards/{TensorboardId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	否	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	46099
TensorboardId	string	是	TensorboardId ID。如何获取 Tensorboard ID，请参见 ListTensorboards 。	tb-20210114104214-xxxxx
JodId	string	否	任务 ID。如何获取任务 ID，请参见 ListJobs 。	dlc-xxxxxxxx
Token	string	否	分享令牌信息，填入该参数可利用分享令牌信息获得查看某个 Tensorboard 任务的权限。可通过执行 GetTensorboardSharedUrl ，在获得的链接中提取。	eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e yJleHAiOjE2OTUyODA0NTMsImlhdCI6MTY5NTE5NDA1MywidXNlcl9pZCI6IjExN Tc3MDMyNzA5OTQ5MDEiLCJ0YXJnZXRfaWQiOiJ0YjRrOGxjNXhmdTM2b3B0Iiw idGFyZ2V0X3R5cGUiOiJ0ZW5zb3Jib2FyZCJ9.6eT68J-KMBwwfN2d7fj7u6vyPcf0erfqYeizd2N****

返回参数

名称	类型	描述	示例值
	Tensorboard	Tensorboard 详情。

示例

正常返回示例

JSON格式

{
  "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": ""
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-08-11	OpenAPI 入参发生变更	查看变更详情