@alicloud/emr-serverless-spark20230808 1.5.0 → 1.7.0

package/dist/client.d.ts

@@ -9,12 +9,14 @@ export declare class Artifact extends $tea.Model {
      * This parameter is required.
      */
     bizId?: string;
+    catagoryBizId?: string;
     /**
      * @remarks
      * This parameter is required.
      */
     creator?: number;
     credential?: Credential;
+    fullPath?: string[];
     /**
      * @remarks
      * This parameter is required.
@@ -307,11 +309,13 @@ export declare class Task extends $tea.Model {
      * This parameter is required.
      */
     creator?: number;
+    credential?: TaskCredential;
     defaultCatalogId?: string;
     defaultDatabase?: string;
     defaultResourceQueueId?: string;
     defaultSqlComputeId?: string;
     deploymentId?: string;
+    environmentId?: string;
     extraArtifactIds?: string[];
     extraSparkSubmitParams?: string;
     files?: string[];
@@ -708,7 +712,7 @@ export declare class CreateSqlStatementRequest extends $tea.Model {
     limit?: number;
     /**
      * @remarks
-     * The SQL compute ID. You can create an SQL compute in the workspace created in EMR Serverless Spark.
+     * The SQL session ID. You can create an SQL session in the workspace created in EMR Serverless Spark.
      *
      * @example
      * sc-dfahdfjafhajd****
@@ -831,6 +835,58 @@ export declare class GetJobRunResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class GetSessionClusterRequest extends $tea.Model {
+    /**
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetSessionClusterResponseBody extends $tea.Model {
+    /**
+     * @remarks
+     * 请求ID。
+     *
+     * @example
+     * DD6B1B2A-5837-5237-ABE4-FF0C8944****
+     */
+    requestId?: string;
+    sessionCluster?: GetSessionClusterResponseBodySessionCluster;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetSessionClusterResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: GetSessionClusterResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class GetSqlStatementRequest extends $tea.Model {
     /**
      * @remarks
@@ -893,12 +949,16 @@ export declare class GetSqlStatementResponse extends $tea.Model {
 export declare class GrantRoleToUsersRequest extends $tea.Model {
     /**
      * @remarks
-     * The Alibaba Cloud Resource Name (ARN) of the role.
+     * The Alibaba Cloud Resource Name (ARN) of the RAM role.
      *
      * @example
      * acs:emr::w-975bcfda9625****:role/Owner
      */
     roleArn?: string;
+    /**
+     * @remarks
+     * The user ARNs.
+     */
     userArns?: string[];
     /**
      * @remarks
@@ -1199,6 +1259,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
@@ -1325,6 +1448,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
@@ -1403,7 +1539,7 @@ export declare class ListSessionClustersResponseBody extends $tea.Model {
     requestId?: string;
     /**
      * @remarks
-     * The SQL computes.
+     * The list of sessions.
      */
     sessionClusters?: ListSessionClustersResponseBodySessionClusters[];
     /**
@@ -1792,16 +1928,25 @@ export declare class StartJobRunResponse extends $tea.Model {
 }
 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
      */
@@ -1819,7 +1964,7 @@ export declare class StartSessionClusterRequest extends $tea.Model {
 export declare class StartSessionClusterResponseBody extends $tea.Model {
     /**
      * @remarks
-     * 请求ID。
+     * The request ID.
      *
      * @example
      * DD6B1B2A-5837-5237-ABE4-FF0C8944****
@@ -1827,7 +1972,7 @@ export declare class StartSessionClusterResponseBody extends $tea.Model {
     requestId?: string;
     /**
      * @remarks
-     * Workspace Id。
+     * The workspace ID.
      *
      * @example
      * w-******
@@ -1861,16 +2006,25 @@ export declare class StartSessionClusterResponse extends $tea.Model {
 }
 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
      */
@@ -1888,7 +2042,7 @@ export declare class StopSessionClusterRequest extends $tea.Model {
 export declare class StopSessionClusterResponseBody extends $tea.Model {
     /**
      * @remarks
-     * 请求ID。
+     * The request ID.
      *
      * @example
      * DD6B1B2A-5837-5237-ABE4-FF0C8944****
@@ -1896,7 +2050,7 @@ export declare class StopSessionClusterResponseBody extends $tea.Model {
     requestId?: string;
     /**
      * @remarks
-     * Workspace Id。
+     * The workspace ID.
      *
      * @example
      * w-******
@@ -2052,6 +2206,25 @@ export declare class SqlOutputSchema extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class TaskCredential extends $tea.Model {
+    accessId?: string;
+    accessUrl?: string;
+    expire?: number;
+    host?: string;
+    path?: string;
+    policy?: string;
+    securityToken?: string;
+    signature?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateSqlStatementResponseBodyData extends $tea.Model {
     /**
      * @remarks
@@ -2141,6 +2314,7 @@ export declare class GetJobRunResponseBodyJobRun extends $tea.Model {
      * 1684119314000
      */
     endTime?: number;
+    environmentId?: string;
     /**
      * @remarks
      * The timeout period of the job.
@@ -2252,6 +2426,198 @@ export declare class GetJobRunResponseBodyJobRun extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class GetSessionClusterResponseBodySessionClusterApplicationConfigs extends $tea.Model {
+    /**
+     * @example
+     * spark-defaults.conf
+     */
+    configFileName?: string;
+    /**
+     * @example
+     * spark.app.name
+     */
+    configItemKey?: string;
+    /**
+     * @example
+     * test
+     */
+    configItemValue?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetSessionClusterResponseBodySessionClusterAutoStartConfiguration extends $tea.Model {
+    /**
+     * @example
+     * false
+     */
+    enable?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetSessionClusterResponseBodySessionClusterAutoStopConfiguration extends $tea.Model {
+    /**
+     * @example
+     * false
+     */
+    enable?: boolean;
+    /**
+     * @example
+     * 60
+     */
+    idleTimeoutMinutes?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetSessionClusterResponseBodySessionClusterStateChangeReason extends $tea.Model {
+    /**
+     * @example
+     * 1000000
+     */
+    code?: string;
+    /**
+     * @example
+     * ok
+     */
+    message?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetSessionClusterResponseBodySessionCluster extends $tea.Model {
+    applicationConfigs?: GetSessionClusterResponseBodySessionClusterApplicationConfigs[];
+    autoStartConfiguration?: GetSessionClusterResponseBodySessionClusterAutoStartConfiguration;
+    autoStopConfiguration?: GetSessionClusterResponseBodySessionClusterAutoStopConfiguration;
+    /**
+     * @example
+     * esr-2.2(Java Runtime)
+     */
+    displayReleaseVersion?: string;
+    /**
+     * @example
+     * your.domain.com
+     */
+    domain?: string;
+    domainInner?: string;
+    /**
+     * @example
+     * TSK-xxxxxxxx
+     */
+    draftId?: string;
+    /**
+     * @example
+     * env-cpv569tlhtgndjl86t40
+     */
+    envId?: string;
+    /**
+     * @example
+     * false
+     */
+    fusion?: boolean;
+    gmtCreate?: number;
+    /**
+     * @example
+     * SQL
+     */
+    kind?: string;
+    /**
+     * @example
+     * test
+     */
+    name?: string;
+    /**
+     * @remarks
+     * 作业实例名称。
+     *
+     * @example
+     * jobName
+     */
+    queueName?: string;
+    /**
+     * @example
+     * esr-2.2（Java Runtime）
+     */
+    releaseVersion?: string;
+    /**
+     * @remarks
+     * 交互式作业会话id。
+     *
+     * @example
+     * 1234abcd-12ab-34cd-56ef-1234567890ab
+     */
+    sessionClusterId?: string;
+    startTime?: number;
+    /**
+     * @remarks
+     * 作业状态。
+     *
+     * @example
+     * Running
+     */
+    state?: string;
+    stateChangeReason?: GetSessionClusterResponseBodySessionClusterStateChangeReason;
+    /**
+     * @remarks
+     * 任务实例ID。
+     *
+     * @example
+     * jr-231231
+     */
+    userId?: string;
+    /**
+     * @example
+     * user1
+     */
+    userName?: string;
+    /**
+     * @example
+     * https://spark-ui/link
+     */
+    webUI?: string;
+    /**
+     * @remarks
+     * 工作空间id。
+     *
+     * @example
+     * w-1234abcd
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class GetSqlStatementResponseBodyDataSqlOutputs extends $tea.Model {
     /**
      * @remarks
@@ -2596,6 +2962,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
@@ -2695,7 +3094,7 @@ export declare class ListSessionClustersResponseBodySessionClustersApplicationCo
     configFileName?: string;
     /**
      * @remarks
-     * The key of the configuration item.
+     * The key of the configuration.
      *
      * @example
      * spark.app.name
@@ -2703,7 +3102,7 @@ export declare class ListSessionClustersResponseBodySessionClustersApplicationCo
     configItemKey?: string;
     /**
      * @remarks
-     * The value of the configuration item.
+     * The configuration value.
      *
      * @example
      * test_application
@@ -2749,7 +3148,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
@@ -2795,7 +3194,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[];
     /**
@@ -2805,17 +3204,50 @@ 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;
+    domainInner?: 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;
+    gmtCreate?: number;
+    /**
+     * @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
@@ -2823,24 +3255,32 @@ 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
      */
     sessionClusterId?: string;
+    startTime?: number;
     /**
      * @remarks
-     * The status of the SQL Compute.
+     * The status of the session.
      *
      * @example
      * Running
@@ -2848,7 +3288,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;
     /**
@@ -2861,12 +3301,19 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
     userId?: string;
     /**
      * @remarks
-     * The name of the user.
+     * The username.
      *
      * @example
      * test_user
      */
     userName?: string;
+    /**
+     * @remarks
+     * The Spark UI of the session.
+     *
+     * @example
+     * http://spark-ui-xxxx
+     */
     webUI?: string;
     /**
      * @remarks
@@ -3362,6 +3809,24 @@ export default class Client extends OpenApi {
      * @returns GetJobRunResponse
      */
     getJobRun(workspaceId: string, jobRunId: string, request: GetJobRunRequest): Promise<GetJobRunResponse>;
+    /**
+     * 查询SessionCluster集群
+     *
+     * @param request - GetSessionClusterRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetSessionClusterResponse
+     */
+    getSessionClusterWithOptions(workspaceId: string, sessionClusterId: string, request: GetSessionClusterRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<GetSessionClusterResponse>;
+    /**
+     * 查询SessionCluster集群
+     *
+     * @param request - GetSessionClusterRequest
+     * @returns GetSessionClusterResponse
+     */
+    getSessionCluster(workspaceId: string, sessionClusterId: string, request: GetSessionClusterRequest): Promise<GetSessionClusterResponse>;
     /**
      * Queries the status of an SQL query task.
      *
@@ -3416,6 +3881,24 @@ export default class Client extends OpenApi {
      * @returns ListJobRunsResponse
      */
     listJobRuns(workspaceId: string, request: ListJobRunsRequest): Promise<ListJobRunsResponse>;
+    /**
+     * Obtains the log content.
+     *
+     * @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>;
+    /**
+     * Obtains the log content.
+     *
+     * @param request - ListLogContentsRequest
+     * @returns ListLogContentsResponse
+     */
+    listLogContents(workspaceId: string, request: ListLogContentsRequest): Promise<ListLogContentsResponse>;
     /**
      * Queries the list of published versions of E-MapReduce (EMR) Serverless Spark.
      *
@@ -3435,7 +3918,7 @@ export default class Client extends OpenApi {
      */
     listReleaseVersions(request: ListReleaseVersionsRequest): Promise<ListReleaseVersionsResponse>;
     /**
-     * 查询run列表
+     * Queries the list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @param headers - map
@@ -3446,14 +3929,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListSessionClustersResponse>;
     /**
-     * 查询run列表
+     * Queries the list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @returns ListSessionClustersResponse
      */
     listSessionClusters(workspaceId: string, request: ListSessionClustersRequest): Promise<ListSessionClustersResponse>;
     /**
-     * 查看工作空间队列列表
+     * Queries the list of queues in a Spark workspace.
      *
      * @param request - ListWorkspaceQueuesRequest
      * @param headers - map
@@ -3464,7 +3947,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListWorkspaceQueuesResponse>;
     /**
-     * 查看工作空间队列列表
+     * Queries the list of queues in a Spark workspace.
      *
      * @param request - ListWorkspaceQueuesRequest
      * @returns ListWorkspaceQueuesResponse
@@ -3507,7 +3990,7 @@ export default class Client extends OpenApi {
      */
     startJobRun(workspaceId: string, request: StartJobRunRequest): Promise<StartJobRunResponse>;
     /**
-     * 启动session集群
+     * Starts a session.
      *
      * @param request - StartSessionClusterRequest
      * @param headers - map
@@ -3518,14 +4001,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<StartSessionClusterResponse>;
     /**
-     * 启动session集群
+     * Starts a session.
      *
      * @param request - StartSessionClusterRequest
      * @returns StartSessionClusterResponse
      */
     startSessionCluster(workspaceId: string, request: StartSessionClusterRequest): Promise<StartSessionClusterResponse>;
     /**
-     * 启动session集群
+     * Stops a session.
      *
      * @param request - StopSessionClusterRequest
      * @param headers - map
@@ -3536,7 +4019,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<StopSessionClusterResponse>;
     /**
-     * 启动session集群
+     * Stops a session.
      *
      * @param request - StopSessionClusterRequest
      * @returns StopSessionClusterResponse