GetTensorboard API请求参数与返回参数-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

调试

您可以在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

路径参数

名称	类型	必填	描述	示例值
TensorboardId	string	是	Tensorboard ID。参见 ListTensorboards 获取 Tensorboard ID。	tb-20210114104214-xxxxx

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	否	工作空间 ID。参见 ListWorkspaces 获取工作空间 ID。	46099
JodId	string	否	任务 ID。参见 ListJobs 获取任务 ID。	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": "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"
}

错误码

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

变更历史

更多信息，参考变更详情。