@alicloud/emr-serverless-spark20230808 2.0.0 → 2.2.0

package/src/models/ListWorkspacesResponseBody.ts

@@ -13,10 +13,9 @@ export class ListWorkspacesResponseBodyWorkspacesPrePaidQuota extends $dara.Mode
   allocatedResource?: string;
   /**
    * @remarks
-   * Indicates whether auto-renewal is enabled for the resource. Valid values:
-   * 
+   * Specifies whether auto-renewal is enabled for the resource. Valid values:
    * - true: Auto-renewal is enabled. The resource is automatically renewed upon expiration.
-   * - false: Auto-renewal is not enabled. The resource stops being available upon expiration.
+   * - false: Auto-renewal is disabled. The resource is stopped upon expiration.
    * 
    * @example
    * true
@@ -24,7 +23,7 @@ export class ListWorkspacesResponseBodyWorkspacesPrePaidQuota extends $dara.Mode
   autoRenewal?: boolean;
   /**
    * @remarks
-   * The time when the resource quota was created.
+   * The time when the resource quota was created. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1745683200000
@@ -32,7 +31,7 @@ export class ListWorkspacesResponseBodyWorkspacesPrePaidQuota extends $dara.Mode
   createTime?: number;
   /**
    * @remarks
-   * The time when the resource quota expires.
+   * The expiration time of the resource quota. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1740537153000
@@ -48,13 +47,16 @@ export class ListWorkspacesResponseBodyWorkspacesPrePaidQuota extends $dara.Mode
   instanceId?: string;
   /**
    * @remarks
-   * The maximum amount of resources available.
+   * The maximum amount of resources that can be used.
    * 
    * @example
    * {\\"cpu\\":\\"1\\",\\"memory\\":\\"4Gi\\",\\"cu\\":\\"1\\"}
    */
   maxResource?: string;
   /**
+   * @remarks
+   * The order ID.
+   * 
    * @example
    * 23464687565
    */
@@ -62,8 +64,8 @@ export class ListWorkspacesResponseBodyWorkspacesPrePaidQuota extends $dara.Mode
   /**
    * @remarks
    * The payment status of the current resource. Valid values:
-   * - NORMAL: Active.
-   * - WAIT_FOR_EXPIRE: About to expire.
+   * - NORMAL: Valid.
+   * - WAIT_FOR_EXPIRE: Expiring.
    * - EXPIRED: Expired.
    * 
    * @example
@@ -116,49 +118,110 @@ export class ListWorkspacesResponseBodyWorkspacesPrePaidQuota extends $dara.Mode
 }
 
 export class ListWorkspacesResponseBodyWorkspacesPrePaidQuotaGpu extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether auto-renewal is enabled.
+   * 
+   * @example
+   * true
+   */
   autoRenewal?: boolean;
+  /**
+   * @remarks
+   * The number of CPU cores.
+   */
   cpuCoreCount?: string;
   /**
+   * @remarks
+   * The time when the GPU subscription quota was created. The value is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1782292672000
    */
   createTime?: number;
   /**
+   * @remarks
+   * The expiration time of the GPU subscription quota. The value is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1782292772000
    */
   expireTime?: number;
+  /**
+   * @remarks
+   * The number of GPUs.
+   * 
+   * @example
+   * 0
+   */
   gpuAmount?: number;
   /**
+   * @remarks
+   * The number of GPU machines.
+   * 
    * @example
    * 4
    */
   gpuMachineNum?: number;
+  /**
+   * @remarks
+   * The GPU memory size.
+   * 
+   * @example
+   * 0
+   */
   gpuMemorySize?: number;
   /**
+   * @remarks
+   * The number of GPUs.
+   * 
    * @example
    * 8
    */
   gpuNum?: number;
   /**
+   * @remarks
+   * The GPU model.
+   * 
    * @example
    * ecs.gn7i-c8g1.2xlarge
    */
   gpuSpec?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * w-xxxxxxxxx-gpu-quota-xxxx
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The instance family.
+   */
   instanceTypeFamily?: string;
+  /**
+   * @remarks
+   * The instance type ID.
+   */
   instanceTypeId?: string;
+  /**
+   * @remarks
+   * The memory size.
+   */
   memorySize?: string;
   /**
+   * @remarks
+   * The order ID.
+   * 
    * @example
    * 2534863936
    */
   orderId?: string;
   /**
+   * @remarks
+   * The order status.
+   * 
    * @example
    * NORMAL
    */
@@ -253,7 +316,15 @@ export class ListWorkspacesResponseBodyWorkspacesStateChangeReason extends $dara
 }
 
 export class ListWorkspacesResponseBodyWorkspacesTags extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key.
+   */
   tagKey?: string;
+  /**
+   * @remarks
+   * The tag value.
+   */
   tagValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -281,7 +352,7 @@ export class ListWorkspacesResponseBodyWorkspacesTags extends $dara.Model {
 export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether auto-renewal is enabled. This parameter is required for the prepaid type.
+   * Specifies whether to enable auto-renewal. This parameter is required for subscription resources.
    * 
    * @example
    * true
@@ -289,7 +360,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   autoRenew?: boolean;
   /**
    * @remarks
-   * The auto-renewal duration. This parameter is required for the prepaid type.
+   * The auto-renewal duration. This parameter is required for subscription resources.
    * 
    * @example
    * 1
@@ -297,7 +368,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   autoRenewPeriod?: number;
   /**
    * @remarks
-   * The auto-renewal epoch unit. This parameter is required for the prepaid type.
+   * The auto-renewal epoch. This parameter is required for subscription resources.
    * 
    * @example
    * YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
@@ -305,7 +376,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   autoRenewPeriodUnit?: string;
   /**
    * @remarks
-   * The time when the workspace was created.
+   * The time when the workspace was created. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1684115879955
@@ -313,7 +384,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The DLF Catalog information.
+   * The DLF catalog information.
    * 
    * @example
    * default
@@ -321,7 +392,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   dlfCatalogId?: string;
   /**
    * @remarks
-   * The DLF binding type.
+   * The type of the associated DLF.
    * 
    * @example
    * 1.0
@@ -329,7 +400,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   dlfType?: string;
   /**
    * @remarks
-   * The subscription period quantity. This parameter is required for the prepaid type.
+   * The duration of the subscription. This parameter is required for subscription resources.
    * 
    * @example
    * 1
@@ -337,7 +408,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   duration?: number;
   /**
    * @remarks
-   * The time when the workspace was released.
+   * The time when the workspace was released. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1687103999999
@@ -345,17 +416,25 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The failure reason.
+   * The reason for the failure.
    * 
    * @example
    * out of stock
    */
   failReason?: string;
+  /**
+   * @remarks
+   * The list of GPU models.
+   */
   gpuSpec?: string[];
+  /**
+   * @remarks
+   * The IP whitelist of the workspace.
+   */
   ipWhiteList?: string[];
   /**
    * @remarks
-   * The subscription period unit. This parameter is required for the prepaid type.
+   * The unit of the subscription period. This parameter is required for subscription resources.
    * 
    * @example
    * YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
@@ -371,7 +450,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   paymentStatus?: string;
   /**
    * @remarks
-   * The payment type.
+   * The billing method.
    * 
    * @example
    * PayAsYouGo or Subscription
@@ -379,9 +458,13 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   paymentType?: string;
   /**
    * @remarks
-   * The prepaid resource quota information.
+   * The information about the subscription resource quota.
    */
   prePaidQuota?: ListWorkspacesResponseBodyWorkspacesPrePaidQuota;
+  /**
+   * @remarks
+   * The list of GPU subscription quotas.
+   */
   prePaidQuotaGpu?: ListWorkspacesResponseBodyWorkspacesPrePaidQuotaGpu[];
   /**
    * @remarks
@@ -400,6 +483,9 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
    */
   releaseType?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-xxxxxxxxxx
    */
@@ -414,7 +500,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   resourceSpec?: string;
   /**
    * @remarks
-   * The state change information of the workspace.
+   * The information about the workspace status change.
    */
   stateChangeReason?: ListWorkspacesResponseBodyWorkspacesStateChangeReason;
   /**
@@ -425,10 +511,14 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
    * spark-result
    */
   storage?: string;
+  /**
+   * @remarks
+   * The list of workspace tags.
+   */
   tags?: ListWorkspacesResponseBodyWorkspacesTags[];
   /**
    * @remarks
-   * Workspace ID。
+   * The workspace ID.
    * 
    * @example
    * w-******
@@ -436,15 +526,15 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   workspaceId?: string;
   /**
    * @remarks
-   * The workspace name.
+   * The name of the workspace.
    * 
    * @example
-   * Spark batch workspace-1
+   * spark-batch-job-workspace-1
    */
   workspaceName?: string;
   /**
    * @remarks
-   * The workspace status.
+   * The status of the workspace.
    * 
    * @example
    * STARTING,RUNNING,TERMINATED
@@ -542,7 +632,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
 export class ListWorkspacesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The maximum number of records to retrieve in a single request.
+   * The maximum number of records to return in a single request.
    * 
    * @example
    * 20
@@ -550,7 +640,7 @@ export class ListWorkspacesResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token for the next page.
+   * The next token.
    * 
    * @example
    * 1

package/src/models/ListWorkspacesShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListWorkspacesShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The maximum number of records to retrieve in a single request.
+   * The maximum number of records to return in a single request.
    * 
    * @example
    * 20
@@ -13,7 +13,7 @@ export class ListWorkspacesShrinkRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The name of the workspace. Fuzzy match is supported.
+   * The name of the workspace. Fuzzy search by workspace name is supported.
    * 
    * @example
    * test_workspace
@@ -21,7 +21,7 @@ export class ListWorkspacesShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The pagination token that marks the current read position.
+   * The token that indicates the position from which to start reading.
    * 
    * @example
    * 1
@@ -36,18 +36,30 @@ export class ListWorkspacesShrinkRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-aek2thxggoqhmhq
    */
   resourceGroupId?: string;
   /**
    * @remarks
-   * The workspace status.
+   * The state of the workspace. Valid values:
+   * - Starting: The workspace is starting.
+   * - Running: The workspace is running.
+   * - Stopping: The workspace is stopping.
+   * - Stopped: The workspace is stopped.
+   * - Error: The workspace failed.
    * 
    * @example
    * running
    */
   state?: string;
+  /**
+   * @remarks
+   * The list of tags used to filter workspaces.
+   */
   tagShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/SubmitRayJobRequest.ts

@@ -13,7 +13,7 @@ export class SubmitRayJobRequestHeadSpec extends $dara.Model {
   cpu?: string;
   /**
    * @remarks
-   * The Ray DPI engine version.
+   * The Ray DPI engine database engine version.
    * 
    * @example
    * err-1.3.0 (Ray 2.55.1, Python 3.12)
@@ -21,7 +21,7 @@ export class SubmitRayJobRequestHeadSpec extends $dara.Model {
   displayReleaseVersion?: string;
   /**
    * @remarks
-   * Specifies whether to enable automatic scaling for workers.
+   * Specifies whether to enable auto-scaling for worker nodes.
    * 
    * @example
    * true
@@ -37,7 +37,7 @@ export class SubmitRayJobRequestHeadSpec extends $dara.Model {
   gpuSpec?: string;
   /**
    * @remarks
-   * The worker idle timeout period after automatic scaling is enabled.
+   * The idle time for worker nodes after auto-scaling is enabled.
    * 
    * @example
    * 60
@@ -45,7 +45,7 @@ export class SubmitRayJobRequestHeadSpec extends $dara.Model {
   idleTimeoutSeconds?: number;
   /**
    * @remarks
-   * The memory size. Unit: GiB.
+   * The memory size, in Gi.
    * 
    * @example
    * 8Gi
@@ -143,7 +143,7 @@ export class SubmitRayJobRequestWorkerSpec extends $dara.Model {
   cpu?: string;
   /**
    * @remarks
-   * The database engine version.
+   * The DPI engine version.
    * 
    * @example
    * ray-1.2.0 (Ray 2.55.1, Python 3.12)
@@ -167,7 +167,7 @@ export class SubmitRayJobRequestWorkerSpec extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The maximum number of workers after automatic scaling is enabled.
+   * The maximum number of workers when automatic scaling is enabled.
    * 
    * @example
    * 10
@@ -175,7 +175,7 @@ export class SubmitRayJobRequestWorkerSpec extends $dara.Model {
   maxReplica?: number;
   /**
    * @remarks
-   * The memory size. Unit: GiB.
+   * The memory size, in Gi.
    * 
    * @example
    * 16Gi
@@ -183,7 +183,7 @@ export class SubmitRayJobRequestWorkerSpec extends $dara.Model {
   memory?: string;
   /**
    * @remarks
-   * The minimum number of workers after automatic scaling is enabled.
+   * The minimum number of workers when automatic scaling is enabled.
    * 
    * @example
    * 1
@@ -255,7 +255,7 @@ export class SubmitRayJobRequestWorkerSpec extends $dara.Model {
 export class SubmitRayJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The timeout period of the job, which includes the cluster creation time and job runtime. The job is canceled if this period is exceeded.
+   * The job timeout period, which includes the cluster creation and job execution time. The job is canceled if it exceeds this period.
    * 
    * @example
    * 3600
@@ -263,7 +263,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   activeDeadlineSeconds?: number;
   /**
    * @remarks
-   * The ID of an existing Ray cluster to which the job is submitted.
+   * The ID of the existing Ray cluster.
    * 
    * @example
    * ray-xxxxxxxxx
@@ -271,7 +271,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The Ray DPI engine version number.
+   * The Ray DPI engine database engine version number.
    * 
    * @example
    * err-1.2.0 (Ray 2.55.1, Python 3.12)
@@ -279,7 +279,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   displayReleaseVersion?: string;
   /**
    * @remarks
-   * The startup command.
+   * The entrypoint command.
    * 
    * @example
    * python -c "print(\\"hello ray job\\")"
@@ -287,7 +287,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   entrypoint?: string;
   /**
    * @remarks
-   * The memory size requested by the entrypoint task.
+   * The memory size requested by the entrypoint job.
    * 
    * @example
    * 4Gi
@@ -295,7 +295,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   entrypointMemory?: string;
   /**
    * @remarks
-   * The number of CPUs requested by the entrypoint task.
+   * The number of CPUs requested by the entrypoint job.
    * 
    * @example
    * 1
@@ -303,7 +303,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   entrypointNumCpus?: string;
   /**
    * @remarks
-   * The number of GPUs requested by the entrypoint task.
+   * The number of GPUs requested by the entrypoint job.
    * 
    * @example
    * 0
@@ -311,7 +311,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   entrypointNumGpus?: string;
   /**
    * @remarks
-   * The custom resource request JSON string for the entrypoint task.
+   * The custom resource request JSON string for the entrypoint job.
    * 
    * @example
    * {"fpu": 1}
@@ -319,7 +319,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   entrypointResources?: string;
   /**
    * @remarks
-   * The extra parameters in a JSON string.
+   * The JSON string for additional parameters.
    * 
    * @example
    * {"userDefinedFiles": "oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json", "userRequirementsFile": "oss://mybucket/requirements.txt"}
@@ -327,7 +327,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   extraParam?: string;
   /**
    * @remarks
-   * The Ray cluster head node parameters.
+   * The parameters of the Ray cluster head node.
    */
   headSpec?: SubmitRayJobRequestHeadSpec;
   /**
@@ -385,7 +385,7 @@ export class SubmitRayJobRequest extends $dara.Model {
   tags?: SubmitRayJobRequestTags[];
   /**
    * @remarks
-   * The number of seconds to wait before destroying the cluster. This parameter takes effect only when shutdownAfterJobFinishes is set to true.
+   * The wait time in seconds before the cluster is destroyed. This parameter takes effect only when shutdownAfterJobFinishes is set to true.
    * 
    * @example
    * 60
@@ -398,12 +398,12 @@ export class SubmitRayJobRequest extends $dara.Model {
   volumeIds?: string[];
   /**
    * @remarks
-   * The parameters of the worker nodes in the Ray cluster.
+   * The Ray cluster worker node parameters.
    */
   workerSpec?: SubmitRayJobRequestWorkerSpec[];
   /**
    * @remarks
-   * The URL of the job code working directory.
+   * The URL of the working directory for the job code.
    * 
    * @example
    * oss://mybucket/rayjob.zip

package/src/models/SubmitRayJobResponseBody.ts

@@ -13,7 +13,7 @@ export class SubmitRayJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Ray Job ID。
+   * The Ray job ID.
    * 
    * @example
    * rj-k7nm8ahl5te4tg91