{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-pai-dsw/create-diagnosis":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_diagnosis","summary":"Diagnoses instance issues","description":"POST /api/v2/diagnoses","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProblemCategory"],"properties":{"GmtFailureTime":{"type":"string","description":"The time when the issue occurred on the instance to be diagnosed"},"InstanceId":{"type":"string","description":"The instance ID"},"ProblemCategory":{"type":"string","description":"The problem category. Valid values: InstanceStartFailed: The instance failed to start. InstanceRecovering: The instance is recovering"}}}}}},"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-dsw/create-idle-instance-culler":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_idle_instance_culler","summary":"Creates an automatic shutdown policy for a specified instance to automatically stop the Data Science…","description":"POST /api/v2/instances/{InstanceId}/idleinstanceculler","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the instance for which you want to configure the automatic shutdown policy. For more information about how to obtain the…"},"CpuPercentThreshold":{"type":"integer","description":"The CPU utilization threshold, in percentage. Valid values: 1 to 100. If the CPU utilization is lower than this value, the instance is…"},"GpuPercentThreshold":{"type":"integer","description":"The GPU utilization threshold, in percentage. Valid values: 1 to 100. This parameter takes effect only if the instance is a…"},"MaxIdleTimeInMinutes":{"type":"integer","description":"The maximum idle time threshold, in minutes. If the idle duration exceeds this value, the DSW instance is automatically stopped"}}}}}},"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-dsw/create-instance":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_instance","summary":"Creates a DSW instance","description":"POST /api/v2/instances","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AccessRestrictionRules":{"type":"object","description":"The instance access restriction rules"},"Accessibility":{"type":"string","description":"The visibility of the instance"},"Affinity":{"type":"object","description":"The affinity configuration information"},"AssignNodeSpec":{"type":"object","description":"The node scheduling configuration"},"CloudDisks":{"type":"array","description":"The list of cloud disks"},"CredentialConfig":{"type":"object","description":"The credential configuration"},"Datasets":{"type":"array","description":"The list of datasets"},"DockerConfig":{"type":"object","description":"The Docker configuration of the instance"},"Driver":{"type":"string","description":"The NVIDIA driver configuration"},"DynamicMount":{"type":"object","description":"The dynamic mount configuration"},"EcsSpec":{"type":"string","description":"The ECS instance type of the instance. For information about how to obtain the ECS instance type, see…"},"EnvironmentVariables":{"type":"object","description":"The environment variables injected into the DSW instance. The environment variables passed here may override the system preset environment…"},"ImageAuth":{"type":"string","description":"The value after Base64 encoding of the account and password information for user private images. The password part is hidden"},"ImageId":{"type":"string","description":"The image ID. For information about how to obtain the image ID, see https://help.aliyun.com/document_detail/449118.html"},"ImageUrl":{"type":"string","description":"The image URL. For information about how to obtain the image URL, see https://help.aliyun.com/document_detail/449118.html"},"InstanceName":{"type":"string","description":"The instance name. Format requirements: The name can contain only letters, digits, and underscores (_). The name cannot exceed 27…"},"Labels":{"type":"array","description":"The custom labels"},"MigrationOptions":{"type":"object","description":"The instance migration options. This parameter is supported only for Lingjun instances with persistent storage enabled. Supported options:…"},"OversoldType":{"type":"string","description":"The type of off-peak resources. Valid values: ForceQuotaOverSold: Uses only off-peak resources. AcceptQuotaOverSold: Accepts off-peak…"},"Priority":{"type":"integer","description":"The priority. When allocating resources to instances, instances with a higher priority are allocated first. Valid values: 1 to 9. 1: The…"},"RequestedResource":{"type":"object","description":"The resource configuration"},"ResourceId":{"type":"string","description":"The resource group ID. Configure this parameter for subscription resources. For information about how to create a dedicated resource…"},"SpotSpec":{"type":"object","description":"The spot instance configuration"},"Tag":{"type":"array","description":"The list of tags"},"UserCommand":{"type":"object","description":"The custom execution command"},"UserId":{"type":"string","description":"The account ID of the instance owner. Alibaba Cloud accounts and Resource Access Management (RAM) users are supported"},"UserMetricsEndpoints":{"type":"array","description":"The UserMetricsEndpoints"},"UserVpc":{"type":"object","description":"The user VPC configuration"},"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"},"WorkspaceSource":{"type":"string","description":"The storage corresponding to the working directory. You can mount cloud disks or datasets in Datasets to the /mnt/workspace working…"}}}}}},"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-dsw/create-instance-shutdown-timer":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_instance_shutdown_timer","summary":"Creates a scheduled stop task for an instance","description":"POST /api/v2/instances/{InstanceId}/shutdowntimer","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance ID"},"DueTime":{"type":"string","description":"The scheduled stop time"},"RemainingTimeInMs":{"type":"integer","description":"The time duration before the instance is stopped. Unit: milliseconds"}}}}}},"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-dsw/create-instance-snapshot":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_instance_snapshot","summary":"Creates an instance snapshot","description":"POST /api/v2/instances/{InstanceId}/snapshots","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","ImageUrl","SnapshotName"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html"},"ExcludePaths":{"type":"array","description":"The list of excluded file paths. This parameter is supported only for Elastic Container Instance (ECI) instances and is used to ignore…"},"ImageUrl":{"type":"string","description":"The image URL. For information about how to obtain the image URL, see https://help.aliyun.com/document_detail/449118.html"},"Labels":{"type":"array","description":"The custom labels"},"Overwrite":{"type":"string","description":"Specifies whether to overwrite an existing image tag in the image repository"},"SnapshotDescription":{"type":"string","description":"The instance snapshot description"},"SnapshotName":{"type":"string","description":"The instance snapshot name. Only lowercase letters, digits, and hyphens (-) are supported. This name is used for the custom image name…"}}}}}},"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-dsw/create-sanity-check-task":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_sanity_check_task","summary":"Submits an asynchronous health check task for a specified Data Science Workshop (DSW) instance. You must…","description":"POST /api/v2/sanitychecks/{CheckType}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CheckType","InstanceId"],"properties":{"CheckType":{"type":"string","description":"The type of the check item. Valid values: SSH: triggers a health check for the SSH connectivity of the instance. CustomService: triggers a…"},"CheckArgs":{"type":"object","description":"The additional parameters required for the health check. Example: \"ServiceName\": \"The service name of the custom service to check\""},"InstanceId":{"type":"string","description":"The instance ID. For more information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/2411819.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-dsw/create-temp-file":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_temp_file","summary":"Creates a temporary file","description":"POST /api/v2/tempfiles","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Capacity":{"type":"integer","description":"The file upload capacity"},"InstanceId":{"type":"string","description":"The ID of the DSW instance"},"Name":{"type":"string","description":"The name of the temporary file"},"Prefix":{"type":"string","description":"The file prefix"},"TaskId":{"type":"string","description":"The ID of the task to which the file 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-dsw/create-temp-file-task":{"post":{"operationId":"cloud_aliyun_pai_dsw_create_temp_file_task","summary":"Creates a temporary file task","description":"POST /api/v2/tempfiletasks","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"InstanceId":{"type":"string","description":"The instance 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-dsw/delete-idle-instance-culler":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_idle_instance_culler","summary":"Deletes the idle shutdown policy for an instance","description":"DELETE /api/v2/instances/{InstanceId}/idleinstanceculler","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.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-dsw/delete-instance":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_instance","summary":"Deletes a specific instance","description":"DELETE /api/v2/instances/{InstanceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance 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-dsw/delete-instance-labels":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_instance_labels","summary":"Delete tags from a Data Science Workshop (DSW) instance","description":"DELETE /api/v2/instances/{InstanceId}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","LabelKeys"],"properties":{"InstanceId":{"type":"string","description":"The ID of the DSW instance"},"LabelKeys":{"type":"string","description":"The keys of the tags that you want to delete. Separate multiple tags with commas (,)"}}}}}},"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-dsw/delete-instance-shutdown-timer":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_instance_shutdown_timer","summary":"Deletes a scheduled stop task of an instance","description":"DELETE /api/v2/instances/{InstanceId}/shutdowntimer","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance 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-dsw/delete-instance-snapshot":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_instance_snapshot","summary":"Deletes an instance snapshot","description":"DELETE /api/v2/instances/{InstanceId}/snapshots/{SnapshotId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","SnapshotId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the instance. For more information, see https://help.aliyun.com/document_detail/470439.html"},"SnapshotId":{"type":"string","description":"The ID of the instance snapshot. For more information, see https://help.aliyun.com/document_detail/470434.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-dsw/delete-instances":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_instances","summary":"Deletes multiple instances","description":"PUT /api/v2/batch/instances/delete","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"InstanceIds":{"type":"array","description":"The list of instance IDs to be deleted"}}}}}},"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-dsw/delete-temp-file":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_temp_file","summary":"Deletes a temporary file","description":"DELETE /api/v2/tempfiles/{TempFileId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TempFileId"],"properties":{"TempFileId":{"type":"string","description":"The ID of the temporary file"}}}}}},"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-dsw/delete-temp-file-task":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_temp_file_task","summary":"Deletes a temporary file task","description":"DELETE /api/v2/tempfiletasks/{TempFileTaskId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TempFileTaskId"],"properties":{"TempFileTaskId":{"type":"string","description":"The ID of the temporary file task"}}}}}},"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-dsw/delete-temp-file-tasks":{"post":{"operationId":"cloud_aliyun_pai_dsw_delete_temp_file_tasks","summary":"Deletes one or more temporary file tasks","description":"PUT /api/v2/batch/tempfiletasks/delete","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"TempFileTaskIds":{"type":"array","description":"The IDs of the temporary file tasks"}}}}}},"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-dsw/get-idle-instance-culler":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_idle_instance_culler","summary":"Queries the information about an auto stop policy for a specific idle instance","description":"GET /api/v2/instances/{InstanceId}/idleinstanceculler","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance ID","schema":{"type":"string","description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dsw/get-instance":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_instance","summary":"Queries the details of a DSW instance","description":"GET /api/v2/instances/{InstanceId}","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html","schema":{"type":"string","description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html"}},{"name":"Token","in":"query","required":false,"description":"The sharing token information","schema":{"type":"string","description":"The sharing token information"},"example":"WUzWCMr325LV0bH2JH4C4HoDaKIU6C4S"},{"name":"Fields","in":"query","required":false,"description":"The fields to return. If you specify this parameter, only the specified fields are returned. Separate multiple fields with commas","schema":{"type":"string","description":"The fields to return. If you specify this parameter, only the specified fields are returned. Separate multiple fields with commas"},"example":"Name,Status,Priority"}],"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-dsw/get-instance-events":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_instance_events","summary":"Retrieves the system events of a DSW instance","description":"GET /api/v2/instances/{InstanceId}/events","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"}},{"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":"2000"},{"name":"StartTime","in":"query","required":false,"description":"The start time of the query","schema":{"type":"string","description":"The start time of the query"},"example":"2020-11-08T15:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query","schema":{"type":"string","description":"The end time of the query"},"example":"2020-11-08T15:00:00Z"},{"name":"Token","in":"query","required":false,"description":"The token used to share the URL","schema":{"type":"string","description":"The token used to share the URL"},"example":"eyJhbGci......"},{"name":"EventLevel","in":"query","required":false,"description":"The event level. Valid values: Warning: Warning event. Normal: Normal event","schema":{"type":"string","description":"The event level. Valid values: Warning: Warning event. Normal: Normal event"},"example":"Warning,\nNormal"},{"name":"Offset","in":"query","required":false,"description":"The pagination offset. Default value: 0","schema":{"type":"integer","description":"The pagination offset. Default value: 0"},"example":"1000"},{"name":"Reverse","in":"query","required":false,"description":"Specifies whether to sort the results in descending order. Default value: false","schema":{"type":"string","description":"Specifies whether to sort the results in descending order. Default value: false"},"example":"false"}],"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-dsw/get-instance-metrics":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_instance_metrics","summary":"Queries the resource metrics of an instance","description":"GET /api/v2/instance/{InstanceId}/metrics","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance ID","schema":{"type":"string","description":"The instance ID. You can call https://help.aliyun.com/document_detail/470439.html to obtain the instance ID"}},{"name":"MetricType","in":"query","required":true,"description":"The metric type. Valid values: GpuCoreUsage: the GPU utilization. GpuMemoryUsage: the GPU memory utilization. CpuCoreUsage: the CPU…","schema":{"type":"string","description":"The metric type. Valid values: GpuCoreUsage: the GPU utilization. GpuMemoryUsage: the GPU memory utilization. CpuCoreUsage: the CPU…"},"example":"GpuCoreUsage"},{"name":"StartTime","in":"query","required":false,"description":"The beginning of the time range to query","schema":{"type":"string","description":"The beginning of the time range to query"},"example":"2020-11-08T15:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end of the time range to query","schema":{"type":"string","description":"The end of the time range to query"},"example":"2020-11-08T15:00:00Z"},{"name":"TimeStep","in":"query","required":false,"description":"The interval at which metrics are returned. Unit: minutes","schema":{"type":"string","description":"The interval at which metrics are returned. Unit: minutes"},"example":"15m"}],"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-dsw/get-instance-shutdown-timer":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_instance_shutdown_timer","summary":"Retrieves the details of a scheduled shutdown task for an instance","description":"GET /api/v2/instances/{InstanceId}/shutdowntimer","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The ID of the instance. For more information, see https://help.aliyun.com/document_detail/470439.html","schema":{"type":"string","description":"The ID of the instance. For more information, see https://help.aliyun.com/document_detail/470439.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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dsw/get-instance-snapshot":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_instance_snapshot","summary":"Retrieves the snapshot of a user instance","description":"GET /api/v2/instances/{InstanceId}/snapshots/{SnapshotId}","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html","schema":{"type":"string","description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html"}},{"name":"SnapshotId","in":"query","required":true,"description":"The instance snapshot ID. For information about how to obtain the instance snapshot ID, see…","schema":{"type":"string","description":"The instance snapshot ID. For information about how to obtain the instance snapshot ID, see…"}}],"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-dsw/get-lifecycle":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_lifecycle","summary":"Retrieves the lifecycle of an instance","description":"GET /api/v2/instances/{InstanceId}/lifecycle","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. For more information about how to obtain an instance ID, see https://help.aliyun.com/document_detail/470439.html","schema":{"type":"string","description":"The instance ID. For more information about how to obtain an instance ID, see https://help.aliyun.com/document_detail/470439.html"}},{"name":"SessionNumber","in":"query","required":false,"description":"A session is the period from when an instance is started until it fails or is stopped. sessionNumber specifies the ordinal number offset…","schema":{"type":"integer","description":"A session is the period from when an instance is started until it fails or is stopped. sessionNumber specifies the ordinal number offset…"},"example":"1"},{"name":"StartTime","in":"query","required":false,"description":"The start time of the query","schema":{"type":"string","description":"The start time of the query"},"example":"2020-11-08T15:00:00Z"},{"name":"EndTime","in":"query","required":false,"description":"The end time of the query","schema":{"type":"string","description":"The end time of the query"},"example":"2020-11-08T15:00:00Z"},{"name":"Limit","in":"query","required":false,"description":"The maximum number of sessions to return in the query","schema":{"type":"integer","description":"The maximum number of sessions to return in the query"},"example":"1"},{"name":"Order","in":"query","required":false,"description":"The order in which to sort the results. Valid values: ASC: ascending order by time. DESC: descending order by time","schema":{"type":"string","description":"The order in which to sort the results. Valid values: ASC: ascending order by time. DESC: descending order by time"},"example":"DESC"},{"name":"Token","in":"query","required":false,"description":"A token used for sharing URLs","schema":{"type":"string","description":"A token used for sharing URLs"}}],"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-dsw/get-metrics":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_metrics","summary":"Retrieves the metrics of an instance","description":"GET /api/v2/instance/{InstanceId}/cms/metrics","tags":["cloud"],"parameters":[{"name":"Namespace","in":"query","required":false,"description":"The namespace in CloudMonitor where the metrics are stored","schema":{"type":"string","description":"The namespace in CloudMonitor where the metrics are stored"},"example":"acs_pai_dsw"},{"name":"InstanceId","in":"query","required":true,"description":"The ID of the DSW instance","schema":{"type":"string","description":"The ID of the DSW instance"}},{"name":"Dimensions","in":"query","required":false,"description":"The request parameters","schema":{"type":"string","description":"The request parameters"},"example":"{\"userId\":\"16122852825*****\",\"jobId\":\"dsw-328d2bbf605*****\",\"regionId\":\"cn-wulanchabu\",\"pod\":\"dsw-45680-76766f8778-95gxh\"}"},{"name":"Length","in":"query","required":false,"description":"The maximum number of entries to return per page. The value cannot exceed 1440","schema":{"type":"string","description":"The maximum number of entries to return per page. The value cannot exceed 1440"},"example":"10"},{"name":"EndTime","in":"query","required":false,"description":"The end time. Default value: the current time","schema":{"type":"string","description":"The end time. Default value: the current time"},"example":"2020-11-08T16:00:00Z"},{"name":"Period","in":"query","required":false,"description":"The time interval","schema":{"type":"string","description":"The time interval"},"example":"60"},{"name":"NextToken","in":"query","required":false,"description":"The pagination token","schema":{"type":"string","description":"The pagination token"},"example":"15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****"},{"name":"MetricName","in":"query","required":false,"description":"Required. The name of the monitoring metrics. For more information, see Metric names…","schema":{"type":"string","description":"Required. The name of the monitoring metrics. For more information, see Metric names…"},"example":"INSTANCE_SPEC_MEMORY_SWAP"},{"name":"StartTime","in":"query","required":false,"description":"The start time. Default value: 1 hour ago","schema":{"type":"string","description":"The start time. Default value: 1 hour ago"},"example":"2020-11-08T15:00:00Z"},{"name":"Token","in":"query","required":false,"description":"The token issued by the GetToken operation to access the monitoring data of the corresponding instance","schema":{"type":"string","description":"The token issued by the GetToken operation to access the monitoring data of the corresponding instance"},"example":"eyJhbxxxxxx......"}],"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-dsw/get-resource-group-statistics":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_resource_group_statistics","summary":"A resource group provides a set of dedicated machine resources for Platform for AI (PAI). These resources…","description":"GET /api/v2/resourcegroupstatistics","tags":["cloud"],"parameters":[{"name":"WorkspaceIds","in":"query","required":true,"description":"The IDs of workspaces. Separate multiple IDs with a comma (,). For more information about how to obtain a workspace ID, see…","schema":{"type":"string","description":"The IDs of workspaces. Separate multiple IDs with a comma (,). For more information about how to obtain a workspace ID, see…"},"example":"27218,34956"},{"name":"ResourceId","in":"query","required":true,"description":"The ID of the resource group (machine group)","schema":{"type":"string","description":"The ID of the resource group (machine group)"},"example":"rg-123456789"},{"name":"StartTime","in":"query","required":true,"description":"The start of the time range for the statistics","schema":{"type":"string","description":"The start of the time range for the statistics"},"example":"2020-11-08T15:00:00Z"},{"name":"EndTime","in":"query","required":true,"description":"The end of the time range for the statistics","schema":{"type":"string","description":"The end of the time range for the statistics"},"example":"2020-11-08T15: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-dsw/get-sanity-check-task":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_sanity_check_task","summary":"Queries the status and results of a health check task. You can provide the task ID and check type to…","description":"GET /api/v2/sanitychecks/{CheckType}/{TaskId}","tags":["cloud"],"parameters":[{"name":"CheckType","in":"query","required":true,"description":"The type of check item. Valid values: SSH: Triggers an SSH health check for the instance","schema":{"type":"string","description":"The type of check item. Valid values: SSH: Triggers an SSH health check for the instance"}},{"name":"TaskId","in":"query","required":true,"description":"The ID of the health check task","schema":{"type":"string","description":"The ID of the health check task"}},{"name":"Verbose","in":"query","required":false,"description":"Specifies whether to return the details of the health check","schema":{"type":"string","description":"Specifies whether to return the details of the health check"},"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-dsw/get-temp-file":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_temp_file","summary":"Gets the details of a temporary file","description":"GET /api/v2/tempfiles/{TempFileId}","tags":["cloud"],"parameters":[{"name":"TempFileId","in":"query","required":true,"description":"The temporary file ID","schema":{"type":"string","description":"The temporary file 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dsw/get-temp-file-task":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_temp_file_task","summary":"Retrieves the details of a temporary file task","description":"GET /api/v2/tempfiletasks/{TempFileTaskId}","tags":["cloud"],"parameters":[{"name":"TempFileTaskId","in":"query","required":true,"description":"The temporary file task ID","schema":{"type":"string","description":"The temporary file task 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dsw/get-token":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_token","summary":"Retrieves the temporary authentication information for a specified DSW instance","description":"GET /api/v2/tokens","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html","schema":{"type":"string","description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html"},"example":"dsw-730xxxxxxxxxx"},{"name":"ExpireTime","in":"query","required":false,"description":"The expiration time, in seconds","schema":{"type":"integer","description":"The expiration time, in seconds"},"example":"60"},{"name":"Type","in":"query","required":false,"description":"The type of the issued token. Valid values: Access: used to access the DSW instance and perform operations. This type grants operation…","schema":{"type":"string","enum":["Access","View"],"description":"The type of the issued token. Valid values: Access: used to access the DSW instance and perform operations. This type grants operation…"},"example":"Access"},{"name":"Audience","in":"query","required":false,"description":"The intended holder (consumer) of the token. If you access the DSW page through a self-built web application, set Audience to ThirdParty","schema":{"type":"string","enum":["Aliyun","ThirdParty"],"description":"The intended holder (consumer) of the token. If you access the DSW page through a self-built web application, set Audience to ThirdParty"},"example":"Aliyun"}],"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-dsw/get-user-command":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_user_command","summary":"Retrieves a user-defined command","description":"GET /api/v2/usercommands/{UserCommandId}","tags":["cloud"],"parameters":[{"name":"UserCommandId","in":"query","required":true,"description":"The ID of the user-defined command. You can get this ID by calling API operations such as GetInstance","schema":{"type":"string","description":"The ID of the user-defined command. You can get this ID by calling API operations such as GetInstance"}},{"name":"InstanceId","in":"query","required":false,"description":"The ID of the Data Science Workshop (DSW) instance. Specify this parameter to find the user command that is attached to the instance. This…","schema":{"type":"string","description":"The ID of the Data Science Workshop (DSW) instance. Specify this parameter to find the user command that is attached to the instance. This…"},"example":"dsw-dlsd0fskn193213xxx"},{"name":"Token","in":"query","required":false,"description":"The token used to access the user command. The token is issued by the GetToken API operation","schema":{"type":"string","description":"The token used to access the user command. The token is issued by the GetToken API operation"},"example":"eyJhbGci......"}],"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-dsw/get-user-config":{"get":{"operationId":"cloud_aliyun_pai_dsw_get_user_config","summary":"You can call GetUserConfig to query user information","description":"GET /api/v2/userconfig","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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-pai-dsw/list-ecs-specs":{"get":{"operationId":"cloud_aliyun_pai_dsw_list_ecs_specs","summary":"Retrieves a list of ECS instance types","description":"GET /api/v2/ecsspecs","tags":["cloud"],"parameters":[{"name":"AcceleratorType","in":"query","required":true,"description":"The accelerator type. Valid values: CPU: No computing acceleration. Only CPUs are used for computing. GPU: Uses GPUs for computing…","schema":{"type":"string","description":"The accelerator type. Valid values: CPU: No computing acceleration. Only CPUs are used for computing. GPU: Uses GPUs for computing…"},"example":"CPU"},{"name":"PageNumber","in":"query","required":false,"description":"The page number of the ECS instance type list. Pages start from 1. Default value: 1","schema":{"type":"integer","description":"The page number of the ECS instance type list. Pages start from 1. Default value: 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The number of ECS instance types to return on each page in a paged query","schema":{"type":"integer","description":"The number of ECS instance types to return on each page in a paged query"},"example":"10"},{"name":"SortBy","in":"query","required":false,"description":"[Deprecated] This field is deprecated. Do not use it","schema":{"type":"string","description":"[Deprecated] This field is deprecated. Do not use it"},"example":"gmtCreate"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: ASC: Ascending order. DESC: Descending order","schema":{"type":"string","description":"The sort order. Valid values: ASC: Ascending order. DESC: Descending order"},"example":"DESC"},{"name":"ResourceType","in":"query","required":false,"description":"The instance resource type","schema":{"type":"string","description":"The instance resource type"},"example":"Lingjun"}],"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-dsw/list-instance-snapshot":{"get":{"operationId":"cloud_aliyun_pai_dsw_list_instance_snapshot","summary":"Queries the list of instance snapshots","description":"GET /api/v2/instances/{InstanceId}/snapshots","tags":["cloud"],"parameters":[{"name":"InstanceId","in":"query","required":true,"description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html","schema":{"type":"string","description":"The instance ID. For information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html"}},{"name":"PageNumber","in":"query","required":false,"description":"The page number of the instance snapshot list. Pages start from 1. Default value: 1","schema":{"type":"integer","description":"The page number of the instance snapshot list. Pages start from 1. Default value: 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The paging settings for the number of instance snapshots to return on each page in a paged query. Default value: 10","schema":{"type":"integer","description":"The paging settings for the number of instance snapshots to return on each page in a paged query. Default value: 10"},"example":"10"},{"name":"SortBy","in":"query","required":false,"description":"The field used to sort the results. Set the value to gmtCreae","schema":{"type":"string","description":"The field used to sort the results. Set the value to gmtCreae"},"example":"gmtCreate"},{"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-dsw/list-instance-statistics":{"get":{"operationId":"cloud_aliyun_pai_dsw_list_instance_statistics","summary":"Retrieves statistics information for instances","description":"GET /api/v2/instancestatistics","tags":["cloud"],"parameters":[{"name":"WorkspaceIds","in":"query","required":true,"description":"The IDs of the workspaces. Separate multiple IDs with commas (,). For more information, see…","schema":{"type":"string","description":"The IDs of the workspaces. Separate multiple IDs with commas (,). For more information, see…"},"example":"27218,34956"}],"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-dsw/list-instances":{"get":{"operationId":"cloud_aliyun_pai_dsw_list_instances","summary":"Queries a list of DSW instances","description":"GET /api/v2/instances","tags":["cloud"],"parameters":[{"name":"WorkspaceId","in":"query","required":false,"description":"Filters instances by workspace ID. For information about how to obtain the workspace ID, see…","schema":{"type":"string","description":"Filters instances by workspace ID. For information about how to obtain the workspace ID, see…"},"example":"40823"},{"name":"InstanceName","in":"query","required":false,"description":"The name of the instance. If you specify this parameter, the system searches for instances whose names match the input value. The search…","schema":{"type":"string","description":"The name of the instance. If you specify this parameter, the system searches for instances whose names match the input value. The search…"},"example":"training_data"},{"name":"ResourceId","in":"query","required":false,"description":"Filters instances by resource quota ID. For information about how to obtain the resource quota ID, see ListQuotas…","schema":{"type":"string","description":"Filters instances by resource quota ID. For information about how to obtain the resource quota ID, see ListQuotas…"},"example":"ALL"},{"name":"Status","in":"query","required":false,"description":"Filters instances by instance status. The default value is empty. In this case, instances of all statuses are queried","schema":{"type":"string","description":"Filters instances by instance status. The default value is empty. In this case, instances of all statuses are queried"},"example":"Running"},{"name":"PaymentType","in":"query","required":false,"description":"Filters instances by billing method. If this parameter is left empty, instances of all billing methods are queried","schema":{"type":"string","description":"Filters instances by billing method. If this parameter is left empty, instances of all billing methods are queried"},"example":"PayAsYouGo"},{"name":"Accessibility","in":"query","required":false,"description":"Filters instances by workspace visibility. If this parameter is left empty, instances with all visibility settings are queried. Valid…","schema":{"type":"string","description":"Filters instances by workspace visibility. If this parameter is left empty, instances with all visibility settings are queried. Valid…"},"example":"PRIVATE"},{"name":"AcceleratorType","in":"query","required":false,"description":"Filters instances by accelerator type. If this parameter is left empty, instances of all accelerator types are queried. Valid values: CPU:…","schema":{"type":"string","description":"Filters instances by accelerator type. If this parameter is left empty, instances of all accelerator types are queried. Valid values: CPU:…"},"example":"CPU"},{"name":"PageNumber","in":"query","required":false,"description":"The page number for the paged query of instances. The paging starts from 1. Default value: 1","schema":{"type":"integer","description":"The page number for the paged query of instances. The paging starts from 1. Default value: 1"},"example":"1"},{"name":"PageSize","in":"query","required":false,"description":"The paging size for a paged query specifies the number of instances to return per page. Default value: 10","schema":{"type":"integer","description":"The paging size for a paged query specifies the number of instances to return per page. Default value: 10"},"example":"10"},{"name":"SortBy","in":"query","required":false,"description":"The field by which to sort the instances","schema":{"type":"string","description":"The field by which to sort the instances"},"example":"GmtCreateTime"},{"name":"Order","in":"query","required":false,"description":"The sort order. Valid values: DESC and ASC. Default value: DESC","schema":{"type":"string","description":"The sort order. Valid values: DESC and ASC. Default value: DESC"},"example":"DESC"},{"name":"InstanceId","in":"query","required":false,"description":"Filters instances by instance ID. For information about how to obtain the instance ID, see…","schema":{"type":"string","description":"Filters instances by instance ID. For information about how to obtain the instance ID, see…"},"example":"dsw-730xxxxxxxxxx"},{"name":"Labels","in":"query","required":false,"description":"Filters instances by label. You can specify up to 4 labels. If multiple labels are specified, they are combined by using the AND operator…","schema":{"type":"string","description":"Filters instances by label. You can specify up to 4 labels. If multiple labels are specified, they are combined by using the AND operator…"},"example":"{\n  \"key1\": \"value1\",\n  \"key2\": \"value2\",\n  \"key3\": \"value3\"\n}"},{"name":"CreateUserId","in":"query","required":false,"description":"Filters instances by the user ID of the creator","schema":{"type":"string","description":"Filters instances by the user ID of the creator"},"example":"12345*****67890"},{"name":"GpuType","in":"query","required":false,"description":"Filters instances by GPU model","schema":{"type":"string","description":"Filters instances by GPU model"},"example":"NVIDIA A10"},{"name":"MinCpu","in":"query","required":false,"description":"The minimum number of CPUs. Unit: 0.001 CPU. 1000 indicates 1 CPU. If you specify this parameter, instances with a CPU count greater than…","schema":{"type":"string","description":"The minimum number of CPUs. Unit: 0.001 CPU. 1000 indicates 1 CPU. If you specify this parameter, instances with a CPU count greater than…"},"example":"2000"},{"name":"MaxCpu","in":"query","required":false,"description":"The maximum number of CPUs. Unit: 0.001 CPU. 1000 indicates 1 CPU. If you specify this parameter, instances with a CPU count less than the…","schema":{"type":"string","description":"The maximum number of CPUs. Unit: 0.001 CPU. 1000 indicates 1 CPU. If you specify this parameter, instances with a CPU count less than the…"},"example":"30000"},{"name":"MinGpu","in":"query","required":false,"description":"The minimum number of GPUs. Unit: 0.001 GPU. 1000 indicates 1 GPU. If you specify this parameter, instances with a GPU count greater than…","schema":{"type":"string","description":"The minimum number of GPUs. Unit: 0.001 GPU. 1000 indicates 1 GPU. If you specify this parameter, instances with a GPU count greater than…"},"example":"100"},{"name":"MaxGpu","in":"query","required":false,"description":"The maximum number of GPUs. Unit: 0.001 GPU. 1000 indicates 1 GPU. If you specify this parameter, instances with a GPU count less than the…","schema":{"type":"string","description":"The maximum number of GPUs. Unit: 0.001 GPU. 1000 indicates 1 GPU. If you specify this parameter, instances with a GPU count less than the…"},"example":"8000"},{"name":"MinMemory","in":"query","required":false,"description":"The minimum memory size. Unit: GB. If you specify this parameter, instances with a memory size greater than the input value are returned","schema":{"type":"string","description":"The minimum memory size. Unit: GB. If you specify this parameter, instances with a memory size greater than the input value are returned"},"example":"4"},{"name":"MaxMemory","in":"query","required":false,"description":"The maximum memory size. Unit: GB. If you specify this parameter, instances with a memory size less than the input value are returned","schema":{"type":"string","description":"The maximum memory size. Unit: GB. If you specify this parameter, instances with a memory size less than the input value are returned"},"example":"48"},{"name":"MinGpuMemory","in":"query","required":false,"description":"The minimum GPU memory size per GPU. Unit: GB. If you specify this parameter, instances with a GPU memory size greater than the input…","schema":{"type":"string","description":"The minimum GPU memory size per GPU. Unit: GB. If you specify this parameter, instances with a GPU memory size greater than the input…"},"example":"8"},{"name":"MaxGpuMemory","in":"query","required":false,"description":"The maximum GPU memory size per GPU. Unit: GB. If you specify this parameter, instances with a GPU memory size less than the input value…","schema":{"type":"string","description":"The maximum GPU memory size per GPU. Unit: GB. If you specify this parameter, instances with a GPU memory size less than the input value…"},"example":"16"},{"name":"ImageName","in":"query","required":false,"description":"The name of the image. If you specify this parameter, instances are filtered by the specified image name","schema":{"type":"string","description":"The name of the image. If you specify this parameter, instances are filtered by the specified image name"},"example":"modelscope:1.9.4-pytorch2.0.1tensorflow2.13.0-cpu-py38-ubuntu20.04"},{"name":"Tag","in":"query","required":false,"description":"The list of tags. You can specify up to 4 tags. If multiple tags are specified, they are combined by using the AND operator (JSON-encoded)","schema":{"type":"string","description":"The list of tags. You can specify up to 4 tags. If multiple tags are specified, they are combined by using the AND operator (JSON-encoded)"}},{"name":"OversoldInfo","in":"query","required":false,"description":"The actual off-peak resource type used by the instance. If you specify this parameter, instances are filtered by the actual off-peak…","schema":{"type":"string","description":"The actual off-peak resource type used by the instance. If you specify this parameter, instances are filtered by the actual off-peak…"},"example":"ForceQuotaOverSold"},{"name":"OversoldType","in":"query","required":false,"description":"The off-peak resource type specified by the user. If you specify this parameter, instances are filtered by the off-peak resource type.…","schema":{"type":"string","description":"The off-peak resource type specified by the user. If you specify this parameter, instances are filtered by the off-peak resource type.…"},"example":"AcceptQuotaOverSold"},{"name":"CreateTimeAfter","in":"query","required":false,"description":"Filters instances whose creation time is later than or equal to the specified time","schema":{"type":"string","description":"Filters instances whose creation time is later than or equal to the specified time"},"example":"2024-01-12T14:36:01Z"},{"name":"CreateTimeBefore","in":"query","required":false,"description":"Filters instances whose creation time is earlier than or equal to the specified time","schema":{"type":"string","description":"Filters instances whose creation time is earlier than or equal to the specified time"},"example":"2024-01-12T15:36:01Z"}],"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-dsw/list-temp-files":{"get":{"operationId":"cloud_aliyun_pai_dsw_list_temp_files","summary":"List temporary files","description":"GET /api/v2/tempfiles","tags":["cloud"],"parameters":[{"name":"Name","in":"query","required":false,"description":"The name of the temporary file","schema":{"type":"string","description":"The name of the temporary file"},"example":"filename"},{"name":"Prefix","in":"query","required":false,"description":"Filters the results to include only files whose names start with the specified prefix","schema":{"type":"string","description":"Filters the results to include only files whose names start with the specified prefix"},"example":"somedir/"},{"name":"Delimiter","in":"query","required":false,"description":"A character used to group file names. All file names that share the same string between the prefix and the first occurrence of the…","schema":{"type":"string","description":"A character used to group file names. All file names that share the same string between the prefix and the first occurrence of the…"},"example":"/"},{"name":"InstanceId","in":"query","required":false,"description":"The instance ID","schema":{"type":"string","description":"The instance ID"},"example":"dsw-730xxxxxxxxxx"},{"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"},{"name":"SortBy","in":"query","required":false,"description":"The field to use for sorting","schema":{"type":"string","description":"The field to use for sorting"},"example":"GmtModifiedTime"},{"name":"Order","in":"query","required":false,"description":"The sort order","schema":{"type":"string","description":"The sort 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-dsw/query-auto-shutdown-policies":{"post":{"operationId":"cloud_aliyun_pai_dsw_query_auto_shutdown_policies","summary":"Retrieves the auto shutdown policies for specified running instances","description":"PUT /api/v2/batch/autoshutdownpolicies/query","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"InstanceIds":{"type":"array","description":"The IDs of up to 100 DSW instances within the same workspace. This parameter is required for requests that are not made from a share page"},"Token":{"type":"string","description":"The sharing token"},"InstanceId":{"type":"string","description":"The instance ID for the share page"}}}}}},"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-dsw/start-instance":{"post":{"operationId":"cloud_aliyun_pai_dsw_start_instance","summary":"Starts a DSW instance","description":"PUT /api/v2/instances/{InstanceId}/start","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the instance. For more information, see https://help.aliyun.com/document_detail/470439.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-dsw/stop-instance":{"post":{"operationId":"cloud_aliyun_pai_dsw_stop_instance","summary":"Stops a DSW instance","description":"PUT /api/v2/instances/{InstanceId}/stop","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the instance. For information about how to obtain an instance ID, see https://help.aliyun.com/document_detail/470439.html"},"SaveImage":{"type":"string","description":"Specifies whether to save the environment before the instance is stopped. true: The environment is saved before the instance is stopped.…"}}}}}},"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-dsw/stop-instances":{"post":{"operationId":"cloud_aliyun_pai_dsw_stop_instances","summary":"Stops a batch of instances","description":"PUT /api/v2/batch/instances/stop","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceIds"],"properties":{"InstanceIds":{"type":"array","description":"The list of instance IDs to stop"}}}}}},"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-dsw/update-instance":{"post":{"operationId":"cloud_aliyun_pai_dsw_update_instance","summary":"Updates the attributes of a DSW instance","description":"PUT /api/v2/instances/{InstanceId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The instance ID. For more information about how to obtain the instance ID, see https://help.aliyun.com/document_detail/470439.html"},"Accessibility":{"type":"string","description":"The visibility of the instance"},"Affinity":{"type":"object","description":"The affinity configuration"},"AssignNodeSpec":{"type":"object","description":"The node scheduling configuration"},"CloudDisks":{"type":"array","description":"The list of cloud disks"},"CredentialConfig":{"type":"object","description":"The credential configuration"},"Datasets":{"type":"array","description":"The list of datasets"},"DisassociateAssignNode":{"type":"string","description":"Specifies whether to disable specified node scheduling"},"DisassociateCredential":{"type":"string","description":"Specifies whether to delete the credential injection information"},"DisassociateDatasets":{"type":"string","description":"Specifies whether to delete the associated datasets. Valid values: true: Delete the associated datasets. false: Retain the associated…"},"DisassociateDriver":{"type":"string","description":"Specifies whether to delete the NVIDIA driver configuration"},"DisassociateEnvironmentVariables":{"type":"string","description":"Specifies whether to delete the environment variables passed by the user"},"DisassociateForwardInfos":{"type":"string","description":"Specifies whether to delete the associated port forwarding information"},"DisassociateMigrationOptions":{"type":"string","description":"Specifies whether to delete the migration options"},"DisassociateSpot":{"type":"string","description":"Specifies whether to disable the spot configuration"},"DisassociateUserCommand":{"type":"string","description":"Specifies whether to delete the custom commands specified by the user"},"DisassociateVpc":{"type":"string","description":"Specifies whether to delete the associated user VPC"},"Driver":{"type":"string","description":"The NVIDIA driver configuration"},"DynamicMount":{"type":"object","description":"The dynamic mount configuration"},"EcsSpec":{"type":"string","description":"The ECS instance type of the instance. For more information about how to obtain the ECS instance type, see…"},"EnvironmentVariables":{"type":"object","description":"The environment variables injected into the DSW instance. The environment variables passed here may override the system preset environment…"},"ImageAuth":{"type":"string","description":"The Base64 encoding of the username and password for the user's private image. The password part is hidden"},"ImageId":{"type":"string","description":"The image ID. For more information about how to obtain the image ID, see https://help.aliyun.com/document_detail/449118.html"},"ImageUrl":{"type":"string","description":"The image URL. For more information about how to obtain the image URL, see https://help.aliyun.com/document_detail/449118.html"},"InstanceName":{"type":"string","description":"The instance name. Format requirements: The name can contain only letters, digits, and underscores (_). The name cannot exceed 27…"},"MigrationOptions":{"type":"object","description":"The instance migration options. This parameter is supported only for Lingjun instances with persistent storage enabled. Supported options:…"},"OversoldType":{"type":"string","description":"The type of oversold resources. Valid values: ForceQuotaOverSold: Uses only oversold resources. AcceptQuotaOverSold: Accepts oversold…"},"Priority":{"type":"integer","description":"The priority. When allocating resources to instances, instances with a higher priority are allocated first. Valid values: 1 to 9. 1: The…"},"RequestedResource":{"type":"object","description":"The resource configuration"},"SpotSpec":{"type":"object","description":"The spot instance configuration"},"StartInstance":{"type":"string","description":"The StartInstance"},"UserCommand":{"type":"object","description":"The custom execution command"},"UserId":{"type":"string","description":"The ID of the instance user"},"UserMetricsEndpoints":{"type":"array","description":"The UserMetricsEndpoints"},"UserVpc":{"type":"object","description":"The user VPC configuration"},"WorkspaceSource":{"type":"string","description":"The storage for the working directory. You can mount cloud disks or datasets from Datasets to the /mnt/working directory at the same time.…"}}}}}},"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-dsw/update-instance-labels":{"post":{"operationId":"cloud_aliyun_pai_dsw_update_instance_labels","summary":"Updates the tags of a Data Science Workshop (DSW) instance. If the tags do not exist, the system adds tags","description":"PUT /api/v2/instances/{InstanceId}/labels","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Labels","InstanceId"],"properties":{"Labels":{"type":"array","description":"The tags that you want to update"},"InstanceId":{"type":"string","description":"The ID of the DSW instance"}}}}}},"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-dsw/update-temp-file":{"post":{"operationId":"cloud_aliyun_pai_dsw_update_temp_file","summary":"Updates the properties of a temporary file","description":"PUT /api/v2/tempfiles/{TempFileId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TempFileId"],"properties":{"TempFileId":{"type":"string","description":"The temporary file ID"},"GmtExpiredTime":{"type":"string","description":"The expiration time for the temporary file"},"Status":{"type":"string","description":"The status of the temporary file"}}}}}},"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-dsw/update-temp-file-task":{"post":{"operationId":"cloud_aliyun_pai_dsw_update_temp_file_task","summary":"Updates a temporary file task","description":"PUT /api/v2/tempfiletasks/{TempFileTaskId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TempFileTaskId"],"properties":{"TempFileTaskId":{"type":"string","description":"The ID of the temporary file task"},"GmtExpiredTime":{"type":"string","description":"The expiration time of the temporary file"}}}}}},"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-dsw/version":{"post":{"operationId":"cloud_aliyun_pai_dsw_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"}}}}}}}