{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-pai-dlc/create-job":{"post":{"operationId":"cloud_aliyun_pai_dlc_create_job","summary":"Creates a job to run in a cluster. You can specify the datasource config, code source configuration, startup…","description":"POST /api/v1/jobs","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DisplayName","JobSpecs","JobType","UserCommand"],"properties":{"Accessibility":{"type":"string","description":"The visibility of the job. Valid values: PUBLIC: Visible to all users in the workspace. PRIVATE: Visible only to you and administrators in…"},"CodeSource":{"type":"object","description":"The code source used by the job. Before the nodes of the job start, DLC automatically downloads the code configured in the code source and…"},"CredentialConfig":{"type":"object","description":"The access credential configuration"},"CustomEnvs":{"type":"array","description":"The list of custom environment variables"},"DataSources":{"type":"array","description":"The list of data sources used to run the job"},"DebuggerConfigContent":{"type":"string","description":"This parameter is not supported. Ignore this parameter"},"Description":{"type":"string","description":"The description of the job"},"DisplayName":{"type":"string","description":"The name of the job. The name must meet the following requirements: The name can be up to 256 characters in length. The name can contain…"},"ElasticSpec":{"type":"object","description":"This parameter is not supported. Ignore this parameter"},"Envs":{"type":"object","description":"The environment variable configuration"},"JobMaxRunningTimeMinutes":{"type":"integer","description":"The maximum running duration of the job, in minutes"},"JobSpecs":{"type":"array","description":"JobSpecs describes various configurations when the job runs, such as the image address, startup command, node resource declaration, and…"},"JobType":{"type":"string","description":"The type of the job. This parameter is case-sensitive. Valid values: TFJob PyTorchJob MPIJob XGBoostJob OneFlowJob ElasticBatchJob…"},"Options":{"type":"string","description":"The additional configurations of the job. You can use this parameter to adjust the behavior of mounted data sources. For example, if the…"},"Priority":{"type":"integer","description":"The priority of the job. This parameter is optional. Default value: 1. Valid values: 1 to 9. 1: The lowest priority. 9: The highest priority"},"ResourceId":{"type":"string","description":"The ID of the resource group. This parameter is optional. If this parameter is left empty, the job is submitted to a public resource…"},"SchedulingStrategy":{"type":"string","description":"The scheduling policy"},"Settings":{"type":"object","description":"The additional parameter settings of the job"},"SuccessPolicy":{"type":"string","description":"The success policy for distributed multi-node jobs. Currently, only multi-node TensorFlow jobs are supported. Valid values: ChiefWorker:…"},"TemplateId":{"type":"string","description":"The ID of the job template"},"TemplateVersion":{"type":"integer","description":"The version of the job template"},"ThirdpartyLibDir":{"type":"string","description":"The name of the folder where the Python third-party library (requirements.txt) file is located. Before each node runs the specified…"},"ThirdpartyLibs":{"type":"array","description":"The list of Python third-party libraries to be installed"},"UserCommand":{"type":"string","description":"The startup command for all nodes of the job"},"UserVpc":{"type":"object","description":"The user VPC configuration"},"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/create-job-template":{"post":{"operationId":"cloud_aliyun_pai_dlc_create_job_template","summary":"Creates a task template","description":"POST /api/v1/jobtemplates","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Content","TemplateName","WorkspaceId"],"properties":{"Constraints":{"type":"object","description":"The field constraint rules. The key is a JSONPath expression, and the value is the constraint type: locked (locked and cannot be…"},"Content":{"type":"string","description":"The configuration content of the task template, which contains job configuration parameters. Pass the value in JSON string format"},"Description":{"type":"string","description":"The description of the task template"},"Metadata":{"type":"object","description":"The custom key-value pair metadata"},"TemplateName":{"type":"string","description":"The name of the task template"},"WorkspaceId":{"type":"string","description":"The ID of the workspace to which the template belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/create-ray-history-server":{"post":{"operationId":"cloud_aliyun_pai_dlc_create_ray_history_server","summary":"Creates a RayHistoryServer","description":"POST /api/v1/rayhistoryservers","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DisplayName","StoragePath","WorkspaceId"],"properties":{"Accessibility":{"type":"string","description":"The visibility of the job. Valid values: PUBLIC: Visible to all users in the workspace. PRIVATE: Visible only to you and administrators in…"},"DisplayName":{"type":"string","description":"The display name of the node"},"EcsSpec":{"type":"string","description":"The hardware specifications of the public resource group. To access a detailed list of specifications, see…"},"MaxRuntimeMinutes":{"type":"integer","description":"The maximum runtime in minutes"},"ResourceId":{"type":"string","description":"The resource group ID. This parameter is optional. If this parameter is left empty, the job is committed to the public resource group. If…"},"StoragePath":{"type":"string","description":"The storage path for Ray logs"},"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain a workspace ID, see https://help.aliyun.com/document_detail/449124.html."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/create-signal":{"post":{"operationId":"cloud_aliyun_pai_dlc_create_signal","summary":"Sends a signal to the pods of a specified job and retrieves the signal ID","description":"POST /api/v1/jobs/{JobId}/signals","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"JobId":{"type":"string","description":"The job ID"},"Signal":{"type":"string","description":"The signal code"},"Target":{"type":"object","description":"The signal delivery scope"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/create-tensorboard":{"post":{"operationId":"cloud_aliyun_pai_dlc_create_tensorboard","summary":"Creates a TensorBoard instance by using a node or a specified datasource config","description":"POST /api/v1/tensorboards","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Accessibility":{"type":"string","description":"The visibility of the job. Valid values: PUBLIC: The job is visible to all users in the workspace. PRIVATE: The job is visible only to you…"},"Cpu":{"type":"integer","description":"The number of CPU cores"},"DataSourceId":{"type":"string","description":"The dataset ID. For more information about how to obtain the dataset ID, see https://help.aliyun.com/document_detail/457222.html."},"DataSourceType":{"type":"string","description":"The dataset type. Valid values: OSS NAS"},"DataSources":{"type":"array","description":"The datasource config"},"DisplayName":{"type":"string","description":"The name of the TensorBoard instance"},"JobId":{"type":"string","description":"The job ID. For more information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html"},"MaxRunningTimeMinutes":{"type":"integer","description":"The maximum running duration. Unit: minutes"},"Memory":{"type":"integer","description":"The memory size. Unit: GB"},"Options":{"type":"string","description":"The extension field of custom dataset, in JSON format. Currently, only MountPath is supported, which specifies the custom mount path of…"},"Priority":{"type":"string","description":"The priority of the job. This parameter is optional. Default value: 1. Valid values: 1 to 9. 1: the lowest priority. 9: the highest priority"},"QuotaId":{"type":"string","description":"The resource quota ID. This parameter is required when you create a TensorBoard job by using resources from a resource quota. For more…"},"SourceId":{"type":"string","description":"The source ID"},"SourceType":{"type":"string","description":"The source type"},"SummaryPath":{"type":"string","description":"The summary directory"},"SummaryRelativePath":{"type":"string","description":"The relative path of the summary directory"},"TensorboardDataSources":{"type":"array","description":"The list of dataset configurations mounted to the TensorBoard job"},"TensorboardSpec":{"type":"object","description":"The pay-as-you-go configuration information of the TensorBoard instance, which is used to create a TensorBoard job that uses pay-as-you-go…"},"Uri":{"type":"string","description":"The URI of the dataset: If DataSourceType is set to OSS, the format is `oss://[oss-bucket].[endpoint]/[path]`. If DataSourceType is set to…"},"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/delete-job":{"post":{"operationId":"cloud_aliyun_pai_dlc_delete_job","summary":"Deletes a job that has completed or been stopped","description":"DELETE /api/v1/jobs/{JobId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"JobId":{"type":"string","description":"The job ID. For information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/delete-job-template":{"post":{"operationId":"cloud_aliyun_pai_dlc_delete_job_template","summary":"Deletes an unused task template. If the template is already in use by a node, it cannot be deleted","description":"DELETE /api/v1/jobtemplates/{TemplateId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId"],"properties":{"TemplateId":{"type":"string","description":"The template ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/delete-ray-history-server":{"post":{"operationId":"cloud_aliyun_pai_dlc_delete_ray_history_server","summary":"Deletes a Ray History Server","description":"DELETE /api/v1/rayhistoryservers/{RayHistoryServerId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RayHistoryServerId"],"properties":{"RayHistoryServerId":{"type":"string","description":"The ID of the Ray History Server to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/delete-tensorboard":{"post":{"operationId":"cloud_aliyun_pai_dlc_delete_tensorboard","summary":"Deletes a stopped TensorBoard","description":"DELETE /api/v1/tensorboards/{TensorboardId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TensorboardId"],"properties":{"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."},"TensorboardId":{"type":"string","description":"The TensorBoard ID. For more information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-dashboard":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_dashboard","summary":"Retrieves the dashboard URL of a DLC job, if available","description":"GET /api/v1/jobs/{jobId}/dashboard","tags":["cloud"],"parameters":[{"name":"jobId","in":"query","required":true,"description":"The job ID","schema":{"type":"string","description":"The job ID"}},{"name":"isShared","in":"query","required":false,"description":"Specifies whether the link is a shared link. If set to true, the token parameter is also required","schema":{"type":"string","enum":["true","false"],"description":"Specifies whether the link is a shared link. If set to true, the token parameter is also required"},"example":"false"},{"name":"token","in":"query","required":false,"description":"The token obtained from the GetToken operation","schema":{"type":"string","description":"The token obtained from the GetToken operation"},"example":"some_token_value"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-job":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_job","summary":"Retrieves the detailed configuration and runtime information of a job","description":"GET /api/v1/jobs/{JobId}","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID. For information about how to obtain a job ID, see https://help.aliyun.com/document_detail/459676.html","schema":{"type":"string","description":"The job ID. For information about how to obtain a job ID, see https://help.aliyun.com/document_detail/459676.html"}},{"name":"NeedDetail","in":"query","required":false,"description":"Specifies whether to return the detailed information of the job. Default value: true","schema":{"type":"string","description":"Specifies whether to return the detailed information of the job. Default value: true"},"example":"true"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-job-events":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_job_events","summary":"Retrieves system events for a job","description":"GET /api/v1/jobs/{JobId}/events","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID. To obtain the job ID, refer to https://help.aliyun.com/document_detail/459676.html","schema":{"type":"string","description":"The job ID. To obtain the job ID, refer to https://help.aliyun.com/document_detail/459676.html"}},{"name":"MaxEventsNum","in":"query","required":false,"description":"The maximum number of events to retrieve. Default value: 2000","schema":{"type":"integer","description":"The maximum number of events to retrieve. Default value: 2000"},"example":"100"},{"name":"StartTime","in":"query","required":false,"description":"The start time (UTC) of the event query interval. Default value: 7 days ago","schema":{"type":"string","description":"The start time (UTC) of the event query interval. Default value: 7 days ago"},"example":"2020-11-08T16:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time (UTC) of the event query interval. Default value: current time","schema":{"type":"string","description":"The end time (UTC) of the event query interval. Default value: current time"},"example":"2020-11-08T18:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-job-metrics":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_job_metrics","summary":"Retrieves the monitoring data of a node, including the CPU, GPU, and memory usage, as well as the network…","description":"GET /api/v1/jobs/{JobId}/metrics","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID. You can call the https://help.aliyun.com/document_detail/459676.html operation to obtain the IDs of all jobs","schema":{"type":"string","description":"The job ID. You can call the https://help.aliyun.com/document_detail/459676.html operation to obtain the IDs of all jobs"}},{"name":"StartTime","in":"query","required":false,"description":"The start time of the time range for querying monitoring data, in UTC. Default value: 1 hour ago","schema":{"type":"string","description":"The start time of the time range for querying monitoring data, in UTC. Default value: 1 hour ago"},"example":"2020-11-08T16:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the time range for querying monitoring data, in UTC. Default value: the current time","schema":{"type":"string","description":"The end time of the time range for querying monitoring data, in UTC. Default value: the current time"},"example":"2020-11-09T16:00:00Z"},{"name":"TimeStep","in":"query","required":false,"description":"The time interval at which monitoring data is returned. Default value: 5 minutes","schema":{"type":"string","description":"The time interval at which monitoring data is returned. Default value: 5 minutes"},"example":"5m"},{"name":"MetricType","in":"query","required":true,"description":"The metric type of the monitoring data to query. Valid values: GpuCoreUsage: the GPU usage GpuMemoryUsage: the GPU memory usage…","schema":{"type":"string","description":"The metric type of the monitoring data to query. Valid values: GpuCoreUsage: the GPU usage GpuMemoryUsage: the GPU memory usage…"},"example":"GpuMemoryUsage"},{"name":"Token","in":"query","required":false,"description":"The temporary token used for authentication","schema":{"type":"string","description":"The temporary token used for authentication"},"example":"eyXXXX-XXXX.XXXXX"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-job-sanity-check-result":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_job_sanity_check_result","summary":"Retrieves a specific computing power health check result for a DLC job","description":"GET /api/v1/jobs/{JobId}/sanitycheckresult","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID. For information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html","schema":{"type":"string","description":"The job ID. For information about how to obtain the job ID, see https://help.aliyun.com/document_detail/459676.html"}},{"name":"SanityCheckNumber","in":"query","required":true,"description":"The sequence number of the computing power health check for the job","schema":{"type":"integer","description":"The sequence number of the computing power health check for the job"},"example":"1"},{"name":"SanityCheckPhase","in":"query","required":false,"description":"The phase of the computing power health check. Valid values: CheckInit: environment preparation. DeviceCheck: single-device computing…","schema":{"type":"string","description":"The phase of the computing power health check. Valid values: CheckInit: environment preparation. DeviceCheck: single-device computing…"},"example":"DeviceCheck"},{"name":"Token","in":"query","required":false,"description":"The token information in the job sharing token. For information about how to obtain the token, see…","schema":{"type":"string","description":"The token information in the job sharing token. For information about how to obtain the token, see…"},"example":"eyJhbG******zI1NiIsInR5cCI6IkpXVCJ9.eyJle****jE3MDk1Mzk0NDIsImlhdCI6MTcwODkzNDY0MiwidXNlcl9pZCI6IjE3NTgwNTQxNjI0Mzg2NTUiLCJ0YXJnZXRfaWQiOiJkbGM1OGh1a2xyYzZwdGMyIiwidGFyZ2V0X3R5cGUiOiJqb2IifQ.GNL7jo6****mgKKv0QeGIYgvBufSU-PH_EQttX****"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-job-template":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_job_template","summary":"Retrieves the details of a task template","description":"GET /api/v1/jobtemplates/{TemplateId}","tags":["cloud"],"parameters":[{"name":"TemplateId","in":"query","required":true,"description":"The unique identifier of the task template","schema":{"type":"string","description":"The unique identifier of the task template"}},{"name":"Version","in":"query","required":false,"description":"If this parameter is not specified, the default version is returned. If a specific number is specified, the corresponding version is…","schema":{"type":"string","description":"If this parameter is not specified, the default version is returned. If a specific number is specified, the corresponding version is…"},"example":"all"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-metrics":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_metrics","summary":"Retrieves metrics data","description":"GET /api/v1/cms/metrics","tags":["cloud"],"parameters":[{"name":"Namespace","in":"query","required":false,"description":"The data namespace of the cloud service. For information about the data namespaces of cloud services, see cloud service monitoring items","schema":{"type":"string","description":"The data namespace of the cloud service. For information about the data namespaces of cloud services, see cloud service monitoring items"},"example":"acs_pai_dlc"},{"name":"JobId","in":"query","required":false,"description":"The job ID","schema":{"type":"string","description":"The job ID"},"example":"dlckjd5hm84tmjec"},{"name":"Dimensions","in":"query","required":false,"description":"(Required) The request parameters","schema":{"type":"string","description":"(Required) The request parameters"},"example":"[{\\\"jobId\\\":\\\"dlcdpfpc96mh63mg\\\",\\\"pod\\\":\\\"dlcdpfpc96mh63mg-worker-748\\\",\\\"regionId\\\":\\\"cn-wulanchabu\\\",\\\"userId\\\":\\\"1458867964644701\\\"}]"},{"name":"Length","in":"query","required":false,"description":"The number of entries per query. This parameter is used for paged query with paging. Default value: 1000","schema":{"type":"string","description":"The number of entries per query. This parameter is used for paged query with paging. Default value: 1000"},"example":"5000"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query. Default value: the current time","schema":{"type":"string","description":"The end time of the query. Default value: the current time"},"example":"2020-11-09T16:00:00Z"},{"name":"Period","in":"query","required":false,"description":"The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600","schema":{"type":"string","description":"The statistical period of the monitoring data. Unit: seconds. Valid values: 15, 60, 900, and 3600"},"example":"5"},{"name":"NextToken","in":"query","required":false,"description":"The pagination token. If you do not set this parameter, data on the first page is returned. If a value is returned for this parameter,…","schema":{"type":"string","description":"The pagination token. If you do not set this parameter, data on the first page is returned. If a value is returned for this parameter,…"},"example":"2c6b65b6f9d625d4716568ca19b2064be0b5e8707e68181f"},{"name":"MetricName","in":"query","required":false,"description":"The metric name. Not populated. Not in use","schema":{"type":"string","description":"The metric name. Not populated. Not in use"},"example":"JOB_MEMORY_FREE"},{"name":"StartTime","in":"query","required":false,"description":"The start time (UTC) of the time range for querying monitoring data. Default value: one hour before the current time","schema":{"type":"string","description":"The start time (UTC) of the time range for querying monitoring data. Default value: one hour before the current time"},"example":"2020-11-08T16:00:00Z"},{"name":"Token","in":"query","required":false,"description":"The temporary token used for authentication","schema":{"type":"string","description":"The temporary token used for authentication"},"example":"eyXXXX-XXXX.XXXXX"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-pod-events":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_pod_events","summary":"Retrieves system events for a specific node in a job to locate and troubleshoot issues","description":"GET /api/v1/jobs/{JobId}/pods/{PodId}/events","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID. You can call https://help.aliyun.com/document_detail/459676.html to obtain the job ID","schema":{"type":"string","description":"The job ID. You can call https://help.aliyun.com/document_detail/459676.html to obtain the job ID"}},{"name":"PodId","in":"query","required":true,"description":"The node ID. You can call https://help.aliyun.com/document_detail/459677.html to obtain the node ID","schema":{"type":"string","description":"The node ID. You can call https://help.aliyun.com/document_detail/459677.html to obtain the node ID"}},{"name":"PodUid","in":"query","required":false,"description":"The node UID. You can call https://help.aliyun.com/document_detail/459677.html to obtain the node UID","schema":{"type":"string","description":"The node UID. You can call https://help.aliyun.com/document_detail/459677.html to obtain the node UID"},"example":"dlc-20210126170216-*****-chief-0"},{"name":"MaxEventsNum","in":"query","required":false,"description":"The maximum number of events to return","schema":{"type":"integer","description":"The maximum number of events to return"},"example":"100"},{"name":"StartTime","in":"query","required":false,"description":"The start time in UTC","schema":{"type":"string","description":"The start time in UTC"},"example":"2020-11-08T16:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time in UTC","schema":{"type":"string","description":"The end time in UTC"},"example":"2020-11-09T16:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-pod-logs":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_pod_logs","summary":"Retrieves or downloads the log of a specific node in a job. The log is collected from stdout and stderr of…","description":"GET /api/v1/jobs/{JobId}/pods/{PodId}/logs","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID. To obtain the job ID, see https://help.aliyun.com/document_detail/459676.html","schema":{"type":"string","description":"The job ID. To obtain the job ID, see https://help.aliyun.com/document_detail/459676.html"}},{"name":"PodId","in":"query","required":true,"description":"The node ID. To obtain the node ID, see https://help.aliyun.com/document_detail/459677.html","schema":{"type":"string","description":"The node ID. To obtain the node ID, see https://help.aliyun.com/document_detail/459677.html"}},{"name":"PodUid","in":"query","required":false,"description":"The node UID. To obtain the node UID, see https://help.aliyun.com/document_detail/459677.html","schema":{"type":"string","description":"The node UID. To obtain the node UID, see https://help.aliyun.com/document_detail/459677.html"},"example":"fe846462-af2c-4521-bd6f-96787a57****"},{"name":"MaxLines","in":"query","required":false,"description":"The maximum number of log lines to return. Default value: 2000","schema":{"type":"integer","description":"The maximum number of log lines to return. Default value: 2000"},"example":"100"},{"name":"StartTime","in":"query","required":false,"description":"The start time of the query. Default value: 7 days ago","schema":{"type":"string","description":"The start time of the query. Default value: 7 days ago"},"example":"2020-11-08T16:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query. Default value: current time","schema":{"type":"string","description":"The end time of the query. Default value: current time"},"example":"2020-11-08T17:00:00Z"},{"name":"DownloadToFile","in":"query","required":false,"description":"Specifies whether to download the log file. Valid values: false (default): The log file is not downloaded. true: The log file is downloaded","schema":{"type":"string","description":"Specifies whether to download the log file. Valid values: false (default): The log file is not downloaded. true: The log file is downloaded"},"example":"true"},{"name":"Containers","in":"query","required":false,"description":"Filters logs by specified containers. Separate multiple container names with commas (,)","schema":{"type":"string","description":"Filters logs by specified containers. Separate multiple container names with commas (,)"},"example":"pytorch,aimaster-worker"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-ray-dashboard":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_ray_dashboard","summary":"Retrieves the Ray Dashboard URL","description":"GET /api/v1/jobs/{jobId}/rayDashboard","tags":["cloud"],"parameters":[{"name":"jobId","in":"query","required":true,"description":"The ID of the DLC job","schema":{"type":"string","description":"The ID of the DLC job"}},{"name":"isShared","in":"query","required":false,"description":"Specifies whether the link is a shared link. If set to true, the token parameter is also required","schema":{"type":"string","enum":["true","false"],"description":"Specifies whether the link is a shared link. If set to true, the token parameter is also required"},"example":"false"},{"name":"token","in":"query","required":false,"description":"The token obtained from the GetToken operation","schema":{"type":"string","description":"The token obtained from the GetToken operation"},"example":"some_token_value"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-ray-history-server":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_ray_history_server","summary":"Queries a RayHistoryServer","description":"GET /api/v1/rayhistoryservers/{RayHistoryServerId}","tags":["cloud"],"parameters":[{"name":"RayHistoryServerId","in":"query","required":true,"description":"The ID of the RayHistoryServer","schema":{"type":"string","description":"The ID of the RayHistoryServer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-signal":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_signal","summary":"Queries the details of a specific signal in a specified job","description":"GET /api/v1/jobs/{JobId}/signals/{SignalId}","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID","schema":{"type":"string","description":"The job ID"}},{"name":"SignalId","in":"query","required":true,"description":"The signal ID","schema":{"type":"string","description":"The signal ID"}},{"name":"Token","in":"query","required":false,"description":"The temporary token used for authentication","schema":{"type":"string","description":"The temporary token used for authentication"},"example":"eyXXXX-XXXX.XXXXX"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-tensorboard":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_tensorboard","summary":"Retrieves the details of a TensorBoard","description":"GET /api/v1/tensorboards/{TensorboardId}","tags":["cloud"],"parameters":[{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. See https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID.","schema":{"type":"string","description":"The workspace ID. See https://help.aliyun.com/document_detail/449124.html to obtain the workspace ID."},"example":"46099"},{"name":"TensorboardId","in":"query","required":true,"description":"The TensorBoard ID. See https://help.aliyun.com/document_detail/459689.html to obtain the TensorBoard ID","schema":{"type":"string","description":"The TensorBoard ID. See https://help.aliyun.com/document_detail/459689.html to obtain the TensorBoard ID"}},{"name":"JodId","in":"query","required":false,"description":"The job ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID","schema":{"type":"string","description":"The job ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID"},"example":"dlc-xxxxxxxx"},{"name":"Token","in":"query","required":false,"description":"The sharing token. Specify this parameter to use the sharing token to obtain the permissions to view a specific TensorBoard job. You can…","schema":{"type":"string","description":"The sharing token. Specify this parameter to use the sharing token to obtain the permissions to view a specific TensorBoard job. You can…"},"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e\nyJleHAiOjE2OTUyODA0NTMsImlhdCI6MTY5NTE5NDA1MywidXNlcl9pZCI6IjExN\nTc3MDMyNzA5OTQ5MDEiLCJ0YXJnZXRfaWQiOiJ0YjRrOGxjNXhmdTM2b3B0Iiw\nidGFyZ2V0X3R5cGUiOiJ0ZW5zb3Jib2FyZCJ9.6eT68J-KMBwwfN2d7fj7u6vyPcf0erfqYeizd2N****"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-tensorboard-shared-url":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_tensorboard_shared_url","summary":"Retrieves the sharing link for a TensorBoard task. The link contains a digital token. You can use the…","description":"GET /api/v1/tensorboards/{TensorboardId}/sharedurl","tags":["cloud"],"parameters":[{"name":"TensorboardId","in":"query","required":true,"description":"The ID of the TensorBoard task","schema":{"type":"string","description":"The ID of the TensorBoard task"}},{"name":"ExpireTimeSeconds","in":"query","required":false,"description":"The validity period of the sharing link, in seconds. The maximum value is 604800","schema":{"type":"string","description":"The validity period of the sharing link, in seconds. The maximum value is 604800"},"example":"86400"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-token":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_token","summary":"Retrieves the sharing token for a DLC job to view information about the shared job","description":"GET /api/v1/tokens","tags":["cloud"],"parameters":[{"name":"TargetType","in":"query","required":false,"description":"The type of the shared job. Valid values: job and tensorboard","schema":{"type":"string","description":"The type of the shared job. Valid values: job and tensorboard"},"example":"job"},{"name":"TargetId","in":"query","required":false,"description":"The ID of the job to be shared","schema":{"type":"string","description":"The ID of the job to be shared"},"example":"dlc*******"},{"name":"ExpireTime","in":"query","required":false,"description":"The expiration time of the sharing link. Default value: 604800 seconds. Minimum value: 0","schema":{"type":"integer","description":"The expiration time of the sharing link. Default value: 604800 seconds. Minimum value: 0"},"example":"60"},{"name":"TokenSettings","in":"query","required":false,"description":"The permission settings of the sharing token, which controls log download and cross-account access (JSON-encoded)","schema":{"type":"string","description":"The permission settings of the sharing token, which controls log download and cross-account access (JSON-encoded)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/get-web-terminal":{"get":{"operationId":"cloud_aliyun_pai_dlc_get_web_terminal","summary":"Provides the method and steps to obtain an HTTP link for accessing a container","description":"GET /api/v1/jobs/{JobId}/pods/{PodId}/webterminal","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID","schema":{"type":"string","description":"The job ID"}},{"name":"PodId","in":"query","required":true,"description":"The pod ID of the job","schema":{"type":"string","description":"The pod ID of the job"}},{"name":"PodUid","in":"query","required":false,"description":"Pod UID","schema":{"type":"string","description":"Pod UID"},"example":"94a7cc7c-0033-48b5-85bd-71c63592****"},{"name":"IsShared","in":"query","required":false,"description":"Specifies whether to create a shared link for accessing the container. Valid values: true: Returns a shared link for accessing the…","schema":{"type":"string","description":"Specifies whether to create a shared link for accessing the container. Valid values: true: Returns a shared link for accessing the…"},"example":"true"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-ecs-specs":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_ecs_specs","summary":"Queries the list of supported machine resource configurations","description":"GET /api/v1/ecsspecs","tags":["cloud"],"parameters":[{"name":"AcceleratorType","in":"query","required":false,"description":"The accelerator type. Valid values: CPU GPU","schema":{"type":"string","description":"The accelerator type. Valid values: CPU GPU"},"example":"GPU"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the returned results. Valid values: CPU GPU Memory GmtCreateTime","schema":{"type":"string","description":"The field by which to sort the returned results. Valid values: CPU GPU Memory GmtCreateTime"},"example":"GPU"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: desc: Descending order. asc: Ascending order","schema":{"type":"string","description":"The sort order. Valid values: desc: Descending order. asc: Ascending order"},"example":"desc"},{"name":"PageNumber","in":"query","required":false,"description":"The page number. Minimum value: 1","schema":{"type":"integer","description":"The page number. Minimum value: 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of entries to return per page in a paging query","schema":{"type":"integer","description":"The number of entries to return per page in a paging query"},"example":"10"},{"name":"InstanceTypes","in":"query","required":false,"description":"The instance types to query. Separate multiple instance types with commas (,)","schema":{"type":"string","description":"The instance types to query. Separate multiple instance types with commas (,)"},"example":"ecs.g6.large,ecs.g6.xlarge"},{"name":"ResourceType","in":"query","required":false,"description":"The resource type. Valid values: ECS Lingjun","schema":{"type":"string","description":"The resource type. Valid values: ECS Lingjun"},"example":"ECS"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-job-sanity-check-results":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_job_sanity_check_results","summary":"Retrieves all computing power health check results for a DLC job","description":"GET /api/v1/jobs/{JobId}/sanitycheckresults","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The ID of the job. You can call the https://help.aliyun.com/document_detail/459676.html operation to obtain the ID","schema":{"type":"string","description":"The ID of the job. You can call the https://help.aliyun.com/document_detail/459676.html operation to obtain the ID"}},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: desc: Descending order. asc: Ascending order","schema":{"type":"string","description":"The sort order. Valid values: desc: Descending order. asc: Ascending order"},"example":"desc"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-job-templates":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_job_templates","summary":"Lists task templates by workspace with support for pagination and sorting. You can filter results by…","description":"GET /api/v1/jobtemplates","tags":["cloud"],"parameters":[{"name":"WorkspaceId","in":"query","required":true,"description":"The workspace ID","schema":{"type":"string","description":"The workspace ID"},"example":"4***9"},{"name":"UserId","in":"query","required":false,"description":"The user ID","schema":{"type":"string","description":"The user ID"},"example":"20**************02"},{"name":"TemplateId","in":"query","required":false,"description":"Filters the list by an exact match of the template ID","schema":{"type":"string","description":"Filters the list by an exact match of the template ID"},"example":"tpl1****6jcq2q"},{"name":"TemplateName","in":"query","required":false,"description":"Filters the list by a fuzzy match of the template name","schema":{"type":"string","description":"Filters the list by a fuzzy match of the template name"},"example":"job-template-example-1778047****"},{"name":"Description","in":"query","required":false,"description":"Filters the list by a fuzzy match of the template description","schema":{"type":"string","description":"Filters the list by a fuzzy match of the template description"},"example":"PyTorch 训练模板"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the results","schema":{"type":"string","enum":["GmtCreateTime","GmtModifyTime","TemplateName","LastUsedTime"],"description":"The field by which to sort the results"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order","schema":{"type":"string","enum":["asc","desc"],"description":"The sort order"},"example":"desc"},{"name":"PageNumber","in":"query","required":false,"description":"The page number","schema":{"type":"integer","description":"The page number"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of entries per page","schema":{"type":"integer","description":"The number of entries per page"},"example":"10"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-jobs":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_jobs","summary":"Retrieves a list of jobs with support for pagination, sorting, and conditional filtering","description":"GET /api/v1/jobs","tags":["cloud"],"parameters":[{"name":"DisplayName","in":"query","required":false,"description":"The name of the job. Fuzzy match is supported. The match is case-insensitive and does not support wildcards. For example, if you enter…","schema":{"type":"string","description":"The name of the job. Fuzzy match is supported. The match is case-insensitive and does not support wildcards. For example, if you enter…"},"example":"tf-mnist-test"},{"name":"JobType","in":"query","required":false,"description":"The type of the job. Default value: empty, which indicates all types. Valid values: TFJob PyTorchJob XGBoostJob OneFlowJob ElasticBatchJob","schema":{"type":"string","description":"The type of the job. Default value: empty, which indicates all types. Valid values: TFJob PyTorchJob XGBoostJob OneFlowJob ElasticBatchJob"},"example":"TFJob"},{"name":"Status","in":"query","required":false,"description":"The running status of the job. Valid values: Creating Queuing Bidding (currently only for Lingjun spot jobs) EnvPreparing SanityChecking…","schema":{"type":"string","description":"The running status of the job. Valid values: Creating Queuing Bidding (currently only for Lingjun spot jobs) EnvPreparing SanityChecking…"},"example":"Running"},{"name":"StartTime","in":"query","required":false,"description":"The start time of the query interval. The creation time of the job is used for filtering. Default value: the current time minus 7 days. If…","schema":{"type":"string","description":"The start time of the query interval. The creation time of the job is used for filtering. Default value: the current time minus 7 days. If…"},"example":"2025-04-16T07:25:34Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query interval. The creation time of the job is used for filtering. Default value: the current time","schema":{"type":"string","description":"The end time of the query interval. The creation time of the job is used for filtering. Default value: the current time"},"example":"2025-04-16T07:26:41Z"},{"name":"PageNumber","in":"query","required":false,"description":"The page number to return for paging in a paged query. Pages start from 1. Default value: 1","schema":{"type":"integer","description":"The page number to return for paging in a paged query. Pages start from 1. Default value: 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of jobs to return on each page","schema":{"type":"integer","description":"The number of jobs to return on each page"},"example":"50"},{"name":"SortBy","in":"query","required":false,"description":"The field used for sorting. Valid values: DisplayName JobType Status GmtCreateTime GmtFinishTime","schema":{"type":"string","description":"The field used for sorting. Valid values: DisplayName JobType Status GmtCreateTime GmtFinishTime"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: desc: descending order. This is the default value. asc: ascending order","schema":{"type":"string","description":"The sort order. Valid values: desc: descending order. This is the default value. asc: ascending order"},"example":"desc"},{"name":"ShowOwn","in":"query","required":false,"description":"Specifies whether to query only the jobs submitted by the current user","schema":{"type":"string","description":"Specifies whether to query only the jobs submitted by the current user"},"example":"true"},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html.","schema":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."},"example":"1****"},{"name":"ResourceId","in":"query","required":false,"description":"The resource group ID. For more information about how to query the ID of a dedicated resource group, see…","schema":{"type":"string","description":"The resource group ID. For more information about how to query the ID of a dedicated resource group, see…"},"example":"r*****"},{"name":"BusinessUserId","in":"query","required":false,"description":"The ID of the user associated with the job","schema":{"type":"string","description":"The ID of the user associated with the job"},"example":"16****"},{"name":"Caller","in":"query","required":false,"description":"The caller","schema":{"type":"string","description":"The caller"},"example":"local"},{"name":"Tags","in":"query","required":false,"description":"The tags used for filtering (JSON-encoded)","schema":{"type":"string","description":"The tags used for filtering (JSON-encoded)"}},{"name":"PipelineId","in":"query","required":false,"description":"The pipeline ID used to filter jobs created by the specified pipeline","schema":{"type":"string","description":"The pipeline ID used to filter jobs created by the specified pipeline"},"example":"flow-*******"},{"name":"FromAllWorkspaces","in":"query","required":false,"description":"Specifies whether to retrieve the job list across workspaces. This parameter must be used together with the `ShowOwn=true` parameter to…","schema":{"type":"string","description":"Specifies whether to retrieve the job list across workspaces. This parameter must be used together with the `ShowOwn=true` parameter to…"},"example":"false"},{"name":"JobId","in":"query","required":false,"description":"The job ID. Fuzzy match is not supported. The match is case-insensitive and does not support wildcards. Default value: empty, which…","schema":{"type":"string","description":"The job ID. Fuzzy match is not supported. The match is case-insensitive and does not support wildcards. Default value: empty, which…"},"example":"dlc********"},{"name":"UserIdForFilter","in":"query","required":false,"description":"The user ID of the job submitter used to filter the job list","schema":{"type":"string","description":"The user ID of the job submitter used to filter the job list"},"example":"20**************"},{"name":"Username","in":"query","required":false,"description":"The username of the job submitter used to filter the job list. Fuzzy match is supported, but wildcards are not supported. Default value:…","schema":{"type":"string","description":"The username of the job submitter used to filter the job list. Fuzzy match is supported, but wildcards are not supported. Default value:…"},"example":"test***"},{"name":"ResourceQuotaName","in":"query","required":false,"description":"The name of the resource quota used to filter the job list. Fuzzy match is supported, but wildcards are not supported. Default value:…","schema":{"type":"string","description":"The name of the resource quota used to filter the job list. Fuzzy match is supported, but wildcards are not supported. Default value:…"},"example":"quota***"},{"name":"Accessibility","in":"query","required":false,"description":"The visibility of the job. Valid values: PUBLIC: visible to all users in the workspace. PRIVATE: visible only to you and administrators in…","schema":{"type":"string","description":"The visibility of the job. Valid values: PUBLIC: visible to all users in the workspace. PRIVATE: visible only to you and administrators in…"},"example":"PRIVATE"},{"name":"OversoldInfo","in":"query","required":false,"description":"The information about idle resources. Valid values: ForbiddenQuotaOverSold ForceQuotaOverSold AcceptQuotaOverSold-true: true indicates…","schema":{"type":"string","description":"The information about idle resources. Valid values: ForbiddenQuotaOverSold ForceQuotaOverSold AcceptQuotaOverSold-true: true indicates…"},"example":"ForbiddenQuotaOverSold"},{"name":"PaymentType","in":"query","required":false,"description":"The resource type. Valid values: PrePaid: resource quota Spot: preemptible resources PostPaid: public resources","schema":{"type":"string","description":"The resource type. Valid values: PrePaid: resource quota Spot: preemptible resources PostPaid: public resources"},"example":"PostPaid"},{"name":"JobIds","in":"query","required":false,"description":"The list of job IDs. Separate multiple IDs with commas (,). If both JobIds and JobId are specified, JobId takes precedence","schema":{"type":"string","description":"The list of job IDs. Separate multiple IDs with commas (,). If both JobIds and JobId are specified, JobId takes precedence"},"example":"dlc123abc"},{"name":"DisplayNameSearchMode","in":"query","required":false,"description":"The search mode for DisplayName. Default value: wildcard match","schema":{"type":"string","description":"The search mode for DisplayName. Default value: wildcard match"},"example":"wildcard"},{"name":"ReasonSearch","in":"query","required":false,"description":"Retrieves data by using the full-text index in the reason field of the failed node. Chinese and English tokenization are supported","schema":{"type":"string","description":"Retrieves data by using the full-text index in the reason field of the failed node. Chinese and English tokenization are supported"},"example":"OOM"},{"name":"UserCommandSearch","in":"query","required":false,"description":"Retrieves data by using the full-text index in the user_command field of the node. Chinese and English tokenization are supported","schema":{"type":"string","description":"Retrieves data by using the full-text index in the user_command field of the node. Chinese and English tokenization are supported"},"example":"python train.py"},{"name":"ImageSearch","in":"query","required":false,"description":"Retrieves data by using the full-text index in the images field of the node. Chinese and English tokenization are supported","schema":{"type":"string","description":"Retrieves data by using the full-text index in the images field of the node. Chinese and English tokenization are supported"},"example":"pytorch"},{"name":"TimeRangeField","in":"query","required":false,"description":"The time field used for StartTime and EndTime filtering. Default value: the creation time","schema":{"type":"string","description":"The time field used for StartTime and EndTime filtering. Default value: the creation time"},"example":"GmtFinishTime"},{"name":"NumericRangeField","in":"query","required":false,"description":"The name of the field used for numeric range filtering. This parameter must be used together with NumericRangeMin and NumericRangeMax","schema":{"type":"string","description":"The name of the field used for numeric range filtering. This parameter must be used together with NumericRangeMin and NumericRangeMax"},"example":"RequestGPU"},{"name":"NumericRangeMin","in":"query","required":false,"description":"The minimum value (inclusive) for numeric range filtering. This parameter must be used together with NumericRangeField","schema":{"type":"integer","description":"The minimum value (inclusive) for numeric range filtering. This parameter must be used together with NumericRangeField"},"example":"4\t"},{"name":"NumericRangeMax","in":"query","required":false,"description":"The maximum value (inclusive) for numeric range filtering. This parameter must be used together with NumericRangeField","schema":{"type":"integer","description":"The maximum value (inclusive) for numeric range filtering. This parameter must be used together with NumericRangeField"},"example":"8"},{"name":"EnableAssignNode","in":"query","required":false,"description":"Specifies whether to filter jobs that run on specified nodes","schema":{"type":"string","description":"Specifies whether to filter jobs that run on specified nodes"},"example":"true"},{"name":"TemplateId","in":"query","required":false,"description":"The template ID used to filter jobs created by the specified template","schema":{"type":"string","description":"The template ID used to filter jobs created by the specified template"},"example":"tmlabc123\t"},{"name":"Description","in":"query","required":false,"description":"The keyword used for full text search in the node description","schema":{"type":"string","description":"The keyword used for full text search in the node description"},"example":"This is a training job"},{"name":"ResourceIds","in":"query","required":false,"description":"The ResourceIds","schema":{"type":"string","description":"The ResourceIds"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-ray-history-servers":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_ray_history_servers","summary":"Lists RayHistoryServer resources","description":"GET /api/v1/rayhistoryservers","tags":["cloud"],"parameters":[{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. To obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html.","schema":{"type":"string","description":"The workspace ID. To obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."},"example":"268"},{"name":"DisplayName","in":"query","required":false,"description":"The display name of the node","schema":{"type":"string","description":"The display name of the node"},"example":"test"},{"name":"Status","in":"query","required":false,"description":"The status of the RayHistoryServer. Valid values: Creating: The RayHistoryServer is being created. Queuing: The RayHistoryServer is…","schema":{"type":"string","description":"The status of the RayHistoryServer. Valid values: Creating: The RayHistoryServer is being created. Queuing: The RayHistoryServer is…"},"example":"running"},{"name":"PageNumber","in":"query","required":false,"description":"The page number for a paging query. Paging starts from page 1","schema":{"type":"integer","description":"The page number for a paging query. Paging starts from page 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of RayHistoryServers to return per page in a paging query","schema":{"type":"integer","description":"The number of RayHistoryServers to return per page in a paging query"},"example":"10"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the results. Valid values: DisplayName GmtCreateTime UserId ResourceId Status GmtModifyTime","schema":{"type":"string","description":"The field by which to sort the results. Valid values: DisplayName GmtCreateTime UserId ResourceId Status GmtModifyTime"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: desc: descending order asc: ascending order","schema":{"type":"string","description":"The sort order. Valid values: desc: descending order asc: ascending order"},"example":"desc"},{"name":"ShowOwn","in":"query","required":false,"description":"Specifies whether to return only the RayHistoryServers created by the current user","schema":{"type":"string","description":"Specifies whether to return only the RayHistoryServers created by the current user"},"example":"true"},{"name":"StartTime","in":"query","required":false,"description":"The start time","schema":{"type":"string","description":"The start time"},"example":"2020-11-08T16:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query range. The node creation time is used for filtering","schema":{"type":"string","description":"The end time of the query range. The node creation time is used for filtering"},"example":"2020-11-09T16:00:00Z"},{"name":"ModifiedAfter","in":"query","required":false,"description":"Filters results by the time after which the resource was last modified","schema":{"type":"string","description":"Filters results by the time after which the resource was last modified"},"example":"2020-11-09T16:00:00Z"},{"name":"ResourceId","in":"query","required":false,"description":"The resource group ID. To query the ID of a dedicated resource group, see https://help.aliyun.com/document_detail/2651299.html","schema":{"type":"string","description":"The resource group ID. To query the ID of a dedicated resource group, see https://help.aliyun.com/document_detail/2651299.html"},"example":"quotaxxx"},{"name":"PaymentType","in":"query","required":false,"description":"The payment method. Valid values: PrePaid PostPaid","schema":{"type":"string","description":"The payment method. Valid values: PrePaid PostPaid"},"example":"Postpaid"},{"name":"IdPrefix","in":"query","required":false,"description":"The ID prefix","schema":{"type":"string","description":"The ID prefix"},"example":"按ID前缀过滤"},{"name":"UserIdForFilter","in":"query","required":false,"description":"Filters results by user ID","schema":{"type":"string","description":"Filters results by user ID"},"example":"123456789"},{"name":"Username","in":"query","required":false,"description":"Filters results by username","schema":{"type":"string","description":"Filters results by username"},"example":"myusername"},{"name":"StoragePath","in":"query","required":false,"description":"The storage path for Ray logs","schema":{"type":"string","description":"The storage path for Ray logs"},"example":"oss://bucket-test-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/tmp"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-signals":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_signals","summary":"Queries all signal records of a specified job","description":"GET /api/v1/jobs/{JobId}/signals","tags":["cloud"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job ID","schema":{"type":"string","description":"The job ID"}},{"name":"Status","in":"query","required":false,"description":"The signal status","schema":{"type":"string","description":"The signal status"},"example":"Succeeded"},{"name":"SortBy","in":"query","required":false,"description":"The field used for sorting","schema":{"type":"string","description":"The field used for sorting"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order","schema":{"type":"string","description":"The sort order"},"example":"desc"},{"name":"PageNumber","in":"query","required":false,"description":"The current page number","schema":{"type":"string","description":"The current page number"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The page size","schema":{"type":"string","description":"The page size"},"example":"20"},{"name":"Token","in":"query","required":false,"description":"The temporary token used for authentication","schema":{"type":"string","description":"The temporary token used for authentication"},"example":"eyXXXX-XXXX.XXXXX"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/list-tensorboards":{"get":{"operationId":"cloud_aliyun_pai_dlc_list_tensorboards","summary":"Queries the list of created TensorBoards","description":"GET /api/v1/tensorboards","tags":["cloud"],"parameters":[{"name":"Verbose","in":"query","required":false,"description":"Specifies whether to display details. Valid values: true: Displays details. false: Does not display details","schema":{"type":"string","description":"Specifies whether to display details. Valid values: true: Displays details. false: Does not display details"},"example":"true"},{"name":"WorkspaceId","in":"query","required":false,"description":"The workspace ID. Retrieves the TensorBoard list based on the workspace ID. See https://help.aliyun.com/document_detail/449124.html to…","schema":{"type":"string","description":"The workspace ID. Retrieves the TensorBoard list based on the workspace ID. See https://help.aliyun.com/document_detail/449124.html to…"},"example":"380"},{"name":"SourceType","in":"query","required":false,"description":"The data source. Currently, only DLC training jobs are supported","schema":{"type":"string","description":"The data source. Currently, only DLC training jobs are supported"},"example":"job"},{"name":"SourceId","in":"query","required":false,"description":"The data source ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID","schema":{"type":"string","description":"The data source ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID"},"example":"dlc-xxxxxx"},{"name":"DisplayName","in":"query","required":false,"description":"The display name of the TensorBoard","schema":{"type":"string","description":"The display name of the TensorBoard"},"example":"TestTensorboard"},{"name":"Status","in":"query","required":false,"description":"The TensorBoard status. Valid values: Creating: The TensorBoard is being created. Running: The TensorBoard is running. Stopped: The…","schema":{"type":"string","description":"The TensorBoard status. Valid values: Creating: The TensorBoard is being created. Running: The TensorBoard is running. Stopped: The…"},"example":"Running"},{"name":"StartTime","in":"query","required":false,"description":"The start time of the query interval. Filters TensorBoards by their creation time in UTC. If this parameter is left empty, the default…","schema":{"type":"string","description":"The start time of the query interval. Filters TensorBoards by their creation time in UTC. If this parameter is left empty, the default…"},"example":"2020-11-08T16:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query interval. Filters TensorBoards by their creation time in UTC. If this parameter is left empty, the default value…","schema":{"type":"string","description":"The end time of the query interval. Filters TensorBoards by their creation time in UTC. If this parameter is left empty, the default value…"},"example":"2020-11-09T14:45:00Z"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the returned results. Valid values: DisplayName: the job name. GmtCreateTime: the job creation time","schema":{"type":"string","description":"The field by which to sort the returned results. Valid values: DisplayName: the job name. GmtCreateTime: the job creation time"},"example":"GmtCreateTime"},{"name":"PageNumber","in":"query","required":false,"description":"The page number to return for paging. The starting value is 1","schema":{"type":"integer","description":"The page number to return for paging. The starting value is 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of TensorBoards to return on each page for paging","schema":{"type":"integer","description":"The number of TensorBoards to return on each page for paging"},"example":"50"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: desc: descending order. asc: ascending order","schema":{"type":"string","description":"The sort order. Valid values: desc: descending order. asc: ascending order"},"example":"desc"},{"name":"JobId","in":"query","required":false,"description":"Filters TensorBoard jobs by DLC job ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID","schema":{"type":"string","description":"Filters TensorBoard jobs by DLC job ID. See https://help.aliyun.com/document_detail/459676.html to obtain the job ID"},"example":"dlc-xxx"},{"name":"TensorboardId","in":"query","required":false,"description":"Filters the TensorBoard list by TensorBoard ID","schema":{"type":"string","description":"Filters the TensorBoard list by TensorBoard ID"},"example":"tensorboard-xxx"},{"name":"ShowOwn","in":"query","required":false,"description":"Specifies whether to return only the TensorBoards created by the current logged-on user","schema":{"type":"string","description":"Specifies whether to return only the TensorBoards created by the current logged-on user"},"example":"false"},{"name":"PaymentType","in":"query","required":false,"description":"The billing method of the TensorBoard job. Valid values: Free: The TensorBoard job uses free resources. Postpaid: The TensorBoard job uses…","schema":{"type":"string","description":"The billing method of the TensorBoard job. Valid values: Free: The TensorBoard job uses free resources. Postpaid: The TensorBoard job uses…"},"example":"Postpaid"},{"name":"UserId","in":"query","required":false,"description":"The user ID","schema":{"type":"string","description":"The user ID"},"example":"161****3000"},{"name":"Username","in":"query","required":false,"description":"The username","schema":{"type":"string","description":"The username"},"example":"she****mo"},{"name":"QuotaId","in":"query","required":false,"description":"The resource quota ID. Currently, only whitelisted users can use resource quotas to create TensorBoard jobs. To use this feature, contact…","schema":{"type":"string","description":"The resource quota ID. Currently, only whitelisted users can use resource quotas to create TensorBoard jobs. To use this feature, contact…"},"example":"quota12***\n"},{"name":"Accessibility","in":"query","required":false,"description":"The visibility of the job. Valid values: PUBLIC: The job is visible to all users in the workspace. PRIVATE: The job is visible only to you…","schema":{"type":"string","description":"The visibility of the job. Valid values: PUBLIC: The job is visible to all users in the workspace. PRIVATE: The job is visible only to you…"},"example":"PRIVATE"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/set-job-template-default-version":{"post":{"operationId":"cloud_aliyun_pai_dlc_set_job_template_default_version","summary":"Sets the default version of a job template","description":"PUT /api/v1/jobtemplates/{TemplateId}/defaultversion","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId","Version"],"properties":{"TemplateId":{"type":"string","description":"The template ID"},"Version":{"type":"integer","description":"The version number to set as the default"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/start-ray-history-server":{"post":{"operationId":"cloud_aliyun_pai_dlc_start_ray_history_server","summary":"Starts a Ray History Server","description":"POST /api/v1/rayhistoryservers/{RayHistoryServerId}/start","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RayHistoryServerId"],"properties":{"RayHistoryServerId":{"type":"string","description":"The ID of the Ray History Server"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/start-tensorboard":{"post":{"operationId":"cloud_aliyun_pai_dlc_start_tensorboard","summary":"Starts a TensorBoard","description":"PUT /api/v1/tensorboards/{TensorboardId}/start","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TensorboardId"],"properties":{"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."},"TensorboardId":{"type":"string","description":"The TensorBoard ID. For more information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/stop-job":{"post":{"operationId":"cloud_aliyun_pai_dlc_stop_job","summary":"Stops a running job","description":"POST /api/v1/jobs/{JobId}/stop","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"JobId":{"type":"string","description":"The job ID. To obtain the job ID, see https://help.aliyun.com/document_detail/459676.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/stop-ray-history-server":{"post":{"operationId":"cloud_aliyun_pai_dlc_stop_ray_history_server","summary":"Stops a Ray History Server","description":"POST /api/v1/rayhistoryservers/{RayHistoryServerId}/stop","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RayHistoryServerId"],"properties":{"RayHistoryServerId":{"type":"string","description":"The ID of the Ray History Server"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/stop-tensorboard":{"post":{"operationId":"cloud_aliyun_pai_dlc_stop_tensorboard","summary":"Stops a TensorBoard","description":"PUT /api/v1/tensorboards/{TensorboardId}/stop","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TensorboardId"],"properties":{"WorkspaceId":{"type":"string","description":"The workspace ID. For information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."},"TensorboardId":{"type":"string","description":"The TensorBoard ID. For information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/tag-resources":{"post":{"operationId":"cloud_aliyun_pai_dlc_tag_resources","summary":"Creates and attaches tags to specified resources","description":"POST /api/v1/tags","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceId","ResourceType"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"ResourceId":{"type":"array","description":"The resource IDs. A maximum of 50 items can be specified"},"ResourceType":{"type":"string","description":"The resource type. Valid values: Job"},"Tag":{"type":"array","description":"The tags to be created and attached. A maximum of 20 items can be specified"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/untag-resources":{"post":{"operationId":"cloud_aliyun_pai_dlc_untag_resources","summary":"Unbinds tags from a specified list of resources","description":"DELETE /api/v1/tags","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType","ResourceId"],"properties":{"ResourceType":{"type":"string","description":"The resource type"},"ResourceId":{"type":"string","description":"The resource ID. You can specify up to 50 resource IDs (JSON-encoded)"},"TagKey":{"type":"string","description":"The list of tag keys. You can specify up to 20 tag keys (JSON-encoded)"},"All":{"type":"string","description":"Specifies whether to unbind all tags from the instance. Valid values: true: Unbinds all tags from the instance. false: Does not unbind all…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/update-job":{"post":{"operationId":"cloud_aliyun_pai_dlc_update_job","summary":"Updates the configuration of a job, such as modifying the priority of a queued job","description":"PUT /api/v1/jobs/{JobId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"JobId":{"type":"string","description":"The job ID. For information about how to obtain a job ID, see https://help.aliyun.com/document_detail/459676.html"},"Accessibility":{"type":"string","description":"The visibility of the job can only be increased, not decreased. Valid values: PUBLIC: The job is visible to all users in the workspace"},"Description":{"type":"string","description":"The description of the job"},"JobSpecs":{"type":"array","description":"The job specifications"},"Priority":{"type":"integer","description":"The priority of the job. Valid values: 1 to 9. 1: The lowest priority. 9: The highest priority"},"UserCommand":{"type":"string","description":"The user command"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/update-job-template":{"post":{"operationId":"cloud_aliyun_pai_dlc_update_job_template","summary":"Updates a task template","description":"PUT /api/v1/jobtemplates/{TemplateId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId"],"properties":{"TemplateId":{"type":"string","description":"The unique identifier of the task template"},"Constraints":{"type":"object","description":"The field constraint rules. The key is a JSONPath expression and the value is the constraint type: locked (cannot be overridden),…"},"Content":{"type":"string","description":"The configuration content of the task template. Supports all parameter fields of the CreateJob operation, passed in JSON format. Providing…"},"Description":{"type":"string","description":"The description of the task template"},"Metadata":{"type":"object","description":"The user-defined key-value pair metadata"},"SetAsDefault":{"type":"string","description":"Specifies whether to set the new version as the default version when a new version is created"},"TemplateName":{"type":"string","description":"The name of the task template"},"version":{"type":"integer","description":"Invalid field"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/update-tensorboard":{"post":{"operationId":"cloud_aliyun_pai_dlc_update_tensorboard","summary":"Updates a TensorBoard","description":"PUT /api/v1/tensorboards/{TensorboardId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TensorboardId"],"properties":{"WorkspaceId":{"type":"string","description":"The workspace ID. For more information about how to obtain the workspace ID, see https://help.aliyun.com/document_detail/449124.html."},"TensorboardId":{"type":"string","description":"The TensorBoard ID. For more information about how to obtain the TensorBoard ID, see https://help.aliyun.com/document_detail/459689.html"},"MaxRunningTimeMinutes":{"type":"integer","description":"The maximum running duration in minutes"},"Accessibility":{"type":"string","description":"The visibility of the task. Valid values: PUBLIC: The task is visible to all users in the workspace. PRIVATE: The task is visible only to…"},"Priority":{"type":"string","description":"The scheduling priority of the TensorBoard task. Valid values: 1 to 9. A value of 1 indicates the lowest priority, and a value of 9…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dlc/version":{"post":{"operationId":"cloud_aliyun_pai_dlc_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}