@alicloud/emr-serverless-spark20230808 1.6.0 → 1.8.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
@@ -890,15 +946,96 @@ export declare class GetSqlStatementResponse extends $tea.Model {
         [key: string]: any;
     });
 }
+export declare class GetTemplateRequest extends $tea.Model {
+    /**
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * TASK
+     */
+    templateType?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetTemplateResponseBody extends $tea.Model {
+    data?: Template;
+    /**
+     * @example
+     * 040003
+     */
+    errorCode?: string;
+    /**
+     * @example
+     * InvalidUser.NotFound
+     */
+    errorMessage?: string;
+    /**
+     * @remarks
+     * Id of the request
+     *
+     * @example
+     * 200
+     */
+    httpStatusCode?: string;
+    /**
+     * @example
+     * 484D9DDA-300D-525E-AF7A-0CCCA5C64A7A
+     */
+    requestId?: string;
+    /**
+     * @example
+     * True
+     */
+    success?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class GetTemplateResponse extends $tea.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: GetTemplateResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 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
@@ -2146,6 +2283,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
@@ -2235,6 +2391,7 @@ export declare class GetJobRunResponseBodyJobRun extends $tea.Model {
      * 1684119314000
      */
     endTime?: number;
+    environmentId?: string;
     /**
      * @remarks
      * The timeout period of the job.
@@ -2346,6 +2503,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
@@ -2822,7 +3171,7 @@ export declare class ListSessionClustersResponseBodySessionClustersApplicationCo
     configFileName?: string;
     /**
      * @remarks
-     * The key of the configuration item.
+     * The key of the configuration.
      *
      * @example
      * spark.app.name
@@ -2830,7 +3179,7 @@ export declare class ListSessionClustersResponseBodySessionClustersApplicationCo
     configItemKey?: string;
     /**
      * @remarks
-     * The value of the configuration item.
+     * The configuration value.
      *
      * @example
      * test_application
@@ -2941,6 +3290,7 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
      */
     displayReleaseVersion?: string;
     domain?: string;
+    domainInner?: string;
     /**
      * @remarks
      * The ID of the job that is associated with the session.
@@ -2957,6 +3307,7 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
      * false
      */
     fusion?: boolean;
+    gmtCreate?: number;
     /**
      * @remarks
      * The session type.
@@ -3003,6 +3354,7 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
      * sc-123131
      */
     sessionClusterId?: string;
+    startTime?: number;
     /**
      * @remarks
      * The status of the session.
@@ -3026,7 +3378,7 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
     userId?: string;
     /**
      * @remarks
-     * The name of the user.
+     * The username.
      *
      * @example
      * test_user
@@ -3534,6 +3886,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.
      *
@@ -3552,6 +3922,24 @@ export default class Client extends OpenApi {
      * @returns GetSqlStatementResponse
      */
     getSqlStatement(workspaceId: string, statementId: string, request: GetSqlStatementRequest): Promise<GetSqlStatementResponse>;
+    /**
+     * 获取任务模板
+     *
+     * @param request - GetTemplateRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetTemplateResponse
+     */
+    getTemplateWithOptions(workspaceBizId: string, request: GetTemplateRequest, headers: {
+        [key: string]: string;
+    }, runtime: $Util.RuntimeOptions): Promise<GetTemplateResponse>;
+    /**
+     * 获取任务模板
+     *
+     * @param request - GetTemplateRequest
+     * @returns GetTemplateResponse
+     */
+    getTemplate(workspaceBizId: string, request: GetTemplateRequest): Promise<GetTemplateResponse>;
     /**
      * Assigns a specified role to users.
      *
@@ -3589,7 +3977,7 @@ export default class Client extends OpenApi {
      */
     listJobRuns(workspaceId: string, request: ListJobRunsRequest): Promise<ListJobRunsResponse>;
     /**
-     * 获取日志内容
+     * Obtains the log content.
      *
      * @param request - ListLogContentsRequest
      * @param headers - map
@@ -3600,7 +3988,7 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListLogContentsResponse>;
     /**
-     * 获取日志内容
+     * Obtains the log content.
      *
      * @param request - ListLogContentsRequest
      * @returns ListLogContentsResponse
@@ -3625,7 +4013,7 @@ export default class Client extends OpenApi {
      */
     listReleaseVersions(request: ListReleaseVersionsRequest): Promise<ListReleaseVersionsResponse>;
     /**
-     * Queries a list of sessions.
+     * Queries the list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @param headers - map
@@ -3636,14 +4024,14 @@ export default class Client extends OpenApi {
         [key: string]: string;
     }, runtime: $Util.RuntimeOptions): Promise<ListSessionClustersResponse>;
     /**
-     * Queries a list of sessions.
+     * 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
@@ -3654,7 +4042,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