All Products
Search

This Product

    Platform For AI:CreateTensorboard

    Document Center

    Platform For AI:CreateTensorboard

    Last Updated:Jan 12, 2026

    Creates a TensorBoard by using a job or specifying a data source configuration.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    paidlc:CreateTensorboardcreate
    *All Resources
    *
      none
    		none

    Request syntax

    POST /api/v1/tensorboards HTTP/1.1

    Request parameters

    ParameterTypeRequiredDescriptionExample
    bodyobjectNo

    The request body.

    WorkspaceIdstringNo

    The workspace ID.

    		123***
    JobIdstringNo

    The job ID. For more information about how to query the job ID, see ListJobs .

    		dlc-20210126170216-mtl37ge7gkvdz
    DataSourceIdstringNo

    The dataset ID.

    		d-xxxxxxxx
    DataSourceTypestringNo

    The dataset type. Valid values:

    • OSS
    • NAS
    		OSS
    UristringNo

    The dataset URI:

    • Value format when DataSourceType is set to OSS: oss://[oss-bucket].[endpoint]/[path].
    • Value format when DataSourceType is set to NAS:nas://[nas-filesystem-id].[region]/[path].
    		oss://.oss-cn-shanghai-finance-1.aliyuncs.com/
    OptionsstringNo

    The extended fields of the dataset are in the JSON format. MountPath: the path to mount the dataset.

    		{"mountpath":"/root/data/"}
    SummaryPathstringNo

    The directory of summary.

    		/root/data/
    SummaryRelativePathstringNo

    The relative path of summary.

    		/summary/
    DisplayNamestringNo

    The TensorBoard name

    		tensorboard
    SourceTypestringNo

    The source type.

    		job
    SourceIdstringNo

    The source ID.

    		dlc-xxxxxx
    MaxRunningTimeMinuteslongNo

    The maximum running duration. Unit: minutes.

    		240
    DataSourcesarrayNo

    The configurations of the data source.

    DataSourceItemNo

    The information about the data source.

    CpulongNo

    The number of vCPU cores.

    		1
    MemorylongNo

    The memory size. Unit: GB.

    		1000
    TensorboardDataSourcesarrayNo

    The configurations of datasets mounted with the TensorBoard job.

    TensorboardDataSourceSpecNo

    The TensorBoard dataset configuration information, which is used to mount multiple datasets. Currently, configuration by dataset (datasource) and configuration by job (dlc) are supported. When this parameter is not empty, the DataSourceId, Uri, and DataSourceType parameters do not take effect.

    TensorboardSpecTensorboardSpecNo

    The pay-as-you-go configuration of TensorBoard, which is used to create TensorBoard jobs that use pay-as-you-go resources.

    QuotaIdstringNo

    The resource quota ID. This parameter is required when you create a TensorBoard job by using a resource quota.

    This feature is currently limited to whitelisted users. If you need to use this feature, contact us.

    		quota12345
    PrioritystringNo

    The priority of the job. Default value: 1. Valid values: 1 to 9.

    • 1 is the lowest priority.
    • 9 is the highest priority.
    		1
    AccessibilitystringNo

    The job visibility. Valid values:

    • PUBLIC: Visible to all members in the workspace.
    • PRIVATE: Visible only to you and the administrator of the workspace.
    		PRIVATE

    Response parameters

    ParameterTypeDescriptionExample
    object
    JobIdstring

    The job ID.

    		dlc-20210126170216-xxxxxxxx
    DataSourceIdstring

    The dataset ID.

    		ds-20210126170216-xxxxxxxx
    TensorboardIdstring

    TensorBoard ID

    		tbxxxxxxxx
    RequestIdstring

    The ID of the request.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Sample success responses

    JSONformat

    {
  "JobId": "dlc-20210126170216-xxxxxxxx",
  "DataSourceId": "ds-20210126170216-xxxxxxxx",
  "TensorboardId": "tbxxxxxxxx",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-07-11The internal configuration of the API is changed, but the call is not affectedView Change Details
    2024-03-28The internal configuration of the API is changed, but the call is not affectedView Change Details