'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'emr-serverless-spark', 'version' => '2023-08-08', ], 'directories' => [ [ 'id' => 389575, 'title' => null, 'type' => 'directory', 'children' => [ 'AddMembers', 'ListMembers', 'GrantRoleToUsers', ], ], [ 'id' => 389579, 'title' => null, 'type' => 'directory', 'children' => [ 'GetSessionCluster', 'CreateSessionCluster', 'StopSessionCluster', 'StartSessionCluster', 'ListSessionClusters', ], ], [ 'id' => 389585, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 389586, 'title' => null, 'type' => 'directory', 'children' => [ 'ListKyuubiSparkApplications', 'CancelKyuubiSparkApplication', 'DeleteKyuubiToken', 'UpdateKyuubiToken', 'GetKyuubiToken', 'CreateKyuubiToken', 'ListKyuubiToken', 'ListKyuubiServices', 'CreateKyuubiService', 'GetKyuubiService', 'UpdateKyuubiService', 'DeleteKyuubiService', 'StartKyuubiService', 'StopKyuubiService', ], ], [ 'id' => 389601, 'title' => null, 'type' => 'directory', 'children' => [ 'ListLivyComputeSessions', 'DeleteLivyCompute', 'CreateLivyCompute', 'UpdateLivyCompute', 'ListLivyCompute', 'StartLivyCompute', 'RefreshLivyComputeToken', 'GetLivyComputeToken', 'CreateLivyComputeToken', 'DeleteLivyComputeToken', 'StopLivyCompute', 'StopLivyCompute', 'ListLivyComputeToken', 'GetLivyCompute', ], ], ], ], [ 'id' => 389615, 'title' => null, 'type' => 'directory', 'children' => [ 'GetTemplate', 'TerminateSqlStatement', 'CreateSqlStatement', 'GetSqlStatement', 'ListSqlStatementContents', ], ], [ 'id' => 389621, 'title' => null, 'type' => 'directory', 'children' => [ 'CreateWorkspace', 'ListWorkspaces', 'ListWorkspaceQueues', 'EditWorkspaceQueue', ], ], [ 'id' => 389626, 'title' => null, 'type' => 'directory', 'children' => [ 'ListReleaseVersions', ], ], [ 'id' => 389628, 'title' => null, 'type' => 'directory', 'children' => [ 'ListJobExecutors', 'ListLogContents', 'GetCuHours', 'GetDoctorApplication', 'CancelJobRun', 'ListJobRuns', 'GetJobRun', 'StartJobRun', 'GetRunConfiguration', ], ], [ 'id' => 389638, 'title' => null, 'type' => 'directory', 'children' => [ 'StartProcessInstance', 'UpdateProcessDefinitionWithSchedule', 'CreateProcessDefinitionWithSchedule', 'GenerateTaskCodes', ], ], [ 'id' => 389643, 'title' => null, 'type' => 'directory', 'children' => [ [ 'id' => 389644, 'title' => null, 'type' => 'directory', 'children' => [ 'UpdateRayCluster', 'GetRayCluster', 'ListRayCluster', 'StopRayCluster', 'StartRayCluster', 'DeleteRayCluster', 'CreateRayCluster', ], ], ], ], [ 'id' => 389652, 'title' => null, 'type' => 'directory', 'children' => [ 'ListCatalogs', 'ListTemplate', ], ], ], 'components' => [ 'schemas' => [ 'Category' => [ 'description' => 'The information about the folder.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '', 'description' => 'The type of the folder.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'TASK', 'checkBlank' => true, 'backendName' => 'type', 'bizType' => 'normal', 'trim' => true, 'default' => 'TASK', 'enum' => [ 'TASK', 'ARTIFACT', ], ], 'gmtModified' => [ 'title' => '', 'description' => 'The time when the folder was last updated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '2025-03-10T02:02:41.000+00:00', 'backendName' => 'gmtModified', ], 'creator' => [ 'title' => '', 'description' => 'The ID of the user who creates the folder.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '150978934701****', 'backendName' => 'creator', ], 'gmtCreated' => [ 'title' => '', 'description' => 'The time when the folder was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '2025-03-10T02:02:41.000+00:00', 'backendName' => 'gmtCreated', ], 'modifier' => [ 'title' => '', 'description' => 'The ID of the user who last modifies the folder.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '150978934701****', 'backendName' => 'modifier', ], 'bizId' => [ 'title' => '', 'description' => 'The folder ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'w-d8********', 'backendName' => 'bizId', ], 'name' => [ 'title' => '', 'description' => 'The name of the folder.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'name', 'maxLength' => 64, 'minLength' => 1, 'checkBlank' => true, 'backendName' => 'name', 'bizType' => 'normal', 'trim' => true, ], 'parentBizId' => [ 'title' => '', 'description' => 'The parent folder ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'w-d6********', 'backendName' => 'parentBizId', ], ], ], 'Configuration' => [ 'title' => 'A short description of struct', 'description' => 'The configurations.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'configFileName' => [ 'title' => '', 'description' => 'The name of the configuration file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'common.conf', 'backendName' => 'configFileName', ], 'configItemKey' => [ 'title' => '', 'description' => 'The name of the configuration item.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'hive.metastore.type', 'backendName' => 'configItemKey', ], 'configItemValue' => [ 'title' => '', 'description' => 'The value of the configuration item.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'USER_RDS', 'backendName' => 'configItemValue', ], ], ], 'JobDriver' => [ 'title' => 'A short description of struct', 'description' => 'The parameters used to submit Spark jobs.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'sparkSubmit' => [ 'title' => 'sparkSubmit', 'description' => 'The configurations of SparkSubmit.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'entryPoint' => [ 'title' => 'entryPoint', 'description' => 'The main program of Spark.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://bucket/path/to/entrypoint.jar', 'backendName' => 'entryPoint', ], 'entryPointArguments' => [ 'title' => 'entryPointArguments', 'description' => 'The parameters related to the main program of Spark.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The parameter related to the main program of Spark.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'arg1', 'extendType' => 'true', ], 'enumValueTitles' => [], 'backendName' => 'entryPointArguments', ], 'sparkSubmitParameters' => [ 'title' => 'sparkSubmitParameters', 'description' => 'The command-line parameter of SparkSubmit.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '--conf spark.app.name=test', 'backendName' => 'sparkSubmitParameters', ], ], 'backendName' => 'sparkSubmit', ], ], ], 'PrincipalAction' => [ 'title' => 'A short description of struct', 'description' => 'The Alibaba Cloud Resource Name (ARN) information.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'principalArn' => [ 'title' => '', 'description' => 'The ARN of the principal.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:emr::workspaceId:user/23759369154162****', 'backendName' => 'principalArn', ], 'actionArn' => [ 'title' => '', 'description' => 'The ARN of the behavior.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:emr::workspaceId:action/create_queue', 'backendName' => 'actionArn', ], ], ], 'RunLog' => [ 'title' => 'A short description of struct', 'description' => 'The log information about Spark jobs.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'driverStdOut' => [ 'title' => 'driverStdOut', 'description' => 'The path of the stdout file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'oss://bucket/path/to/stdout', 'backendName' => 'driverStdOut', ], 'driverStdError' => [ 'title' => 'driverStdError', 'description' => 'The path of the stderr file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://bucket/path/to/stderr', 'backendName' => 'driverStdError', ], 'driverSyslog' => [ 'title' => 'driverSyslog', 'description' => 'The path of the syslog file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://bucket/path/to/syslog', 'backendName' => 'driverSyslog', ], 'driverStartup' => [ 'title' => 'driverStartup', 'description' => 'The path of the startup file.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://bucket/path/to/startup', 'backendName' => 'driverStartup', ], ], ], 'SparkConf' => [ 'description' => 'The details of the SparkConf object.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'value' => [ 'title' => 'spark conf value', 'description' => 'The value of the SparkConf object.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_application', 'backendName' => 'value', ], 'key' => [ 'title' => 'spark conf key', 'description' => 'The key of the SparkConf object.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'spark.app.name', 'backendName' => 'key', ], ], ], 'Tag' => [ 'description' => 'The details of the tag.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'key' => [ 'title' => '', 'description' => 'The tag key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'workflowId', 'backendName' => 'key', ], 'value' => [ 'title' => '', 'description' => 'The tag value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'wf-123test', 'backendName' => 'value', ], ], ], 'TaskInstance' => [ 'description' => 'The job information.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'taskInfo' => [ 'title' => '', 'description' => 'The details of the job.'."\n", 'visibility' => 'Public', 'required' => false, 'backendName' => 'taskInfo', '$ref' => '#/components/schemas/Task', ], 'workspaceBizId' => [ 'title' => '', 'description' => 'The workspace ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'w-d2d82aa09151****', 'backendName' => 'workspaceBizId', ], 'taskBizId' => [ 'title' => '', 'description' => 'The ID of the data development job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'TSK-d87******************', 'backendName' => 'taskBizId', ], 'taskStatus' => [ 'title' => '', 'description' => 'The job run ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running', 'backendName' => 'taskStatus', ], 'bizId' => [ 'title' => '', 'description' => 'The ID of the folder.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'w-d8********', 'backendName' => 'bizId', ], 'fenixRunId' => [ 'title' => 'fenix run id', 'description' => 'The job run ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'jr-93d98d2f7061****', 'backendName' => 'fenixRunId', ], 'gmtCreated' => [ 'title' => '', 'description' => 'The time when the job was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-09-05T02:03:19Z', 'backendName' => 'gmtCreated', ], 'creator' => [ 'title' => '', 'description' => 'The ID of the user who creates the job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '150978934701****', 'backendName' => 'creator', ], ], ], 'Template' => [ 'description' => 'The template of a Spark job.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'sparkDriverCores' => [ 'title' => '', 'description' => 'The number of driver cores of the Spark job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'backendName' => 'sparkDriverCores', ], 'sparkDriverMemory' => [ 'title' => '', 'description' => 'The size of driver memory of the Spark job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1073741824', 'backendName' => 'sparkDriverMemory', ], 'sparkExecutorMemory' => [ 'title' => '', 'description' => 'The size of executor memory of the Spark job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1073741824', 'backendName' => 'sparkExecutorMemory', ], 'sparkVersion' => [ 'title' => '', 'description' => 'The engine version of Spark.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'esr-4.1.1', 'backendName' => 'sparkVersion', ], 'sparkLogLevel' => [ 'title' => '', 'description' => 'The level of the Spark log.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'INFO', 'backendName' => 'sparkLogLevel', ], 'sparkExecutorCores' => [ 'title' => '', 'description' => 'The number of executor cores of the Spark job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'backendName' => 'sparkExecutorCores', ], 'gmtModified' => [ 'title' => '', 'description' => 'The time when the job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '2025-03-10T02:02:41.000+00:00', 'backendName' => 'gmtModified', ], 'sparkLogPath' => [ 'title' => '', 'description' => 'The path where the operational logs of the Spark job are stored.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'oss://your_bucket/path/to/your/log', 'backendName' => 'sparkLogPath', ], 'creator' => [ 'title' => '', 'description' => 'The user ID of the job creator.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '150978934701****', 'backendName' => 'creator', ], 'gmtCreated' => [ 'title' => '', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '2025-03-10T02:02:41.000+00:00'."\n", 'backendName' => 'gmtCreated', ], 'modifier' => [ 'title' => '', 'description' => 'The ID of the user who last modified the job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '150978934701****'."\n", 'backendName' => 'modifier', ], 'sparkConf' => [ 'title' => 'spark conf', 'description' => 'The SparkConf objects.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The SparkConf object.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/SparkConf', ], 'backendName' => 'sparkConf', ], 'templateType' => [ 'title' => '', 'description' => 'The template type.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'TASK', 'backendName' => 'templateType', ], 'fusion' => [ 'title' => '', 'description' => 'Indicates whether Fusion engine is enabled for acceleration.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'."\n", 'backendName' => 'fusion', ], 'displaySparkVersion' => [ 'title' => '', 'description' => 'The displayed version of the Spark engine.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'esr-4.1.1', 'backendName' => 'displaySparkVersion', ], ], ], 'TimeRange' => [ 'title' => '', 'description' => 'The time range.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'startTime' => [ 'title' => '', 'description' => 'The start time of the time range.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1688370894339', 'backendName' => 'startTime', ], 'endTime' => [ 'title' => '', 'description' => 'The end time of the time range.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1688370894339', 'backendName' => 'endTime', ], ], ], ], ], 'apis' => [ 'AddMembers' => [ 'summary' => 'Adds a RAM user or RAM role to a workspace as a member.', 'path' => '/api/v1/auth/members', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'abilityTreeCode' => '193369', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-975bcfda9625****', ], 'memberArns' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, 'example' => '', ], 'required' => true, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'AddMembers', ], 'ListMembers' => [ 'summary' => '查询用户列表', 'path' => '/api/v1/auth/{workspaceId}/members', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce0SZW92', ], ], 'parameters' => [ [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '标记当前开始读取的位置。', 'description' => '标记当前开始读取的位置，置空表示从头开始。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '一次获取的最大记录数。', 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => '工作空间id。', 'type' => 'string', 'required' => true, 'example' => 'w-975bcfda9625****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'members' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'memberArn' => [ 'title' => '用户 arn。', 'description' => '用户 arn。', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:member/202265*****276', ], 'userName' => [ 'title' => '用户名称。', 'description' => '用户名称。', 'type' => 'string', 'example' => 'jia***test@195*****7311.onaliyun.com', ], 'displayName' => [ 'title' => '用户展示名称。', 'description' => '用户展示名称。', 'type' => 'string', 'example' => 'jia***test', ], 'userType' => [ 'title' => '用户类型。', 'description' => '用户类型。', 'type' => 'string', 'enumValueTitles' => [ 'ROLE' => 'ROLE', 'MEMBER' => 'MEMBER', ], 'example' => 'MEMBER', ], 'roles' => [ 'title' => '用户角色列表。', 'description' => '用户角色列表。', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'roleArn' => [ 'title' => '角色 arn。', 'description' => '角色 arn。', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:role/DataScience', ], 'roleName' => [ 'title' => '角色名称。', 'description' => '角色名称。', 'type' => 'string', 'example' => 'DataScience', ], 'description' => [ 'title' => '描述。', 'description' => '描述。', 'type' => 'string', 'example' => 'DataScience', ], 'createTime' => [ 'title' => '创建时间。', 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1753412502000', ], 'actions' => [ 'title' => '权限列表。', 'description' => '权限列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'actionArn' => [ 'title' => '行为 arn。', 'description' => '行为 arn。', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:action/add_MEMBER', ], 'actionName' => [ 'title' => '权限名称。', 'description' => '权限名称。', 'type' => 'string', 'example' => 'add', ], 'displayName' => [ 'title' => '权限展示名称。', 'description' => '权限展示名称。', 'type' => 'string', 'example' => 'add members', ], 'description' => [ 'title' => 'action 描述。', 'description' => 'action 描述。', 'type' => 'string', 'example' => 'add members'."\n", ], 'dependencies' => [ 'title' => 'action 依赖列表。', 'description' => 'action 依赖列表。', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'VIEW', ], 'example' => '["view"]', ], ], ], ], ], ], ], 'actions' => [ 'title' => '针对此用户允许的操作列表。', 'description' => '针对此用户允许的操作列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'actionArn' => [ 'title' => '行为 arn。', 'description' => '行为 arn。', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:action/add_MEMBER', ], 'actionName' => [ 'title' => '权限名称。', 'description' => '权限名称。', 'type' => 'string', 'example' => 'add', ], 'displayName' => [ 'title' => '权限展示名称。', 'description' => '权限展示名称。', 'type' => 'string', 'example' => 'add members', ], 'description' => [ 'title' => 'action 描述。', 'description' => 'action 描述。', 'type' => 'string', 'example' => 'add members', ], 'dependencies' => [ 'title' => 'action 依赖列表。', 'description' => 'action 依赖列表。', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'VIEW', ], 'example' => '["view"]', ], ], ], ], 'visible' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'createTime' => [ 'description' => '', 'type' => 'string', 'example' => '1753412502000', ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '下一页TOKEN。', 'description' => '下一页TOKEN。', 'type' => 'string', 'example' => '1', ], 'maxResults' => [ 'title' => '一次获取的最大记录数。', 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'title' => '记录总数。', 'description' => '记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"members\\": [\\n {\\n \\"memberArn\\": \\"acs:emr::w-1234****abcd:member/202265*****276\\",\\n \\"userName\\": \\"jia***test@195*****7311.onaliyun.com\\",\\n \\"displayName\\": \\"jia***test\\",\\n \\"userType\\": \\"MEMBER\\",\\n \\"roles\\": [\\n {\\n \\"roleArn\\": \\"acs:emr::w-1234****abcd:role/DataScience\\",\\n \\"roleName\\": \\"DataScience\\",\\n \\"description\\": \\"DataScience\\",\\n \\"createTime\\": 1753412502000,\\n \\"actions\\": [\\n {\\n \\"actionArn\\": \\"acs:emr::w-1234****abcd:action/add_MEMBER\\",\\n \\"actionName\\": \\"add\\",\\n \\"displayName\\": \\"add members\\",\\n \\"description\\": \\"add members\\\\n\\",\\n \\"dependencies\\": [\\n \\"VIEW\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"actions\\": [\\n {\\n \\"actionArn\\": \\"acs:emr::w-1234****abcd:action/add_MEMBER\\",\\n \\"actionName\\": \\"add\\",\\n \\"displayName\\": \\"add members\\",\\n \\"description\\": \\"add members\\",\\n \\"dependencies\\": [\\n \\"VIEW\\"\\n ]\\n }\\n ],\\n \\"visible\\": true,\\n \\"createTime\\": \\"1753412502000\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', ], 'GrantRoleToUsers' => [ 'summary' => 'Assigns a specified role to users.', 'path' => '/api/v1/auth/roles/grant', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '193394', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ 'roleArn' => [ 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:emr::w-975bcfda9625****:role/Owner', ], 'userArns' => [ 'description' => 'The user ARNs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The user ARN.'."\n", 'type' => 'string', 'required' => false, 'example' => 'acs:emr::w-975bcfda96258dd7:member/20468369839086****', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'GrantRoleToUsers', ], 'GetSessionCluster' => [ 'summary' => 'Queries the information about a session.', 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters/{sessionClusterId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203510', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-1234abcd', ], ], [ 'name' => 'sessionClusterId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '作业名称。', 'description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr-spark-demo-job', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'sessionCluster' => [ 'description' => 'The session object.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-1234abcd', ], 'sessionClusterId' => [ 'title' => '交互式作业会话id。', 'description' => 'The session ID.'."\n", 'type' => 'string', 'example' => '1234abcd-12ab-34cd-56ef-1234567890ab', ], 'userId' => [ 'title' => '任务实例ID。', 'description' => 'The user ID.'."\n", 'type' => 'string', 'example' => 'jr-231231', ], 'queueName' => [ 'title' => '作业实例名称。', 'description' => 'The queue name.'."\n", 'type' => 'string', 'example' => 'jobName', ], 'state' => [ 'title' => '作业状态。', 'description' => 'The job status.'."\n" ."\n" .'* Starting'."\n" .'* Running'."\n" .'* Stopping'."\n" .'* Stopped'."\n" .'* Error'."\n", 'type' => 'string', 'enumValueTitles' => [], 'example' => 'Running', ], 'stateChangeReason' => [ 'description' => 'The reason of the job status change.'."\n", 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The status change code.'."\n", 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => 'The status change message.'."\n", 'type' => 'string', 'example' => 'ok', ], ], ], 'autoStartConfiguration' => [ 'description' => 'Indicates whether automatic startup is enabled.'."\n", 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => 'Indicates whether automatic startup is enabled.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'false', ], ], ], 'autoStopConfiguration' => [ 'description' => 'Indicates whether automatic termination is enabled.'."\n", 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => 'Indicates whether automatic termination is enabled.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'false', ], 'idleTimeoutMinutes' => [ 'description' => 'The idle timeout period. The session is automatically terminated when the idle timeout period is exceeded.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], ], ], 'applicationConfigs' => [ 'description' => 'The Spark configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The Spark configuration.'."\n", 'type' => 'object', 'properties' => [ 'configFileName' => [ 'description' => 'The name of the configuration file.'."\n", 'type' => 'string', 'example' => 'spark-defaults.conf', ], 'configItemKey' => [ 'description' => 'The key of the configuration.'."\n", 'type' => 'string', 'example' => 'spark.app.name', ], 'configItemValue' => [ 'description' => 'The configuration value.'."\n", 'type' => 'string', 'example' => 'test', ], ], ], ], 'releaseVersion' => [ 'description' => 'The version of Serverless Spark.'."\n", 'type' => 'string', 'example' => 'esr-2.2(Java Runtime)', ], 'name' => [ 'description' => 'The name of the session.'."\n", 'type' => 'string', 'example' => 'test', ], 'userName' => [ 'description' => 'The name of the account that is used to create the session.'."\n", 'type' => 'string', 'example' => 'user1', ], 'kind' => [ 'description' => 'The type of the job. This parameter is required and cannot be modified after the deployment is created. Valid values:'."\n" ."\n" .'* SQLSCRIPT'."\n" .'* JAR'."\n" .'* PYTHON'."\n", 'type' => 'string', 'example' => 'SQL', ], 'webUI' => [ 'description' => 'The Spark UI of the session.'."\n", 'type' => 'string', 'example' => 'https://spark-ui/link', ], 'draftId' => [ 'description' => 'The ID of the job that is associated with the session.'."\n", 'type' => 'string', 'example' => 'TSK-xxxxxxxx', ], 'domain' => [ 'description' => 'The domain name to which the Spark UI of the session belongs.'."\n", 'type' => 'string', 'example' => 'your.domain.com', ], 'displayReleaseVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'example' => 'esr-2.2(Java Runtime)', ], 'fusion' => [ 'description' => 'Indicates whether the Fusion engine is used for acceleration.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'envId' => [ 'description' => 'The environment ID.'."\n", 'type' => 'string', 'example' => 'env-cpv569tlhtgndjl86t40', ], 'gmtCreate' => [ 'description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-01 06:23:01'."\n", ], 'startTime' => [ 'description' => 'The start time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-01 06:23:01', ], 'domainInner' => [ 'description' => 'The internal endpoint.'."\n", 'type' => 'string', 'example' => 'emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com', ], 'extra' => [ 'description' => 'The additional metadata of the session.'."\n", 'type' => 'string', 'example' => '{"extraInfoKey":"extraInfoValue"}', ], 'publicEndpointEnabled' => [ 'type' => 'boolean', ], 'connectionToken' => [ 'type' => 'string', ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionCluster\\": {\\n \\"workspaceId\\": \\"w-1234abcd\\",\\n \\"sessionClusterId\\": \\"1234abcd-12ab-34cd-56ef-1234567890ab\\",\\n \\"userId\\": \\"123xxxxxxxx\\",\\n \\"queueName\\": \\"dev_queue\\",\\n \\"state\\": \\"Running\\",\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n },\\n \\"autoStartConfiguration\\": {\\n \\"enable\\": false\\n },\\n \\"autoStopConfiguration\\": {\\n \\"enable\\": false,\\n \\"idleTimeoutMinutes\\": 60\\n },\\n \\"applicationConfigs\\": [\\n {\\n \\"configFileName\\": \\"spark-defaults.conf\\",\\n \\"configItemKey\\": \\"spark.app.name\\",\\n \\"configItemValue\\": \\"test\\"\\n }\\n ],\\n \\"releaseVersion\\": \\"esr-4.0.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"name\\": \\"test\\",\\n \\"userName\\": \\"user1\\",\\n \\"kind\\": \\"SQL\\",\\n \\"webUI\\": \\"https://spark-ui/link\\",\\n \\"draftId\\": \\"TSK-xxxxxxxx\\",\\n \\"domain\\": \\"your.domain.com\\",\\n \\"displayReleaseVersion\\": \\"esr-4.0.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"fusion\\": false,\\n \\"envId\\": \\"env-cpv569tlhtgndjl8****\\",\\n \\"gmtCreate\\": 0,\\n \\"startTime\\": 0,\\n \\"domainInner\\": \\"emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com\\",\\n \\"extra\\": \\"{\\\\\\"extraInfoKey\\\\\\":\\\\\\"extraInfoValue\\\\\\"}\\",\\n \\"publicEndpointEnabled\\": true,\\n \\"connectionToken\\": \\"\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'GetSessionCluster', ], 'CreateSessionCluster' => [ 'summary' => 'Creates a session.', 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '202902', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'queueName' => [ 'description' => 'The queue name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'autoStartConfiguration' => [ 'description' => 'Specifies whether to enable automatic startup.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => 'Specifies whether to enable automatic startup.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'autoStopConfiguration' => [ 'description' => 'The automatic termination configuration.'."\n", 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => 'Specifies whether to enable automatic termination.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'idleTimeoutMinutes' => [ 'description' => 'The idle timeout period. The session is automatically terminated when the idle timeout period is exceeded.'."\n", 'type' => 'integer', 'required' => false, 'example' => '60', ], ], 'required' => false, ], 'applicationConfigs' => [ 'description' => 'The Spark configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The Spark configuration.'."\n", 'type' => 'object', 'properties' => [ 'configFileName' => [ 'description' => 'The name of the configuration file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark-defaults.conf'."\n", ], 'configItemKey' => [ 'description' => 'The key of SparkConf.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark.app.name', ], 'configItemValue' => [ 'description' => 'The value of SparkConf.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', ], ], 'required' => false, ], 'required' => false, ], 'releaseVersion' => [ 'description' => 'The version number of Spark.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-3.3.1', ], 'name' => [ 'description' => 'The name of the job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark_job_name', ], 'kind' => [ 'description' => 'The session type.'."\n" ."\n" .'* SQL'."\n" .'* NOTEBOOK'."\n", 'type' => 'string', 'required' => false, 'example' => 'SQL', 'default' => 'SQL', ], 'displayReleaseVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-3.3.1'."\n", ], 'fusion' => [ 'description' => 'Specifies whether to enable Fusion engine for acceleration.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'envId' => [ 'description' => 'The ID of the Python environment. This parameter takes effect only for notebook sessions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'env-cpv569tlhtgndjl86t40', ], 'publicEndpointEnabled' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', ], 'clientToken' => [ 'type' => 'string', ], ], 'required' => false, ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-790b443d72394bfc', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'sessionClusterId' => [ 'title' => 'Workspace Id。', 'description' => 'The session ID.'."\n", 'type' => 'string', 'example' => 'w-******', ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusterId\\": \\"w-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'CreateSessionCluster', ], 'StopSessionCluster' => [ 'summary' => 'Stops a session.', 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters/action/stopSessionCluster', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'description' => 'The request struct.'."\n", 'type' => 'object', 'properties' => [ 'queueName' => [ 'description' => 'The queue name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'sessionClusterId' => [ 'description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sc-xxxxxxxxxxxx', ], ], 'required' => false, ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'sessionClusterId' => [ 'title' => 'Workspace Id。', 'description' => 'The session ID.', 'type' => 'string', 'example' => 'w-******', ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusterId\\": \\"w-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'StopSessionCluster', ], 'StartSessionCluster' => [ 'summary' => 'Starts a session.', 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters/action/startSessionCluster', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'description' => 'The request struct.'."\n", 'type' => 'object', 'properties' => [ 'queueName' => [ 'description' => 'The queue name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'sessionClusterId' => [ 'description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sc-xxxxxxxxxxx', ], ], 'required' => false, ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'sessionClusterId' => [ 'title' => 'Workspace Id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-******', ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusterId\\": \\"w-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'StartSessionCluster', ], 'ListSessionClusters' => [ 'summary' => 'Queries the list of sessions.', 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '202905', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '标记当前开始读取的位置。', 'description' => 'The pagination token that is used in the request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C89568980', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '一次获取的最大记录数。', 'description' => 'The maximum number of entries to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-1234abcd', ], ], [ 'name' => 'sessionClusterId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '作业名称。', 'description' => 'The name of the job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr-spark-demo-job', ], ], [ 'name' => 'queueName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', ], ], [ 'name' => 'kind', 'in' => 'query', 'schema' => [ 'description' => 'The session type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* NOTEBOOK'."\n" .'* THRIFT'."\n" .'* SQL'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'NOTEBOOK' => 'NOTEBOOK', 'THRIFT' => 'THRIFT', 'SQL' => 'SQL', ], 'example' => 'SQL', 'default' => 'SQL', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'sessionClusters' => [ 'description' => 'The sessions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The information about the session.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-1234abcd', ], 'sessionClusterId' => [ 'title' => '交互式作业会话id。', 'description' => 'The session ID.'."\n", 'type' => 'string', 'example' => 'sc-123131', ], 'userId' => [ 'title' => '任务实例ID。', 'description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '123131', ], 'queueName' => [ 'title' => '作业实例名称。', 'description' => 'The name of the queue that is used to run the session.'."\n", 'type' => 'string', 'example' => 'dev_queue', ], 'state' => [ 'title' => '作业状态。', 'description' => 'The status of the session.'."\n" ."\n" .'* Starting'."\n" .'* Running'."\n" .'* Stopping'."\n" .'* Stopped'."\n" .'* Error'."\n", 'type' => 'string', 'example' => 'Running', ], 'stateChangeReason' => [ 'description' => 'The details of the most recent status change of the session.'."\n", 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The status change code.'."\n", 'type' => 'string', 'example' => '200', ], 'message' => [ 'description' => 'The status change message.'."\n", 'type' => 'string', 'example' => 'ok', ], ], ], 'autoStartConfiguration' => [ 'description' => 'The automatic startup configurations.'."\n", 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => 'Indicates whether automatic startup is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], 'autoStopConfiguration' => [ 'description' => 'The configurations of automatic termination.'."\n", 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => 'Indicates whether automatic termination is enabled.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'idleTimeoutMinutes' => [ 'description' => 'The idle timeout period. The session is automatically terminated when the idle timeout period is exceeded.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '45', ], ], ], 'applicationConfigs' => [ 'description' => 'The session configurations, which are equivalent to the configurations of the Spark job.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The session configuration, which is equivalent to the configuration of the Spark job.'."\n", 'type' => 'object', 'properties' => [ 'configFileName' => [ 'description' => 'The name of the configuration file.'."\n", 'type' => 'string', 'example' => 'spark-default.conf', ], 'configItemKey' => [ 'description' => 'The key of the configuration.'."\n", 'type' => 'string', 'example' => 'spark.app.name', ], 'configItemValue' => [ 'description' => 'The configuration value.'."\n", 'type' => 'string', 'example' => 'test_application', ], ], ], ], 'name' => [ 'description' => 'The name of the session.'."\n", 'type' => 'string', 'example' => 'adhoc_query', ], 'userName' => [ 'description' => 'The username.'."\n", 'type' => 'string', 'example' => 'test_user', ], 'kind' => [ 'description' => 'The session type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* NOTEBOOK'."\n" .'* THRIFT'."\n" .'* SQL'."\n", 'type' => 'string', 'enumValueTitles' => [ 'NOTEBOOK' => 'NOTEBOOK', 'THRIFT' => 'THRIFT', 'SQL' => 'SQL', ], 'example' => 'SQL', ], 'webUI' => [ 'description' => 'The Spark UI of the session.'."\n", 'type' => 'string', 'example' => 'http://spark-ui-xxxx', ], 'releaseVersion' => [ 'description' => 'The version of EMR Serverless Spark.'."\n", 'type' => 'string', 'example' => 'esr-2.1', ], 'draftId' => [ 'description' => 'The ID of the job that is associated with the session.'."\n", 'type' => 'string', 'example' => 'TSK-xxxxxxxxx'."\n", ], 'domain' => [ 'description' => 'The public endpoint of the Thrift server.'."\n", 'type' => 'string', 'example' => 'emr-spark-gateway-cn-hangzhou.data.aliyun.com', ], 'displayReleaseVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', ], 'fusion' => [ 'description' => 'Indicates whether the Fusion engine is used for acceleration.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'gmtCreate' => [ 'description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1732267598000', ], 'startTime' => [ 'description' => 'The start time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1732267598000', ], 'domainInner' => [ 'description' => 'The internal endpoint of the Thrift server.'."\n", 'type' => 'string', 'example' => 'emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com', ], 'extra' => [ 'description' => 'The additional metadata of the session.'."\n", 'type' => 'string', 'example' => '{"extraInfoKey":"extraInfoValue"}', ], 'publicEndpointEnabled' => [ 'type' => 'boolean', ], 'connectionToken' => [ 'type' => 'string', ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '返回读取到的数据位置。', 'description' => 'A pagination token.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C89568980', ], 'maxResults' => [ 'title' => '本次请求所返回的最大记录条数。', 'description' => 'The maximum number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'title' => '本次请求条件下的数据总量。', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusters\\": [\\n {\\n \\"workspaceId\\": \\"w-1234abcd\\",\\n \\"sessionClusterId\\": \\"sc-123131\\",\\n \\"userId\\": \\"123131\\",\\n \\"queueName\\": \\"dev_queue\\",\\n \\"state\\": \\"Running\\",\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"ok\\"\\n },\\n \\"autoStartConfiguration\\": {\\n \\"enable\\": true\\n },\\n \\"autoStopConfiguration\\": {\\n \\"enable\\": false,\\n \\"idleTimeoutMinutes\\": 45\\n },\\n \\"applicationConfigs\\": [\\n {\\n \\"configFileName\\": \\"spark-default.conf\\",\\n \\"configItemKey\\": \\"spark.app.name\\",\\n \\"configItemValue\\": \\"test_application\\"\\n }\\n ],\\n \\"name\\": \\"adhoc_query\\",\\n \\"userName\\": \\"test_user\\",\\n \\"kind\\": \\"SQL\\",\\n \\"webUI\\": \\"http://spark-ui-xxxx\\",\\n \\"releaseVersion\\": \\"esr-4.0.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"draftId\\": \\"TSK-xxxxxxxxx\\\\n\\",\\n \\"domain\\": \\"emr-spark-gateway-cn-hangzhou.data.aliyun.com\\",\\n \\"displayReleaseVersion\\": \\"esr-4.0.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"fusion\\": false,\\n \\"gmtCreate\\": 1732267598000,\\n \\"startTime\\": 1732267598000,\\n \\"domainInner\\": \\"emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com\\",\\n \\"extra\\": \\"{\\\\\\"extraInfoKey\\\\\\":\\\\\\"extraInfoValue\\\\\\"}\\",\\n \\"publicEndpointEnabled\\": true,\\n \\"connectionToken\\": \\"\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', 'title' => 'ListSessionClusters', ], 'ListKyuubiSparkApplications' => [ 'summary' => 'Queries the applications that are submitted by using a Kyuubi gateway.', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/applications', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => 'The maximum number of entries to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => 'The ID of the Kyuubi service.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', 'title' => 'Kyuubi 服务 ID。', ], ], [ 'name' => 'applicationId', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the application that is submitted by using a Kyuubi gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', ], ], [ 'name' => 'applicationName', 'in' => 'query', 'schema' => [ 'description' => 'The name of the Spark application that is submitted by using a Kyuubi gateway.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****', ], ], [ 'name' => 'startTime', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The range of start time.'."\n", 'type' => 'object', 'properties' => [ 'startTime' => [ 'description' => 'The beginning of the start time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709740800000', ], 'endTime' => [ 'description' => 'The end of the start time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710432000000', ], ], 'required' => false, ], ], [ 'name' => 'resourceQueueId', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'minDuration', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', ], ], [ 'name' => 'orderBy', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], [ 'name' => 'sort', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'applications' => [ 'description' => 'The details of the applications.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The application details.'."\n", 'type' => 'object', 'properties' => [ 'applicationId' => [ 'description' => 'The ID of the application that is submitted by using a Kyuubi gateway.'."\n", 'type' => 'string', 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', ], 'applicationName' => [ 'description' => 'The name of the Spark application that is submitted by using a Kyuubi gateway.'."\n", 'type' => 'string', 'example' => 'kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****', ], 'webUI' => [ 'description' => 'The URL of the web UI for the Spark application.'."\n", 'type' => 'string', 'example' => 'https://emr-spark-ui-cn-hangzhou.data.aliyun.com/history/w-cf351f3b6dcb****-spark-339f844005b6404c95f9f7c7a13b****/jobs/?spm=emr-serverless-spark.gateway_sessions.0.0.711344e3QfMVTz&token=NS9CU1lpWGl1Q2RRdi9sZUtuS3hy****', ], 'state' => [ 'description' => 'The status of the Spark application.'."\n" ."\n" .'* STARTING'."\n" .'* RUNNING'."\n" .'* TERMINATED'."\n", 'type' => 'string', 'example' => 'STARTING', ], 'startTime' => [ 'description' => 'The time when the task started.'."\n", 'type' => 'string', 'example' => '2025-02-12 19:59:16', ], 'endTime' => [ 'description' => 'The time when the task ended.'."\n", 'type' => 'string', 'example' => '2025-02-12 20:02:02', ], 'cuHours' => [ 'description' => 'The number of CUs consumed during a specified cycle of a task. The value is an estimated value. Refer to your Alibaba Cloud bill for the actual number of consumed CUs.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.238302', ], 'mbSeconds' => [ 'description' => 'The total amount of memory allocated to the job multiplied by the running duration (seconds).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3513900', ], 'vcoreSeconds' => [ 'description' => 'The total number of CPU cores allocated to the job multiplied by the running duration (seconds).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '780', ], 'resourceQueueId' => [ 'description' => 'The name of the resource queue on which the Spark jobs run.'."\n", 'type' => 'string', 'example' => 'dev_queue', ], 'exitReason' => [ 'title' => '退出码。', 'type' => 'string', 'example' => 'Exit Code: 137, Exit Reason: OOMKilled', ], 'latestSqlStatementStatus' => [ 'title' => '在该会话内，最近一次任务执行的状态。', 'type' => 'string', 'example' => 'SUCCESS', ], 'runLog' => [ 'title' => '应用日志。', '$ref' => '#/components/schemas/RunLog', ], 'kyuubiServiceId' => [ 'title' => 'Kyuubi 服务 ID。', 'type' => 'string', 'example' => 'kb-2b93ec*******c9440c', ], 'tags' => [ 'title' => '标签。', 'type' => 'array', 'items' => [ 'title' => '标签。', '$ref' => '#/components/schemas/Tag', ], ], ], ], ], 'requestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '1', ], 'maxResults' => [ 'description' => 'The maximum number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"applications\\": [\\n {\\n \\"applicationId\\": \\"spark-339f844005b6404c95f9f7c7a13b****\\",\\n \\"applicationName\\": \\"kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****\\",\\n \\"webUI\\": \\"https://emr-spark-ui-cn-hangzhou.data.aliyun.com/history/w-cf351f3b6dcb****-spark-339f844005b6404c95f9f7c7a13b****/jobs/?spm=emr-serverless-spark.gateway_sessions.0.0.711344e3QfMVTz&token=NS9CU1lpWGl1Q2RRdi9sZUtuS3hy****\\",\\n \\"state\\": \\"STARTING\\",\\n \\"startTime\\": \\"2025-02-12 19:59:16\\",\\n \\"endTime\\": \\"2025-02-12 20:02:02\\",\\n \\"cuHours\\": 0.238302,\\n \\"mbSeconds\\": 3513900,\\n \\"vcoreSeconds\\": 780,\\n \\"resourceQueueId\\": \\"dev_queue\\",\\n \\"exitReason\\": \\"Exit Code: 137, Exit Reason: OOMKilled\\",\\n \\"latestSqlStatementStatus\\": \\"SUCCESS\\",\\n \\"runLog\\": {\\n \\"driverStdOut\\": \\"\\",\\n \\"driverStdError\\": \\"\\",\\n \\"driverSyslog\\": \\"\\",\\n \\"driverStartup\\": \\"\\"\\n },\\n \\"kyuubiServiceId\\": \\"kb-2b93ec*******c9440c\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"workflowId\\",\\n \\"value\\": \\"wf-123test\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', 'title' => 'ListKyuubiSparkApplications', ], 'CancelKyuubiSparkApplication' => [ 'summary' => 'CancelKyuubiSparkApplication', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/application/{applicationId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', ], ], [ 'name' => 'applicationId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'body' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'applicationId' => [ 'description' => '', 'type' => 'string', 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', ], 'success' => [ 'description' => '', 'type' => 'boolean', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"body\\": {\\n \\"applicationId\\": \\"spark-339f844005b6404c95f9f7c7a13b****\\",\\n \\"success\\": true\\n }\\n}","type":"json"}]', ], 'DeleteKyuubiToken' => [ 'summary' => '删除compute的token', 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', ], ], [ 'name' => 'tokenId', 'in' => 'path', 'schema' => [ 'description' => 'Token ID。', 'type' => 'string', 'required' => false, 'example' => 'tk-zpi0*****hdv4y', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', ], 'UpdateKyuubiToken' => [ 'summary' => '更新kyuubi的token', 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****'."\n", ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", ], ], [ 'name' => 'tokenId', 'in' => 'path', 'schema' => [ 'description' => 'Token ID。', 'type' => 'string', 'required' => false, 'example' => 'tk-zpi0*****hdv4y'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_serverless_spark'."\n", ], 'token' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rjy7ejhej9gkzjjuun49jnx2xk8if2cu', ], 'autoExpireConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'expireDays' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365', ], ], 'required' => false, ], 'memberArns' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', ], 'GetKyuubiToken' => [ 'summary' => '获取compute的token', 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', ], ], [ 'name' => 'tokenId', 'in' => 'path', 'schema' => [ 'description' => 'Token ID。', 'type' => 'string', 'required' => false, 'example' => 'tk-zpi0*****hdv4y', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokenId' => [ 'description' => 'Token ID。', 'type' => 'string', 'example' => 'tk-zpi0*****hdv4y', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'dev_serverless_spark'."\n", ], 'token' => [ 'description' => '', 'type' => 'string', 'example' => 'dxj**********wfg'."\n", ], 'createdBy' => [ 'description' => '', 'type' => 'string', 'example' => 'admin', ], 'createTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'expireTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1753932319390', ], 'lastUsedTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456098000', ], 'autoExpireConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'expireDays' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '365', ], ], ], 'memberArns' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"tokenId\\": \\"tk-zpi0*****hdv4y\\",\\n \\"name\\": \\"dev_serverless_spark\\\\n\\",\\n \\"token\\": \\"dxj**********wfg\\\\n\\",\\n \\"createdBy\\": \\"admin\\",\\n \\"createTime\\": 1749456094000,\\n \\"expireTime\\": 1753932319390,\\n \\"lastUsedTime\\": 1749456098000,\\n \\"autoExpireConfiguration\\": {\\n \\"enable\\": true,\\n \\"expireDays\\": 365\\n },\\n \\"memberArns\\": [\\n \\"acs:emr::w-d2d82aa09155****:member/195****7311\\"\\n ]\\n }\\n}","type":"json"}]', ], 'CreateKyuubiToken' => [ 'summary' => '创建kyuubi的token', 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****'."\n", ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_serverless_spark', ], 'token' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'rjy7ejhej9gkzjjuun49jnx2xk8if2cu', ], 'autoExpireConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'expireDays' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365', ], ], 'required' => false, ], 'memberArns' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311'."\n", ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokenId' => [ 'description' => 'Token ID。', 'type' => 'string', 'example' => 'tk-zpi0*****hdv4y'."\n", ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"tokenId\\": \\"tk-zpi0*****hdv4y\\\\n\\"\\n }\\n}","type":"json"}]', ], 'ListKyuubiToken' => [ 'summary' => '列出compute的token', 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokens' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokenId' => [ 'description' => 'Token ID。', 'type' => 'string', 'example' => 'f14c1347-dcfd-4082-b101-77aa96b5de36'."\n", ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'dev_serveless_spark', ], 'token' => [ 'description' => '', 'type' => 'string', 'example' => 'f14c1347-dcfd-4082-b101-77aa96b5de36', ], 'createdBy' => [ 'description' => '', 'type' => 'string', 'example' => 'test_user', ], 'createTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-02-11T02:23:02Z', ], 'expireTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1740366769165', ], 'lastUsedTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1740366232121', ], 'memberArns' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'accountNames' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"tokens\\": [\\n {\\n \\"tokenId\\": \\"tk-zpi0*****hdv4y\\",\\n \\"name\\": \\"dev_serverless_spark\\",\\n \\"token\\": \\"dxj**********wfg\\",\\n \\"createdBy\\": \\"admin\\",\\n \\"createTime\\": 1755496031000,\\n \\"expireTime\\": 1787033891000,\\n \\"lastUsedTime\\": 1760366232121,\\n \\"memberArns\\": [\\n \\"acs:emr::w-d2d82aa09155****:member/195****7311\\"\\n ],\\n \\"accountNames\\": [\\n \\"dev-serverless-spark\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListKyuubiServices' => [ 'summary' => 'Gets the list of KyuubiServers', 'path' => '/api/v1/kyuubi/{workspaceId}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'kyuubiServices' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'kyuubiConfigs' => [ 'description' => '', 'type' => 'string', 'example' => 'kyuubi.conf.key=value1'."\n" .'kyuubi.conf.key1=value2', ], 'sparkConfigs' => [ 'description' => '', 'type' => 'string', 'example' => 'spark.conf.key=value1'."\n" .'spark.conf.key1=value2', ], 'state' => [ 'description' => '', 'type' => 'string', 'example' => 'Running', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'queue' => [ 'description' => '', 'type' => 'string', 'example' => 'dev_queue', ], 'createTime' => [ 'description' => '', 'type' => 'string', 'example' => '2025-03-11T08:21:58Z', ], 'startTime' => [ 'description' => '', 'type' => 'string', 'example' => '2024-11-23 09:22:00', ], 'creator' => [ 'description' => '', 'type' => 'string', 'example' => '103*******', ], 'kyuubiServiceId' => [ 'description' => 'KyuubiServer ID。', 'type' => 'string', 'example' => 'kb-070104e7631242448d12a1377c309f30', ], 'innerEndpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com', ], 'publicEndpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com', ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'example' => 'esr-4.2.0 (Spark 3.5.2, Scala 2.12)'."\n", ], 'computeInstance' => [ 'description' => '', 'type' => 'string', 'example' => '4C16G', ], 'replica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'kyuubiReleaseVersion' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"kyuubiServices\\": [\\n {\\n \\"kyuubiConfigs\\": \\"kyuubi.conf.key=value1\\\\nkyuubi.conf.key1=value2\\",\\n \\"sparkConfigs\\": \\"spark.conf.key=value1\\\\nspark.conf.key1=value2\\",\\n \\"state\\": \\"Running\\",\\n \\"name\\": \\"test\\",\\n \\"queue\\": \\"dev_queue\\",\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"startTime\\": \\"2024-11-23 09:22:00\\",\\n \\"creator\\": \\"103*******\\",\\n \\"kyuubiServiceId\\": \\"kb-070104e7631242448d12a1377c309f30\\",\\n \\"innerEndpoint\\": \\"kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com\\",\\n \\"publicEndpoint\\": \\"emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com\\",\\n \\"releaseVersion\\": \\"esr-4.2.0 (Spark 3.5.2, Scala 2.12)\\\\n\\",\\n \\"computeInstance\\": \\"4C16G\\",\\n \\"replica\\": 3,\\n \\"kyuubiReleaseVersion\\": \\"1.9.2-0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListKyuubiServices', ], 'CreateKyuubiService' => [ 'summary' => 'CreateKyuubiService', 'path' => '/api/v1/kyuubi/{workspaceId}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'kyuubiConfigs' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[{\\"key\\":\\"kyuubi.engine.share.level\\",\\"value\\":\\"USER\\"}]', ], 'sparkConfigs' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[{\\"key\\":\\"spark.app.name\\",\\"value\\":\\"test\\"}]', ], 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_serverless_spark', ], 'queue' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_queue', ], 'computeInstance' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2c8g', ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'esr-4.6.0 (Spark 3.5.2, Scala 2.12)', ], 'publicEndpointEnabled' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], 'replica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', ], 'kyuubiReleaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1.9.2-0.0.2', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'kyuubiServiceId' => [ 'description' => 'Kyuubi Service ID。', 'type' => 'string', 'example' => 'kb-f99935b350fb4****7ef700b8b4197a3', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\",\\n \\"data\\": {\\n \\"kyuubiServiceId\\": \\"kb-f99935b350fb4****7ef700b8b4197a3\\"\\n }\\n}","type":"json"}]', ], 'GetKyuubiService' => [ 'summary' => 'GetKyuubiService', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-cea2c314a****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-415ddee******f1d1eac0388b86', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '8CE06D75-E6A2-505D-9B4B-31DEE3D98A04', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'kyuubiConfigs' => [ 'description' => '', 'type' => 'string', 'example' => '[]', ], 'sparkConfigs' => [ 'description' => '', 'type' => 'string', 'example' => '[]', ], 'state' => [ 'description' => '', 'type' => 'string', 'example' => 'RUNNING', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'dev_serverless_spark'."\n", ], 'queue' => [ 'description' => '', 'type' => 'string', 'example' => 'dev_queue', ], 'createTime' => [ 'description' => '', 'type' => 'string', 'example' => '1749456094000', ], 'startTime' => [ 'description' => '', 'type' => 'string', 'example' => '1749456094000', ], 'creator' => [ 'description' => '', 'type' => 'string', 'example' => '150978934701****', ], 'kyuubiServiceId' => [ 'description' => 'Kyuubi Service ID。', 'type' => 'string', 'example' => 'kb-4e209b04588***95f04ad3538ae4', ], 'innerEndpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'kyuubi-cn-beijing-internal.spark.emr.aliyuncs.com', ], 'publicEndpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'emr-spark-kyuubi-gateway-cn-beijing.aliyuncs.com', ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'example' => 'esr-4.6.0 (Spark 3.5.2, Scala 2.12)', ], 'computeInstance' => [ 'description' => '', 'type' => 'string', 'example' => '2c8g', ], 'publicEndpointEnabled' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'replica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'kyuubiReleaseVersion' => [ 'description' => '', 'type' => 'string', 'example' => '1.9.2-0.0.2', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8CE06D75-E6A2-505D-9B4B-31DEE3D98A04\\",\\n \\"data\\": {\\n \\"kyuubiConfigs\\": \\"[]\\",\\n \\"sparkConfigs\\": \\"[]\\",\\n \\"state\\": \\"RUNNING\\",\\n \\"name\\": \\"dev_serverless_spark\\\\n\\",\\n \\"queue\\": \\"dev_queue\\",\\n \\"createTime\\": \\"1749456094000\\",\\n \\"startTime\\": \\"1749456094000\\",\\n \\"creator\\": \\"150978934701****\\",\\n \\"kyuubiServiceId\\": \\"kb-4e209b04588***95f04ad3538ae4\\",\\n \\"innerEndpoint\\": \\"kyuubi-cn-beijing-internal.spark.emr.aliyuncs.com\\",\\n \\"publicEndpoint\\": \\"emr-spark-kyuubi-gateway-cn-beijing.aliyuncs.com\\",\\n \\"releaseVersion\\": \\"esr-4.6.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"computeInstance\\": \\"2c8g\\",\\n \\"publicEndpointEnabled\\": true,\\n \\"replica\\": 0,\\n \\"kyuubiReleaseVersion\\": \\"1.9.2-0.0.2\\"\\n }\\n}","type":"json"}]', ], 'UpdateKyuubiService' => [ 'summary' => 'UpdateKyuubiService', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'kyuubiConfigs' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[]', ], 'sparkConfigs' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '[]', ], 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_serverless_spark'."\n", ], 'queue' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_queue', ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'esr-4.6.0 (Spark 3.5.2, Scala 2.12)', ], 'computeInstance' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2c8g', ], 'publicEndpointEnabled' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], 'replica' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'kyuubiReleaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1.9.2-0.0.2', ], 'restart' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'any', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], 'DeleteKyuubiService' => [ 'summary' => 'DeleteKyuubiService', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'any', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], 'StartKyuubiService' => [ 'summary' => 'StartKyuubiService', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/start', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-cea2c314a****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-415ddee******f1d1eac0388b86', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => '', 'type' => 'any', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], 'StopKyuubiService' => [ 'summary' => 'StopKyuubiService', 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/stop', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREemapreduce5JTF6C', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", ], 'data' => [ 'description' => '', 'type' => 'any', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], 'ListLivyComputeSessions' => [ 'summary' => '获取livy gateway历史session', 'path' => '/api/v1/workspaces/{workspaceId}/livycompute/{livyComputeId}/session', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '246258', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], 'autoTest' => false, 'notSupportAutoTestReason' => '不支持', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d80f373d3ace824f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', ], ], [ 'name' => 'pageNum', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '8FAA8EEC-3026-5D15-8733-4E2A3DD970A1', ], 'totalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'sessions' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test_session', ], 'computeId' => [ 'description' => '', 'type' => 'string', 'example' => 'lc-xxxxxx', ], 'sessionId' => [ 'description' => '', 'type' => 'string', 'example' => 'livy-xxxxxx', ], 'sparkConf' => [ 'description' => '', 'type' => 'string', 'example' => '{'."\n" .' "proxyUser": "test",'."\n" .' "conf": {'."\n" .' "spark.driver.cores": 1'."\n" .' }'."\n" .'}', ], 'state' => [ 'description' => '', 'type' => 'string', 'example' => 'running', 'enum' => [ 'starting', 'running', 'error', 'terminated', 'terminating', ], ], 'info' => [ 'description' => '', 'type' => 'string', 'example' => 'null', ], 'createTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1768213240000', ], 'webUI' => [ 'description' => '', 'type' => 'string', 'example' => 'http://emr-spark-ui-cn-hangzhou.data.aliyun.com', ], 'endTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1768213240000', ], 'queue' => [ 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'cuHours' => [ 'description' => '', 'type' => 'number', 'format' => 'double', 'example' => '322.5', ], 'vcoreSeconds' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '343', ], 'mbSeconds' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1098888', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FAA8EEC-3026-5D15-8733-4E2A3DD970A1\\",\\n \\"totalCount\\": 10,\\n \\"sessions\\": [\\n {\\n \\"name\\": \\"test_session\\",\\n \\"computeId\\": \\"lc-xxxxxx\\",\\n \\"sessionId\\": \\"livy-xxxxxx\\",\\n \\"sparkConf\\": \\"{\\\\n \\\\\\"proxyUser\\\\\\": \\\\\\"test\\\\\\",\\\\n \\\\\\"conf\\\\\\": {\\\\n \\\\\\"spark.driver.cores\\\\\\": 1\\\\n }\\\\n}\\",\\n \\"state\\": \\"running\\",\\n \\"info\\": \\"null\\",\\n \\"createTime\\": 1768213240000,\\n \\"webUI\\": \\"http://emr-spark-ui-cn-hangzhou.data.aliyun.com\\",\\n \\"endTime\\": 1768213240000,\\n \\"queue\\": \\"root_queue\\",\\n \\"cuHours\\": 322.5,\\n \\"vcoreSeconds\\": 343,\\n \\"mbSeconds\\": 1098888\\n }\\n ]\\n}","type":"json"}]', ], 'DeleteLivyCompute' => [ 'summary' => '删除livy compute', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '222245', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'CreateLivyCompute' => [ 'summary' => '创建Livy compute', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '222228', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'testGateway', ], 'livyVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '0.8.0', 'enum' => [ '0.8.0', ], ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)', ], 'queueName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'cpuLimit' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 1 => '1', '2', 4 => '4', ], 'example' => '1', ], 'memoryLimit' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ '16Gi' => '16Gi', '4Gi' => '4Gi', '8Gi' => '8Gi', ], 'example' => '4Gi', ], 'autoStartConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'autoStopConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'idleTimeoutMinutes' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', ], ], 'required' => false, ], 'authType' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Token', 'enum' => [ 'Token', ], ], 'displayReleaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12)'."\n", ], 'fusion' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'environmentId' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ev-ctfq0fem1hkhgv4hapng', ], 'networkName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'livyServerConf' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "sparkDefaultsConf": "spark.driver.cores 1\\nspark.driver.memory 4g\\nspark.executor.cores 1\\nspark.executor.memory 4g\\n",'."\n" .' "sparkBlackListConf": "spark.driver.cores\\nspark.driver.memory",'."\n" .' "livyConf": "livy.server.session.timeout 1h\\n",'."\n" .' "livyClientConf": "livy.rsc.sql.num-rows 1000\\n"'."\n" .'}', ], 'enablePublic' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'livyComputeId' => [ 'description' => '', 'type' => 'string', 'example' => 'lc-i8xogcdfa4fk3yn1', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"livyComputeId\\": \\"lc-i8xogcdfa4fk3yn1\\"\\n }\\n}","type":"json"}]', ], 'UpdateLivyCompute' => [ 'summary' => '更新livy compute', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '222234', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'livyVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '0.8.0', 'enum' => [ '0.8.0', ], ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)'."\n", ], 'queueName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'cpuLimit' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 1 => '1', '2', 4 => '4', ], 'example' => '1', ], 'memoryLimit' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ '16Gi' => '16Gi', '4Gi' => '4Gi', '8Gi' => '8Gi', ], 'example' => '4Gi', ], 'autoStartConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], 'autoStopConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'idleTimeoutMinutes' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', ], ], 'required' => false, ], 'authType' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Token', 'enum' => [ 'Token', ], ], 'displayReleaseVersion' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12)'."\n", ], 'fusion' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'environmentId' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ev-cq146allhtgkulp5smk0', ], 'networkName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'livyServerConf' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "sparkDefaultsConf": "spark.driver.cores 1\\nspark.driver.memory 4g\\nspark.executor.cores 1\\nspark.executor.memory 4g\\n",'."\n" .' "sparkBlackListConf": "spark.driver.cores\\nspark.driver.memory",'."\n" .' "livyConf": "livy.server.session.timeout 1h\\n",'."\n" .' "livyClientConf": "livy.rsc.sql.num-rows 1000\\n"'."\n" .'}', ], 'enablePublic' => [ 'description' => '', 'type' => 'boolean', 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'ListLivyCompute' => [ 'summary' => 'List the Livy Gateway.', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '222250', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'environmentId', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ev-cq31c7tlhtgm9nrrlj4g', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'livyComputes' => [ 'description' => '', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'computeId' => [ 'description' => '', 'type' => 'string', 'example' => 'lc-xxxxxxxxxxxx', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'queueName' => [ 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'status' => [ 'description' => '', 'type' => 'string', 'example' => 'RUNNING', 'enum' => [ 'RUNNING', 'STOPPED', 'STARTING', 'STOPPING', 'FAILED', ], ], 'endpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx', ], 'createdBy' => [ 'description' => '', 'type' => 'string', 'example' => 'alice', ], 'gmtCreate' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'startTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'endpointInner' => [ 'description' => '', 'type' => 'string', 'example' => 'emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"livyComputes\\": [\\n {\\n \\"computeId\\": \\"lc-xxxxxxxxxxxx\\",\\n \\"name\\": \\"test\\",\\n \\"queueName\\": \\"root_queue\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"endpoint\\": \\"emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx\\",\\n \\"createdBy\\": \\"alice\\",\\n \\"gmtCreate\\": 1749456094000,\\n \\"startTime\\": 1749456094000,\\n \\"endpointInner\\": \\"emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'ListLivyCompute', ], 'StartLivyCompute' => [ 'summary' => '启动livy compute', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/start', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222269', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'RefreshLivyComputeToken' => [ 'summary' => '更新Livy Compute的token', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '222308', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', ], ], [ 'name' => 'tokenId', 'in' => 'path', 'schema' => [ 'description' => 'Token ID。', 'type' => 'string', 'required' => false, 'example' => 'lctk-xxxxxxxx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'test', ], 'token' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'fe86812667f04v343', ], 'autoExpireConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'expireDays' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'GetLivyComputeToken' => [ 'summary' => '获取livy compute token', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '222371', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-6mkvn01zrg8rqhhv', ], ], [ 'name' => 'tokenId', 'in' => 'path', 'schema' => [ 'description' => 'Token ID。', 'type' => 'string', 'required' => false, 'example' => 'lctk-xxxxxxxx', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '484D9DDA-300D-525E-AF7A-0CCCA5C64A7A', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokenId' => [ 'description' => 'Token ID。', 'type' => 'string', 'example' => 'lctk-xxxxxxxxxx', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'token' => [ 'description' => '', 'type' => 'string', 'example' => 'd25561157a635bb', ], 'createdBy' => [ 'description' => '', 'type' => 'string', 'example' => 'alice', ], 'createTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'expireTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749457994000', ], 'lastUsedTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456098000', ], 'autoExpireConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'expireDays' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"484D9DDA-300D-525E-AF7A-0CCCA5C64A7A\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"tokenId\\": \\"lctk-xxxxxxxxxx\\",\\n \\"name\\": \\"test\\",\\n \\"token\\": \\"d25561157a635bb\\",\\n \\"createdBy\\": \\"alice\\",\\n \\"createTime\\": 1749456094000,\\n \\"expireTime\\": 1749457994000,\\n \\"lastUsedTime\\": 1749456098000,\\n \\"autoExpireConfiguration\\": {\\n \\"enable\\": false,\\n \\"expireDays\\": 7\\n }\\n }\\n}","type":"json"}]', ], 'CreateLivyComputeToken' => [ 'summary' => '创建Livy Compute的token', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '222305', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'mytoken', ], 'token' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'gs3fy75w4o7hqe5s', ], 'autoExpireConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'expireDays' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', ], ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokenId' => [ 'description' => 'Token ID。', 'type' => 'string', 'example' => 'lctk-xxxxxxxx', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"tokenId\\": \\"lctk-xxxxxxxx\\"\\n }\\n}","type":"json"}]', ], 'DeleteLivyComputeToken' => [ 'summary' => '删除Livy Compute的token', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '222309', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', ], ], [ 'name' => 'tokenId', 'in' => 'path', 'schema' => [ 'description' => 'Token ID。', 'type' => 'string', 'required' => false, 'example' => 'lctk-xxxxxxxxxx', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'StopLivyCompute' => [ 'summary' => '停止livy compute', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/stop', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '222278', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-6mkvn01zrg8rqhhv', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '484D9DDA-300D-525E-AF7A-0CCCA5C64A7A', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"484D9DDA-300D-525E-AF7A-0CCCA5C64A7A\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'ListLivyComputeToken' => [ 'summary' => '列出livy compute token', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '222370', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokens' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'tokenId' => [ 'description' => 'Token ID。', 'type' => 'string', 'example' => 'lctk-xxxxxxxxxxx', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'token' => [ 'description' => '', 'type' => 'string', 'example' => '5d37843fb6f1e8', ], 'createdby' => [ 'description' => '', 'type' => 'string', 'example' => 'alice', ], 'createTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'expireTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456994000', ], 'lastUsedTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456098000', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"tokens\\": [\\n {\\n \\"tokenId\\": \\"lctk-xxxxxxxxxxx\\",\\n \\"name\\": \\"test\\",\\n \\"token\\": \\"5d37843fb6f1e8\\",\\n \\"createdby\\": \\"alice\\",\\n \\"createTime\\": 1749456094000,\\n \\"expireTime\\": 1749456994000,\\n \\"lastUsedTime\\": 1749456098000\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'GetLivyCompute' => [ 'summary' => '获取livy compute', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '222260', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'livyComputeId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'string', 'example' => '1000000', ], 'message' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'computeId' => [ 'description' => '', 'type' => 'string', 'example' => 'lc-xxxxxxxxxxxxx', ], 'name' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'livyVersion' => [ 'description' => '', 'type' => 'string', 'example' => '0.8.0', 'enum' => [ '0.8.0', ], ], 'releaseVersion' => [ 'description' => '', 'type' => 'string', 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)'."\n", ], 'queueName' => [ 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'cpuLimit' => [ 'description' => '', 'type' => 'string', 'enumValueTitles' => [ 1 => '1', '2', 4 => '4', ], 'example' => '1', ], 'memoryLimit' => [ 'description' => '', 'type' => 'string', 'enumValueTitles' => [ '16Gi' => '16Gi', '4Gi' => '4Gi', '8Gi' => '8Gi', ], 'example' => '4Gi', ], 'autoStopConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'enable' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'idleTimeoutMinutes' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '300', ], ], ], 'authType' => [ 'description' => '', 'type' => 'string', 'example' => 'Token', 'enum' => [ 'Token', ], ], 'status' => [ 'description' => '', 'type' => 'string', 'example' => 'RUNNING', 'enum' => [ 'RUNNING', 'STOPPED', 'STARTING', 'STOPPING', 'FAILED', ], ], 'endpoint' => [ 'description' => '', 'type' => 'string', 'example' => 'emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx', ], 'createdBy' => [ 'description' => '', 'type' => 'string', 'example' => 'alice', ], 'ramUserId' => [ 'description' => '', 'type' => 'string', 'example' => '10000001', ], 'displayReleaseVersion' => [ 'description' => '', 'type' => 'string', 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12)', ], 'fusion' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false'."\n", ], 'startTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'gmtCreate' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', ], 'environmentId' => [ 'description' => '', 'type' => 'string', 'example' => 'ev-cq31c7tlhtgm9nrrlj4g', ], 'endpointInner' => [ 'description' => '', 'type' => 'string', 'example' => 'emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx', ], 'networkName' => [ 'description' => '', 'type' => 'string', 'example' => 'test', ], 'livyServerConf' => [ 'description' => '', 'type' => 'string', 'example' => ' '."\n" .'{'."\n" .' "sparkDefaultsConf": "spark.driver.cores 1\\nspark.driver.memory 4g\\nspark.executor.cores 1\\nspark.executor.memory 4g\\n",'."\n" .' "sparkBlackListConf": "spark.driver.cores\\nspark.driver.memory",'."\n" .' "livyConf": "livy.server.session.timeout 1h\\n",'."\n" .' "livyClientConf": "livy.rsc.sql.num-rows 1000\\n"'."\n" .'}', ], 'enablePublic' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"computeId\\": \\"lc-xxxxxxxxxxxxx\\",\\n \\"name\\": \\"test\\",\\n \\"livyVersion\\": \\"0.8.0\\",\\n \\"releaseVersion\\": \\"esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)\\\\n\\",\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpuLimit\\": \\"1\\",\\n \\"memoryLimit\\": \\"4Gi\\",\\n \\"autoStopConfiguration\\": {\\n \\"enable\\": false,\\n \\"idleTimeoutMinutes\\": 300\\n },\\n \\"authType\\": \\"Token\\",\\n \\"status\\": \\"RUNNING\\",\\n \\"endpoint\\": \\"emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx\\",\\n \\"createdBy\\": \\"alice\\",\\n \\"ramUserId\\": \\"10000001\\",\\n \\"displayReleaseVersion\\": \\"esr-4.3.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"fusion\\": true,\\n \\"startTime\\": 1749456094000,\\n \\"gmtCreate\\": 1749456094000,\\n \\"environmentId\\": \\"ev-cq31c7tlhtgm9nrrlj4g\\",\\n \\"endpointInner\\": \\"emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx\\",\\n \\"networkName\\": \\"test\\",\\n \\"livyServerConf\\": \\"\\\\t\\\\n{\\\\n \\\\\\"sparkDefaultsConf\\\\\\": \\\\\\"spark.driver.cores 1\\\\\\\\nspark.driver.memory 4g\\\\\\\\nspark.executor.cores 1\\\\\\\\nspark.executor.memory 4g\\\\\\\\n\\\\\\",\\\\n \\\\\\"sparkBlackListConf\\\\\\": \\\\\\"spark.driver.cores\\\\\\\\nspark.driver.memory\\\\\\",\\\\n \\\\\\"livyConf\\\\\\": \\\\\\"livy.server.session.timeout 1h\\\\\\\\n\\\\\\",\\\\n \\\\\\"livyClientConf\\\\\\": \\\\\\"livy.rsc.sql.num-rows 1000\\\\\\\\n\\\\\\"\\\\n}\\",\\n \\"enablePublic\\": true\\n }\\n}","type":"json"}]', ], 'GetTemplate' => [ 'summary' => 'Queries task templates.', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/template', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191100', 'abilityTreeNodes' => [ 'FEATUREemapreduceUECZZL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'templateType', 'in' => 'query', 'schema' => [ 'description' => 'The template type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* TASK'."\n" .'* SESSION'."\n", 'type' => 'string', 'required' => false, 'example' => 'TASK', 'default' => 'TASK', 'enum' => [ 'TASK', 'SESSION', ], ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'templateBizId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'httpStatusCode' => [ 'title' => 'Id of the request', 'description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', ], 'errorCode' => [ 'description' => '* If the value of success was false, an error code was returned.'."\n" .'* If the value of success was true, a null value was returned.'."\n", 'type' => 'string', 'example' => '040003', ], 'errorMessage' => [ 'description' => '* If the value of success was false, an error message was returned.'."\n" .'* If the value of success was true, a null value was returned.'."\n", 'type' => 'string', 'example' => 'InvalidUser.NotFound', ], 'data' => [ 'description' => 'The returned data.'."\n", '$ref' => '#/components/schemas/Template', ], 'success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'True', ], 'requestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '484D9DDA-300D-525E-AF7A-0CCCA5C64A7A', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"httpStatusCode\\": \\"200\\",\\n \\"errorCode\\": \\"040003\\",\\n \\"errorMessage\\": \\"InvalidUser.NotFound\\",\\n \\"data\\": {\\n \\"templateType\\": \\"\\",\\n \\"gmtModified\\": \\"\\",\\n \\"creator\\": 0,\\n \\"sparkLogLevel\\": \\"\\",\\n \\"gmtCreated\\": \\"\\",\\n \\"sparkDriverMemory\\": 0,\\n \\"modifier\\": 0,\\n \\"sparkExecutorCores\\": 0,\\n \\"sparkConf\\": [\\n {\\n \\"value\\": \\"\\",\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"sparkVersion\\": \\"\\",\\n \\"sparkExecutorMemory\\": 0,\\n \\"fusion\\": true,\\n \\"isDefault\\": true,\\n \\"sparkDriverCores\\": 0,\\n \\"displaySparkVersion\\": \\"\\",\\n \\"sparkLogPath\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"bizId\\": \\"\\"\\n },\\n \\"success\\": true,\\n \\"requestId\\": \\"484D9DDA-300D-525E-AF7A-0CCCA5C64A7A\\"\\n}","type":"json"}]', 'title' => 'GetTemplate', ], 'TerminateSqlStatement' => [ 'summary' => 'Terminates an SQL query task.', 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement/{statementId}/terminate', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '224753', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'statementId', 'in' => 'path', 'schema' => [ 'description' => 'The interactive query ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'st-abcadfadf12****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'TerminateSqlStatement', ], 'CreateSqlStatement' => [ 'summary' => 'Creates an SQL query task.', 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '224750', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'flat', 'schema' => [ 'description' => 'The request body.'."\n", 'type' => 'object', 'properties' => [ 'codeContent' => [ 'description' => 'The SQL code. You can specify one or more SQL statements.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES', ], 'defaultDatabase' => [ 'description' => 'The name of the default database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], 'limit' => [ 'description' => 'The maximum number of entries to return. Valid values: 1 to 10000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'default' => '1000', ], 'defaultCatalog' => [ 'description' => 'The default Data Lake Formation (DLF) catalog ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default_catalog', ], 'sqlComputeId' => [ 'description' => 'The SQL session ID. You can create an SQL session in the workspace created in EMR Serverless Spark.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sc-dfahdfjafhajd****', ], 'taskBizId' => [ 'type' => 'string', ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'statementId' => [ 'description' => 'The interactive query ID.'."\n", 'type' => 'string', 'example' => 'st-1231dfafadfa***', ], ], ], 'requestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"statementId\\": \\"st-1231dfafadfa***\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'CreateSqlStatement', ], 'GetSqlStatement' => [ 'summary' => 'Queries the status of an SQL query task.', 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement/{statementId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '224752', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'statementId', 'in' => 'path', 'schema' => [ 'description' => 'The interactive query ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'st-2dadfhajk11cv****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'statementId' => [ 'description' => 'The query ID.'."\n", 'type' => 'string', 'example' => 'st-1231311abadfaa', ], 'state' => [ 'description' => 'The query status.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* running'."\n" .'* available'."\n" .'* cancelled'."\n" .'* error'."\n" .'* cancelling'."\n", 'type' => 'string', 'enumValueTitles' => [ 'running' => 'running', 'available' => 'available', 'cancelled' => 'cancelled', 'error' => 'error', 'cancelling' => 'cancelling', ], 'example' => 'running', 'enum' => [ 'running', 'error', 'waiting', 'cancelling', 'cancelled', 'available', 'success', ], ], 'sqlOutputs' => [ 'description' => 'The query results.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'rows' => [ 'description' => 'The queried data, which is a string in the JSON format.'."\n", 'type' => 'string', 'example' => '[{\\"values\\":[\\"test_db\\",\\"test_table\\",false]}', ], 'schema' => [ 'description' => 'The information about the schema, which is a string in the JSON format.'."\n", 'type' => 'string', 'example' => '{\\"type\\":\\"struct\\",\\"fields\\":[{\\"name\\":\\"namespace\\",\\"type\\":\\"string\\",\\"nullable\\":false,\\"metadata\\":{}},{\\"name\\":\\"tableName\\",\\"type\\":\\"string\\",\\"nullable\\":false,\\"metadata\\":{}},{\\"name\\":\\"isTemporary\\",\\"type\\":\\"boolean\\",\\"nullable\\":false,\\"metadata\\":{}}]}', ], 'rowsFilePath' => [ 'type' => 'string', ], ], ], ], 'sqlErrorCode' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'ERROR-102', ], 'sqlErrorMessage' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'error message', ], 'executionTime' => [ 'description' => 'The list of time that is consumed by SQL queries.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The time consumed by each SQL query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1717138731701', ], ], ], ], 'requestId' => [ 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"statementId\\": \\"st-1231311abadfaa\\",\\n \\"state\\": \\"running\\",\\n \\"sqlOutputs\\": [\\n {\\n \\"rows\\": \\"[{\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"test_db\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"test_table\\\\\\\\\\\\\\",false]}\\",\\n \\"schema\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"struct\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fields\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"namespace\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nullable\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{}},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"tableName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nullable\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{}},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"isTemporary\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"boolean\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nullable\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{}}]}\\",\\n \\"rowsFilePath\\": \\"\\"\\n }\\n ],\\n \\"sqlErrorCode\\": \\"ERROR-102\\",\\n \\"sqlErrorMessage\\": \\"error message\\",\\n \\"executionTime\\": [\\n 1717138731701\\n ]\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'GetSqlStatement', ], 'ListSqlStatementContents' => [ 'summary' => '获取sql statement内容', 'path' => '/api/v1/workspaces/{workspaceId}/action/listSqlStatementContents', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduceLNUXSK', ], ], 'parameters' => [ [ 'name' => 'fileName', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'oss://oss-****.cn-hangzhou.oss-dls.aliyuncs.com/w-86a9a4da*****a1/spark/logs/jr-b737b****6164d/driver/st-afde7******bb3f', ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-72704d9fb0******', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'sqlStatementContents' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'contents' => [ 'description' => '', 'type' => 'string', 'example' => '[{\\"values\\":[\\"wj*****\\",\\"test\\",\\"2025-04-15\\"]}]', ], 'nextToken' => [ 'description' => '', 'type' => 'string', 'example' => '1', ], 'maxResults' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'totalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '40000', ], ], ], 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sqlStatementContents\\": {\\n \\"contents\\": \\"[{\\\\\\\\\\\\\\"values\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"wj*****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"2025-04-15\\\\\\\\\\\\\\"]}]\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 2000,\\n \\"totalCount\\": 40000\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', ], 'CreateWorkspace' => [ 'summary' => 'Creates a workspace.', 'path' => '/api/v1/workspaces', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191902', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'description' => 'The request struct.'."\n", 'type' => 'object', 'properties' => [ 'workspaceName' => [ 'description' => 'The name of the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', ], 'resourceSpec' => [ 'description' => 'The resource specifications.'."\n", 'type' => 'object', 'properties' => [ 'cu' => [ 'description' => 'The maximum resource quota for a workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', ], ], 'required' => false, ], 'ossBucket' => [ 'description' => 'The name of the Object Storage Service (OSS) bucket.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/', ], 'dlfCatalogId' => [ 'description' => 'The information of the Data Lake Formation (DLF) catalog.'."\n", 'type' => 'string', 'required' => false, 'example' => '123xxxxx', ], 'paymentType' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'* PayAsYouGo'."\n" .'* Pre'."\n", 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo', ], 'paymentDurationUnit' => [ 'description' => 'The unit of the subscription duration.'."\n", 'type' => 'string', 'required' => false, 'example' => '1000', ], 'duration' => [ 'description' => 'The subscription period. This parameter is required only if the paymentType parameter is set to Pre.'."\n", 'type' => 'string', 'required' => false, 'example' => '12452', ], 'autoRenew' => [ 'description' => 'Specifies whether to enable auto-renewal. This parameter is required only if the paymentType parameter is set to Pre.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', ], 'autoRenewPeriod' => [ 'description' => 'The auto-renewal duration. This parameter is required only if the paymentType parameter is set to Pre.'."\n", 'type' => 'string', 'required' => false, 'example' => '100', ], 'autoRenewPeriodUnit' => [ 'description' => 'The unit of the auto-renewal duration. This parameter is required only if the paymentType parameter is set to Pre.'."\n", 'type' => 'string', 'required' => false, 'example' => 'month', ], 'clientToken' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '8e6aae2810c8f67229ca70bb31cd****', ], 'ramRoleName' => [ 'description' => 'The name of the role used to run Spark jobs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AliyunEMRSparkJobRunDefaultRole', ], 'autoStartSessionCluster' => [ 'description' => 'Specifies whether to automatically start a session.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'releaseType' => [ 'description' => 'The type of the version.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pro', ], 'dlfType' => [ 'description' => 'The version of DLF.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dlf1.0', 'default' => '1.0', ], 'tag' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => [ 'type' => 'string', ], 'value' => [ 'type' => 'string', ], ], ], 'maxItems' => 20, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'title' => 'Workspace Id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-******', ], 'operationId' => [ 'title' => 'Operation Id。', 'description' => 'The operation ID.'."\n", 'type' => 'string', 'example' => 'op-******', ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workspaceId\\": \\"w-******\\",\\n \\"operationId\\": \\"op-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'CreateWorkspace', ], 'ListWorkspaces' => [ 'summary' => 'Queries a list of workspaces.', 'path' => '/api/v1/workspaces', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192019', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '标记当前开始读取的位置。', 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '一次获取的最大记录数。', 'description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the workspace. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_workspace', ], ], [ 'name' => 'state', 'in' => 'query', 'schema' => [ 'description' => 'The state of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'running', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'tag', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => [ 'type' => 'string', 'required' => false, ], 'value' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'workspaces' => [ 'description' => 'The queried workspaces.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The details of the workspace.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'title' => 'Workspace Id。', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-******', ], 'workspaceName' => [ 'title' => '工作空间名称。', 'description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'spark-1', ], 'resourceSpec' => [ 'title' => '资源规格。', 'description' => 'The resource specifications.', 'type' => 'string', 'example' => '100cu', ], 'storage' => [ 'title' => 'oss 路径。', 'description' => 'The OSS path.', 'type' => 'string', 'example' => 'spark-result', ], 'dlfCatalogId' => [ 'title' => 'dlf catalog 信息。', 'description' => 'The information of the Data Lake Formation (DLF) catalog.', 'type' => 'string', 'example' => 'default', ], 'paymentType' => [ 'title' => '付费类型。', 'description' => 'The billing method. Valid values:'."\n" ."\n" .'- PayAsYouGo'."\n" .'- Pre', 'type' => 'string', 'example' => 'PayAsYouGo', ], 'paymentDurationUnit' => [ 'title' => '订购周期(pre付费类型必须)。', 'description' => 'The unit of the subscription duration.', 'type' => 'string', 'example' => 'YEAR, MONTH, WEEK, DAY, HOUR, MINUTE', ], 'duration' => [ 'title' => '订购周期数量(pre付费类型必须)。', 'description' => 'The subscription period. This parameter is required only if the paymentType parameter is set to Pre.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'autoRenew' => [ 'title' => '是否自动续费(pre付费类型必须)。', 'description' => 'Specifies whether to enable auto-renewal. This parameter is required only if the paymentType parameter is set to Pre.', 'type' => 'boolean', 'example' => 'true', ], 'autoRenewPeriod' => [ 'title' => '自动续费时长(pre付费类型必须)。', 'description' => 'The auto-renewal duration. This parameter is required only if the paymentType parameter is set to Pre.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'autoRenewPeriodUnit' => [ 'title' => '自动续费周期(pre付费类型必须)。', 'description' => 'The unit of the auto-renewal duration. This parameter is required only if the paymentType parameter is set to Pre.', 'type' => 'string', 'example' => 'YEAR, MONTH, WEEK, DAY, HOUR, MINUTE', ], 'workspaceStatus' => [ 'title' => '工作空间状态。', 'description' => 'The workspace status.', 'type' => 'string', 'example' => 'STARTING,RUNNING,TERMINATED', ], 'failReason' => [ 'title' => '失败原因。', 'description' => 'The failure reason.', 'type' => 'string', 'example' => 'out of stock', ], 'paymentStatus' => [ 'title' => '支付状态。', 'description' => 'The status of the payment.', 'type' => 'string', 'example' => 'PAID/UNPAID', ], 'regionId' => [ 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', ], 'createTime' => [ 'description' => 'The time when the workflow was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684115879955', ], 'endTime' => [ 'description' => 'The end of the end time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1687103999999', ], 'stateChangeReason' => [ 'description' => 'The reason of the job status change.', 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The error code.', 'type' => 'string', 'example' => '0', ], 'message' => [ 'description' => 'The error message.', 'type' => 'string', 'example' => 'Success', ], ], ], 'releaseType' => [ 'description' => 'The reason why the workspace is released.', 'type' => 'string', 'example' => 'SERVICE_RELEASE', ], 'dlfType' => [ 'description' => 'The version of DLF.'."\n", 'type' => 'string', 'example' => '1.0', ], 'prePaidQuota' => [ 'description' => 'The information about the subscription quota.'."\n", 'type' => 'object', 'properties' => [ 'usedResource' => [ 'description' => 'The amount of resources that are used.'."\n", 'type' => 'string', 'example' => '{\\"cpu\\":\\"0\\",\\"memory\\":\\"0Gi\\",\\"cu\\":\\"0\\"}', ], 'maxResource' => [ 'description' => 'The maximum amount of resources that can be used in a subscription quota.'."\n", 'type' => 'string', 'example' => '{\\"cpu\\":\\"1\\",\\"memory\\":\\"4Gi\\",\\"cu\\":\\"1\\"}', ], 'allocatedResource' => [ 'description' => 'The amount of resources that are allocated by a subscription quota.'."\n", 'type' => 'string', 'example' => '{\\"cpu\\":\\"1\\",\\"memory\\":\\"4Gi\\",\\"cu\\":\\"1\\"}', ], 'createTime' => [ 'description' => 'The creation time of the subscription quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1745683200000', ], 'expireTime' => [ 'description' => 'The expiration time of the subscription quota.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1740537153000', ], 'autoRenewal' => [ 'description' => 'Indicates whether auto-renewal is enabled for the subscription quota.'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true', ], 'paymentStatus' => [ 'description' => 'The status of the subscription quota. Valid values:'."\n" ."\n" .'* NORMAL'."\n" .'* WAIT_FOR_EXPIRE'."\n" .'* EXPIRED'."\n", 'type' => 'string', 'example' => 'NORMAL', ], 'instanceId' => [ 'description' => 'The ID of the instance that is generated when you purchase the subscription quota.'."\n", 'type' => 'string', 'example' => 'i-abc12345', ], 'orderId' => [ 'type' => 'string', ], ], ], 'tags' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'tagKey' => [ 'type' => 'string', ], 'tagValue' => [ 'type' => 'string', ], ], ], ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '下一页TOKEN。', 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '1', ], 'maxResults' => [ 'title' => '一次获取的最大记录数。', 'description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'title' => '记录总数。', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workspaces\\": [\\n {\\n \\"workspaceId\\": \\"w-******\\",\\n \\"workspaceName\\": \\"spark批作业空间-1\\",\\n \\"resourceSpec\\": \\"100cu\\",\\n \\"storage\\": \\"spark-result\\",\\n \\"dlfCatalogId\\": \\"default\\",\\n \\"paymentType\\": \\"PayAsYouGo or Subscription\\",\\n \\"paymentDurationUnit\\": \\"YEAR, MONTH, WEEK, DAY, HOUR, MINUTE\\",\\n \\"duration\\": 1,\\n \\"autoRenew\\": true,\\n \\"autoRenewPeriod\\": 1,\\n \\"autoRenewPeriodUnit\\": \\"YEAR, MONTH, WEEK, DAY, HOUR, MINUTE\\",\\n \\"workspaceStatus\\": \\"STARTING,RUNNING,TERMINATED\\",\\n \\"failReason\\": \\"out of stock\\",\\n \\"paymentStatus\\": \\"PAID/UNPAID\\",\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"createTime\\": 1684115879955,\\n \\"endTime\\": 1687103999999,\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"0\\",\\n \\"message\\": \\"Success\\"\\n },\\n \\"releaseType\\": \\"SERVICE_RELEASE\\",\\n \\"dlfType\\": \\"1.0\\",\\n \\"prePaidQuota\\": {\\n \\"usedResource\\": \\"{\\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0Gi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cu\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"}\\",\\n \\"maxResource\\": \\"{\\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4Gi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cu\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"allocatedResource\\": \\"{\\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4Gi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cu\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"createTime\\": 1745683200000,\\n \\"expireTime\\": 1740537153000,\\n \\"autoRenewal\\": true,\\n \\"paymentStatus\\": \\"NORMAL\\",\\n \\"instanceId\\": \\"i-abc12345\\",\\n \\"orderId\\": \\"\\"\\n },\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"\\",\\n \\"tagValue\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', 'title' => 'ListWorkspaces', ], 'ListWorkspaceQueues' => [ 'summary' => 'Queries the list of queues in a Spark workspace.', 'path' => '/api/v1/workspaces/{workspaceId}/queues', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192786', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d71e6e', ], ], [ 'name' => 'environment', 'in' => 'query', 'schema' => [ 'description' => 'The environment type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* dev'."\n" .'* production'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'dev' => 'dev', 'production' => 'production', ], 'example' => 'production', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'queues' => [ 'description' => 'The list of queues.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The queue details.'."\n", 'type' => 'object', 'properties' => [ 'regionId' => [ 'title' => 'regionId。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', ], 'queueName' => [ 'title' => '队列名称。', 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'example' => 'dev_queue', ], 'workspaceId' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-1234abcd', ], 'queueType' => [ 'title' => '队列类型', 'description' => 'The type of the queue. Valid values:'."\n" ."\n" .'* instance'."\n" .'* instanceChildren'."\n", 'type' => 'string', 'example' => 'instance, instanceChildren', ], 'properties' => [ 'title' => '队列Label', 'description' => 'The queue label.'."\n", 'type' => 'string', 'example' => 'dev_queue', ], 'queueScope' => [ 'title' => '队列架构', 'description' => 'The queue architecture.'."\n", 'type' => 'string', 'example' => '{"arch": "x86"}', ], 'maxResource' => [ 'title' => '队列资源最大容量', 'description' => 'The maximum capacity of resources that can be used in the queue.'."\n", 'type' => 'string', 'example' => '{"cpu": "2","memory": "2Gi"}', ], 'minResource' => [ 'title' => '队列资源最小容量', 'description' => 'The minimum capacity of resources that can be used in the queue.'."\n", 'type' => 'string', 'example' => '{"cpu": "2","memory": "2Gi"}', ], 'usedResource' => [ 'title' => '队列资源使用容量', 'description' => 'The capacity of resources that are used in the queue.'."\n", 'type' => 'string', 'example' => '{"cpu": "2","memory": "2Gi"}', ], 'queueStatus' => [ 'description' => 'The status of the queue.'."\n", 'type' => 'string', 'example' => 'RUNNING', ], 'creator' => [ 'description' => 'The ID of the user who created the queue.'."\n", 'type' => 'string', 'example' => '237109', ], 'allowActions' => [ 'title' => '队列允许的操作', 'description' => 'The operations allowed for the queue.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The operation allowed for the queue.'."\n", 'type' => 'object', 'properties' => [ 'actionArn' => [ 'title' => '行为 arn。', 'description' => 'The Alibaba Cloud Resource Name (ARN) of a behavior.'."\n", 'type' => 'string', 'example' => 'acs:emr::workspaceId:action/create_queue', ], 'actionName' => [ 'title' => '权限名称。', 'description' => 'The name of the permission.'."\n", 'type' => 'string', 'example' => 'view', ], 'displayName' => [ 'title' => '权限展示名称。', 'description' => 'The display name of the permission.'."\n", 'type' => 'string', 'example' => '文件目录遍历、文件浏览', ], 'description' => [ 'title' => 'action 描述。', 'description' => 'The description of the operation.'."\n", 'type' => 'string', 'example' => '文件目录遍历、文件浏览', ], 'dependencies' => [ 'title' => 'action 依赖列表。', 'description' => 'The dependencies of the operation.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The dependency of the operation.'."\n", 'type' => 'string', 'example' => 'view', ], 'example' => '["view"]', ], ], ], ], 'environments' => [ 'description' => 'The environment types of the queue.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The environment type of the queue.'."\n", 'type' => 'string', 'example' => 'production', ], ], 'paymentType' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'* PayAsYouGo'."\n" .'* Pre'."\n", 'type' => 'string', 'example' => 'PayAsYouGo', ], 'createTime' => [ 'description' => 'The time when the workspace was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1684115879955', ], 'preheat' => [ 'title' => '是否进行资源预热'."\n", 'type' => 'boolean', ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '下一页TOKEN。', 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '1', ], 'maxResults' => [ 'title' => '一次获取的最大记录数。', 'description' => 'The maximum number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'title' => '记录总数。', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"queues\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"queueName\\": \\"dev_queue\\",\\n \\"workspaceId\\": \\"w-1234abcd\\",\\n \\"queueType\\": \\"instance\\",\\n \\"properties\\": \\"dev_queue\\",\\n \\"queueScope\\": \\"{\\\\\\"arch\\\\\\": \\\\\\"x86\\\\\\"}\\",\\n \\"maxResource\\": \\"{\\\\\\"cpu\\\\\\": \\\\\\"2\\\\\\",\\\\\\"memory\\\\\\": \\\\\\"2Gi\\\\\\"}\\",\\n \\"minResource\\": \\"{\\\\\\"cpu\\\\\\": \\\\\\"2\\\\\\",\\\\\\"memory\\\\\\": \\\\\\"2Gi\\\\\\"}\\",\\n \\"usedResource\\": \\"{\\\\\\"cpu\\\\\\": \\\\\\"2\\\\\\",\\\\\\"memory\\\\\\": \\\\\\"2Gi\\\\\\"}\\",\\n \\"queueStatus\\": \\"RUNNING\\",\\n \\"creator\\": \\"237109\\",\\n \\"allowActions\\": [\\n {\\n \\"actionArn\\": \\"acs:emr::workspaceId:action/create_queue\\",\\n \\"actionName\\": \\"view\\",\\n \\"displayName\\": \\"文件目录遍历、文件浏览\\",\\n \\"description\\": \\"文件目录遍历、文件浏览\\",\\n \\"dependencies\\": [\\n \\"view\\"\\n ]\\n }\\n ],\\n \\"environments\\": [\\n \\"production\\"\\n ],\\n \\"paymentType\\": \\"PayAsYouGo\\",\\n \\"createTime\\": 1684115879955,\\n \\"preheat\\": true\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', 'title' => 'ListWorkspaceQueues', ], 'EditWorkspaceQueue' => [ 'summary' => 'Modifies the queue of a workspace.', 'path' => '/api/v1/workspaces/queues/action/edit', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192830', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-975bcfda9625****', ], 'resourceSpec' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'cu' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], 'maxCu' => [ 'title' => '最大cu数', 'type' => 'integer', 'format' => 'int64', 'example' => '0.5', ], ], 'required' => false, ], 'workspaceQueueName' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'dev_queue', ], 'environments' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'prod', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'EditWorkspaceQueue', ], 'ListReleaseVersions' => [ 'summary' => 'Queries the list of published versions of E-MapReduce (EMR) Serverless Spark.', 'path' => '/api/v1/releaseVersions', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192442', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'serviceFilter', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'releaseVersion', 'in' => 'query', 'schema' => [ 'description' => 'The version of EMR Serverless Spark.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)', ], ], [ 'name' => 'releaseVersionStatus', 'in' => 'query', 'schema' => [ 'description' => 'The status of the version.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* ONLINE'."\n" .'* OFFLINE'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'ONLINE' => '', 'OFFLINE' => '', ], 'example' => 'ONLINE', ], ], [ 'name' => 'releaseType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the version.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* stable'."\n" .'* Beta', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'stable' => '', 'beta' => '', ], 'example' => 'stable', ], ], [ 'name' => 'workspaceId', 'in' => 'query', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'releaseVersions' => [ 'description' => 'The versions.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The version.'."\n", 'type' => 'object', 'properties' => [ 'releaseVersion' => [ 'description' => 'The version number.'."\n", 'type' => 'string', 'example' => 'esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)', ], 'state' => [ 'description' => 'The status of the version.'."\n", 'type' => 'string', 'example' => 'ONLINE', ], 'type' => [ 'description' => 'The type of the version.'."\n", 'type' => 'string', 'example' => 'stable', ], 'iaasType' => [ 'description' => 'The type of the Infrastructure as a Service (IaaS) layer.'."\n", 'type' => 'string', 'example' => 'ASI', ], 'gmtCreate' => [ 'description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1716215854101', ], 'scalaVersion' => [ 'description' => 'The version of Scala.'."\n", 'type' => 'string', 'example' => '2.12', ], 'communityVersion' => [ 'description' => 'The version number of open source Spark.'."\n", 'type' => 'string', 'example' => 'Spark 3.3.1', ], 'cpuArchitectures' => [ 'description' => 'The CPU architectures.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The CPU architecture.'."\n", 'type' => 'string', 'example' => 'x86', ], ], 'displayReleaseVersion' => [ 'description' => 'The version number.'."\n", 'type' => 'string', 'example' => 'esr-2.1 (Spark 3.3.1, Scala 2.12)', ], 'fusion' => [ 'description' => 'Indicates whether the Fusion engine is used for acceleration.'."\n", 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '', 'false' => '', ], 'example' => 'true', ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '下一页TOKEN。', 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '1', ], 'maxResults' => [ 'title' => '一次获取的最大记录数。', 'description' => 'The maximum number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'title' => '记录总数。', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"releaseVersions\\": [\\n {\\n \\"releaseVersion\\": \\"esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)\\",\\n \\"state\\": \\"ONLINE\\",\\n \\"type\\": \\"stable\\",\\n \\"iaasType\\": \\"ASI\\",\\n \\"gmtCreate\\": 1716215854101,\\n \\"scalaVersion\\": \\"2.12\\",\\n \\"communityVersion\\": \\"Spark 3.3.1\\",\\n \\"cpuArchitectures\\": [\\n \\"x86\\"\\n ],\\n \\"displayReleaseVersion\\": \\"esr-2.1 (Spark 3.3.1, Scala 2.12)\\",\\n \\"fusion\\": true\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', 'title' => 'ListReleaseVersions', ], 'ListJobExecutors' => [ 'summary' => '列出作业的executors', 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}/executors', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231260', 'abilityTreeNodes' => [ 'FEATUREemapreduceT8XN05', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'jobRunId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'jr-f09a8fda2396****', ], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'status', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Dead', ], ], [ 'name' => 'executorType', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'driver', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'description' => '', 'type' => 'string', 'example' => '2', ], 'maxResults' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'exexutors' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'description' => '', 'type' => 'string', 'example' => 'w-78faee4da118f02e', ], 'jobRunId' => [ 'description' => '', 'type' => 'string', 'example' => 'jr-1fe145df8ade366a', ], 'executorId' => [ 'description' => '', 'type' => 'string', 'example' => '1', ], 'status' => [ 'description' => '', 'type' => 'string', 'example' => 'Running', ], 'hostPort' => [ 'description' => '', 'type' => 'string', 'example' => '21.10.x.x:1201x', ], 'rddBlocks' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'memoryUsed' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'diskUsed' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'totalCores' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'activeTasks' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'failedTasks' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'completedTasks' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], 'totalTasks' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'totalDuration' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'totalGCTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'totalInputBytes' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', ], 'totalShuffleRead' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2048', ], 'totalShuffleWrite' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2048'."\n", ], 'maxMemory' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '4294967296', ], 'addTime' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1760601***', ], 'executorType' => [ 'description' => '', 'type' => 'string', 'example' => 'driver', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200,\\n \\"exexutors\\": [\\n {\\n \\"workspaceId\\": \\"w-78faee4da118f02e\\",\\n \\"jobRunId\\": \\"jr-1fe145df8ade366a\\",\\n \\"executorId\\": \\"1\\",\\n \\"status\\": \\"Running\\",\\n \\"hostPort\\": \\"21.10.x.x:1201x\\",\\n \\"rddBlocks\\": 10,\\n \\"memoryUsed\\": 30,\\n \\"diskUsed\\": 20,\\n \\"totalCores\\": 4,\\n \\"activeTasks\\": 10,\\n \\"failedTasks\\": 2,\\n \\"completedTasks\\": 8,\\n \\"totalTasks\\": 50,\\n \\"totalDuration\\": 123,\\n \\"totalGCTime\\": 3,\\n \\"totalInputBytes\\": 1024,\\n \\"totalShuffleRead\\": 2048,\\n \\"totalShuffleWrite\\": 2048,\\n \\"maxMemory\\": 4294967296,\\n \\"addTime\\": 0,\\n \\"executorType\\": \\"driver\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListLogContents' => [ 'summary' => 'Get Log Content', 'path' => '/api/v1/workspaces/{workspaceId}/action/listLogContents', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194779', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'fileName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'Full path of the file.', 'type' => 'string', 'required' => false, 'example' => 'oss://datadev******.cn-hangzhou.oss-dls.aliyuncs.com/w-72704d9fb0******/spark/logs/jr-af51aa63cc******/driver/stdout.log', ], ], [ 'name' => 'offset', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'Start line for query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'length', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'Length of the log.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9999', ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'description' => 'Workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-72704d9fb0******', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'Returned data', 'type' => 'object', 'properties' => [ 'listLogContent' => [ 'description' => 'Log content.', 'type' => 'object', 'properties' => [ 'contents' => [ 'description' => 'List of log line contents.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LineContent' => [ 'description' => 'Log line content.', 'type' => 'string', 'example' => 'spark pi is 3.14\\n', ], ], ], ], 'totalLength' => [ 'description' => 'Total number of log lines.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"listLogContent\\": {\\n \\"contents\\": [\\n {\\n \\"LineContent\\": \\"spark pi is 3.14\\\\\\\\n\\"\\n }\\n ],\\n \\"totalLength\\": 10\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'Query Log Content', 'translator' => 'machine', ], 'GetCuHours' => [ 'summary' => 'Queries the number of CU-hours consumed by a queue during a specified cycle.', 'path' => '/api/v1/workspaces/{workspaceId}/metric/cuHours/{queue}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduceT8XN05', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-dsa23*****', ], ], [ 'name' => 'queue', 'in' => 'path', 'schema' => [ 'description' => 'The name of the queue.'."\n", 'type' => 'string', 'required' => true, 'example' => 'root_queue', ], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => [ 'description' => 'The start time of the query time range.'."\n", 'type' => 'string', 'required' => true, 'example' => '2024-01-01 00:00:00', ], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => [ 'description' => 'The end time of the query time range.'."\n", 'type' => 'string', 'required' => true, 'example' => '2024-01-08 00:00:00', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'cuHours' => [ 'description' => 'The number of CU-hours consumed by a queue during a specified cycle. The value is an estimated value. Refer to your Alibaba Cloud bill for the actual number of consumed CU-hours.'."\n", 'type' => 'string', 'example' => '{2025-01-09 00:00:00=2.033333, 2025-01-09 01:00:00=2.033333, 2025-01-09 02:00:00=2.033333, 2025-01-09 03:00:00=2.033333, 2025-01-09 04:00:00=2.033333, 2025-01-09 05:00:00=2.033333, 2025-01-09 06:00:00=2.033333, 2025-01-09 07:00:00=2.033333, 2025-01-09 08:00:00=2.033333, 2025-01-09 09:00:00=1.933333, 2025-01-09 10:00:00=2.133333, 2025-01-09 11:00:00=3.100000, 2025-01-09 12:00:00=2.900000}', ], ], 'example' => '{'."\n" .' "cuHours": "{2025-01-09 00:00:00=2.033333, 2025-01-09 01:00:00=2.033333, 2025-01-09 02:00:00=2.033333, 2025-01-09 03:00:00=2.033333, 2025-01-09 04:00:00=2.033333, 2025-01-09 05:00:00=2.033333, 2025-01-09 06:00:00=2.033333, 2025-01-09 07:00:00=2.033333, 2025-01-09 08:00:00=2.033333, 2025-01-09 09:00:00=1.933333, 2025-01-09 10:00:00=2.133333, 2025-01-09 11:00:00=3.100000, 2025-01-09 12:00:00=2.900000}"'."\n" .'}', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"cuHours\\": \\"{2025-01-09 00:00:00=2.033333, 2025-01-09 01:00:00=2.033333, 2025-01-09 02:00:00=2.033333, 2025-01-09 03:00:00=2.033333, 2025-01-09 04:00:00=2.033333, 2025-01-09 05:00:00=2.033333, 2025-01-09 06:00:00=2.033333, 2025-01-09 07:00:00=2.033333, 2025-01-09 08:00:00=2.033333, 2025-01-09 09:00:00=1.933333, 2025-01-09 10:00:00=2.133333, 2025-01-09 11:00:00=3.100000, 2025-01-09 12:00:00=2.900000}\\"\\n }\\n}","type":"json"}]', 'title' => 'GetCuHours', ], 'GetDoctorApplication' => [ 'summary' => 'Obtains job analysis information on E-MapReduce (EMR) Doctor.', 'path' => '/api/v1/workspaces/{workspaceId}/runs/{runId}/action/getDoctorApplication', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '193399', 'abilityTreeNodes' => [ 'FEATUREemapreduce60H0RM', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'runId', 'in' => 'path', 'schema' => [ 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jr-d2d82aa09155****', ], ], [ 'name' => 'queryTime', 'in' => 'query', 'schema' => [ 'description' => 'The query time.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-01-01', ], ], [ 'name' => 'locale', 'in' => 'query', 'schema' => [ 'description' => 'The language of diagnostic information.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'default' => 'zh-CN', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'suggestions' => [ 'description' => 'The diagnostics list.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The description of the diagnosis.'."\n", 'type' => 'string', 'example' => '', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"suggestions\\": [\\n \\"正常。\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'GetDoctorApplication', ], 'CancelJobRun' => [ 'summary' => 'Terminates a Spark job.', 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '215798', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-1234abcd', ], ], [ 'name' => 'jobRunId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '任务实例ID。', 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'jr-231231', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'jobRunId' => [ 'description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'jr-1a2bc3', ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobRunId\\": \\"jr-f09a8fda2396****\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'CancelJobRun', ], 'ListJobRuns' => [ 'summary' => 'Queries a list of Spark jobs.', 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '215800', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'nextToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '标记当前开始读取的位置。', 'description' => 'The pagination token that is used in the request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C89568980', ], ], [ 'name' => 'maxResults', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '一次获取的最大记录数。', 'description' => 'The maximum number of entries to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-1234abcd', ], ], [ 'name' => 'name', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '作业名称。', 'description' => 'The job name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr-spark-demo-job', ], ], [ 'name' => 'creator', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '创建用户Uid。', 'description' => 'The ID of the user who created the job.'."\n", 'type' => 'string', 'required' => false, 'example' => '1509789347011222', ], ], [ 'name' => 'jobRunId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '作业id。', 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'j-xxx', ], ], [ 'name' => 'tags', 'in' => 'query', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'title' => '标签。', 'description' => 'The tags of the job.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag of the job.'."\n", 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'The key of tag N.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tag_key', ], 'value' => [ 'description' => 'The value of tag N.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'states', 'in' => 'query', 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ 'title' => '作业状态。', 'description' => 'The job states.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The job state. Valid values:'."\n" ."\n" .'* Submitted'."\n" .'* Pending'."\n" .'* Running'."\n" .'* Success'."\n" .'* Failed'."\n" .'* Cancelling'."\n" .'* Cancelled'."\n" .'* CancelFailed'."\n", 'type' => 'string', 'required' => false, 'example' => 'Running', ], 'required' => false, 'example' => '["Running","Submitted"]', ], ], [ 'name' => 'startTime', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The range of start time.'."\n", 'type' => 'object', 'properties' => [ 'startTime' => [ 'description' => 'The beginning of the start time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709740800000', ], 'endTime' => [ 'description' => 'The end of the start time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710432000000', ], ], 'required' => false, ], ], [ 'name' => 'endTime', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The range of end time.'."\n", 'type' => 'object', 'properties' => [ 'startTime' => [ 'description' => 'The beginning of the end time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709740800000', ], 'endTime' => [ 'description' => 'The end of the end time range.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710432000000', ], ], 'required' => false, ], ], [ 'name' => 'resourceQueueId', 'in' => 'query', 'schema' => [ 'description' => 'The name of the resource queue on which the Spark jobs run.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dev_queue', ], ], [ 'name' => 'jobRunDeploymentId', 'in' => 'query', 'schema' => [ 'description' => 'The job run ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jd-b6d003f1930f****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'minDuration', 'in' => 'query', 'schema' => [ 'description' => 'The minimum running duration of the job. Unit: ms.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000', ], ], [ 'name' => 'isWorkflow', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'runtimeConfigs', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], [ 'name' => 'applicationConfigs', 'in' => 'query', 'schema' => [ 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'jobRuns' => [ 'description' => 'The Spark jobs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The Spark job.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-1234abcd', ], 'jobRunId' => [ 'title' => '任务实例ID。', 'description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'jr-231231', ], 'name' => [ 'title' => '作业实例名称。', 'description' => 'The job name.'."\n", 'type' => 'string', 'example' => 'jobName', ], 'state' => [ 'title' => '作业状态。', 'description' => 'The job state.'."\n", 'type' => 'string', 'example' => 'Running', ], 'stateChangeReason' => [ 'description' => 'The reason of the job status change.'."\n", 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => '0', ], 'message' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'success', ], ], ], 'submitTime' => [ 'title' => '作业提交时间。', 'description' => 'The time when the job was submitted.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', ], 'endTime' => [ 'title' => '作业结束时间。', 'description' => 'The end time of the job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', ], 'codeType' => [ 'title' => '作业代码类型。', 'description' => 'The code type of the job. Valid values:'."\n" ."\n" .'SQL'."\n" ."\n" .'JAR'."\n" ."\n" .'PYTHON'."\n", 'type' => 'string', 'example' => 'SQL', ], 'webUI' => [ 'title' => '作业web ui。', 'description' => 'The web UI of the job.'."\n", 'type' => 'string', 'example' => 'http://spark-ui', ], 'executionTimeoutSeconds' => [ 'title' => '运行超时时间。', 'description' => 'The timeout period of the job.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3600', ], 'creator' => [ 'title' => '创建用户Uid。', 'description' => 'The ID of the user who created the job.'."\n", 'type' => 'string', 'example' => '1509789347011222', ], 'tags' => [ 'title' => '标签。', 'description' => 'The tags of the job.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag.'."\n", '$ref' => '#/components/schemas/Tag', ], ], 'log' => [ 'description' => 'The path where the operational logs are stored.'."\n", '$ref' => '#/components/schemas/RunLog', ], 'releaseVersion' => [ 'description' => 'The version of Spark on which the jobs run.'."\n", 'type' => 'string', 'example' => 'esr-native-3.4.0', ], 'jobDriver' => [ 'description' => 'The information about Spark Driver.'."\n", '$ref' => '#/components/schemas/JobDriver', ], 'configurationOverrides' => [ 'description' => 'The advanced configurations of Spark.'."\n", 'type' => 'object', 'properties' => [ 'configurations' => [ 'description' => 'The SparkConf objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The SparkConf object.'."\n", '$ref' => '#/components/schemas/Configuration', ], ], ], ], 'displayReleaseVersion' => [ 'description' => 'The version of Spark on which the jobs run.'."\n", 'type' => 'string', 'example' => 'esr-3.0.0 (Spark 3.4.3, Scala 2.12)', ], 'fusion' => [ 'description' => 'Indicates whether the Fusion engine is used for acceleration.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'vcoreSeconds' => [ 'description' => 'The total number of CPU cores allocated to the job multiplied by the running duration (seconds).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '8236', ], 'mbSeconds' => [ 'description' => 'The total amount of memory allocated to the job multiplied by the running duration (seconds).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33030784', ], 'cuHours' => [ 'description' => 'The number of CUs consumed during a specified cycle of a task. The value is an estimated value. Refer to your Alibaba Cloud bill for the actual number of consumed CUs.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '2.059', ], 'resourceQueueId' => [ 'title' => '运行任务的队列名称。', 'type' => 'string', 'example' => 'dev_queue', ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '返回读取到的数据位置。', 'description' => 'A pagination token.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C89568980', ], 'maxResults' => [ 'title' => '本次请求所返回的最大记录条数。', 'description' => 'The maximum number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'totalCount' => [ 'title' => '本次请求条件下的数据总量。', 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobRuns\\": [\\n {\\n \\"workspaceId\\": \\"w-d2d82aa09155****\\",\\n \\"jobRunId\\": \\"jr-231231\\",\\n \\"name\\": \\"jobName\\",\\n \\"state\\": \\"Running\\",\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"0\\",\\n \\"message\\": \\"connection refused\\\\n\\"\\n },\\n \\"submitTime\\": 1684119314000,\\n \\"endTime\\": 1684119314000,\\n \\"codeType\\": \\"SQL\\",\\n \\"webUI\\": \\"http://spark-ui\\",\\n \\"executionTimeoutSeconds\\": 3600,\\n \\"creator\\": \\"150978934701****\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"workflowId\\",\\n \\"value\\": \\"wf-123test\\"\\n }\\n ],\\n \\"log\\": {\\n \\"driverStdOut\\": \\"\\",\\n \\"driverStdError\\": \\"\\",\\n \\"driverSyslog\\": \\"\\",\\n \\"driverStartup\\": \\"\\"\\n },\\n \\"releaseVersion\\": \\"esr-3.0.0 (Spark 3.4.3, Scala 2.12, Native Runtime)\\",\\n \\"jobDriver\\": {\\n \\"sparkSubmit\\": {\\n \\"entryPoint\\": \\"\\",\\n \\"entryPointArguments\\": [\\n \\"\\"\\n ],\\n \\"sparkSubmitParameters\\": \\"\\"\\n }\\n },\\n \\"configurationOverrides\\": {\\n \\"configurations\\": [\\n {\\n \\"configFileName\\": \\"\\",\\n \\"configItemKey\\": \\"\\",\\n \\"configItemValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"displayReleaseVersion\\": \\"esr-3.0.0 (Spark 3.4.3, Scala 2.12)\\",\\n \\"fusion\\": true,\\n \\"vcoreSeconds\\": 8236,\\n \\"mbSeconds\\": 33030784,\\n \\"cuHours\\": 2.059,\\n \\"resourceQueueId\\": \\"dev_queue\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', 'title' => 'ListJobRuns', ], 'GetJobRun' => [ 'summary' => 'Obtain the job details.', 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '215794', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-1234abcd', ], ], [ 'name' => 'jobRunId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '任务实例ID。', 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'jr-231231', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'jobRun' => [ 'description' => 'The details of the job.'."\n", 'type' => 'object', 'properties' => [ 'workspaceId' => [ 'title' => '工作空间id。', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'w-1234abcd', ], 'jobRunId' => [ 'title' => '任务实例ID。', 'description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'jr-231231', ], 'name' => [ 'title' => '作业实例名称。', 'description' => 'The job name.'."\n", 'type' => 'string', 'example' => 'jobName', ], 'state' => [ 'title' => '作业状态。', 'description' => 'The job state.'."\n", 'type' => 'string', 'example' => 'Running', ], 'stateChangeReason' => [ 'description' => 'The reason of the job status change.'."\n", 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'ERR-100000', ], 'message' => [ 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'connection refused', ], ], ], 'submitTime' => [ 'title' => '作业提交时间。', 'description' => 'The time when the job was submitted.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', ], 'endTime' => [ 'title' => '作业结束时间。', 'description' => 'The end time of the job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', ], 'codeType' => [ 'title' => '作业代码类型。', 'description' => 'The code type of the job. Valid values:'."\n" ."\n" .'* SQL'."\n" .'* JAR'."\n" .'* PYTHON'."\n", 'type' => 'string', 'example' => 'SQL', ], 'webUI' => [ 'title' => '作业web ui。', 'description' => 'The web UI of the job.'."\n", 'type' => 'string', 'example' => 'http://spark-ui', ], 'executionTimeoutSeconds' => [ 'title' => '运行超时时间。', 'description' => 'The timeout period of the job.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3600', ], 'resourceOwnerId' => [ 'title' => '创建用户Uid。', 'description' => 'The ID of the user who created the job.'."\n", 'type' => 'string', 'example' => '1509789347011222', ], 'tags' => [ 'title' => '标签。', 'description' => 'The tags of the job.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag of the job.'."\n", '$ref' => '#/components/schemas/Tag', ], ], 'log' => [ 'description' => 'The path where the operational logs are stored.'."\n", '$ref' => '#/components/schemas/RunLog', ], 'releaseVersion' => [ 'description' => 'The version of the Spark engine on which the job runs.'."\n", 'type' => 'string', 'example' => 'esr-3.3.1', ], 'resourceQueueId' => [ 'description' => 'The name of the queue on which the job runs.'."\n", 'type' => 'string', 'example' => 'root_queue', ], 'jobDriver' => [ 'description' => 'The information about Spark Driver.'."\n", '$ref' => '#/components/schemas/JobDriver', ], 'configurationOverrides' => [ 'description' => 'The configurations of the Spark jobs.'."\n", 'type' => 'object', 'properties' => [ 'configurations' => [ 'description' => 'The configurations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configuration.'."\n", '$ref' => '#/components/schemas/Configuration', ], ], ], ], 'displayReleaseVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', ], 'fusion' => [ 'description' => 'Indicates whether the Fusion engine is used for acceleration.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'environmentId' => [ 'description' => 'The environment ID.'."\n", 'type' => 'string', 'example' => 'env-cpv569tlhtgndjl8****', ], 'notebookAccessUrl' => [ 'title' => '如果Job类型为NOTEBOOK，此参数返回NOTEBOOK文件的下载链接', 'type' => 'string', 'example' => 'http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx', ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobRun\\": {\\n \\"workspaceId\\": \\"w-d2d82aa09155****\\",\\n \\"jobRunId\\": \\"jr-93d98d2f7061****\\",\\n \\"name\\": \\"jobName\\",\\n \\"state\\": \\"Running\\",\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"ERR-100000\\",\\n \\"message\\": \\"connection refused\\"\\n },\\n \\"submitTime\\": 1684119314000,\\n \\"endTime\\": 1684122914000,\\n \\"codeType\\": \\"SQL\\",\\n \\"webUI\\": \\"http://spark-ui\\",\\n \\"executionTimeoutSeconds\\": 3600,\\n \\"resourceOwnerId\\": \\"150978934701****\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"workflowId\\",\\n \\"value\\": \\"wf-123test\\"\\n }\\n ],\\n \\"log\\": {\\n \\"driverStdOut\\": \\"\\",\\n \\"driverStdError\\": \\"\\",\\n \\"driverSyslog\\": \\"\\",\\n \\"driverStartup\\": \\"\\"\\n },\\n \\"releaseVersion\\": \\"esr-3.3.1\\",\\n \\"resourceQueueId\\": \\"root_queue\\",\\n \\"jobDriver\\": {\\n \\"sparkSubmit\\": {\\n \\"entryPoint\\": \\"\\",\\n \\"entryPointArguments\\": [\\n \\"\\"\\n ],\\n \\"sparkSubmitParameters\\": \\"\\"\\n }\\n },\\n \\"configurationOverrides\\": {\\n \\"configurations\\": [\\n {\\n \\"configFileName\\": \\"\\",\\n \\"configItemKey\\": \\"\\",\\n \\"configItemValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"displayReleaseVersion\\": \\"esr-4.0.0 (Spark 3.5.2, Scala 2.12)\\",\\n \\"fusion\\": false,\\n \\"environmentId\\": \\"env-cpv569tlhtgndjl8****\\",\\n \\"notebookAccessUrl\\": \\"http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'GetJobRun', ], 'StartJobRun' => [ 'summary' => 'Starts a Spark job.', 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '215792', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request parameters.'."\n", 'type' => 'object', 'properties' => [ 'releaseVersion' => [ 'description' => 'The version number of Spark.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-3.3.1', ], 'jobId' => [ 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jr-12345', ], 'name' => [ 'description' => 'The name of the job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark_job_name', ], 'resourceQueueId' => [ 'description' => 'The name of the resource queue on which the Spark job runs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dev_queue', ], 'codeType' => [ 'description' => 'The code type of the job. Valid values:'."\n" ."\n" .'* SQL'."\n" .'* JAR'."\n" .'* PYTHON'."\n", 'type' => 'string', 'required' => false, 'example' => 'SQL', ], 'executionTimeoutSeconds' => [ 'description' => 'The timeout period of the job.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], 'configurationOverrides' => [ 'description' => 'The advanced configurations of Spark.'."\n", 'type' => 'object', 'properties' => [ 'configurations' => [ 'description' => 'The SparkConf objects.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The SparkConf object.'."\n", 'type' => 'object', 'properties' => [ 'configFileName' => [ 'description' => 'The configuration file of SparkConf.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark-default.conf', ], 'configItemKey' => [ 'description' => 'The key of SparkConf.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark.app.name', ], 'configItemValue' => [ 'description' => 'The value of SparkConf.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_app', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'tags' => [ 'description' => 'The tags of the job.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The tag of the job.'."\n", 'required' => false, '$ref' => '#/components/schemas/Tag', ], 'required' => false, ], 'clientToken' => [ 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '8e6aae2810c8f67229ca70bb31cd6028', ], 'jobDriver' => [ 'description' => 'The information about Spark Driver.'."\n", 'required' => false, '$ref' => '#/components/schemas/JobDriver', ], 'displayReleaseVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-3.3.1'."\n", ], 'fusion' => [ 'description' => 'Specifies whether to enable Fusion engine for acceleration.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-123213123131', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'jobRunId' => [ 'description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'jr-54321', ], 'requestId' => [ 'title' => '请求ID。', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobRunId\\": \\"jr-f09a8fda2396****\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', 'title' => 'StartJobRun', ], 'GetRunConfiguration' => [ 'summary' => '获取任务配置', 'path' => '/api/v1/workspaces/{workspaceId}/runs/{runId}/action/getRunConfiguration', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '工作空间id。', 'description' => '工作空间id。', 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09151****', ], ], [ 'name' => 'runId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'title' => '任务实例ID。', 'description' => '任务实例ID。', 'type' => 'string', 'required' => true, 'example' => 'jr-93d98d2f7061****', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'runConfiguration' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'runtimeConfigs' => [ 'title' => '运行配置。', 'description' => '运行配置。', 'type' => 'array', 'items' => [ 'description' => '', '$ref' => '#/components/schemas/Tag', ], ], 'applicationConfigs' => [ 'title' => '应用配置项', 'description' => '应用配置项', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'configFileName' => [ 'title' => '应用配置文件名。 应用配置文件名。 ```spark-defaults.conf```', 'description' => '应用配置文件名。 应用配置文件名。 ```spark-defaults.conf```', 'type' => 'string', 'example' => 'spark-defaults.conf', ], 'configItemKey' => [ 'title' => '配置项键。 配置项键。 ```dfs.namenode.checkpoint.period```', 'description' => '配置项键。 配置项键。 ```dfs.namenode.checkpoint.period```', 'type' => 'string', 'example' => 'spark.driver.cores', ], 'configItemValue' => [ 'title' => '配置项值。 配置项值。 ```3600s```', 'description' => '配置项值。 配置项值。 ```3600s```', 'type' => 'string', 'example' => '2', ], ], ], ], 'logConfig' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LogLevel' => [ 'description' => '', 'type' => 'string', 'example' => 'INFO', ], 'LogPath' => [ 'description' => '', 'type' => 'string', 'example' => 'oss://test', ], ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"runConfiguration\\": {\\n \\"runtimeConfigs\\": [\\n {\\n \\"key\\": \\"workflowId\\",\\n \\"value\\": \\"wf-123test\\"\\n }\\n ],\\n \\"applicationConfigs\\": [\\n {\\n \\"configFileName\\": \\"spark-defaults.conf\\",\\n \\"configItemKey\\": \\"spark.driver.cores\\",\\n \\"configItemValue\\": \\"2\\"\\n }\\n ],\\n \\"logConfig\\": {\\n \\"LogLevel\\": \\"INFO\\",\\n \\"LogPath\\": \\"oss://test\\"\\n }\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', ], 'StartProcessInstance' => [ 'summary' => 'Manually runs a workflow.', 'path' => '/dolphinscheduler/projects/{bizId}/executors/start-process-instance', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192046', 'abilityTreeNodes' => [ 'FEATUREemapreduceT8XN05', ], ], 'parameters' => [ [ 'name' => 'productNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SS', ], ], [ 'name' => 'bizId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-d8********', ], ], [ 'name' => 'processDefinitionCode', 'in' => 'query', 'schema' => [ 'description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12***********', ], ], [ 'name' => 'versionNumber', 'in' => 'query', 'schema' => [ 'description' => 'The version number of the workflow.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'isProd', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to run the workflow in the production environment.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'runtimeQueue', 'in' => 'query', 'schema' => [ 'description' => 'The queue on which the workflow runs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], ], [ 'name' => 'versionHashCode', 'in' => 'query', 'schema' => [ 'description' => 'The hash code of the version.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dh*********', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'interval', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'action', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'comments', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'email', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => 'The code that is returned by the backend server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1400009', ], 'msg' => [ 'description' => 'The description of the returned code.'."\n", 'type' => 'string', 'example' => 'No permission for resource action', ], 'data' => [ 'description' => 'The data returned.'."\n", 'type' => 'any', 'example' => '{\'sessionBizId\': \'sc-dc85644dba1c8c63\', \'bizId\': \'st-aeed3b0d4f87418a9a9dcbd757477658\', \'gmtCreated\': \'Thu Sep 12 02:28:45 UTC 2024\'}', ], 'success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', ], 'failed' => [ 'description' => 'Indicates whether the workflow fails to be run manually.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'httpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": 1400009,\\n \\"msg\\": \\"No permission for resource action\\",\\n \\"data\\": \\"null\\",\\n \\"success\\": true,\\n \\"failed\\": false,\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'StartProcessInstance', ], 'UpdateProcessDefinitionWithSchedule' => [ 'summary' => 'Updates the workflow and time-based scheduling configurations.', 'path' => '/dolphinscheduler/projects/{bizId}/process-definition/{code}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191361', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'productNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SS', ], ], [ 'name' => 'bizId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-d8********'."\n", ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the workflow.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ods_batch_workflow'."\n", ], ], [ 'name' => 'code', 'in' => 'path', 'schema' => [ 'description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12************', ], ], [ 'name' => 'description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ods batch workflow', ], ], [ 'name' => 'timeout', 'in' => 'query', 'schema' => [ 'description' => 'The default timeout period of the workflow.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], ], [ 'name' => 'taskDefinitionJson', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The descriptions of all nodes in the workflow.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The description of the node in the workflow.'."\n", 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23************', ], 'description' => [ 'description' => 'The node description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ods transform task'."\n", ], 'alertEmailAddress' => [ 'description' => 'The email address to receive alerts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'foo_bar@spark.alert.invalid.com'."\n", ], 'startAlertEnable' => [ 'description' => 'Specifies whether to send alerts when the node is started.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'failAlertEnable' => [ 'description' => 'Specifies whether to send alerts when the node fails.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'failRetryTimes' => [ 'description' => 'The number of retries when the node fails.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'name' => [ 'description' => 'The name of the job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ods_transform_task'."\n", ], 'taskParams' => [ 'description' => 'The job parameters.'."\n", 'type' => 'object', 'properties' => [ 'workspaceBizId' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-d8********'."\n", ], 'taskBizId' => [ 'description' => 'The ID of the data development job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TSK-d87******************'."\n", ], 'resourceQueueId' => [ 'description' => 'The name of the queue on which the job runs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'root_queue', ], 'sparkDriverCores' => [ 'description' => 'The number of driver cores of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'sparkExecutorCores' => [ 'description' => 'The number of executor cores of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'sparkDriverMemory' => [ 'description' => 'The size of driver memory of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4g', ], 'sparkExecutorMemory' => [ 'description' => 'The size of executor memory of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4g', ], 'sparkConf' => [ 'description' => 'The configurations of the Spark jobs.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The configurations of the Spark job.'."\n", 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'The key of the SparkConf object.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark.dynamicAllocation.enabled'."\n", ], 'value' => [ 'description' => 'The value of the SparkConf object.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], 'required' => false, ], 'sparkVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)'."\n", ], 'sparkLogLevel' => [ 'description' => 'The level of the Spark log.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INFO', ], 'sparkLogPath' => [ 'description' => 'The path where the operational logs of the Spark job are stored.'."\n", 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'oss://data***/spark/logs'."\n", ], 'displaySparkVersion' => [ 'description' => 'The displayed version of the Spark engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', ], 'fusion' => [ 'description' => 'Specifies whether to enable Fusion engine for acceleration.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'environmentId' => [ 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ev-h*************', ], 'type' => [ 'description' => 'The type of the Spark job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SQL', ], 'localParams' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'prop' => [ 'type' => 'string', 'required' => false, ], 'direct' => [ 'type' => 'string', 'required' => false, ], 'type' => [ 'type' => 'string', 'required' => false, ], 'value' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], 'taskType' => [ 'description' => 'The type of the node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'EMR-SERVERLESS-SPARK', ], 'timeout' => [ 'description' => 'The default timeout period of the node.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], 'tags' => [ 'description' => 'The tags of the job.'."\n", 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => ' '."\n" .'“{\\"tagkey\\":\\"tagvalue\\"}”'."\n", 'description' => 'The tag. The value is a JSON string.'."\n", ], ], ], 'required' => true, ], 'required' => true, ], ], [ 'name' => 'taskRelationJson', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The dependencies of all nodes in the workflow. preTaskCode specifies the ID of an upstream node, and postTaskCode specifies the ID of a downstream node. The ID of each node is unique. If a node does not have an upstream node, set preTaskCode to 0.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The dependency of the node in the workflow. preTaskCode specifies the ID of an upstream node, and postTaskCode specifies the ID of a downstream node. The ID of the node is unique. If a node does not have an upstream node, set preTaskCode to 0.'."\n", 'type' => 'object', 'properties' => [ 'name' => [ 'description' => 'The name of the node topology. You can enter a workflow name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ods batch workflow'."\n", ], 'preTaskCode' => [ 'description' => 'The ID of the upstream node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '16************'."\n", ], 'preTaskVersion' => [ 'description' => 'The version of the upstream node.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'postTaskCode' => [ 'description' => 'The ID of the downstream node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19************'."\n", ], 'postTaskVersion' => [ 'description' => 'The version of the downstream node.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => true, ], 'required' => true, ], ], [ 'name' => 'executionType', 'in' => 'query', 'schema' => [ 'description' => 'The execution policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'PARALLEL', ], ], [ 'name' => 'alertEmailAddress', 'in' => 'query', 'schema' => [ 'description' => 'The email address to receive alerts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'foo_bar@spark.alert.invalid.com', ], ], [ 'name' => 'schedule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The scheduling settings.'."\n", 'type' => 'object', 'properties' => [ 'startTime' => [ 'description' => 'The start time of the scheduling.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-12-23 16:13:27'."\n", ], 'endTime' => [ 'description' => 'The end time of the scheduling.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-12-23 16:13:27'."\n", ], 'crontab' => [ 'description' => 'The CRON expression that is used for scheduling.'."\n", 'type' => 'string', 'required' => false, 'example' => ' '."\n" .'0 0 0 * * ?'."\n", ], 'timezoneId' => [ 'description' => 'The ID of the time zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'."\n", ], ], 'required' => false, ], ], [ 'name' => 'retryTimes', 'in' => 'query', 'schema' => [ 'description' => 'The number of retries.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'taskParallelism', 'in' => 'query', 'schema' => [ 'description' => 'The node parallelism.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => ' '."\n" .'“{\\"tagkey\\":\\"tagvalue\\"}”'."\n", 'description' => 'The tag. The value is a JSON string.'."\n", ], ], ], [ 'name' => 'resourceQueue', 'in' => 'query', 'schema' => [ 'description' => 'The resource queue.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], ], [ 'name' => 'releaseState', 'in' => 'query', 'schema' => [ 'description' => 'The status of the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ONLINE', ], ], [ 'name' => 'runAs', 'in' => 'query', 'schema' => [ 'description' => 'The execution user.'."\n", 'type' => 'string', 'required' => false, 'example' => '113***************'."\n", ], ], [ 'name' => 'publish', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to publish the workflow.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'globalParams', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'prop' => [ 'type' => 'string', 'required' => false, ], 'value' => [ 'type' => 'string', 'required' => false, ], 'direct' => [ 'type' => 'string', 'required' => false, ], 'type' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => 'The code that is returned by the backend server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1400009', ], 'msg' => [ 'description' => 'The description of the returned code.'."\n", 'type' => 'string', 'example' => 'No permission for resource action', ], 'success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'true', ], 'failed' => [ 'description' => 'Indicates whether the request failed.'."\n", 'type' => 'string', 'example' => 'false', ], 'data' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'id' => [ 'description' => 'The serial number of the workflow.'."\n", 'type' => 'string', 'example' => '123223', ], 'code' => [ 'description' => 'The workflow ID.'."\n", 'type' => 'string', 'example' => '12***********', ], 'name' => [ 'description' => 'The name of the workflow.'."\n", 'type' => 'string', 'example' => 'ods_batch_workflow', ], 'version' => [ 'description' => 'The version number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'releaseState' => [ 'description' => 'The status of the workflow.'."\n", 'type' => 'string', 'example' => 'ONLINE', ], 'bizId' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'example' => 'alicloud_ack_one_cluster', ], 'description' => [ 'description' => 'The node description.'."\n", 'type' => 'string', 'example' => '1', ], 'createTime' => [ 'description' => 'The time when the workflow was created.'."\n", 'type' => 'string', 'example' => '2024-09-05T02:03:19Z', ], 'updateTime' => [ 'description' => 'The time when the workflow was updated.'."\n", 'type' => 'string', 'example' => '2024-03-05T06:24:27Z', ], 'userId' => [ 'description' => 'The ID of the user that is used to initiate a scheduling.'."\n", 'type' => 'string', 'example' => '113*********', ], 'userName' => [ 'description' => 'The name of the user that is used to initiate a scheduling.'."\n", 'type' => 'string', 'example' => 'w-********', ], 'projectName' => [ 'description' => 'The name of the project to which the workflow belongs.'."\n", 'type' => 'string', 'example' => 'w-********', ], 'executionType' => [ 'description' => 'The execution policy.'."\n", 'type' => 'string', 'example' => 'SERIAL', ], 'alertEmailAddress' => [ 'description' => 'The email address to receive alerts.'."\n", 'type' => 'string', 'example' => 'foo_bar@spark.alert.invalid.com'."\n", ], 'startTime' => [ 'description' => 'The start time of the scheduling.'."\n", 'type' => 'string', 'example' => '0', ], 'endTime' => [ 'description' => 'The end of the end time range.'."\n", 'type' => 'string', 'example' => '1710432000000', ], 'timezoneId' => [ 'description' => 'The ID of the time zone.'."\n", 'type' => 'string', 'example' => 'Asia/Shanghai'."\n", ], 'crontab' => [ 'description' => 'The CRON expression that is used for scheduling.'."\n", 'type' => 'string', 'example' => '0 0 0 * * ?'."\n", ], 'versionHashCode' => [ 'description' => 'The hash code of the version.'."\n", 'type' => 'string', 'example' => 'dwerf*********', ], ], ], 'httpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": 1400009,\\n \\"msg\\": \\"No permission for resource action\\",\\n \\"success\\": \\"true\\",\\n \\"failed\\": \\"false\\",\\n \\"data\\": {\\n \\"id\\": \\"123223\\",\\n \\"code\\": \\"12***********\\",\\n \\"name\\": \\"ods_batch_workflow\\",\\n \\"version\\": 1,\\n \\"releaseState\\": \\"ONLINE\\",\\n \\"bizId\\": \\"alicloud_ack_one_cluster\\",\\n \\"description\\": \\"1\\",\\n \\"createTime\\": \\"2024-09-05T02:03:19Z\\",\\n \\"updateTime\\": \\"2024-03-05T06:24:27Z\\",\\n \\"userId\\": \\"113*********\\",\\n \\"userName\\": \\"w-********\\",\\n \\"projectName\\": \\"w-********\\",\\n \\"executionType\\": \\"SERIAL\\",\\n \\"alertEmailAddress\\": \\"foo_bar@spark.alert.invalid.com\\\\n\\",\\n \\"startTime\\": \\"0\\",\\n \\"endTime\\": \\"1710432000000\\",\\n \\"timezoneId\\": \\"Asia/Shanghai\\\\n\\",\\n \\"crontab\\": \\"0 0 0 * * ?\\\\n\\",\\n \\"versionHashCode\\": \\"dwerf*********\\"\\n },\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'UpdateProcessDefinitionWithSchedule', ], 'CreateProcessDefinitionWithSchedule' => [ 'summary' => 'Creates a workflow.', 'path' => '/dolphinscheduler/projects/{bizId}/process-definition', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191322', 'abilityTreeNodes' => [ 'FEATUREemapreduceTW58EL', ], ], 'parameters' => [ [ 'name' => 'productNamespace', 'in' => 'query', 'schema' => [ 'description' => 'The code of the service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'SS', ], ], [ 'name' => 'bizId', 'in' => 'path', 'schema' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-d8********', ], ], [ 'name' => 'name', 'in' => 'query', 'schema' => [ 'description' => 'The name of the workflow.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ods_batch_workflow', ], ], [ 'name' => 'description', 'in' => 'query', 'schema' => [ 'description' => 'The description of the workflow.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ods batch workflow', ], ], [ 'name' => 'timeout', 'in' => 'query', 'schema' => [ 'description' => 'The default timeout period of the workflow.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], ], [ 'name' => 'taskRelationJson', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The dependencies of all nodes in the workflow. preTaskCode specifies the ID of an upstream node, and postTaskCode specifies the ID of a downstream node. The ID of each node is unique. If a node does not have an upstream node, set preTaskCode to 0.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The dependency of the node in the workflow. preTaskCode specifies the ID of an upstream node, and postTaskCode specifies the ID of a downstream node. The ID of the node is unique. If a node does not have an upstream node, set preTaskCode to 0.'."\n", 'type' => 'object', 'properties' => [ 'name' => [ 'description' => 'The name of the node topology. You can enter a workflow name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ods batch workflow', ], 'preTaskCode' => [ 'description' => 'The ID of the upstream node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '16************', ], 'preTaskVersion' => [ 'description' => 'The version of the upstream node.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'postTaskCode' => [ 'description' => 'The ID of the downstream node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '28************', ], 'postTaskVersion' => [ 'description' => 'The version of the downstream node.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => true, ], 'required' => true, ], ], [ 'name' => 'taskDefinitionJson', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The descriptions of all nodes in the workflow.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The description of the node in the workflow.'."\n", 'type' => 'object', 'properties' => [ 'code' => [ 'description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36************', ], 'description' => [ 'description' => 'The node description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ods transform task', ], 'alertEmailAddress' => [ 'description' => 'The email address to receive alerts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'foo_bar@spark.alert.invalid.com', ], 'startAlertEnable' => [ 'description' => 'Specifies whether to send alerts when the node is started.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'failAlertEnable' => [ 'description' => 'Specifies whether to send alerts when the node fails.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'failRetryTimes' => [ 'description' => 'The number of retries when the node fails.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'name' => [ 'description' => 'The name of the node.'."\n", 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'ods_transform_task', ], 'taskParams' => [ 'description' => 'The job parameters.'."\n", 'type' => 'object', 'properties' => [ 'workspaceBizId' => [ 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-d8********', ], 'taskBizId' => [ 'description' => 'The ID of the data development job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'TSK-d87******************', ], 'resourceQueueId' => [ 'description' => 'The name of the resource queue on which the job runs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'root_queue', ], 'sparkDriverCores' => [ 'description' => 'The number of driver cores of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'sparkExecutorCores' => [ 'description' => 'The number of executor cores of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'sparkDriverMemory' => [ 'description' => 'The size of driver memory of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4g', ], 'sparkExecutorMemory' => [ 'description' => 'The size of executor memory of the Spark job.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4g', ], 'sparkConf' => [ 'description' => 'The configurations of the Spark job.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => [ 'description' => 'The key of the SparkConf object.'."\n", 'type' => 'string', 'required' => false, 'example' => 'spark.dynamicAllocation.enabled', ], 'value' => [ 'description' => 'The value of the SparkConf object.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', ], ], 'required' => false, 'description' => '', ], 'required' => false, ], 'sparkVersion' => [ 'description' => 'The version of the Spark engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', ], 'sparkLogLevel' => [ 'description' => 'The level of the Spark log.'."\n", 'type' => 'string', 'required' => false, 'example' => 'INFO', ], 'sparkLogPath' => [ 'description' => 'The path where the operational logs of the Spark job are stored.'."\n", 'type' => 'string', 'required' => false, 'example' => 'oss://data***/spark/logs', ], 'displaySparkVersion' => [ 'description' => 'The displayed version of the Spark engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', ], 'fusion' => [ 'description' => 'Specifies whether to enable Fusion engine for acceleration.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'environmentId' => [ 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'env-crhq2h5lhtgju93buhkg', ], 'type' => [ 'description' => 'The type of the Spark job.'."\n", 'type' => 'string', 'required' => false, 'example' => 'VPC', ], 'localParams' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'prop' => [ 'type' => 'string', 'required' => false, ], 'direct' => [ 'type' => 'string', 'required' => false, ], 'type' => [ 'type' => 'string', 'required' => false, ], 'value' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], 'required' => true, ], 'taskType' => [ 'description' => 'The type of the node.'."\n", 'type' => 'string', 'required' => true, 'example' => 'MigrateData', ], 'timeout' => [ 'description' => 'The timeout period of the callback. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1200', ], 'tags' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '“{\\"tagkey\\":\\"tagvalue\\"}”', 'description' => 'The tag. The value is a JSON string.'."\n", ], ], ], 'required' => true, ], 'required' => true, ], ], [ 'name' => 'executionType', 'in' => 'query', 'schema' => [ 'description' => 'The execution policy'."\n", 'type' => 'string', 'required' => true, 'example' => 'PARALLEL', ], ], [ 'name' => 'alertEmailAddress', 'in' => 'query', 'schema' => [ 'description' => 'The email address to receive alerts.'."\n", 'type' => 'string', 'required' => false, 'example' => 'foo_bar@spark.alert.invalid.com', ], ], [ 'name' => 'schedule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The scheduling settings.'."\n", 'type' => 'object', 'properties' => [ 'startTime' => [ 'description' => 'The start time of the scheduling.'."\n", 'type' => 'string', 'required' => false, 'example' => '2024-12-23 16:13:27', ], 'endTime' => [ 'description' => 'The end time of the scheduling.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-12-23 16:13:27', ], 'crontab' => [ 'description' => 'The CRON expression that is used for scheduling.'."\n", 'type' => 'string', 'required' => false, 'example' => '0 0 0 * * ?', ], 'timezoneId' => [ 'description' => 'The ID of the time zone.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', ], ], 'required' => false, ], ], [ 'name' => 'retryTimes', 'in' => 'query', 'schema' => [ 'description' => 'The number of retries.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'taskParallelism', 'in' => 'query', 'schema' => [ 'description' => 'The node parallelism.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'resourceQueue', 'in' => 'query', 'schema' => [ 'description' => 'The resource queue.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The tags.'."\n", 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '“{\\"tagkey\\":\\"tagvalue\\"}”', 'description' => 'The tag. The value is a JSON string.'."\n", ], ], ], [ 'name' => 'publish', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to publish the workflow.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'runAs', 'in' => 'query', 'schema' => [ 'description' => 'The ID of the Alibaba Cloud account used by the user who creates the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => '113***************', ], ], [ 'name' => 'globalParams', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'prop' => [ 'type' => 'string', 'required' => false, ], 'value' => [ 'type' => 'string', 'required' => false, ], 'direct' => [ 'type' => 'string', 'required' => false, ], 'type' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => 'The code that is returned by the backend server.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1400009', ], 'msg' => [ 'description' => 'The description of the returned code.'."\n", 'type' => 'string', 'example' => 'No permission for resource action', ], 'success' => [ 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'true', ], 'failed' => [ 'description' => 'Indicates whether the request failed.'."\n", 'type' => 'string', 'example' => 'false', ], 'data' => [ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ 'id' => [ 'description' => 'The serial number of the workflow.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12342', ], 'code' => [ 'description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '160************', ], ], ], 'httpStatusCode' => [ 'description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": 1400009,\\n \\"msg\\": \\"No permission for resource action\\",\\n \\"success\\": \\"true\\",\\n \\"failed\\": \\"false\\",\\n \\"data\\": {\\n \\"id\\": 12342,\\n \\"code\\": 0\\n },\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'CreateProcessDefinitionWithSchedule', ], 'GenerateTaskCodes' => [ 'summary' => '上线工作流及其调度', 'path' => '/dolphinscheduler/projects/{bizId}/task-definition/gen-task-codes', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'bizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'w-d8********'."\n", ], ], [ 'name' => 'genNum', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'productNamespace', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => true, 'example' => 'SS', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'code' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1000000', ], 'msg' => [ 'description' => '', 'type' => 'string', 'example' => 'No permission for resource action', ], 'success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'failed' => [ 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1263424***', ], ], 'httpStatusCode' => [ 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": 1000000,\\n \\"msg\\": \\"No permission for resource action\\",\\n \\"success\\": true,\\n \\"failed\\": false,\\n \\"data\\": [\\n 0\\n ],\\n \\"httpStatusCode\\": 200\\n}","type":"json"}]', ], 'UpdateRayCluster' => [ 'summary' => '更新Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', ], ], [ 'name' => 'clusterId', 'in' => 'path', 'schema' => [ 'title' => '集群ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-uiulpgow9xljimm1', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => 'Ray集群名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'myRayCluster', ], 'displayReleaseVersion' => [ 'title' => 'Ray引擎版本。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', ], 'description' => [ 'title' => '描述。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Ray Cluster for dev.', ], 'networkServiceName' => [ 'title' => '网络连接名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'headSpec' => [ 'title' => 'Ray集群Head节点信息。', 'description' => '', 'type' => 'object', 'properties' => [ 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '8Gi', ], 'enableAutoScaling' => [ 'title' => '是否开启自动扩缩容。', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'idleTimeoutSeconds' => [ 'title' => '开启自动扩缩容后Worker的Idle时间。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], ], 'required' => false, ], 'workerSpec' => [ 'title' => 'Ray集群Worker节点信息。', 'description' => '', 'type' => 'array', 'items' => [ 'title' => 'Ray集群Worker节点信息结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'groupName' => [ 'title' => 'Worker组名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'WorkerGroup1', ], 'workerType' => [ 'title' => 'Worker类型。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'CPU', 'enum' => [ 'CPU', ], ], 'replica' => [ 'title' => 'Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '8Gi', ], 'minReplica' => [ 'title' => '最小Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'maxReplica' => [ 'title' => '最大Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => false, ], 'required' => false, ], 'extraParam' => [ 'title' => '额外参数，json格式。'."\n", 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', ], 'clusterId' => [ 'title' => '集群ID。', 'description' => '', 'type' => 'string', 'example' => 'ray-xxxxxxxxxxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"clusterId\\": \\"ray-xxxxxxxxxxx\\"\\n}","type":"json"}]', ], 'GetRayCluster' => [ 'summary' => '获取Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', ], ], [ 'name' => 'clusterId', 'in' => 'path', 'schema' => [ 'title' => '集群ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-xxxxxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', ], 'clusterId' => [ 'title' => 'Ray集群ID。'."\n", 'description' => '', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91', ], 'name' => [ 'title' => 'Ray集群名称。', 'description' => '', 'type' => 'string', 'example' => 'myRayCluster', ], 'displayReleaseVersion' => [ 'title' => 'Ray引擎版本。', 'description' => '', 'type' => 'string', 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', ], 'description' => [ 'title' => '描述信息。', 'description' => '', 'type' => 'string', 'example' => 'Ray Cluster for dev.', ], 'networkServiceName' => [ 'title' => '网络连接名称。', 'description' => '', 'type' => 'string', 'example' => 'vpc', ], 'headSpec' => [ 'title' => 'Ray集群Head节点参数。', 'description' => '', 'type' => 'object', 'properties' => [ 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'example' => '8Gi', ], 'enableAutoScaling' => [ 'title' => 'Worker节点是否开启自动扩缩容。', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'idleTimeoutSeconds' => [ 'title' => '开启自动扩缩容后Worker节点Idle时间。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'replica' => [ 'title' => '节点数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'state' => [ 'title' => '会话状态。'."\n" .'- Starting：启动中。'."\n" .'- Running：运行中。'."\n" .'- Stopping：正在停止。'."\n" .'- Stopped：已停止。'."\n" .'- Error：已失败。', 'description' => '', 'type' => 'string', 'example' => 'Running', 'enum' => [ 'Starting', 'Running', 'Stopping', 'Stopped', 'Error', ], ], 'creator' => [ 'title' => '创建集群的用户UID。', 'description' => '', 'type' => 'string', 'example' => '202077646755523991', ], 'creatorName' => [ 'title' => '创建者昵称。', 'description' => '', 'type' => 'string', 'example' => 'Alice', ], 'modifier' => [ 'title' => '集群更新者UID。', 'description' => '', 'type' => 'string', 'example' => '202077646755523991', ], 'modifierName' => [ 'title' => '修改者昵称。', 'description' => '', 'type' => 'string', 'example' => 'Alice', ], 'userId' => [ 'title' => '创建者主账号ID。', 'description' => '', 'type' => 'string', 'example' => '123456789012', ], 'dashboardUrl' => [ 'title' => 'Ray集群Dashboard链接。', 'description' => '', 'type' => 'string', 'example' => 'https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx', ], 'jobUrl' => [ 'title' => '提交Ray Job的地址。', 'description' => '', 'type' => 'string', 'example' => 'https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com', ], 'submitToken' => [ 'title' => '提交Ray Job时的鉴权Token。', 'description' => '', 'type' => 'string', 'example' => '1d06484d3b424f7fa4ab7082a4076da2', ], 'modified' => [ 'title' => '配置是否修改过。', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'extraParam' => [ 'title' => '额外参数，json格式。', 'description' => '', 'type' => 'string', 'example' => '{}', ], 'message' => [ 'title' => '状态为Error时的错误信息。', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'instances' => [ 'title' => 'Ray集群节点ID。', 'description' => '', 'type' => 'array', 'items' => [ 'title' => 'Ray集群节点结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '节点类型。', 'description' => '', 'type' => 'string', 'example' => 'Head', ], 'instanceId' => [ 'title' => '节点ID。', 'description' => '', 'type' => 'string', 'example' => 'ray-uiulpgow9xljim10-head-7cgta', ], 'containerState' => [ 'title' => '主容器状态。', 'description' => '', 'type' => 'string', 'example' => 'Running', ], 'reason' => [ 'title' => '节点信息。', 'description' => '', 'type' => 'string', 'example' => 'OOMKilled', ], 'phase' => [ 'title' => '节点Pod状态。', 'description' => '', 'type' => 'string', 'example' => 'Running', ], 'message' => [ 'title' => '节点Pod状态信息。', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'startTime' => [ 'title' => '启动时间。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1762946698000', ], 'createTime' => [ 'title' => '创建时间。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1735870116167', ], 'containerStateReason' => [ 'title' => '主容器信息。', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'containerStateMessage' => [ 'title' => '主容器状态信息。', 'description' => '', 'type' => 'string', 'example' => 'ContainerExit', ], 'containerExitCode' => [ 'title' => '主容器退出码。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '137', ], ], ], ], 'instanceId' => [ 'title' => 'Ray集群节点ID。', 'description' => '', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg93-xxxxxxx', ], 'workerSpec' => [ 'title' => 'Ray集群Worker节点信息。', 'description' => '', 'type' => 'array', 'items' => [ 'title' => 'Ray集群Worker节点信息结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'groupName' => [ 'title' => 'Worker节点组名称。', 'description' => '', 'type' => 'string', 'example' => 'WorkerGroup1', ], 'workerType' => [ 'title' => 'Worker节点组类型。', 'description' => '', 'type' => 'string', 'example' => 'CPU', 'enum' => [ 'CPU', ], ], 'replica' => [ 'title' => 'Worker节点数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'example' => '8Gi', ], 'minReplica' => [ 'title' => 'Worker最小数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'maxReplica' => [ 'title' => 'Worker最大数量', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], 'startTime' => [ 'title' => '启动时间，Unix时间戳，单位毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1750327083303', ], 'createTime' => [ 'title' => '创建时间，Unix时间戳，单位毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1750327083303', ], 'modifiedTime' => [ 'title' => '更新时间，Unix时间戳，单位毫秒。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1754274541693', ], 'grpcEndpoint' => [ 'title' => 'gRPC连接地址。', 'description' => '', 'type' => 'string', 'example' => 'ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"clusterId\\": \\"ray-k7nm8ahl5te4tg91\\",\\n \\"name\\": \\"myRayCluster\\",\\n \\"displayReleaseVersion\\": \\"ray-1.0.0 (Ray 2.47.1, Python 3.12)\\",\\n \\"description\\": \\"Ray Cluster for dev.\\",\\n \\"networkServiceName\\": \\"vpc\\",\\n \\"headSpec\\": {\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpu\\": \\"2\\",\\n \\"memory\\": \\"8Gi\\",\\n \\"enableAutoScaling\\": false,\\n \\"idleTimeoutSeconds\\": 60,\\n \\"replica\\": 1\\n },\\n \\"state\\": \\"Running\\",\\n \\"creator\\": \\"202077646755523991\\",\\n \\"creatorName\\": \\"Alice\\",\\n \\"modifier\\": \\"202077646755523991\\",\\n \\"modifierName\\": \\"Alice\\",\\n \\"userId\\": \\"123456789012\\",\\n \\"dashboardUrl\\": \\"https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx\\",\\n \\"jobUrl\\": \\"https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com\\",\\n \\"submitToken\\": \\"1d06484d3b424f7fa4ab7082a4076da2\\",\\n \\"modified\\": false,\\n \\"extraParam\\": \\"{}\\",\\n \\"message\\": \\"ok\\",\\n \\"instances\\": [\\n {\\n \\"type\\": \\"Head\\",\\n \\"instanceId\\": \\"ray-uiulpgow9xljim10-head-7cgta\\",\\n \\"containerState\\": \\"Running\\",\\n \\"reason\\": \\"OOMKilled\\",\\n \\"phase\\": \\"Running\\",\\n \\"message\\": \\"ok\\",\\n \\"startTime\\": 1762946698000,\\n \\"createTime\\": 1735870116167,\\n \\"containerStateReason\\": \\"ok\\",\\n \\"containerStateMessage\\": \\"ContainerExit\\",\\n \\"containerExitCode\\": 137\\n }\\n ],\\n \\"instanceId\\": \\"ray-k7nm8ahl5te4tg93-xxxxxxx\\",\\n \\"workerSpec\\": [\\n {\\n \\"groupName\\": \\"WorkerGroup1\\",\\n \\"workerType\\": \\"CPU\\",\\n \\"replica\\": 2,\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpu\\": \\"2\\",\\n \\"memory\\": \\"8Gi\\",\\n \\"minReplica\\": 1,\\n \\"maxReplica\\": 10\\n }\\n ],\\n \\"startTime\\": 1750327083303,\\n \\"createTime\\": 1750327083303,\\n \\"modifiedTime\\": 1754274541693,\\n \\"grpcEndpoint\\": \\"ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80\\"\\n}","type":"json"}]', ], 'ListRayCluster' => [ 'summary' => '列出Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '返回结果的分页数。默认值：20。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'pageNum', 'in' => 'query', 'schema' => [ 'title' => '页码。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', ], 'rayClusters' => [ 'title' => 'Ray集群列表。', 'description' => '', 'type' => 'array', 'items' => [ 'title' => 'Ray集群结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'clusterId' => [ 'title' => '集群ID。', 'description' => '', 'type' => 'string', 'example' => 'ray-uiulpgow9xljimm1', ], 'name' => [ 'title' => 'Ray集群名称。', 'description' => '', 'type' => 'string', 'example' => 'testRayCluster', ], 'displayReleaseVersion' => [ 'title' => 'Ray引擎版本。', 'description' => '', 'type' => 'string', 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', ], 'description' => [ 'title' => '描述。', 'description' => '', 'type' => 'string', 'example' => 'Ray Cluster for dev.', ], 'networkServiceName' => [ 'title' => '网络连接名称。', 'description' => '', 'type' => 'string', 'example' => 'vpc', ], 'headSpec' => [ 'title' => 'Ray集群Head节点信息。', 'description' => '', 'type' => 'object', 'properties' => [ 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'example' => '8Gi', ], 'enableAutoScaling' => [ 'title' => 'Worker节点是否开启自动扩缩容。', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'idleTimeoutSeconds' => [ 'title' => 'Worker节点Idle时间。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '60', ], 'replica' => [ 'title' => '节点数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'workerSpec' => [ 'title' => 'Ray集群Worker信息。', 'description' => '', 'type' => 'array', 'items' => [ 'title' => 'Ray集群Worker信息结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'groupName' => [ 'title' => 'Worker组名称。', 'description' => '', 'type' => 'string', 'example' => 'Group1', ], 'workerType' => [ 'title' => 'Worker类型。', 'description' => '', 'type' => 'string', 'example' => 'CPU', 'enum' => [ 'CPU', ], ], 'replica' => [ 'title' => '节点数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'example' => '8Gi', ], 'minReplica' => [ 'title' => '开启自动扩缩容后最小Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'maxReplica' => [ 'title' => '开启自动扩缩容后最大Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], ], 'state' => [ 'title' => '集群状态。'."\n" .'- Starting：启动中。'."\n" .'- Running：运行中。'."\n" .'- Stopping：正在停止。'."\n" .'- Stopped：已停止。'."\n" .'- Error：已失败。', 'description' => '', 'type' => 'string', 'example' => 'Running', 'enum' => [ 'Starting', 'Running', 'Stopping', 'Stopped', 'Error', ], ], 'createTime' => [ 'title' => '创建时间。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1723722279800', ], 'modifiedTime' => [ 'title' => '修改时间。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1723722279800', ], 'creator' => [ 'title' => '创建用户UID。', 'description' => '', 'type' => 'string', 'example' => '202077646755123991', ], 'creatorName' => [ 'title' => '创建者昵称。', 'description' => '', 'type' => 'string', 'example' => 'Alice', ], 'modifier' => [ 'title' => '最后更新者UID。', 'description' => '', 'type' => 'string', 'example' => '202077646755123991', ], 'modifierName' => [ 'title' => '修改者昵称。', 'description' => '', 'type' => 'string', 'example' => 'Alice', ], 'userId' => [ 'title' => '主账号ID。', 'description' => '', 'type' => 'string', 'example' => '1234567890', ], 'dashboardUrl' => [ 'title' => 'Ray集群Dashboard链接。', 'description' => '', 'type' => 'string', 'example' => 'https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx', ], 'modified' => [ 'title' => '配置是否修改过。', 'description' => '', 'type' => 'boolean', 'example' => 'false', ], 'message' => [ 'title' => '错误信息。', 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'instanceId' => [ 'title' => 'Ray集群实例ID。', 'description' => '', 'type' => 'string', 'example' => 'ray-uiulpgow9xljimm1-xxxxxxx', ], 'startTime' => [ 'title' => '启动时间。', 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1723722279800', ], 'grpcEndpoint' => [ 'title' => 'gRPC连接地址。', 'description' => '', 'type' => 'string', 'example' => 'ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"rayClusters\\": [\\n {\\n \\"clusterId\\": \\"ray-uiulpgow9xljimm1\\",\\n \\"name\\": \\"testRayCluster\\",\\n \\"displayReleaseVersion\\": \\"ray-1.0.0 (Ray 2.47.1, Python 3.12)\\",\\n \\"description\\": \\"Ray Cluster for dev.\\",\\n \\"networkServiceName\\": \\"vpc\\",\\n \\"headSpec\\": {\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpu\\": \\"2\\",\\n \\"memory\\": \\"8Gi\\",\\n \\"enableAutoScaling\\": false,\\n \\"idleTimeoutSeconds\\": 60,\\n \\"replica\\": 1\\n },\\n \\"workerSpec\\": [\\n {\\n \\"groupName\\": \\"Group1\\",\\n \\"workerType\\": \\"CPU\\",\\n \\"replica\\": 2,\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpu\\": \\"2\\",\\n \\"memory\\": \\"8Gi\\",\\n \\"minReplica\\": 1,\\n \\"maxReplica\\": 10\\n }\\n ],\\n \\"state\\": \\"Running\\",\\n \\"createTime\\": 1723722279800,\\n \\"modifiedTime\\": 1723722279800,\\n \\"creator\\": \\"202077646755123991\\",\\n \\"creatorName\\": \\"Alice\\",\\n \\"modifier\\": \\"202077646755123991\\",\\n \\"modifierName\\": \\"Alice\\",\\n \\"userId\\": \\"1234567890\\",\\n \\"dashboardUrl\\": \\"https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx\\",\\n \\"modified\\": false,\\n \\"message\\": \\"ok\\",\\n \\"instanceId\\": \\"ray-uiulpgow9xljimm1-xxxxxxx\\",\\n \\"startTime\\": 1723722279800,\\n \\"grpcEndpoint\\": \\"ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80\\"\\n }\\n ]\\n}","type":"json"}]', ], 'StopRayCluster' => [ 'summary' => '停止Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}/stop', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', ], ], [ 'name' => 'clusterId', 'in' => 'path', 'schema' => [ 'title' => 'Ray集群ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-k7nm8ahl5te4tg91', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'instanceId' => [ 'title' => 'Ray集群实例ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-k7nm8ahl5te4tg91-ey7blpbg', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\"\\n}","type":"json"}]', ], 'StartRayCluster' => [ 'summary' => '启动Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}/start', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', ], ], [ 'name' => 'clusterId', 'in' => 'path', 'schema' => [ 'title' => 'Ray集群ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-uiulagow9xljimm0', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求结构体', 'description' => '', 'type' => 'object', 'properties' => [ 'clientToken' => [ 'title' => '幂等校验TOKEN。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'c533e141-bf99-4236-8b6b-30e133db113c', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => '8CE06D75-E6A2-505D-9B4B-31DEE3D98A04', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8CE06D75-E6A2-505D-9B4B-31DEE3D98A04\\"\\n}","type":"json"}]', ], 'DeleteRayCluster' => [ 'summary' => '删除Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d11', ], ], [ 'name' => 'clusterId', 'in' => 'path', 'schema' => [ 'title' => 'Ray集群ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-k7nm8ahl5te4tg91', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\"\\n}","type":"json"}]', ], 'CreateRayCluster' => [ 'summary' => '创建Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREemapreduce8QU4HW', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'schema' => [ 'title' => '工作空间ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'name' => [ 'title' => 'Ray集群名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'testRayCluster', ], 'displayReleaseVersion' => [ 'title' => 'Ray引擎版本。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', ], 'description' => [ 'title' => '描述信息。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'Ray Cluster for dev.', ], 'networkServiceName' => [ 'title' => '网络连接名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'headSpec' => [ 'title' => 'Ray集群Head节点参数。', 'description' => '', 'type' => 'object', 'properties' => [ 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '2', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '8Gi', ], 'enableAutoScaling' => [ 'title' => '是否开启Worker自动扩缩容。', 'description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'idleTimeoutSeconds' => [ 'title' => '开启自动扩缩容后Worker Idle时间。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', ], ], 'required' => false, ], 'workerSpec' => [ 'title' => 'Ray集群Worker节点参数。', 'description' => '', 'type' => 'array', 'items' => [ 'title' => 'Worker节点结构体。', 'description' => '', 'type' => 'object', 'properties' => [ 'groupName' => [ 'title' => 'Worker组名。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'WorkerGroup1', ], 'workerType' => [ 'title' => 'Worker类型。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'CPU', 'enum' => [ 'CPU', ], ], 'replica' => [ 'title' => 'Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'queueName' => [ 'title' => '队列名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'root_queue', ], 'cpu' => [ 'title' => 'CPU核数。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '4', ], 'memory' => [ 'title' => '内存，单位Gi。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '16Gi', ], 'minReplica' => [ 'title' => '开启自动扩缩容后最小Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'maxReplica' => [ 'title' => '开启自动扩缩容后最大Worker数量。', 'description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], 'required' => false, ], 'required' => false, ], 'extraParam' => [ 'title' => '额外参数，json格式。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => '请求ID。', 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', ], 'clusterId' => [ 'title' => 'Ray集群ID。', 'description' => '', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"clusterId\\": \\"ray-k7nm8ahl5te4tg91\\"\\n}","type":"json"}]', ], 'ListCatalogs' => [ 'summary' => '查看数据目录列表', 'path' => '/api/v1/workspaces/{workspaceId}/catalogs', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213262', 'abilityTreeNodes' => [ 'FEATUREemapreduceR6MU4Y', ], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', 'allowEmptyValue' => false, 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', ], ], [ 'name' => 'environment', 'in' => 'query', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'dev' => 'dev', 'production' => 'production', ], 'example' => 'dev', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '', 'type' => 'object', 'properties' => [ 'catalogs' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'catalogId' => [ 'title' => 'regionId。', 'description' => 'regionId。', 'type' => 'string', 'example' => '15097**********', ], 'workspaceId' => [ 'title' => '工作空间id。', 'description' => '工作空间id。', 'type' => 'string', 'example' => 'w-d2d82aa09155****'."\n", ], 'environments' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'string', 'example' => 'dev,production', ], ], 'catalogType' => [ 'description' => '', 'type' => 'string', 'example' => 'default_catalog', ], 'catalogProvider' => [ 'description' => '', 'type' => 'string', 'example' => 'HMS', ], 'gmtCreate' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1760604889', ], 'gmtModified' => [ 'description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1760604889', ], 'resourceOwnerId' => [ 'description' => '', 'type' => 'string', 'example' => '15097**********', ], 'alias' => [ 'title' => 'alias', 'type' => 'string', 'example' => 'alias', ], 'extras' => [ 'description' => '', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '', 'example' => '{"networkName":"hms","metastoreUrl":"thrift://master-1-1.c-70*********.cn-hangzhou.emr.aliyuncs.com:9083","keytabPath":"oss://********/hive.keytab","principal":"hive/master-1-1.c-70****************"}', ], ], ], ], ], 'requestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', ], 'nextToken' => [ 'title' => '下一页TOKEN。', 'description' => '下一页TOKEN。', 'type' => 'string', 'example' => '1', ], 'totalCount' => [ 'title' => '记录总数。', 'description' => '记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'maxResults' => [ 'title' => '一次获取的最大记录数。', 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"catalogs\\": [\\n {\\n \\"catalogId\\": \\"15097**********\\",\\n \\"workspaceId\\": \\"w-d2d82aa09155****\\\\n\\",\\n \\"environments\\": [\\n \\"dev,production\\"\\n ],\\n \\"catalogType\\": \\"default_catalog\\",\\n \\"catalogProvider\\": \\"HMS\\",\\n \\"gmtCreate\\": 1760604889,\\n \\"gmtModified\\": 1760604889,\\n \\"resourceOwnerId\\": \\"15097**********\\",\\n \\"alias\\": \\"alias\\",\\n \\"extras\\": {\\n \\"key\\": \\"{\\\\\\"networkName\\\\\\":\\\\\\"hms\\\\\\",\\\\\\"metastoreUrl\\\\\\":\\\\\\"thrift://master-1-1.c-70*********.cn-hangzhou.emr.aliyuncs.com:9083\\\\\\",\\\\\\"keytabPath\\\\\\":\\\\\\"oss://********/hive.keytab\\\\\\",\\\\\\"principal\\\\\\":\\\\\\"hive/master-1-1.c-70****************\\\\\\"}\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"totalCount\\": 200,\\n \\"maxResults\\": 20\\n}","type":"json"}]', ], 'ListTemplate' => [ 'summary' => '获取任务模板列表', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/template/listing', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191100', 'abilityTreeNodes' => [ 'FEATUREemapreduceUECZZL', ], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', ], ], [ 'name' => 'regionId', 'in' => 'query', 'schema' => [ 'title' => '区域ID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'httpStatusCode' => [ 'title' => 'Id of the request', 'description' => '', 'type' => 'string', 'example' => '200', ], 'errorCode' => [ 'description' => '', 'type' => 'string', 'example' => 'ERR-00000000', ], 'errorMessage' => [ 'description' => '', 'type' => 'string', 'example' => 'ok', ], 'data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', '$ref' => '#/components/schemas/Template', ], ], 'success' => [ 'description' => '', 'type' => 'boolean', 'example' => 'true', ], 'requestId' => [ 'description' => '', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"httpStatusCode\\": \\"200\\",\\n \\"errorCode\\": \\"ERR-00000000\\",\\n \\"errorMessage\\": \\"ok\\",\\n \\"data\\": [\\n {\\n \\"templateType\\": \\"\\",\\n \\"gmtModified\\": \\"\\",\\n \\"creator\\": 0,\\n \\"sparkLogLevel\\": \\"\\",\\n \\"gmtCreated\\": \\"\\",\\n \\"sparkDriverMemory\\": 0,\\n \\"modifier\\": 0,\\n \\"sparkExecutorCores\\": 0,\\n \\"sparkConf\\": [\\n {\\n \\"value\\": \\"\\",\\n \\"key\\": \\"\\"\\n }\\n ],\\n \\"sparkVersion\\": \\"\\",\\n \\"sparkExecutorMemory\\": 0,\\n \\"fusion\\": true,\\n \\"isDefault\\": true,\\n \\"sparkDriverCores\\": 0,\\n \\"displaySparkVersion\\": \\"\\",\\n \\"sparkLogPath\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"bizId\\": \\"\\"\\n }\\n ],\\n \\"success\\": true,\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ [ 'regionId' => 'cn-beijing', 'endpoint' => 'emr-serverless-spark.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'emr-serverless-spark.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'emr-serverless-spark.cn-wulanchabu.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'emr-serverless-spark.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'emr-serverless-spark.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'emr-serverless-spark.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'emr-serverless-spark.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'emr-serverless-spark.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'emr-serverless-spark.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'emr-serverless-spark.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'emr-serverless-spark.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'emr-serverless-spark.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'emr-serverless-spark.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'emr-serverless-spark.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'na-south-1', 'endpoint' => 'emr-serverless-spark.na-south-1.aliyuncs.com', ], ], ];