@alicloud/emr-serverless-spark20230808 1.4.2 → 1.6.0

package/dist/client.d.ts

@@ -392,6 +392,7 @@ export declare class Task extends $tea.Model {
     tags?: {
         [key: string]: string;
     };
+    timeout?: number;
     /**
      * @remarks
      * This parameter is required.
@@ -955,7 +956,7 @@ export declare class GrantRoleToUsersResponse extends $tea.Model {
 export declare class ListJobRunsRequest extends $tea.Model {
     /**
      * @remarks
-     * The ID of the user who creates a Spark job.
+     * The ID of the user who created the job.
      *
      * @example
      * 1509789347011222
@@ -1046,7 +1047,7 @@ export declare class ListJobRunsRequest extends $tea.Model {
 export declare class ListJobRunsShrinkRequest extends $tea.Model {
     /**
      * @remarks
-     * The ID of the user who creates a Spark job.
+     * The ID of the user who created the job.
      *
      * @example
      * 1509789347011222
@@ -1198,6 +1199,69 @@ export declare class ListJobRunsResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class ListLogContentsRequest extends $tea.Model {
+    fileName?: string;
+    /**
+     * @example
+     * 9999
+     */
+    length?: number;
+    /**
+     * @example
+     * 0
+     */
+    offset?: number;
+    /**
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListLogContentsResponseBody extends $tea.Model {
+    listLogContent?: ListLogContentsResponseBodyListLogContent;
+    /**
+     * @remarks
+     * 请求ID。
+     *
+     * @example
+     * DD6B1B2A-5837-5237-ABE4-FF0C8944****
+     */
+    requestId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListLogContentsResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: ListLogContentsResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ListReleaseVersionsRequest extends $tea.Model {
     /**
      * @remarks
@@ -1214,7 +1278,7 @@ export declare class ListReleaseVersionsRequest extends $tea.Model {
      * Valid values:
      *
      * *   stable
-     * *   beta
+     * *   Beta
      *
      * @example
      * stable
@@ -1222,7 +1286,7 @@ export declare class ListReleaseVersionsRequest extends $tea.Model {
     releaseType?: string;
     /**
      * @remarks
-     * The version of Serverless Spark.
+     * The version of EMR Serverless Spark.
      *
      * @example
      * esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)
@@ -1230,7 +1294,7 @@ export declare class ListReleaseVersionsRequest extends $tea.Model {
     releaseVersion?: string;
     /**
      * @remarks
-     * The status of the version. Valid values:
+     * The status of the version.
      *
      * Valid values:
      *
@@ -1241,6 +1305,14 @@ export declare class ListReleaseVersionsRequest extends $tea.Model {
      * ONLINE
      */
     releaseVersionStatus?: string;
+    /**
+     * @remarks
+     * The workspace ID.
+     *
+     * @example
+     * w-d2d82aa09155****
+     */
+    workspaceId?: string;
     static names(): {
         [key: string]: string;
     };
@@ -1316,6 +1388,19 @@ export declare class ListReleaseVersionsResponse extends $tea.Model {
     });
 }
 export declare class ListSessionClustersRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The session type.
+     *
+     * Valid values:
+     *
+     * *   NOTEBOOK
+     * *   THRIFT
+     * *   SQL
+     *
+     * @example
+     * SQL
+     */
     kind?: string;
     /**
      * @remarks
@@ -1394,7 +1479,7 @@ export declare class ListSessionClustersResponseBody extends $tea.Model {
     requestId?: string;
     /**
      * @remarks
-     * The SQL computes.
+     * The list of sessions.
      */
     sessionClusters?: ListSessionClustersResponseBodySessionClusters[];
     /**
@@ -1781,6 +1866,162 @@ export declare class StartJobRunResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class StartSessionClusterRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The queue name.
+     *
+     * @example
+     * root_queue
+     */
+    queueName?: string;
+    /**
+     * @remarks
+     * The session ID.
+     *
+     * @example
+     * sc-xxxxxxxxxxx
+     */
+    sessionClusterId?: string;
+    /**
+     * @remarks
+     * The region ID.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class StartSessionClusterResponseBody extends $tea.Model {
+    /**
+     * @remarks
+     * The request ID.
+     *
+     * @example
+     * DD6B1B2A-5837-5237-ABE4-FF0C8944****
+     */
+    requestId?: string;
+    /**
+     * @remarks
+     * The workspace ID.
+     *
+     * @example
+     * w-******
+     */
+    sessionClusterId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class StartSessionClusterResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: StartSessionClusterResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class StopSessionClusterRequest extends $tea.Model {
+    /**
+     * @remarks
+     * The queue name.
+     *
+     * @example
+     * root_queue
+     */
+    queueName?: string;
+    /**
+     * @remarks
+     * The session ID.
+     *
+     * @example
+     * sc-xxxxxxxxxxxx
+     */
+    sessionClusterId?: string;
+    /**
+     * @remarks
+     * The region ID.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class StopSessionClusterResponseBody extends $tea.Model {
+    /**
+     * @remarks
+     * The request ID.
+     *
+     * @example
+     * DD6B1B2A-5837-5237-ABE4-FF0C8944****
+     */
+    requestId?: string;
+    /**
+     * @remarks
+     * The workspace ID.
+     *
+     * @example
+     * w-******
+     */
+    sessionClusterId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class StopSessionClusterResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: StopSessionClusterResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class TerminateSqlStatementRequest extends $tea.Model {
     /**
      * @remarks
@@ -2449,6 +2690,39 @@ export declare class ListJobRunsResponseBodyJobRuns extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class ListLogContentsResponseBodyListLogContentContents extends $tea.Model {
+    /**
+     * @example
+     * spark pi is 3.14\\n
+     */
+    lineContent?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListLogContentsResponseBodyListLogContent extends $tea.Model {
+    contents?: ListLogContentsResponseBodyListLogContentContents[];
+    /**
+     * @example
+     * 10
+     */
+    totalLength?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ListReleaseVersionsResponseBodyReleaseVersions extends $tea.Model {
     /**
      * @remarks
@@ -2463,7 +2737,21 @@ export declare class ListReleaseVersionsResponseBodyReleaseVersions extends $tea
      * The CPU architectures.
      */
     cpuArchitectures?: string[];
+    /**
+     * @remarks
+     * The version number.
+     *
+     * @example
+     * esr-2.1 (Spark 3.3.1, Scala 2.12)
+     */
     displayReleaseVersion?: string;
+    /**
+     * @remarks
+     * Indicates whether the Fusion engine is used for acceleration.
+     *
+     * @example
+     * true
+     */
     fusion?: boolean;
     /**
      * @remarks
@@ -2483,7 +2771,7 @@ export declare class ListReleaseVersionsResponseBodyReleaseVersions extends $tea
     iaasType?: string;
     /**
      * @remarks
-     * The version.
+     * The version number.
      *
      * @example
      * esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)
@@ -2588,7 +2876,7 @@ export declare class ListSessionClustersResponseBodySessionClustersAutoStopConfi
     enable?: boolean;
     /**
      * @remarks
-     * The idle timeout period. The SQL Compute is automatically terminated if the idle timeout period is exceeded.
+     * The idle timeout period. The session is automatically terminated when the idle timeout period is exceeded.
      *
      * @example
      * 45
@@ -2634,7 +2922,7 @@ export declare class ListSessionClustersResponseBodySessionClustersStateChangeRe
 export declare class ListSessionClustersResponseBodySessionClusters extends $tea.Model {
     /**
      * @remarks
-     * The SQL Compute configurations, which are equivalent to the configurations of the Spark job.
+     * The session configurations, which are equivalent to the configurations of the Spark job.
      */
     applicationConfigs?: ListSessionClustersResponseBodySessionClustersApplicationConfigs[];
     /**
@@ -2644,17 +2932,48 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
     autoStartConfiguration?: ListSessionClustersResponseBodySessionClustersAutoStartConfiguration;
     /**
      * @remarks
-     * The automatic termination configurations.
+     * The configurations of automatic termination.
      */
     autoStopConfiguration?: ListSessionClustersResponseBodySessionClustersAutoStopConfiguration;
+    /**
+     * @remarks
+     * The version of the Spark engine.
+     */
     displayReleaseVersion?: string;
     domain?: string;
+    /**
+     * @remarks
+     * The ID of the job that is associated with the session.
+     *
+     * @example
+     * TSK-xxxxxxxxx
+     */
     draftId?: string;
+    /**
+     * @remarks
+     * Indicates whether the Fusion engine is used for acceleration.
+     *
+     * @example
+     * false
+     */
     fusion?: boolean;
+    /**
+     * @remarks
+     * The session type.
+     *
+     * Valid values:
+     *
+     * *   NOTEBOOK
+     * *   THRIFT
+     * *   SQL
+     *
+     * @example
+     * SQL
+     */
     kind?: string;
     /**
      * @remarks
-     * The name of the SQL Compute.
+     * The name of the session.
      *
      * @example
      * adhoc_query
@@ -2662,16 +2981,23 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
     name?: string;
     /**
      * @remarks
-     * The name of the queue on which the SQL Compute runs.
+     * The name of the queue that is used to run the session.
      *
      * @example
      * dev_queue
      */
     queueName?: string;
+    /**
+     * @remarks
+     * The version of EMR Serverless Spark.
+     *
+     * @example
+     * esr-2.1
+     */
     releaseVersion?: string;
     /**
      * @remarks
-     * The SQL Compute ID.
+     * The session ID.
      *
      * @example
      * sc-123131
@@ -2679,7 +3005,7 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
     sessionClusterId?: string;
     /**
      * @remarks
-     * The status of the SQL Compute.
+     * The status of the session.
      *
      * @example
      * Running
@@ -2687,7 +3013,7 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
     state?: string;
     /**
      * @remarks
-     * The details of the last status change of the SQL Compute.
+     * The details of the most recent status change of the session.
      */
     stateChangeReason?: ListSessionClustersResponseBodySessionClustersStateChangeReason;
     /**
@@ -2706,6 +3032,13 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
      * test_user
      */
     userName?: string;
+    /**
+     * @remarks
+     * The Spark UI of the session.
+     *
+     * @example
+     * http://spark-ui-xxxx
+     */
     webUI?: string;
     /**
      * @remarks
@@ -3166,7 +3499,7 @@ export default class Client extends OpenApi {
      */
     cancelJobRun(workspaceId: string, jobRunId: string, request: CancelJobRunRequest): Promise<CancelJobRunResponse>;
     /**
-     * 使用session运行SQL
+     * Creates an SQL query task.
      *
      * @param request - CreateSqlStatementRequest
      * @param headers - map
@@ -3177,7 +3510,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<CreateSqlStatementResponse>;
     /**
-     * 使用session运行SQL
+     * Creates an SQL query task.
      *
      * @param request - CreateSqlStatementRequest
      * @returns CreateSqlStatementResponse
@@ -3202,7 +3535,7 @@ export default class Client extends OpenApi {
      */
     getJobRun(workspaceId: string, jobRunId: string, request: GetJobRunRequest): Promise<GetJobRunResponse>;
     /**
-     * 获取Sql Statement状态
+     * Queries the status of an SQL query task.
      *
      * @param request - GetSqlStatementRequest
      * @param headers - map
@@ -3213,7 +3546,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<GetSqlStatementResponse>;
     /**
-     * 获取Sql Statement状态
+     * Queries the status of an SQL query task.
      *
      * @param request - GetSqlStatementRequest
      * @returns GetSqlStatementResponse
@@ -3256,7 +3589,25 @@ export default class Client extends OpenApi {
      */
     listJobRuns(workspaceId: string, request: ListJobRunsRequest): Promise<ListJobRunsResponse>;
     /**
-     * 获取发布版本列表
+     * 获取日志内容
+     *
+     * @param request - ListLogContentsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListLogContentsResponse
+     */
+    listLogContentsWithOptions(workspaceId: string, request: ListLogContentsRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<ListLogContentsResponse>;
+    /**
+     * 获取日志内容
+     *
+     * @param request - ListLogContentsRequest
+     * @returns ListLogContentsResponse
+     */
+    listLogContents(workspaceId: string, request: ListLogContentsRequest): Promise<ListLogContentsResponse>;
+    /**
+     * Queries the list of published versions of E-MapReduce (EMR) Serverless Spark.
      *
      * @param request - ListReleaseVersionsRequest
      * @param headers - map
@@ -3267,14 +3618,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListReleaseVersionsResponse>;
     /**
-     * 获取发布版本列表
+     * Queries the list of published versions of E-MapReduce (EMR) Serverless Spark.
      *
      * @param request - ListReleaseVersionsRequest
      * @returns ListReleaseVersionsResponse
      */
     listReleaseVersions(request: ListReleaseVersionsRequest): Promise<ListReleaseVersionsResponse>;
     /**
-     * 查询run列表
+     * Queries a list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @param headers - map
@@ -3285,7 +3636,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListSessionClustersResponse>;
     /**
-     * 查询run列表
+     * Queries a list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @returns ListSessionClustersResponse
@@ -3346,7 +3697,43 @@ export default class Client extends OpenApi {
      */
     startJobRun(workspaceId: string, request: StartJobRunRequest): Promise<StartJobRunResponse>;
     /**
-     * 终止 session statement
+     * Starts a session.
+     *
+     * @param request - StartSessionClusterRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns StartSessionClusterResponse
+     */
+    startSessionClusterWithOptions(workspaceId: string, request: StartSessionClusterRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<StartSessionClusterResponse>;
+    /**
+     * Starts a session.
+     *
+     * @param request - StartSessionClusterRequest
+     * @returns StartSessionClusterResponse
+     */
+    startSessionCluster(workspaceId: string, request: StartSessionClusterRequest): Promise<StartSessionClusterResponse>;
+    /**
+     * Stops a session.
+     *
+     * @param request - StopSessionClusterRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns StopSessionClusterResponse
+     */
+    stopSessionClusterWithOptions(workspaceId: string, request: StopSessionClusterRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<StopSessionClusterResponse>;
+    /**
+     * Stops a session.
+     *
+     * @param request - StopSessionClusterRequest
+     * @returns StopSessionClusterResponse
+     */
+    stopSessionCluster(workspaceId: string, request: StopSessionClusterRequest): Promise<StopSessionClusterResponse>;
+    /**
+     * Terminates an SQL query task.
      *
      * @param request - TerminateSqlStatementRequest
      * @param headers - map
@@ -3357,7 +3744,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<TerminateSqlStatementResponse>;
     /**
-     * 终止 session statement
+     * Terminates an SQL query task.
      *
      * @param request - TerminateSqlStatementRequest
      * @returns TerminateSqlStatementResponse