diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/emr-serverless-spark/2023-08-08/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/emr-serverless-spark/2023-08-08/api-docs.php')
| -rw-r--r-- | data/en_us/emr-serverless-spark/2023-08-08/api-docs.php | 18524 |
1 files changed, 8163 insertions, 10361 deletions
diff --git a/data/en_us/emr-serverless-spark/2023-08-08/api-docs.php b/data/en_us/emr-serverless-spark/2023-08-08/api-docs.php index 15998b3..59aef64 100644 --- a/data/en_us/emr-serverless-spark/2023-08-08/api-docs.php +++ b/data/en_us/emr-serverless-spark/2023-08-08/api-docs.php @@ -1,264 +1,240 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'emr-serverless-spark', - 'version' => '2023-08-08', - ], + 'info' => ['style' => 'ROA', 'product' => 'emr-serverless-spark', 'version' => '2023-08-08'], 'directories' => [ [ - 'id' => 389575, - 'title' => null, + 'children' => ['AddMembers', 'ListMembers', 'GrantRoleToUsers'], 'type' => 'directory', - 'children' => [ - 'AddMembers', - 'ListMembers', - 'GrantRoleToUsers', - ], + 'title' => 'Permission management', ], [ - 'id' => 389579, - 'title' => null, + 'children' => ['GetSessionCluster', 'CreateSessionCluster', 'StartSessionCluster', 'ListSessionClusters'], 'type' => 'directory', - 'children' => [ - 'GetSessionCluster', - 'CreateSessionCluster', - 'StopSessionCluster', - 'StartSessionCluster', - 'ListSessionClusters', - ], + 'title' => 'Session management', ], [ - 'id' => 389585, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 389586, - 'title' => null, + 'children' => ['ListKyuubiSparkApplications', 'CancelKyuubiSparkApplication', 'DeleteKyuubiToken', 'UpdateKyuubiToken', 'GetKyuubiToken', 'CreateKyuubiToken', 'ListKyuubiToken', 'ListKyuubiServices', 'CreateKyuubiService', 'GetKyuubiService', 'UpdateKyuubiService', 'DeleteKyuubiService', 'StartKyuubiService', 'StopKyuubiService'], 'type' => 'directory', - 'children' => [ - 'ListKyuubiSparkApplications', - 'CancelKyuubiSparkApplication', - 'DeleteKyuubiToken', - 'UpdateKyuubiToken', - 'GetKyuubiToken', - 'CreateKyuubiToken', - 'ListKyuubiToken', - 'ListKyuubiServices', - 'CreateKyuubiService', - 'GetKyuubiService', - 'UpdateKyuubiService', - 'DeleteKyuubiService', - 'StartKyuubiService', - 'StopKyuubiService', - ], - ], - [ - 'id' => 389601, - 'title' => null, + 'title' => 'Kyuubi Gateway', + ], + [ + 'children' => ['ListLivyComputeSessions', 'DeleteLivyCompute', 'CreateLivyCompute', 'UpdateLivyCompute', 'ListLivyCompute', 'StartLivyCompute', 'RefreshLivyComputeToken', 'GetLivyComputeToken', 'CreateLivyComputeToken', 'DeleteLivyComputeToken', 'StopLivyCompute', 'ListLivyComputeToken', 'GetLivyCompute'], 'type' => 'directory', - 'children' => [ - 'ListLivyComputeSessions', - 'DeleteLivyCompute', - 'CreateLivyCompute', - 'UpdateLivyCompute', - 'ListLivyCompute', - 'StartLivyCompute', - 'RefreshLivyComputeToken', - 'GetLivyComputeToken', - 'CreateLivyComputeToken', - 'DeleteLivyComputeToken', - 'StopLivyCompute', - 'StopLivyCompute', - 'ListLivyComputeToken', - 'GetLivyCompute', - ], + 'title' => 'Livy Gateway', ], ], + 'type' => 'directory', + 'title' => 'Gateway', ], [ - 'id' => 389615, - 'title' => null, + 'children' => ['TerminateSqlStatement', 'CreateSqlStatement', 'GetSqlStatement', 'ListSqlStatementContents'], 'type' => 'directory', - 'children' => [ - 'GetTemplate', - 'TerminateSqlStatement', - 'CreateSqlStatement', - 'GetSqlStatement', - 'ListSqlStatementContents', - ], + 'title' => 'Data development', ], [ - 'id' => 389621, - 'title' => null, + 'children' => ['ListWorkspaceQueues', 'EditWorkspaceQueue'], 'type' => 'directory', - 'children' => [ - 'CreateWorkspace', - 'ListWorkspaces', - 'ListWorkspaceQueues', - 'EditWorkspaceQueue', - ], + 'title' => 'Workspace management', ], [ - 'id' => 389626, - 'title' => null, + 'children' => ['ListReleaseVersions'], 'type' => 'directory', - 'children' => [ - 'ListReleaseVersions', - ], + 'title' => 'Spark version management', ], [ - 'id' => 389628, - 'title' => null, + 'children' => ['ListJobExecutors', 'ListLogContents', 'GetDoctorApplication', 'ListJobRuns', 'GetJobRun', 'StartJobRun', 'GetRunConfiguration'], 'type' => 'directory', - 'children' => [ - 'ListJobExecutors', - 'ListLogContents', - 'GetCuHours', - 'GetDoctorApplication', - 'CancelJobRun', - 'ListJobRuns', - 'GetJobRun', - 'StartJobRun', - 'GetRunConfiguration', - ], + 'title' => 'Spark job management', ], [ - 'id' => 389638, - 'title' => null, + 'children' => ['StartProcessInstance', 'UpdateProcessDefinitionWithSchedule', 'CreateProcessDefinitionWithSchedule', 'GenerateTaskCodes'], 'type' => 'directory', - 'children' => [ - 'StartProcessInstance', - 'UpdateProcessDefinitionWithSchedule', - 'CreateProcessDefinitionWithSchedule', - 'GenerateTaskCodes', - ], + 'title' => 'Job orchestration', ], [ - 'id' => 389643, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 389644, - 'title' => null, + 'children' => ['UpdateRayCluster', 'GetRayCluster', 'ListRayCluster', 'StopRayCluster', 'StartRayCluster', 'DeleteRayCluster', 'CreateRayCluster'], 'type' => 'directory', - 'children' => [ - 'UpdateRayCluster', - 'GetRayCluster', - 'ListRayCluster', - 'StopRayCluster', - 'StartRayCluster', - 'DeleteRayCluster', - 'CreateRayCluster', - ], + 'title' => 'Ray cluster', ], ], + 'type' => 'directory', + 'title' => 'Cluster management', ], [ - 'id' => 389652, - 'title' => null, + 'children' => ['ListNetworkServices', 'CreateNetworkService'], 'type' => 'directory', + 'title' => 'Network connectivity', + ], + [ 'children' => [ - 'ListCatalogs', - 'ListTemplate', + 'ListCatalogs', 'ListExecutorLogs', 'GetCacheCluster', 'StartCacheCluster', 'StopCacheCluster', 'ActivateAICenter', 'ChangeResourceGroup', 'CreateWorkspace', 'GetAICenterState', 'GetTemplate', 'ListTemplate', 'ListWorkspaces', 'UpdateWorkspace', 'CancelJobRun', 'CancelRayJob', 'GetCuHours', 'GetRayJob', 'GetRayLog', 'ListRayJob', 'ListRayLogs', + 'StopSessionCluster', 'SubmitRayJob', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ - 'Category' => [ - 'description' => 'The information about the folder.'."\n", - 'visibility' => 'Public', + 'CacheCluster' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'type' => [ + 'clusterId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'state' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'creator' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'modifier' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'paymentType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'resourceSpec' => [ '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', + 'type' => 'object', + 'properties' => [ + 'bandWidth' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'storage' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int64'], + 'ha' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], - 'gmtModified' => [ + 'regionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'usedResourceSpec' => [ + 'type' => 'object', + 'properties' => [ + 'bandWidth' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'storage' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + ], + 'description' => '', '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' => [ + 'example' => '', + ], + 'gmtCreated' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'gmtModified' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'configuration' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'resourceGroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'cacheClusterId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'createTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'cacheClusterName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'version' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'configurations' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => 'cacheset.xml', + 'default' => 'cacheset.xml', + 'enum' => ['cacheset.xml'], + ], + 'content' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', 'title' => '', - 'description' => 'The ID of the user who creates the folder.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '150978934701****', - 'backendName' => 'creator', + 'example' => '', ], - 'gmtCreated' => [ + 'bindedWorkspaces' => [ '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', + 'type' => 'array', + 'items' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], - 'modifier' => [ + 'cachesets' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'path' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', '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', + 'example' => '', ], - 'bizId' => [ + 'tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', 'title' => '', - 'description' => 'The folder ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'w-d8********', - 'backendName' => 'bizId', + 'example' => '', ], - 'name' => [ + 'tables' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'catalogId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'catalogProvider' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'database' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'table' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'workspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', 'title' => '', - 'description' => 'The name of the folder.'."\n", + 'example' => '', + ], + 'extra' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'example' => '', + ], + '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' => 'name', - 'maxLength' => 64, - 'minLength' => 1, + 'example' => 'TASK', 'checkBlank' => true, - 'backendName' => 'name', + 'backendName' => 'type', 'bizType' => 'normal', 'trim' => true, + 'default' => 'TASK', + 'enum' => ['TASK', 'ARTIFACT'], ], - 'parentBizId' => [ - 'title' => '', - 'description' => 'The parent folder ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'w-d6********', - 'backendName' => 'parentBizId', + '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' => '创建者uid', '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' => '最后更新者uid', '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' => '目录业务id', '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' => '父目录业务id', 'description' => 'The parent folder ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'w-d6********', 'backendName' => 'parentBizId'], ], ], 'Configuration' => [ @@ -267,30 +243,9 @@ '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', - ], + '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' => [ @@ -305,37 +260,17 @@ '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', - ], + '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', - ], + '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', - ], + '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', ], @@ -347,22 +282,8 @@ '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', - ], + 'principalArn' => ['title' => '主体Arn', 'description' => 'The ARN of the principal.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:emr::workspaceId:user/23759369154162****', 'backendName' => 'principalArn'], + 'actionArn' => ['title' => '行为Arn', 'description' => 'The ARN of the behavior.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:emr::workspaceId:action/create_queue', 'backendName' => 'actionArn'], ], ], 'RunLog' => [ @@ -380,30 +301,9 @@ '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', - ], + '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' => [ @@ -411,24 +311,8 @@ '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', - ], + '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' => [ @@ -436,301 +320,316 @@ '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', - ], + 'key' => ['title' => '标签key值。', 'description' => 'The tag key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'workflowId', 'backendName' => 'key'], + 'value' => ['title' => '标签key值。', 'description' => 'The tag value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'wf-123test', 'backendName' => 'value'], ], ], - 'TaskInstance' => [ - 'description' => 'The job information.'."\n", - 'visibility' => 'Public', + 'Task' => [ 'type' => 'object', 'properties' => [ - 'taskInfo' => [ + 'sparkArgs' => ['title' => '', 'description' => 'The Spark parameters.', 'type' => 'string', 'example' => '100'], + 'sparkDriverMemory' => ['title' => '', 'description' => 'The Spark driver memory.', 'type' => 'integer', 'example' => '', 'format' => 'int64', 'required' => true], + 'sparkVersion' => ['title' => '', 'description' => 'The Spark version.', 'type' => 'string', 'example' => '', 'required' => true], + 'sparkExecutorMemory' => ['title' => '', 'description' => 'The Spark executor memory.', 'type' => 'integer', 'example' => '', 'format' => 'int64', 'required' => true], + 'sparkLogLevel' => ['title' => '', 'description' => 'The Spark log level.', 'type' => 'string', 'example' => '', 'required' => true], + 'sparkEntrypoint' => ['title' => '', 'description' => 'The Spark main class entry point.', 'type' => 'string', 'example' => '', 'required' => false], + 'gmtModified' => ['title' => '', 'description' => 'The last modification time.', 'type' => 'string', 'example' => '', 'required' => true], + 'hasCommited' => ['title' => '', 'description' => 'Indicates whether the task has been submitted.', 'type' => 'boolean', 'example' => '', 'required' => true], + 'sparkLogPath' => ['title' => '', 'description' => 'The Spark log path.', 'type' => 'string', 'example' => '', 'required' => true], + 'creator' => ['title' => '', 'description' => 'The UID of the creator.', 'type' => 'integer', 'example' => '', 'format' => 'int64', 'required' => true], + 'gmtCreated' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '', 'required' => true], + 'name' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => '', 'required' => true], + 'sparkDriverCores' => ['title' => '', 'description' => 'The number of Spark driver cores.', 'type' => 'integer', 'example' => '', 'format' => 'int32', 'required' => true], + 'type' => ['title' => '', 'description' => 'The task type.', 'type' => 'string', 'example' => '', 'required' => true], + 'sparkExecutorCores' => ['title' => '', 'description' => 'The number of Spark executor cores.', 'type' => 'integer', 'example' => '', 'format' => 'int32', 'required' => true], + 'content' => ['title' => '', 'description' => 'The Spark job content.', 'type' => 'string', 'example' => '', 'required' => false], + 'extraArtifactIds' => [ 'title' => '', - 'description' => 'The details of the job.'."\n", - 'visibility' => 'Public', + 'description' => 'The IDs of extra Spark resources.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], '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', + 'example' => '', ], - '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' => [ + 'lastRunResourceQueueId' => ['title' => '', 'description' => 'The ID of the resource queue used in the last run.', 'type' => 'string', 'example' => ''], + 'modifier' => ['title' => '', 'description' => 'The UID of the last modifier.', 'type' => 'integer', 'example' => '', 'format' => 'int64', 'required' => true], + 'sparkConf' => [ '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' => [ + 'description' => 'The list of Spark configurations.', + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SparkConf'], + 'example' => '', + ], + 'bizId' => ['title' => '', 'description' => 'The business ID.', 'type' => 'string', 'example' => '', 'required' => true], + 'categoryBizId' => ['title' => '', 'description' => 'The folder business ID.', 'type' => 'string', 'example' => ''], + 'artifactUrl' => ['title' => '', 'description' => 'The temporary URL for accessing the resource file.', 'type' => 'string', 'example' => ''], + 'defaultResourceQueueId' => ['title' => '', 'description' => 'The default queue ID of the task.', 'type' => 'string', 'example' => ''], + 'tags' => [ 'title' => '', - 'description' => 'The size of executor memory of the Spark job.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1073741824', - 'backendName' => 'sparkExecutorMemory', + 'description' => 'The task labels.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'tag key'], + 'example' => '', ], - 'sparkVersion' => [ + 'defaultDatabase' => ['title' => '', 'description' => 'The default database.', 'type' => 'string', 'example' => ''], + 'hasChanged' => ['title' => '', 'description' => 'Indicates whether the task has been changed since the last submission.', 'type' => 'boolean', 'example' => ''], + 'pyFiles' => [ 'title' => '', - 'description' => 'The engine version of Spark.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'esr-4.1.1', - 'backendName' => 'sparkVersion', + 'description' => 'The Spark PySpark dependency pyfiles.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'example' => '', ], - 'sparkLogLevel' => [ + 'defaultCatalogId' => ['title' => '', 'description' => 'The default catalog ID.', 'type' => 'string', 'example' => ''], + 'defaultSqlComputeId' => ['title' => '', 'description' => 'The default SQL session ID.', 'type' => 'string', 'example' => ''], + 'jars' => [ 'title' => '', - 'description' => 'The level of the Spark log.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'INFO', - 'backendName' => 'sparkLogLevel', + 'description' => 'The --jars parameter.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], - 'sparkExecutorCores' => [ + 'archives' => [ 'title' => '', - 'description' => 'The number of executor cores of the Spark job.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'backendName' => 'sparkExecutorCores', + 'description' => 'The --archives parameter.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], - 'gmtModified' => [ + 'files' => [ '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' => [ + 'description' => 'The --files parameter.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'extraSparkSubmitParams' => ['title' => '', 'description' => 'The custom Spark submit configuration parameters.', 'type' => 'string', 'example' => ''], + 'deploymentId' => ['title' => '', 'description' => 'The deployment ID of the streaming task.', 'type' => 'string', 'example' => ''], + 'isStreaming' => ['title' => '', 'description' => 'Indicates whether the task is a streaming task.', 'type' => 'boolean', 'example' => ''], + 'sparkSubmitClause' => ['title' => '', 'description' => 'The Spark submit task submission statement.', 'type' => 'string', 'example' => ''], + 'fusion' => ['title' => '', 'description' => 'Indicates whether the fusion switch is enabled.', 'type' => 'boolean', 'example' => ''], + 'timeout' => ['title' => '', 'description' => 'The task timeout period.', 'type' => 'integer', 'example' => '', 'format' => 'int32'], + 'credential' => [ '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', + 'description' => 'The OSS direct upload credentials.', + 'type' => 'object', + 'properties' => [ + 'accessId' => ['title' => '', 'description' => 'access id', 'type' => 'string', 'example' => ''], + 'securityToken' => ['title' => '', 'description' => 'security token', 'type' => 'string', 'example' => ''], + 'policy' => ['title' => '', 'description' => 'policy', 'type' => 'string', 'example' => ''], + 'signature' => ['title' => '', 'description' => 'The signature.', 'type' => 'string', 'example' => ''], + 'path' => ['title' => '', 'description' => 'The path.', 'type' => 'string', 'example' => ''], + 'host' => ['title' => '', 'description' => 'The domain name.', 'type' => 'string', 'example' => ''], + 'expire' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'integer', 'example' => '', 'format' => 'int64'], + 'accessUrl' => ['title' => '', 'description' => 'The access URL.', 'type' => 'string', 'example' => ''], + ], + 'example' => '', ], - 'creator' => [ + 'environmentId' => ['title' => '', 'description' => 'The environment ID.', 'type' => 'string', 'example' => ''], + 'sessionClusterId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'kernelId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'params' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', 'title' => '', - 'description' => 'The user ID of the job creator.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '150978934701****', - 'backendName' => 'creator', - ], - 'gmtCreated' => [ + 'example' => '', + ], + 'rayEntrypoint' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayNetworkServiceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayRuntimeEnvJson' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayWorkingDir' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayMetadataJson' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'raySubmissionMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayEntrypointNumCpus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayEntrypointNumGpus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayEntrypointMemory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayEntrypointResources' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayShutdownAfterJobFinishes' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'rayTtlSecondsAfterFinished' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'rayActiveDeadlineSeconds' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'rayBackoffLimit' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'rayHeadSpec' => [ + 'type' => 'object', + 'properties' => [ + 'replica' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'enableAutoScaling' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'idleTimeoutSeconds' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int64'], + 'queueName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'cpu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'memory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'gpuSpec' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', 'title' => '', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '2025-03-10T02:02:41.000+00:00'."\n", - 'backendName' => 'gmtCreated', + 'example' => '', ], - 'modifier' => [ + 'rayExtraParam' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'rayVolumeIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', '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', + 'example' => '', ], - 'sparkConf' => [ - 'title' => 'spark conf', - 'description' => 'The SparkConf objects.'."\n", - 'visibility' => 'Public', + 'rayWorkerSpec' => [ 'type' => 'array', 'items' => [ - 'description' => 'The SparkConf object.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/SparkConf', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'replica' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'minReplica' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'maxReplica' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32'], + 'queueName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'cpu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'memory' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'gpuSpec' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'backendName' => 'sparkConf', - ], - 'templateType' => [ - 'title' => '', - 'description' => 'The template type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'TASK', - 'backendName' => 'templateType', - ], - 'fusion' => [ + 'description' => '', 'title' => '', - 'description' => 'Indicates whether Fusion engine is enabled for acceleration.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false'."\n", - 'backendName' => 'fusion', + 'example' => '', ], - 'displaySparkVersion' => [ + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + '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' => '工作空间id', 'description' => 'The workspace ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'w-d2d82aa09151****', 'backendName' => 'workspaceBizId'], + 'taskBizId' => ['title' => '任务业务id', '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' => '任务实例业务id', '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' => '创建者uid', 'description' => 'The ID of the user who creates the job.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '150978934701****', 'backendName' => 'creator'], + ], + ], + 'Template' => [ + 'description' => 'Spark task template object.', + 'type' => 'object', + 'properties' => [ + 'templateType' => ['title' => '', 'description' => 'Template type.', 'type' => 'string', 'example' => 'TASK', 'visibility' => 'Public', 'backendName' => 'templateType'], + 'gmtModified' => ['title' => '', 'description' => 'Last modified time.', 'type' => 'string', 'required' => true, 'example' => '2025-03-10T02:02:41.000+00:00', 'visibility' => 'Public', 'backendName' => 'gmtModified'], + 'creator' => ['title' => '', 'description' => 'Creator UID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '150978934701****', 'visibility' => 'Public', 'backendName' => 'creator'], + 'sparkLogLevel' => ['title' => '', 'description' => 'Spark log level.', 'type' => 'string', 'required' => true, 'example' => 'INFO', 'visibility' => 'Public', 'backendName' => 'sparkLogLevel'], + 'gmtCreated' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'required' => true, 'example' => '2025-03-10T02:02:41.000+00:00'."\n", 'visibility' => 'Public', 'backendName' => 'gmtCreated'], + 'sparkDriverMemory' => ['title' => '', 'description' => 'Spark Driver memory.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1073741824', 'visibility' => 'Public', 'backendName' => 'sparkDriverMemory'], + 'modifier' => ['title' => '', 'description' => 'Last modifier UID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '150978934701****'."\n", 'visibility' => 'Public', 'backendName' => 'modifier'], + 'sparkExecutorCores' => ['title' => '', 'description' => 'Spark Executor cores.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'visibility' => 'Public', 'backendName' => 'sparkExecutorCores'], + 'sparkConf' => [ 'title' => '', - 'description' => 'The displayed version of the Spark engine.'."\n", + 'description' => 'Spark Conf', + 'type' => 'array', + 'items' => ['description' => 'Spark configuration object.', '$ref' => '#/components/schemas/SparkConf', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'esr-4.1.1', - 'backendName' => 'displaySparkVersion', + 'backendName' => 'sparkConf', ], + 'sparkVersion' => ['title' => '', 'description' => 'Spark internal release version.', 'type' => 'string', 'required' => true, 'example' => 'esr-4.1.1', 'visibility' => 'Public', 'backendName' => 'sparkVersion'], + 'sparkExecutorMemory' => ['title' => '', 'description' => 'Spark Executor memory.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1073741824', 'visibility' => 'Public', 'backendName' => 'sparkExecutorMemory'], + 'fusion' => ['title' => '', 'description' => 'Whether to enable the fusion switch.', 'type' => 'boolean', 'example' => 'false'."\n", 'visibility' => 'Public', 'backendName' => 'fusion'], + 'isDefault' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'isDefault'], + 'sparkDriverCores' => ['title' => '', 'description' => 'Spark Driver cores.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'visibility' => 'Public', 'backendName' => 'sparkDriverCores'], + 'displaySparkVersion' => ['title' => '', 'description' => 'Spark engine display version.', 'type' => 'string', 'example' => 'esr-4.1.1', 'visibility' => 'Public', 'backendName' => 'displaySparkVersion'], + 'sparkLogPath' => ['title' => '', 'description' => 'Spark log path.', 'type' => 'string', 'required' => true, 'example' => 'oss://your_bucket/path/to/your/log', 'visibility' => 'Public', 'backendName' => 'sparkLogPath'], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'name'], + 'bizId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'bizId'], ], + 'title' => '', + 'example' => '', + 'visibility' => 'Public', ], 'TimeRange' => [ - 'title' => '', + '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', - ], + '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', - ], + 'ActivateAICenter' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/activateaicenter', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceLNUXSK'], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + ], + 'title' => '', + 'description' => 'Response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ActivateAICenter', + 'summary' => 'Activates the AI center.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'produces' => [ - 'application/json', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'AddMembers' => [ + 'summary' => 'Adds a Resource Access Management (RAM) user or a 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', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ @@ -738,1081 +637,862 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'workspaceId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-975bcfda9625****', - ], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'w-975bcfda9625****', 'title' => ''], 'memberArns' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'Ram User示例值：acs:ram::113545727984****:user/20468369839086****'."\n" + ."\n" + .'Ram Role示例值：acs:ram::113545727984****:role/aliyunemrsparkjobrundefaultrole', 'title' => ''], 'required' => true, + 'description' => '', + 'title' => '', + 'example' => 'Ram User Example value: acs:ram::113545727984****:user/20468369839086****'."\n" + ."\n" + .'Ram Role Example value: acs:ram::113545727984****:role/aliyunemrsparkjobrundefaultrole', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:AddMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce0SZW92', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '215798', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'nextToken', - 'in' => 'query', + 'name' => 'workspaceId', + 'in' => 'path', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '标记当前开始读取的位置。', - 'description' => '标记当前开始读取的位置，置空表示从头开始。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09155****'], ], [ - 'name' => 'maxResults', - 'in' => 'query', + 'name' => 'jobRunId', + 'in' => 'path', 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'jr-f09a8fda2396****'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '一次获取的最大记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'jobRunId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'jr-f09a8fda2396****', 'title' => ''], + 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobRunId\\": \\"jr-f09a8fda2396****\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + 'title' => 'CancelJobRun', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CancelJobRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + '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', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => '工作空间id。', - 'type' => 'string', - 'required' => true, - 'example' => 'w-975bcfda9625****', - ], + 'schema' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], + ], + [ + 'name' => 'kyuubiServiceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'required' => false, 'title' => '', 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => 'The ID of the Spark application submitted by Kyuubi.', 'required' => false, 'title' => '', 'example' => 'spark-339f844005b6404c95f9f7c7a13b****'], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'description' => 'The region ID.', 'required' => false, 'title' => '', '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' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'body' => [ + 'type' => 'object', + 'properties' => [ + 'applicationId' => ['type' => 'string', 'description' => 'The ID of the Spark application submitted by Kyuubi.', 'title' => '', 'example' => 'spark-339f844005b6404c95f9f7c7a13b****'], + 'success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'title' => '', 'example' => ''], ], - ], - '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', + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response struct.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CancelKyuubiSparkApplication', + 'summary' => 'Cancels a Kyuubi Spark application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"body\\": {\\n \\"applicationId\\": \\"spark-339f844005b6404c95f9f7c7a13b****\\",\\n \\"success\\": false\\n }\\n}","type":"json"}]', ], - 'GrantRoleToUsers' => [ - 'summary' => 'Assigns a specified role to users.', - 'path' => '/api/v1/auth/roles/grant', - 'methods' => [ - 'post', + 'CancelRayJob' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/rayJob/{submissionId}/cancel', + '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' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'required' => false], + ], + [ + 'name' => 'submissionId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'rayjob ID。', 'type' => 'string', 'example' => 'rj-k7nm8ahl5te4tg91', 'required' => false], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944'], + 'success' => ['title' => '', 'description' => 'Indicates whether the cancellation is successfully triggered.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop a ray job', + 'summary' => 'Stops a RayJob.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => 'Moves an instance to a different resource group.', + 'path' => '/changeResourceGroup', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => ['description' => 'The resource type. Set this to `Workspace`.', 'type' => 'string', 'required' => false, 'default' => 'Instance', 'title' => '', 'example' => 'Workspace'], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource to move.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-asfx12xxxxxx'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the resource is located.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination resource group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rg-aek2thxggoqhmhq'], + ], ], - 'produces' => [ - 'application/json', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The unique ID generated for the request.', 'type' => 'string', 'title' => '', 'example' => '8CE06D75-E6A2-505D-9B4B-31DEE3D98A04'], + ], + 'title' => '', + 'description' => 'Container for the response data.', + 'example' => '', + ], + ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '193394', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'MissingParameter.RegionId', 'errorMessage' => 'The RegionId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], ], + 403 => [ + ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ChangeResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8CE06D75-E6A2-505D-9B4B-31DEE3D98A04\\"\\n}","type":"json"}]', + ], + 'CreateKyuubiService' => [ + 'summary' => 'Creates a Kyuubi gateway.', + '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' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], + ], + [ '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, - ], + 'kyuubiConfigs' => ['type' => 'string', 'description' => 'The Kyuubi service configuration.', 'required' => false, 'title' => '', 'example' => '[{\\"key\\":\\"kyuubi.engine.share.level\\",\\"value\\":\\"USER\\"}]'], + 'sparkConfigs' => ['type' => 'string', 'description' => 'The Spark configuration.', 'required' => false, 'title' => '', 'example' => '[{\\"key\\":\\"spark.app.name\\",\\"value\\":\\"test\\"}]'], + 'name' => ['type' => 'string', 'description' => 'The Kyuubi service name.', 'required' => false, 'title' => '', 'example' => 'dev_serverless_spark'], + 'queue' => ['type' => 'string', 'description' => 'The queue where the Kyuubi service runs.', 'required' => false, 'title' => '', 'example' => 'dev_queue'], + 'computeInstance' => ['type' => 'string', 'description' => 'The specifications of the Kyuubi service.', 'required' => false, 'title' => '', 'example' => '2c8g'], + 'releaseVersion' => ['type' => 'string', 'description' => 'The Spark database engine version.', 'required' => false, 'title' => '', 'example' => 'esr-4.6.0 (Spark 3.5.2, Scala 2.12)'], + 'publicEndpointEnabled' => ['type' => 'boolean', 'default' => 'false', 'description' => 'Specifies whether to enable public network access.', 'required' => false, 'title' => '', 'example' => 'true'], + 'replica' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of replicas for high availability (HA).', 'required' => false, 'title' => '', 'example' => '3'], + 'kyuubiReleaseVersion' => ['type' => 'string', 'description' => 'The Kyuubi service database engine version.', 'required' => false, 'title' => '', 'example' => '1.9.2-0.0.2'], ], + 'description' => 'The request body.', 'required' => false, - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], ], '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****', + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n"], + 'data' => [ + 'type' => 'object', + 'properties' => [ + 'kyuubiServiceId' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'title' => '', 'example' => 'kb-f99935b350fb4****7ef700b8b4197a3'], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response struct.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateKyuubiService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', - 'title' => 'GrantRoleToUsers', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\",\\n \\"data\\": {\\n \\"kyuubiServiceId\\": \\"kb-f99935b350fb4****7ef700b8b4197a3\\"\\n }\\n}","type":"json"}]', ], - 'GetSessionCluster' => [ - 'summary' => 'Queries the information about a session.', - 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters/{sessionClusterId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateKyuubiToken' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '203510', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-1234abcd', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****'."\n", 'title' => ''], ], [ - 'name' => 'sessionClusterId', + 'name' => 'kyuubiServiceId', 'in' => 'path', - 'allowEmptyValue' => false, + 'schema' => ['description' => 'The Kyuubi service ID.', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '作业名称。', - 'description' => 'The session ID.'."\n", - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The token name.', 'type' => 'string', 'required' => false, 'example' => 'dev_serverless_spark', 'title' => ''], + 'token' => ['description' => 'The token content. The token must be 32 characters long and contain only lowercase letters and digits.', 'type' => 'string', 'required' => false, 'example' => 'rjy7ejhej9gkzjjuun49jnx2xk8if2cu', 'title' => ''], + 'autoExpireConfiguration' => [ + 'description' => 'The automatic expiration settings.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether the token automatically expires.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'expireDays' => ['description' => 'The expiration period in days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'memberArns' => [ + 'description' => 'The list of ARNs of authorized users.', + 'type' => 'array', + 'items' => ['description' => 'The ARN of an authorized user.', 'type' => 'string', 'required' => false, 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311'."\n", 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'sparkRole' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'emr-spark-demo-job', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'sessionCluster' => [ - 'description' => 'The session object.'."\n", + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => [ + 'description' => 'The returned data.', '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', - ], + 'tokenId' => ['description' => 'The token ID.', 'type' => 'string', 'example' => 'tk-zpi0*****hdv4y'."\n", 'title' => ''], ], - ], - 'requestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateKyuubiToken', + 'summary' => 'Creates a Kyuubi Gateway authentication token.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"tokenId\\": \\"tk-zpi0*****hdv4y\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'CreateLivyCompute' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '202902', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '222228', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ + 'name' => 'workspaceBizId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], + ], + [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'queueName' => [ - 'description' => 'The queue name.'."\n", + 'name' => ['description' => 'The name of the Livy Gateway.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testGateway'], + 'livyVersion' => [ + 'description' => 'The Livy version.', 'type' => 'string', 'required' => false, - 'example' => 'root_queue', + 'enum' => ['0.8.0'], + 'title' => '', + 'enumValueTitles' => [], + 'example' => '0.8.0', + ], + 'releaseVersion' => ['description' => 'The version number of the Spark engine. This parameter is deprecated. Use displayReleaseVersion instead.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)'], + 'queueName' => ['description' => 'The name of the submission queue.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'root_queue'], + 'cpuLimit' => [ + 'description' => 'The number of CPU cores for the Livy server.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [1 => '1', '2', 4 => '4'], + 'title' => '', + 'example' => '1', + ], + 'memoryLimit' => [ + 'description' => 'The memory size of the Livy server.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['16Gi' => '16 Gi', '4Gi' => '4 Gi', '8Gi' => '8 Gi'], + 'title' => '', + 'example' => '4Gi', ], 'autoStartConfiguration' => [ - 'description' => 'Specifies whether to enable automatic startup.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", + 'description' => 'The automatic startup configuration.', 'type' => 'object', 'properties' => [ - 'enable' => [ - 'description' => 'Specifies whether to enable automatic startup.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'enable' => ['description' => 'Specifies whether to automatically start the Livy Gateway after it is created.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'autoStopConfiguration' => [ - 'description' => 'The automatic termination configuration.'."\n", + 'description' => 'The automatic stop configuration.', '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, + 'enable' => ['description' => 'Specifies whether to automatically stop the Livy Gateway.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'idleTimeoutMinutes' => ['description' => 'The number of minutes after which the Livy Gateway is automatically stopped if it is idle.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '300'], ], 'required' => false, + 'title' => '', + 'example' => '', ], - '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", + 'authType' => [ + 'description' => 'The authentication method.', 'type' => 'string', 'required' => false, - 'example' => 'env-cpv569tlhtgndjl86t40', - ], - 'publicEndpointEnabled' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - 'clientToken' => [ - 'type' => 'string', + 'enum' => ['Token'], + 'title' => '', + 'enumValueTitles' => [], + 'example' => 'Token', ], + 'displayReleaseVersion' => ['description' => 'The version number of the Spark engine.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12)'."\n"], + 'fusion' => ['description' => 'Specifies whether to enable acceleration with the Fusion engine.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'environmentId' => ['description' => 'The ID of the runtime environment.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ev-ctfq0fem1hkhgv4hapng'], + 'networkName' => ['description' => 'The name of the network connection.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], + 'livyServerConf' => ['description' => 'The configuration of the Livy Gateway. This parameter is in JSON format and supports the following files:'."\n" + ."\n" + .'- sparkDefaultsConf'."\n" + ."\n" + .'- sparkBlackListConf'."\n" + ."\n" + .'- livyConf'."\n" + ."\n" + .'- livyClientConf', 'type' => 'string', 'required' => false, 'title' => '', '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' => 'Specifies whether to enable the public endpoint.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], 'required' => false, - ], - ], - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-790b443d72394bfc', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response body.', '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****', + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The status code of the request. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. For more information, see the message parameter.', 'type' => 'string', 'title' => '', 'example' => '1000000'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'livyComputeId' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'title' => '', 'example' => 'lc-i8xogcdfa4fk3yn1'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateLivyCompute', + 'summary' => 'Creates a Livy compute.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'CreateLivyComputeToken' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '222305', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], - 'operationType' => 'read', - 'systemTags' => [], 'parameters' => [ [ + 'name' => 'workspaceBizId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'lc-zm4dzdiubu73w2yx'], + ], + [ 'name' => 'body', 'in' => 'body', - 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => 'The request struct.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'queueName' => [ - 'description' => 'The queue name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'root_queue', - ], - 'sessionClusterId' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', + 'name' => ['description' => 'The token name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'mytoken'], + 'token' => ['description' => 'The token content. The length must be 16 or more characters.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'gs3fy75w4o7hqe5s'], + 'autoExpireConfiguration' => [ + 'description' => 'The token expiration information struct.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether the token automatically expires.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'expireDays' => ['description' => 'The expiration period in days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '7'], + ], 'required' => false, - 'example' => 'sc-xxxxxxxxxxxx', + 'title' => '', + 'example' => '', ], ], 'required' => false, - ], - ], - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response schema.', '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****', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. See the message parameter for error details.', 'type' => 'string', 'title' => '', 'example' => '1000000'], + 'message' => ['description' => 'The error details.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'tokenId' => ['description' => 'The token ID.', 'type' => 'string', 'title' => '', 'example' => 'lctk-xxxxxxxx'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateLivyComputeToken', + 'summary' => 'Creates a token for a Livy Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'CreateNetworkService' => [ + 'summary' => 'Creates a network service.', + 'path' => '/api/v1/workspaces/{workspaceId}/networkServices', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceX85SDM'], + ], 'parameters' => [ [ 'name' => 'body', @@ -1820,587 +1500,331 @@ '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', + 'name' => ['description' => 'The name of the network service.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'type' => ['description' => 'The type of the network service.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1g14f566kbk8jex****', 'title' => ''], + 'vswitchIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1j94qrn5meu5ft0****', 'title' => ''], + 'description' => 'A list of vSwitch IDs.', 'required' => false, - 'example' => 'sc-xxxxxxxxxxx', + 'title' => '', + 'example' => '', ], + 'securityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => false, 'example' => ' securityGroupId', 'title' => ''], + 'clientToken' => ['description' => 'A token to ensure the idempotency of the request.', 'type' => 'string', 'required' => false, 'example' => 'acaf8f54-d40e-4c33-a900-f6c1b345cb47', 'title' => ''], ], + 'description' => 'The request body.', 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], '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****', - ], + 'operationId' => ['description' => 'The operation ID.', 'type' => 'string', 'example' => 'w-******', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - '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', + 'title' => 'CreateNetworkService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"operationId\\": \\"w-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'CreateProcessDefinitionWithSchedule' => [ + 'path' => '/dolphinscheduler/projects/{bizId}/process-definition', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '202905', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '191322', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'nextToken', + 'name' => 'productNamespace', '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', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SS'], ], [ - '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' => 'bizId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-d8********'], ], [ - 'name' => 'workspaceId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-1234abcd', - ], + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the workflow.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ods_batch_workflow'], ], [ - 'name' => 'sessionClusterId', + 'name' => 'description', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '作业名称。', - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr-spark-demo-job', - ], + 'schema' => ['description' => 'The description of the workflow.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ods batch workflow'], ], [ - 'name' => 'queueName', + 'name' => 'timeout', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the queue.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'root', - ], + 'schema' => ['description' => 'The default timeout period for a workflow run.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '60'], ], [ - 'name' => 'kind', + 'name' => 'taskRelationJson', 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'A JSON array of task dependencies. \\`preTaskCode\\` specifies the upstream task ID and \\`postTaskCode\\` specifies the downstream task ID. Each task must have a unique ID. For tasks without an upstream dependency, set \\`preTaskCode\\` to 0.', + 'type' => 'array', + 'items' => [ + 'description' => 'A JSON array of task dependencies. \\`preTaskCode\\` specifies the upstream task ID and \\`postTaskCode\\` specifies the downstream task ID. Each task must have a unique ID. For tasks without an upstream dependency, set \\`preTaskCode\\` to 0.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the task topology. Use the workflow name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ods batch workflow'], + 'preTaskCode' => ['description' => 'The ID of the upstream task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '16************'], + 'preTaskVersion' => ['description' => 'The version of the upstream task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], + 'postTaskCode' => ['description' => 'The ID of the downstream task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '28************'], + 'postTaskVersion' => ['description' => 'The version of the downstream task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'example' => 'SQL', - 'default' => 'SQL', + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'regionId', + 'name' => 'taskDefinitionJson', 'in' => 'query', + 'style' => 'json', '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", + 'description' => 'A JSON array of task definitions. This array contains the details for all tasks in the workflow.', + 'type' => 'array', + 'items' => [ + 'description' => 'A JSON object that defines a task. This object contains the details for the task.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The ID of the task definition.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '36************'], + 'description' => ['description' => 'The description of the task definition.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ods transform task'], + 'alertEmailAddress' => ['description' => 'The email address to which alerts are sent.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'foo_bar@spark.alert.invalid.com'], + 'startAlertEnable' => ['description' => 'Specifies whether to enable alerts when a task starts.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'failAlertEnable' => ['description' => 'Specifies whether to enable alerts when a task fails.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'failRetryTimes' => ['description' => 'The number of times to retry a task after it fails.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'name' => [ + 'description' => 'The name of the task.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'title' => '', + 'example' => 'ods_transform_task', + ], + 'taskParams' => [ + 'description' => 'The parameters of the task definition.', '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', + 'workspaceBizId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-d8********'], + 'taskBizId' => ['description' => 'The ID of the Data Development task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'TSK-d87******************'], + 'resourceQueueId' => ['description' => 'The resource queue in which the Spark task runs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'root_queue'], + 'sparkDriverCores' => ['description' => 'The number of cores for the Spark driver.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'sparkExecutorCores' => ['description' => 'The number of cores for each Spark executor.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'sparkDriverMemory' => ['description' => 'The memory of the Spark driver.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '4g'], + 'sparkExecutorMemory' => ['description' => 'The memory of each Spark executor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '4g'], + 'sparkConf' => [ + 'description' => 'The configurations of the Spark task.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the Spark configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark.dynamicAllocation.enabled'], + 'value' => ['description' => 'The value of the Spark configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'true'], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'applicationConfigs' => [ - 'description' => 'The session configurations, which are equivalent to the configurations of the Spark job.'."\n", + 'sparkVersion' => ['description' => 'The version of the Spark engine.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)'], + 'sparkLogLevel' => ['description' => 'The log level for Spark.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'INFO'], + 'sparkLogPath' => ['description' => 'The path where the Spark task logs are stored.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'oss://data***/spark/logs'], + 'displaySparkVersion' => ['description' => 'The display version of the Spark engine.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)'], + 'fusion' => ['description' => 'Specifies whether to enable the Fusion engine for acceleration.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'environmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'env-crhq2h5lhtgju93buhkg'], + 'type' => ['description' => 'The type of the Spark task.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SQL'], + 'localParams' => [ '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', - ], + 'prop' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'direct' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'type' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - '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', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'taskType' => ['description' => 'The type of the workflow node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'EMR_SERVERLESS_SPARK'], + 'timeout' => ['description' => 'The timeout period for the callback method, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1200'], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'A JSON string of tag key-value pairs.', 'title' => '', 'example' => '“{\\"tagkey\\":\\"tagvalue\\"}”'], + 'title' => '', + 'example' => '', ], ], - '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', - ], + 'required' => true, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - ], - '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', + 'name' => 'executionType', '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', - ], + 'schema' => ['description' => 'The execution policy.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'PARALLEL'], ], [ - 'name' => 'maxResults', + 'name' => 'alertEmailAddress', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The email address to which alerts are sent.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'foo_bar@spark.alert.invalid.com'], ], [ - 'name' => 'workspaceId', - 'in' => 'path', + 'name' => 'schedule', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', + 'description' => 'The scheduling configuration.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start time of the schedule.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-12-23 16:13:27'], + 'endTime' => ['description' => 'The end time of the schedule.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-12-23 16:13:27'], + 'crontab' => ['description' => 'The cron expression for the schedule.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0 0 0 * * ?'], + 'timezoneId' => ['description' => 'The time zone ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Asia/Shanghai'], + ], 'required' => false, - 'example' => 'w-d2d82aa09155****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'kyuubiServiceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Kyuubi service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', - 'title' => 'Kyuubi 服务 ID。', - ], + 'name' => 'retryTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'applicationId', + 'name' => 'taskParallelism', '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****', - ], + 'schema' => ['description' => 'The degree of parallelism for tasks.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ - 'name' => 'applicationName', + 'name' => 'resourceQueue', '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****', - ], + 'schema' => ['description' => 'The resource queue.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'root_queue'], ], [ - 'name' => 'startTime', + 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The range of start time.'."\n", + 'description' => 'The tags.', '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, + 'additionalProperties' => ['type' => 'string', 'description' => 'A JSON string of tag key-value pairs.', 'title' => '', 'example' => '“{\\"tagkey\\":\\"tagvalue\\"}”'], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'resourceQueueId', + 'name' => 'publish', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to publish the workflow.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], ], [ - 'name' => 'minDuration', + 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'orderBy', + 'name' => 'runAs', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud UID of the user who runs the workflow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '113***************'], + ], + [ + 'name' => 'globalParams', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'prop' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'direct' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'type' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - [ - 'name' => 'sort', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -2408,2070 +1832,1724 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', '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' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The API return code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1400009'], + 'msg' => ['description' => 'A detailed message for the return code.', 'type' => 'string', 'title' => '', 'example' => 'No permission for resource action'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'title' => '', 'example' => 'true'], + 'failed' => ['description' => 'Indicates whether the request failed.', 'type' => 'string', 'title' => '', 'example' => 'false'], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The serial number of the workflow definition.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '12342'], + 'code' => ['description' => 'The ID of the workflow definition.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '160************'], ], + 'title' => '', + 'example' => '', ], - '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', - ], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateProcessDefinitionWithSchedule', + 'summary' => 'Creates a workflow definition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateProcessDefinitionWithSchedule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', + '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"}]', ], - 'CancelKyuubiSparkApplication' => [ - 'summary' => 'CancelKyuubiSparkApplication', - 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/application/{applicationId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'CreateRayCluster' => [ + 'summary' => 'Creates a Ray cluster.', + 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], '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****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'title' => '', 'required' => false], ], [ - 'name' => 'applicationId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the Ray cluster. The name must be 1 to 64 characters in length.', 'type' => 'string', 'example' => 'testRayCluster', 'title' => '', 'required' => false], + 'displayReleaseVersion' => ['description' => 'The version of the Ray engine.', 'type' => 'string', 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', 'title' => '', 'required' => false], + 'description' => ['description' => 'The description of the cluster.', 'type' => 'string', 'example' => 'Ray Cluster for dev.', 'title' => '', 'required' => false], + 'networkServiceName' => ['description' => 'The name of the network connection.', 'type' => 'string', 'example' => 'vpc', 'title' => '', 'required' => false], + 'headSpec' => [ + 'type' => 'object', + 'properties' => [ + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'title' => '', 'required' => false], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => '', 'required' => false], + 'memory' => ['description' => 'The memory size, in GiB.', 'type' => 'string', 'example' => '8Gi', 'title' => '', 'required' => false], + 'enableAutoScaling' => ['description' => 'Specifies whether to enable automatic scaling for worker nodes.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], + 'idleTimeoutSeconds' => ['description' => 'The idle timeout period in seconds for worker nodes when automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => '', 'required' => false], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The parameters for the head node of the Ray cluster.', + 'required' => false, + 'example' => '', + ], + 'workerSpec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the worker group.', 'type' => 'string', 'example' => 'WorkerGroup1', 'title' => '', 'required' => false], + 'workerType' => [ + 'description' => 'The worker type.', + 'type' => 'string', + 'example' => 'CPU', + 'enum' => ['CPU'], + 'title' => '', + 'required' => false, + ], + 'replica' => ['description' => 'The number of worker nodes. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'required' => false], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'title' => '', 'required' => false], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '4', 'title' => '', 'required' => false], + 'memory' => ['description' => 'The memory size, in GiB.', 'type' => 'string', 'example' => '16Gi', 'title' => '', 'required' => false], + 'minReplica' => ['description' => 'The minimum number of worker nodes for automatic scaling. The minimum value is 1. This value must be less than or equal to maxReplica.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + 'maxReplica' => ['description' => 'The maximum number of worker nodes for automatic scaling. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The struct of the worker node.', + 'required' => false, + 'example' => '', + ], + 'title' => '', + 'description' => 'The parameters for the worker nodes of the Ray cluster. You can specify up to 50 worker groups.', + 'required' => false, + 'example' => '', + ], + 'extraParam' => ['description' => 'Additional parameters. The value must be in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => '', 'required' => false], + 'volumeIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'vol-1234567890', 'description' => '', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The request struct.', 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => '', ], ], ], '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', - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', 'title' => ''], + 'clusterId' => ['description' => 'The ID of the Ray cluster.', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateRayCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"body\\": {\\n \\"applicationId\\": \\"spark-339f844005b6404c95f9f7c7a13b****\\",\\n \\"success\\": true\\n }\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"clusterId\\": \\"ray-k7nm8ahl5te4tg91\\"\\n}","type":"json"}]', ], - 'DeleteKyuubiToken' => [ - 'summary' => '删除compute的token', - 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'CreateSessionCluster' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeCode' => '202902', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], - ], - [ - 'name' => 'kyuubiServiceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'root_queue'], + 'autoStartConfiguration' => [ + 'description' => 'The automatic startup configuration.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether to enable automatic startup.'."\n" + ."\n" + .'- true: Enables automatic startup.'."\n" + ."\n" + .'- false: Disables automatic startup.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'autoStopConfiguration' => [ + 'description' => 'The automatic stop configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether to enable automatic stop.'."\n" + ."\n" + .'- true: Enables automatic stop.'."\n" + ."\n" + .'- false: Disables automatic stop.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'idleTimeoutMinutes' => ['description' => 'The idle timeout period of the session. The session is automatically stopped after it is idle for the specified period. Unit: minutes.', 'type' => 'integer', 'required' => false, 'title' => '', 'example' => '60'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'applicationConfigs' => [ + 'description' => 'The Spark application configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'A Spark application configuration.', + 'type' => 'object', + 'properties' => [ + 'configFileName' => ['description' => 'The name of the configuration file.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark-defaults.conf'."\n"], + 'configItemKey' => ['description' => 'The key of a Spark configuration item.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark.app.name'], + 'configItemValue' => ['description' => 'The value of a Spark configuration item.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'releaseVersion' => ['description' => 'The version of the Spark engine.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-3.3.1'], + 'name' => ['description' => 'The name of the task.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark_job_name'], + 'kind' => ['description' => 'The type of the session. Valid values:'."\n" + ."\n" + .'- SQL: an SQL session.'."\n" + ."\n" + .'- NOTEBOOK: a Notebook session.', 'type' => 'string', 'required' => false, 'default' => 'SQL', 'title' => '', 'example' => 'SQL'], + 'displayReleaseVersion' => ['description' => 'The version that is displayed in the console.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-3.3.1'."\n"], + 'fusion' => ['description' => 'Specifies whether to enable the Fusion engine for acceleration.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'envId' => ['description' => 'The ID of the Python environment. This parameter applies only to Notebook sessions.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'env-cpv569tlhtgndjl86t40'], + 'publicEndpointEnabled' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + 'clientToken' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'tokenId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Token ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'tk-zpi0*****hdv4y', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-790b443d72394bfc'], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'sessionClusterId' => ['title' => 'Workspace Id。', 'description' => 'The session ID.', 'type' => 'string', 'example' => 'w-******'], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'CreateSessionCluster', + 'summary' => 'Creates a session cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusterId\\": \\"w-******\\",\\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', - ], + 'CreateSqlStatement' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeCode' => '224750', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d****'], ], [ - 'name' => 'kyuubiServiceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body to create an SQL query.', + 'type' => 'object', + 'properties' => [ + 'codeContent' => ['description' => 'The SQL code. This parameter accepts one or more SQL statements for execution.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SHOW TABLES'], + 'defaultDatabase' => ['description' => 'The name of the default database.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'default'], + 'limit' => ['description' => 'The limit value. The value must be between 1 and 10000, inclusive.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1000', 'title' => '', 'example' => '1000'], + 'defaultCatalog' => ['description' => 'The ID of the default DLF Catalog.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'default_catalog'], + 'sqlComputeId' => ['description' => 'The ID of the SQL session. The session must be created in the Session Manager module of the EMR Serverless Spark workspace.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'sc-dfahdfjafhajd****'], + 'taskBizId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'tokenId', - 'in' => 'path', + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Token ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'tk-zpi0*****hdv4y'."\n", + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'statementId' => ['description' => 'The ID of the interactive query.', 'type' => 'string', 'title' => '', 'example' => 'st-1231dfafadfa***'], + ], + 'title' => '', + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateSqlStatement', + 'summary' => 'Creates an SQL statement.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"statementId\\": \\"st-1231dfafadfa***\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'CreateWorkspace' => [ + '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' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dev_serverless_spark'."\n", - ], - 'token' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rjy7ejhej9gkzjjuun49jnx2xk8if2cu', - ], - 'autoExpireConfiguration' => [ - 'description' => '', + 'workspaceName' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'resourceSpec' => [ + 'description' => 'The resource specifications.', 'type' => 'object', 'properties' => [ - 'enable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'expireDays' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '365', - ], + 'cu' => ['description' => 'The resource quota for the workspace.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + 'gpu' => ['description' => 'The GPU resource quota for the workspace.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'memberArns' => [ - 'description' => '', + 'ossBucket' => ['description' => 'The OSS bucket for the workspace. The path must be in the `oss://<bucket-name>/` format.', 'type' => 'string', 'required' => false, 'example' => 'oss://test-bucket/', 'title' => ''], + 'dlfCatalogId' => ['description' => 'The DLF Catalog ID.', 'type' => 'string', 'required' => false, 'example' => '123xxxxx', 'title' => ''], + 'paymentType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- `PayAsYouGo`: pay-as-you-go'."\n" + ."\n" + .'- `Pre`: subscription', 'type' => 'string', 'required' => false, 'example' => 'PayAsYouGo', 'title' => ''], + 'paymentDurationUnit' => ['description' => 'The unit of the subscription duration. This parameter is required if you set `paymentType` to `Pre`.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + 'duration' => ['description' => 'The subscription duration. This parameter is required if you set `paymentType` to `Pre`.', 'type' => 'string', 'required' => false, 'example' => '12452', 'title' => ''], + 'autoRenew' => ['description' => 'Specifies whether to enable auto-renewal. This parameter is required if you set `paymentType` to `Pre`.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + 'autoRenewPeriod' => ['description' => 'The auto-renewal duration. This parameter is required if `autoRenew` is set to `true`.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], + 'autoRenewPeriodUnit' => ['description' => 'The unit of the auto-renewal duration. This parameter is required if `autoRenew` is set to `true`.', 'type' => 'string', 'required' => false, 'example' => 'month', 'title' => ''], + 'clientToken' => ['description' => 'A token that ensures the idempotency of the request.', 'type' => 'string', 'required' => false, 'example' => '8e6aae2810c8f67229ca70bb31cd****', 'title' => ''], + 'ramRoleName' => ['description' => 'The name of the RAM role used to run Spark jobs.', 'type' => 'string', 'required' => false, 'example' => 'AliyunEMRSparkJobRunDefaultRole', 'title' => ''], + 'autoStartSessionCluster' => ['description' => 'Specifies whether to automatically start a session cluster when the workspace is created.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'releaseType' => ['description' => 'The release type.', 'type' => 'string', 'required' => false, 'example' => 'pro', 'title' => ''], + 'dlfType' => ['description' => 'The DLF type.', 'type' => 'string', 'default' => '1.0', 'required' => false, 'example' => 'dlf1.0', 'title' => ''], + 'tag' => [ 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], 'required' => false, - 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311', + 'description' => 'A tag.', + 'title' => '', + 'example' => '', ], + 'maxItems' => 20, 'required' => false, + 'description' => 'The tags to add to the workspace.', + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmwpi66knkxny', 'required' => false, 'title' => ''], + 'gpuSpec' => [ + 'type' => 'array', + 'items' => ['description' => 'The instance type of the GPU resources.', 'type' => 'string', 'example' => 'ecs.gn7i-c8g1.2xlarge', 'title' => ''], + 'description' => 'The specifications for the GPU resources.', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", - ], + 'workspaceId' => ['title' => 'Workspace Id。', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-******'], + 'operationId' => ['title' => 'Operation Id。', 'description' => 'The operation ID.', 'type' => 'string', 'example' => 'op-******'], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'CreateWorkspace', + 'summary' => 'Creates a workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workspaceId\\": \\"w-******\\",\\n \\"operationId\\": \\"op-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', ], - 'GetKyuubiToken' => [ - 'summary' => '获取compute的token', - 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteKyuubiService' => [ + 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', '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', - ], + 'schema' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'required' => false, 'title' => '', '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' => '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', - ], - ], - ], - ], + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => ['type' => 'any', 'description' => 'The returned data.', 'title' => '', 'example' => 'true'], ], + 'title' => '', + 'description' => 'The response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteKyuubiService', + 'summary' => 'Deletes a Kyuubi gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', ], - 'CreateKyuubiToken' => [ - 'summary' => '创建kyuubi的token', - 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteKyuubiToken' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****'."\n", - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", - ], + 'schema' => ['description' => 'The Kyuubi service ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'tokenId', + 'in' => 'path', + 'schema' => ['description' => 'The token ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'tk-zpi0*****hdv4y'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'The response object.', '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, - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteKyuubiToken', + 'summary' => 'Deletes a Kyuubi Gateway authentication token.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'DeleteLivyCompute' => [ + 'summary' => 'Deletes a Livy gateway.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy gateway.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'lc-i8xogcdfa4fk3yn1'], + ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response schema.', '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", - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. For more information about the error, see the message parameter.', 'type' => 'string', 'title' => '', 'example' => '1000000'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'DeleteLivyCompute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'DeleteLivyComputeToken' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '222309', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceId', + 'name' => 'workspaceBizId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], ], [ - 'name' => 'kyuubiServiceId', + 'name' => 'livyComputeId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', - ], + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', 'title' => ''], + ], + [ + 'name' => 'tokenId', + 'in' => 'path', + 'schema' => ['description' => 'The token ID.', 'type' => 'string', 'required' => false, 'example' => 'lctk-xxxxxxxxxx', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response schema.', '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', - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates a successful request. Other values indicate a failed request. For error details, see the message parameter.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteLivyComputeToken', + 'summary' => 'Deletes a token for a Livy Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + ], + 'DeleteRayCluster' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-26ca1703f6d11', 'title' => '', 'required' => false], + ], + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => ['description' => 'The Ray cluster ID.', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91', 'title' => '', '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' => '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', - ], - ], - ], - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteRayCluster', + 'summary' => 'Deletes a Ray cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\"\\n}","type":"json"}]', ], - 'CreateKyuubiService' => [ - 'summary' => 'CreateKyuubiService', - 'path' => '/api/v1/kyuubi/{workspaceId}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'EditWorkspaceQueue' => [ + 'summary' => 'Updates a Workspace Queue.', + 'path' => '/api/v1/workspaces/queues/action/edit', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeCode' => '192830', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], - ], - [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', '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', + 'workspaceId' => ['description' => 'The Workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-975bcfda9625****', 'title' => ''], + 'resourceSpec' => [ + 'description' => 'The resource specifications.', + 'type' => 'object', + 'properties' => [ + 'cu' => ['description' => 'The maximum resource capacity of the Workspace Queue.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + 'maxCu' => ['type' => 'integer', 'format' => 'int64', 'example' => '0.5', 'description' => '', 'title' => ''], + 'gpu' => ['type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => '', 'title' => ''], + ], 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'title' => '', + 'example' => '', ], - 'replica' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'workspaceQueueName' => ['description' => 'The name of the Workspace Queue.', 'type' => 'string', 'required' => false, 'example' => 'dev_queue', 'title' => ''], + 'environments' => [ + 'description' => 'The environment types.', + 'type' => 'array', + 'items' => ['description' => 'The queue environment type.', 'type' => 'string', 'required' => false, 'example' => 'prod', 'title' => ''], 'required' => false, - 'example' => '3', + 'title' => '', + 'example' => '', ], - 'kyuubiReleaseVersion' => [ + 'gpuSpec' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'ecs.gn7i-c8g1.2xlarge', 'description' => '', 'title' => ''], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.9.2-0.0.2', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Returned Data', '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', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'EditWorkspaceQueue', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:EditWorkspaceQueue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\",\\n \\"data\\": {\\n \\"kyuubiServiceId\\": \\"kb-f99935b350fb4****7ef700b8b4197a3\\"\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', ], - 'GetKyuubiService' => [ - 'summary' => 'GetKyuubiService', - 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GenerateTaskCodes' => [ + 'summary' => 'Publishes a workflow and its scheduling configuration.', + 'path' => '/dolphinscheduler/projects/{bizId}/task-definition/gen-task-codes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'bizId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The workspace ID.', 'title' => '', 'example' => 'w-d8********'."\n"], + ], + [ + 'name' => 'genNum', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'description' => 'The number of codes to generate.', 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'productNamespace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The product namespace.', 'title' => '', 'example' => 'SS'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The error code.', 'title' => '', 'example' => '1000000'], + 'msg' => ['type' => 'string', 'description' => 'The error message.', 'title' => '', 'example' => 'No permission for resource action'], + 'success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful.', 'title' => '', 'example' => 'true'], + 'failed' => ['type' => 'boolean', 'description' => 'Indicates whether the request failed.', 'title' => '', 'example' => 'false'], + 'data' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => 'A randomly generated code for the workflow node definition.', 'title' => '', 'example' => '1263424***'], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', + ], + 'httpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The HTTP status code.', 'title' => '', 'example' => '200'], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GenerateTaskCodes', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'produces' => [ - 'application/json', + 'ramActions' => [], + '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"}]', + ], + 'GetAICenterState' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/aicenter', + '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', - ], + 'abilityTreeNodes' => ['FEATUREemapreduceLNUXSK'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-cea2c314a****', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'state' => [ + 'description' => 'The state of the AI center. Valid values:'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- inactive'."\n" + ."\n" + .'- activating', + 'type' => 'string', + 'enum' => ['active', 'inactive', 'activating'], + 'example' => 'Running', + 'title' => '', + ], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAICenterState', + 'summary' => 'Gets the state of an AI center.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"state\\": \\"Running\\"\\n}","type":"json"}]', + ], + 'GetCacheCluster' => [ + 'path' => '/api/v1/cache/{cacheClusterId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'kyuubiServiceId', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'cacheClusterId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-415ddee******f1d1eac0388b86', - ], + 'schema' => ['description' => 'The ID of the Cache cluster.', 'type' => 'string', 'required' => false, 'example' => 'spc-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', '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', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'cacheClusters' => ['description' => 'The list of Cache clusters.', '$ref' => '#/components/schemas/CacheCluster', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get cache cluster details', + 'summary' => 'Retrieves the details of a Cache cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"cacheClusters\\": {\\n \\"clusterId\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"state\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"modifier\\": \\"\\",\\n \\"paymentType\\": \\"\\",\\n \\"resourceSpec\\": {\\n \\"bandWidth\\": 0,\\n \\"storage\\": 0,\\n \\"ha\\": false\\n },\\n \\"regionId\\": \\"\\",\\n \\"usedResourceSpec\\": {\\n \\"bandWidth\\": 0,\\n \\"storage\\": 0\\n },\\n \\"gmtCreated\\": 0,\\n \\"gmtModified\\": 0,\\n \\"configuration\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"cacheClusterId\\": \\"\\",\\n \\"createTime\\": \\"\\",\\n \\"cacheClusterName\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"configurations\\": [\\n {\\n \\"name\\": \\"cacheset.xml\\",\\n \\"content\\": \\"\\"\\n }\\n ],\\n \\"bindedWorkspaces\\": [\\n \\"\\"\\n ],\\n \\"cachesets\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"path\\": \\"\\"\\n }\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"tables\\": [\\n {\\n \\"catalogId\\": \\"\\",\\n \\"catalogProvider\\": \\"\\",\\n \\"database\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"workspaceId\\": \\"\\"\\n }\\n ],\\n \\"extra\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'UpdateKyuubiService' => [ - 'summary' => 'UpdateKyuubiService', - 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + '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' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeNodes' => ['FEATUREemapreduceT8XN05'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'w-dsa23*****', 'title' => ''], ], [ - 'name' => 'kyuubiServiceId', + 'name' => 'queue', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', - ], + 'schema' => ['description' => 'The name of the queue.'."\n", 'type' => 'string', 'required' => true, 'example' => 'root_queue', 'title' => ''], ], [ - '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, - ], + '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', 'title' => ''], + ], + [ + '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'true', + '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}', 'title' => ''], + ], + '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" + .'}', + 'title' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetCuHours', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + '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' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'abilityTreeCode' => '193399', + 'abilityTreeNodes' => ['FEATUREemapreduce60H0RM'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'kyuubiServiceId', + 'name' => 'runId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => 'jr-d2d82aa09155****', 'title' => ''], + ], + [ + 'name' => 'queryTime', + 'in' => 'query', + 'schema' => ['description' => 'The query time.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01', 'title' => ''], + ], + [ + 'name' => 'locale', + 'in' => 'query', + 'schema' => ['description' => 'The language of diagnostic information.', 'type' => 'string', 'default' => 'zh-CN', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'true', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'suggestions' => [ + 'description' => 'The diagnostics list.', + 'type' => 'array', + 'items' => ['description' => 'The description of the diagnosis.', 'type' => 'string', 'example' => '正常。', 'title' => ''], + 'title' => '', + 'example' => 'Normal.', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"suggestions\\": [\\n \\"正常。\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetDoctorApplication', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetDoctorApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'StartKyuubiService' => [ - 'summary' => 'StartKyuubiService', - 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/start', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetJobRun' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '215794', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-cea2c314a****', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09151****', 'title' => ''], ], [ - 'name' => 'kyuubiServiceId', + 'name' => 'jobRunId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-415ddee******f1d1eac0388b86', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The ID of the job run.', 'type' => 'string', 'required' => true, 'example' => 'jr-93d98d2f7061****', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. For example, cn-hangzhou represents the Hangzhou region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'true', + 'jobRun' => [ + 'description' => 'The details of the job.', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155****', 'title' => ''], + 'jobRunId' => ['description' => 'The job run ID.', 'type' => 'string', 'example' => 'jr-93d98d2f7061****', 'title' => ''], + 'name' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'jobName', 'title' => ''], + 'state' => ['description' => 'The state of the job.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'stateChangeReason' => [ + 'description' => 'The reason for the state change.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ERR-100000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'connection refused', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'submitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', 'title' => ''], + 'endTime' => ['description' => 'The time when the job ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684122914000', 'title' => ''], + 'codeType' => ['description' => 'The code type of the job. Valid values:'."\n" + ."\n" + .'- SQL'."\n" + ."\n" + .'- JAR'."\n" + ."\n" + .'- PYTHON', 'type' => 'string', 'example' => 'SQL', 'title' => ''], + 'webUI' => ['description' => 'The web UI of the job.', 'type' => 'string', 'title' => '', 'example' => 'http://spark-ui'], + 'executionTimeoutSeconds' => ['description' => 'The timeout period for the job execution.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'resourceOwnerId' => ['description' => 'The UID of the user who creates the job.', 'type' => 'string', 'example' => '150978934701****', 'title' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => ['description' => 'A tag.', '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'log' => ['description' => 'The path of the run log.', '$ref' => '#/components/schemas/RunLog', 'title' => '', 'example' => ''], + 'releaseVersion' => ['description' => 'The Spark engine version.', 'type' => 'string', 'example' => 'esr-3.3.1', 'title' => ''], + 'resourceQueueId' => ['description' => 'The name of the queue on which the job runs.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'jobDriver' => ['description' => 'The Spark driver information.', '$ref' => '#/components/schemas/JobDriver', 'title' => '', 'example' => ''], + 'configurationOverrides' => [ + 'description' => 'The Spark configurations of the job.', + 'type' => 'object', + 'properties' => [ + 'configurations' => [ + 'description' => 'The configurations.', + 'type' => 'array', + 'items' => ['description' => 'The configurations.', '$ref' => '#/components/schemas/Configuration', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'displayReleaseVersion' => ['description' => 'The version that is displayed in the console.', 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', 'title' => ''], + 'fusion' => ['description' => 'Indicates whether to enable the Fusion engine to accelerate the job execution.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'environmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => 'env-cpv569tlhtgndjl8****', 'title' => ''], + 'notebookAccessUrl' => ['description' => 'The access URL for the notebook of the job run.', 'type' => 'string', 'example' => 'http://workflow-ide-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/spark-notebook-output/w-xxxxxxxxx/xxxxxxx', 'title' => ''], + 'priority' => ['description' => 'The priority of the job run.', 'type' => 'string', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'GetJobRun', + 'summary' => 'Get the details of a job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetJobRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + '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\\": \\"oss://bucket/path/to/stdout\\",\\n \\"driverStdError\\": \\"oss://bucket/path/to/stderr\\",\\n \\"driverSyslog\\": \\"oss://bucket/path/to/syslog\\",\\n \\"driverStartup\\": \\"oss://bucket/path/to/startup\\"\\n },\\n \\"releaseVersion\\": \\"esr-3.3.1\\",\\n \\"resourceQueueId\\": \\"root_queue\\",\\n \\"jobDriver\\": {\\n \\"sparkSubmit\\": {\\n \\"entryPoint\\": \\"oss://bucket/path/to/entrypoint.jar\\",\\n \\"entryPointArguments\\": [\\n \\"arg1\\"\\n ],\\n \\"sparkSubmitParameters\\": \\"--conf spark.app.name=test\\"\\n }\\n },\\n \\"configurationOverrides\\": {\\n \\"configurations\\": [\\n {\\n \\"configFileName\\": \\"common.conf\\",\\n \\"configItemKey\\": \\"hive.metastore.type\\",\\n \\"configItemValue\\": \\"USER_RDS\\"\\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 \\"priority\\": \\"5\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', ], - 'StopKyuubiService' => [ - 'summary' => 'StopKyuubiService', - 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/stop', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetKyuubiService' => [ + 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5JTF6C', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => 'w-cea2c314a****'], ], [ 'name' => 'kyuubiServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", - ], + 'schema' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'required' => false, 'title' => '', '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****'."\n", - ], + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '8CE06D75-E6A2-505D-9B4B-31DEE3D98A04'], 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'kyuubiConfigs' => ['type' => 'string', 'description' => 'The configuration of the Kyuubi service.', 'title' => '', 'example' => '[]'], + 'sparkConfigs' => ['type' => 'string', 'description' => 'The Spark configuration.', 'title' => '', 'example' => '[]'], + 'state' => ['type' => 'string', 'description' => 'The state of the Kyuubi service.', 'title' => '', 'example' => 'RUNNING'], + 'name' => ['type' => 'string', 'description' => 'The name of the Kyuubi service.', 'title' => '', 'example' => 'dev_serverless_spark'."\n"], + 'queue' => ['type' => 'string', 'description' => 'The name of the queue.', 'title' => '', 'example' => 'dev_queue'], + 'createTime' => ['type' => 'string', 'description' => 'The timestamp when the service was created.', 'title' => '', 'example' => '1749456094000'], + 'startTime' => ['type' => 'string', 'description' => 'The timestamp when the service was started.', 'title' => '', 'example' => '1749456094000'], + 'creator' => ['type' => 'string', 'description' => 'The UID of the creator.', 'title' => '', 'example' => '150978934701****'], + 'kyuubiServiceId' => ['type' => 'string', 'description' => 'The ID of the Kyuubi service.', 'title' => '', 'example' => 'kb-4e209b04588***95f04ad3538ae4'], + 'innerEndpoint' => ['type' => 'string', 'description' => 'The internal same-region endpoint.', 'title' => '', 'example' => 'kyuubi-cn-beijing-internal.spark.emr.aliyuncs.com'], + 'publicEndpoint' => ['type' => 'string', 'description' => 'The public domain name.', 'title' => '', 'example' => 'emr-spark-kyuubi-gateway-cn-beijing.aliyuncs.com'], + 'releaseVersion' => ['type' => 'string', 'description' => 'The Spark engine version.', 'title' => '', 'example' => 'esr-4.6.0 (Spark 3.5.2, Scala 2.12)'], + 'computeInstance' => ['type' => 'string', 'description' => 'The specifications of the Kyuubi service.', 'title' => '', 'example' => '2c8g'], + 'publicEndpointEnabled' => ['type' => 'boolean', 'description' => 'Indicates whether public network access is enabled.', 'title' => '', 'example' => 'true'], + 'replica' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of high-availability (HA) replicas.', 'title' => '', 'example' => '0'], + 'kyuubiReleaseVersion' => ['type' => 'string', 'description' => 'The Kyuubi service engine version.', 'title' => '', 'example' => '1.9.2-0.0.2'], + ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response struct.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetKyuubiService', + 'summary' => 'Retrieves the details of a Kyuubi Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + 'ramActions' => [], + '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"}]', ], - 'ListLivyComputeSessions' => [ - 'summary' => '获取livy gateway历史session', - 'path' => '/api/v1/workspaces/{workspaceId}/livycompute/{livyComputeId}/session', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetKyuubiToken' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '246258', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '不支持', - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d80f373d3ace824f', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'livyComputeId', + 'name' => 'kyuubiServiceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-zm4dzdiubu73w2yx', - ], + 'schema' => ['description' => 'The Kyuubi service ID.', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', 'title' => ''], ], [ - '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' => 'tokenId', + 'in' => 'path', + 'schema' => ['description' => 'The token ID.', 'type' => 'string', 'required' => false, 'example' => 'tk-zpi0*****hdv4y', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data structure of the 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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'tokenId' => ['description' => 'The token ID.', 'type' => 'string', 'example' => 'tk-zpi0*****hdv4y', 'title' => ''], + 'name' => ['description' => 'The token name.', 'type' => 'string', 'example' => 'dev_serverless_spark'."\n", 'title' => ''], + 'token' => ['description' => 'The masked token.', 'type' => 'string', 'example' => 'dxj**********wfg'."\n", 'title' => ''], + 'createdBy' => ['description' => 'The creator name.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753932319390', 'title' => ''], + 'lastUsedTime' => ['description' => 'The last used time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456098000', 'title' => ''], + 'autoExpireConfiguration' => [ + 'description' => 'The automatic expiration configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Indicates whether the token automatically expires.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'expireDays' => ['description' => 'The expiration period, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '365', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'memberArns' => [ + 'description' => 'The Alibaba Cloud Resource Names (ARNs) of the authorized users.', + 'type' => 'array', + 'items' => ['description' => 'The ARN of the authorized user.', 'type' => 'string', 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'sparkRole' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetKyuubiToken', + 'summary' => 'Obtains an authentication token for Kyuubi Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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 \\"sparkRole\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteLivyCompute' => [ - 'summary' => '删除livy compute', + 'GetLivyCompute' => [ + 'summary' => 'Retrieves information about a Livy Gateway.', 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '222245', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '222260', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], ], [ 'name' => 'livyComputeId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-i8xogcdfa4fk3yn1', - ], + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -4481,1191 +3559,1006 @@ '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates a successful request. Other values indicate a failed request. Check the message parameter for the error details.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'computeId' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'example' => 'lc-xxxxxxxxxxxxx', 'title' => ''], + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'livyVersion' => [ + 'description' => 'The Livy version.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['0.8.0'], + 'example' => '0.8.0', + 'title' => '', + ], + 'releaseVersion' => ['description' => 'The version number of the Spark engine. This parameter is deprecated. Use displayReleaseVersion instead.', 'type' => 'string', 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)'."\n", 'title' => ''], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'cpuLimit' => [ + 'description' => 'The number of CPU cores for the Livy server.', + 'enumValueTitles' => [1 => '1', '2', 4 => '4'], + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'memoryLimit' => [ + 'description' => 'The memory size of the Livy server.', + 'enumValueTitles' => ['16Gi' => '16Gi', '4Gi' => '4Gi', '8Gi' => '8Gi'], + 'type' => 'string', + 'example' => '4Gi', + 'title' => '', + ], + 'autoStopConfiguration' => [ + 'description' => 'The auto-stop configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Indicates whether to automatically start the gateway after it is created.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'idleTimeoutMinutes' => ['description' => 'The number of minutes after which the Livy Gateway is automatically stopped if it is idle.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'authType' => [ + 'description' => 'The authentication method.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Token'], + 'example' => 'Token', + 'title' => '', + ], + 'status' => [ + 'description' => 'The running status.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['RUNNING', 'STOPPED', 'STARTING', 'STOPPING', 'FAILED'], + 'example' => 'RUNNING', + 'title' => '', + ], + 'endpoint' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx', 'title' => ''], + 'createdBy' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ramUserId' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '10000001', 'title' => ''], + 'displayReleaseVersion' => ['description' => 'The version number of the Spark engine.', 'type' => 'string', 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12)', 'title' => ''], + 'fusion' => ['description' => 'Indicates whether the fusion switch is enabled.', 'type' => 'boolean', 'example' => 'false'."\n", 'title' => ''], + 'startTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', 'title' => ''], + 'gmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', 'title' => ''], + 'environmentId' => ['description' => 'The ID of the runtime environment.', 'type' => 'string', 'example' => 'ev-cq31c7tlhtgm9nrrlj4g', 'title' => ''], + 'endpointInner' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx', 'title' => ''], + 'networkName' => ['description' => 'The name of the network connection.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'livyServerConf' => ['description' => 'The Livy Gateway configuration in JSON format. The following files are supported:'."\n" + ."\n" + .'- sparkDefaultsConf'."\n" + ."\n" + .'- sparkBlackListConf'."\n" + ."\n" + .'- livyConf'."\n" + ."\n" + .'- livyClientConf', '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" + .'}', 'title' => ''], + 'enablePublic' => ['description' => 'The status of the public endpoint switch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetLivyCompute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'GetLivyComputeToken' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '222228', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '222371', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], ], [ - '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' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-6mkvn01zrg8rqhhv', 'title' => ''], + ], + [ + 'name' => 'tokenId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the token.', 'type' => 'string', 'required' => false, 'example' => 'lctk-xxxxxxxx', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of the 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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '484D9DDA-300D-525E-AF7A-0CCCA5C64A7A'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. For more information about the error, see the message parameter.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'livyComputeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lc-i8xogcdfa4fk3yn1', + 'tokenId' => ['description' => 'The ID of the token.', 'type' => 'string', 'example' => 'lctk-xxxxxxxxxx', 'title' => ''], + 'name' => ['description' => 'The name of the token.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'token' => ['description' => 'The content of the token.', 'type' => 'string', 'example' => 'd25561157a635bb', 'title' => ''], + 'createdBy' => ['description' => 'The name of the user who created the token.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'createTime' => ['description' => 'The time when the token was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', 'title' => ''], + 'expireTime' => ['description' => 'The time when the token expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749457994000', 'title' => ''], + 'lastUsedTime' => ['description' => 'The time when the token was last used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456098000', 'title' => ''], + 'autoExpireConfiguration' => [ + 'description' => 'The information about token expiration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether the token automatically expires.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'expireDays' => ['description' => 'The expiration period, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetLivyComputeToken', + 'summary' => 'Retrieves a token for a Livy Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'GetRayCluster' => [ + 'summary' => 'Retrieves the details of a Ray cluster, including its configuration, runtime state, node information, and connection endpoints.', + 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '222234', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'title' => '', 'required' => false], ], [ - 'name' => 'livyComputeId', + 'name' => 'clusterId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-i8xogcdfa4fk3yn1', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'ray-xxxxxxxxxx', 'title' => '', 'required' => false], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ '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' => '', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', 'title' => ''], + 'clusterId' => ['description' => 'The ID of the Ray cluster.', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91', 'title' => ''], + 'name' => ['description' => 'The name of the Ray cluster.', 'type' => 'string', 'example' => 'myRayCluster', 'title' => ''], + 'displayReleaseVersion' => ['description' => 'The version of the Ray engine.', 'type' => 'string', 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', 'title' => ''], + 'description' => ['description' => 'The description of the Ray cluster.', 'type' => 'string', 'example' => 'Ray Cluster for dev.', 'title' => ''], + 'networkServiceName' => ['description' => 'The name of the network connection.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'headSpec' => [ 'type' => 'object', 'properties' => [ - 'enable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'idleTimeoutMinutes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], + 'queueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'memory' => ['description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'title' => ''], + 'enableAutoScaling' => ['description' => 'Specifies whether auto scaling is enabled for worker nodes.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'idleTimeoutSeconds' => ['description' => 'The idle timeout period for worker nodes, in seconds. Applies only when auto scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'replica' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'description' => 'The configuration of the head node.', + 'example' => '', ], - 'authType' => [ - 'description' => '', + 'state' => [ + 'description' => 'The session state. Valid values:'."\n" + ."\n" + .'- Starting: The session is starting.'."\n" + ."\n" + .'- Running: The session is running.'."\n" + ."\n" + .'- Stopping: The session is being stopped.'."\n" + ."\n" + .'- Stopped: The session is stopped.'."\n" + ."\n" + .'- Error: The session has failed.', 'type' => 'string', - 'required' => false, - 'example' => 'Token', - 'enum' => [ - 'Token', + 'example' => 'Running', + 'enum' => ['Starting', 'Running', 'Stopping', 'Stopped', 'Error'], + 'title' => '', + ], + 'creator' => ['description' => 'The UID of the user who created the cluster.', 'type' => 'string', 'example' => '202077646755523991', 'title' => ''], + 'creatorName' => ['description' => 'The nickname of the creator.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'modifier' => ['description' => 'The UID of the user who last updated the cluster.', 'type' => 'string', 'example' => '202077646755523991', 'title' => ''], + 'modifierName' => ['description' => 'The nickname of the modifier.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'userId' => ['description' => 'The ID of the Alibaba Cloud account that created the cluster.', 'type' => 'string', 'example' => '123456789012', 'title' => ''], + 'dashboardUrl' => ['description' => 'The URL of the Ray Dashboard for this cluster.', 'type' => 'string', 'example' => 'https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx', 'title' => ''], + 'jobUrl' => ['description' => 'The public endpoint for submitting Ray jobs.', 'type' => 'string', 'example' => 'https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com', 'title' => ''], + 'submitToken' => ['description' => 'The authentication token for submitting Ray jobs. Add this token to the request header in the format `"ray-token": "token"`.', 'type' => 'string', 'example' => '1d06484d3b424f7fa4ab7082a4076da2', 'title' => ''], + 'modified' => ['description' => 'Indicates whether the configuration was modified.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'extraParam' => ['description' => 'Additional parameters in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'message' => ['description' => 'The error message. Returned when `state` is `Error`.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'instances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'Head', 'title' => ''], + 'instanceId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 'ray-uiulpgow9xljim10-head-7cgta', 'title' => ''], + 'containerState' => ['description' => 'The state of the main container.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'reason' => ['description' => 'Additional information about the node.', 'type' => 'string', 'example' => 'OOMKilled', 'title' => ''], + 'phase' => ['description' => 'The phase of the node pod.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'message' => ['description' => 'The status message of the node pod.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'startTime' => ['description' => 'The time when the node started. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1762946698000', 'title' => ''], + 'createTime' => ['description' => 'The time when the node was created. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735870116167', 'title' => ''], + 'containerStateReason' => ['description' => 'Additional information about the main container state.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'containerStateMessage' => ['description' => 'The status message of the main container.', 'type' => 'string', 'example' => 'ContainerExit', 'title' => ''], + 'containerExitCode' => ['description' => 'The exit code of the main container.', 'type' => 'integer', 'format' => 'int32', 'example' => '137', 'title' => ''], + ], + 'title' => '', + 'description' => 'The details of a Ray cluster node.', + 'example' => '', ], + 'title' => '', + 'description' => 'The list of nodes in the Ray cluster.', + 'example' => '', ], - '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' => [ + 'instanceId' => ['description' => 'The ID of the Ray cluster node.', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg93-xxxxxxx', 'title' => ''], + 'workerSpec' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the worker node group.', 'type' => 'string', 'example' => 'WorkerGroup1', 'title' => ''], + 'workerType' => [ + 'description' => 'The type of the worker node group.', + 'type' => 'string', + 'example' => 'CPU', + 'enum' => ['CPU'], + 'title' => '', + ], + 'replica' => ['description' => 'The number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'queueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'cpu' => ['description' => 'The number of CPU cores per worker node.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'memory' => ['description' => 'The memory size per worker node. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'title' => ''], + 'minReplica' => ['description' => 'The minimum number of worker nodes in the group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'maxReplica' => ['description' => 'The maximum number of worker nodes in the group.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The configuration of a worker node group.', + 'example' => '', + ], + 'title' => '', + 'description' => 'The list of worker node group configurations.', + 'example' => '', + ], + 'startTime' => ['description' => 'The time when the cluster started. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1750327083303', 'title' => ''], + 'createTime' => ['description' => 'The time when the cluster was created. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1750327083303', 'title' => ''], + 'modifiedTime' => ['description' => 'The time when the cluster was last updated. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754274541693', 'title' => ''], + 'grpcEndpoint' => ['description' => 'The gRPC endpoint for the internal network. You can also use the domain name in this endpoint to submit Ray jobs.', 'type' => 'string', 'example' => 'ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80', 'title' => ''], + 'volumeIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'vol-123456789', 'description' => '', 'title' => ''], 'description' => '', - 'type' => 'boolean', - 'required' => false, + 'title' => '', + 'example' => '', ], + 'jobUrlInner' => ['type' => 'string', 'example' => 'http://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com', 'description' => '', 'title' => ''], ], - 'required' => false, - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - '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'], + 'title' => 'GetRayCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + '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 \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\"\\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 \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\"\\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 \\"volumeIds\\": [\\n \\"vol-123456789\\"\\n ],\\n \\"jobUrlInner\\": \\"http://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com\\"\\n}","type":"json"}]', ], - 'ListLivyCompute' => [ - 'summary' => 'List the Livy Gateway.', - 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRayJob' => [ + 'summary' => 'Retrieves Ray Job information.', + 'path' => '/api/v1/workspaces/{workspaceId}/rayJob/{submissionId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '222250', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'required' => false], ], [ - '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', - ], + 'name' => 'submissionId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the Ray Job.', 'type' => 'string', 'example' => 'rj-xxxxxxxxxx', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944'], + 'submissionId' => ['description' => 'The ID of the Ray Job.', 'type' => 'string', 'example' => 'rj-xxxxxxxxxx', 'title' => ''], + 'name' => ['title' => '', 'description' => 'The Ray cluster name.', 'type' => 'string', 'example' => 'myRayCluster'], + 'displayReleaseVersion' => ['title' => '', 'description' => 'The Ray DPI engine version.', 'type' => 'string', 'example' => 'err-1.2.0 (Ray 2.55.1, Python 3.12)'], + 'tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => ['description' => 'The tags.', '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'status' => [ + 'title' => '', + 'description' => 'The job status. Valid values:'."\n" + .'- Submitted: Submitted.'."\n" + .'- Pending: The cluster is being created.'."\n" + .'- Running: The job is running.'."\n" + .'- Succeeded: The job succeeded.'."\n" + .'- Failed: The job failed.'."\n" + .'- Cancelling: Cancelling.'."\n" + .'- Cancelled: Cancelled.'."\n" + .'- Timeout: Timed out and cancelled.', 'type' => 'string', - 'example' => 'ok', + 'example' => 'Running', + 'enum' => ['Submitted', 'Pending', 'Running', 'Succeeded', 'Failed', 'Cancelling', 'Cancelled', 'Timeout'], + ], + 'message' => ['title' => '', 'description' => 'The execution message.', 'type' => 'string', 'example' => 'Job finished successfully.'], + 'entrypoint' => ['description' => 'The startup command.', 'type' => 'string', 'example' => 'python main.py', 'title' => ''], + 'submitTime' => ['description' => 'The job submission time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1750327082303', 'title' => ''], + 'startTime' => ['title' => '', 'description' => 'The start time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1750327083303'], + 'endTime' => ['description' => 'The job end time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1762949372000', 'title' => ''], + 'duration' => ['description' => 'The job duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2459764', 'title' => ''], + 'networkServiceName' => ['title' => '', 'description' => 'The network connectivity name.', 'type' => 'string', 'example' => 'vpc'], + 'runtimeEnvJson' => ['title' => '', 'description' => 'The Ray runtime environment JSON string.', 'type' => 'string', 'example' => '{"pip":["requests==2.26.0","pendulum==2.1.2"],"env_vars":{"KEY":"VALUE"}}'], + 'workingDir' => ['title' => '', 'description' => 'The URL of the job code working directory.', 'type' => 'string', 'example' => 'oss://mybucket/hello.zip'], + 'submissionMode' => ['title' => '', 'description' => 'The job submission mode.', 'type' => 'string', 'example' => 'HTTPMode'], + 'metadataJson' => ['title' => '', 'description' => 'The job metadata JSON string.', 'type' => 'string', 'example' => '{"owner": "alice"}'], + 'entrypointNumCpus' => ['title' => '', 'description' => 'The number of CPUs requested by the entrypoint task.', 'type' => 'string', 'example' => '1'], + 'entrypointNumGpus' => ['title' => '', 'description' => 'The number of GPUs requested by the entrypoint task.', 'type' => 'string', 'example' => '0'], + 'entrypointMemory' => ['title' => '', 'description' => 'The memory size requested by the entrypoint task.', 'type' => 'string', 'example' => '4Gi'], + 'entrypointResources' => ['title' => '', 'description' => 'The custom resource request JSON string for the entrypoint task.', 'type' => 'string', 'example' => '{"fpu": 1}'], + 'shutdownAfterJobFinishes' => ['title' => '', 'description' => 'Specifies whether to automatically destroy the temporary cluster after the job finishes. Default value: true.', 'type' => 'boolean', 'example' => 'true'], + 'ttlSecondsAfterFinished' => ['title' => '', 'description' => 'The number of seconds to wait before destroying the cluster. This parameter takes effect only when shutdownAfterJobFinishes is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'activeDeadlineSeconds' => ['title' => '', 'description' => 'The timeout period.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'], + 'volumeIds' => [ + 'title' => '', + 'description' => 'The list of managed file IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The managed file ID.', 'type' => 'string', 'example' => 'vol-123456789'], + 'example' => '', ], - 'data' => [ - 'description' => '', + 'backoffLimit' => ['title' => '', 'description' => 'The number of failure retries. Currently fixed at 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'headSpec' => [ + 'title' => '', + 'description' => 'The Ray cluster head node parameters.', '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', - ], - ], - ], + 'replica' => ['title' => '', 'description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'enableAutoScaling' => ['title' => '', 'description' => 'Indicates whether auto scaling is enabled for worker nodes.', 'type' => 'boolean', 'example' => 'true'], + 'idleTimeoutSeconds' => ['title' => '', 'description' => 'The idle timeout in seconds for worker nodes when auto scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'queueName' => ['title' => '', 'description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue'], + 'cpu' => ['title' => '', 'description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2'], + 'memory' => ['title' => '', 'description' => 'The memory size, in GiB.', 'type' => 'string', 'example' => '8Gi'], + 'gpuSpec' => ['title' => '', 'description' => 'The GPU type.', 'type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge'], + ], + 'example' => '', + ], + 'workerSpecs' => [ + 'title' => '', + 'description' => 'The Ray cluster worker node information.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The Ray cluster worker node information struct.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['title' => '', 'description' => 'The worker node group name.', 'type' => 'string', 'example' => 'WorkerGroup1'], + 'replica' => ['title' => '', 'description' => 'The number of worker nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'minReplica' => ['title' => '', 'description' => 'The minimum number of workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'maxReplica' => ['title' => '', 'description' => 'The maximum number of workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'queueName' => ['title' => '', 'description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue'], + 'cpu' => ['title' => '', 'description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2'], + 'memory' => ['title' => '', 'description' => 'The memory size, in GiB.', 'type' => 'string', 'example' => '8Gi'], + 'gpuSpec' => ['title' => '', 'description' => 'The GPU type.', 'type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge'], ], + 'example' => '', + ], + 'example' => '', + ], + 'extraParam' => ['title' => '', 'description' => 'The extra parameters in JSON format.', 'type' => 'string', 'example' => '{"userDefinedFiles": "oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json", "userRequirementsFile": "oss://mybucket/requirements.txt"}'], + 'creatorName' => ['description' => 'The nickname of the creator.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'dashboardUrl' => ['title' => '', 'description' => 'The Ray cluster dashboard URL. When the Ray cluster is in Running state, this is the Runtime UI. After the cluster is deleted, this is the History UI. History UI is supported only in err-1.2.0 and later versions.', 'type' => 'string', 'example' => 'https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx'], + 'logBucketName' => ['title' => '', 'description' => 'The name of the bucket that stores logs.', 'type' => 'string', 'example' => 'ss-ray-cn-hangzhou'], + 'logPath' => ['title' => '', 'description' => 'The path where logs are stored.', 'type' => 'string', 'example' => 'w-xxxxxxx/ray/logs/xxxxxx/'], + 'cuHours' => ['title' => '', 'description' => 'The consumed CU resources. This value is returned 10 minutes after the cluster is released.', 'type' => 'number', 'format' => 'double', 'example' => '1899'], + 'guHours' => [ + 'description' => 'The consumed GPU hours. Currently empty.', + 'type' => 'object', + 'properties' => [ + 'gpuSpec' => ['description' => 'The GPU type.', 'type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'title' => ''], + 'gpuHours' => ['description' => 'The consumed GPU hours.', 'type' => 'number', 'format' => 'double', 'example' => '2.6', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'dashboardUrlExtra' => [ + 'description' => 'The extra dashboard UI URLs. Currently empty.', + 'type' => 'array', + 'items' => ['description' => 'The extra dashboard UI URL. Currently empty.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'clusterState' => [ + 'description' => 'The status of the corresponding Ray cluster. Valid values:'."\n" + .'- Deleted: Deleted.'."\n" + .'- Submitted: Submitted but not yet created.'."\n" + .'- Pending: Being created.'."\n" + .'- Running: Running.', + 'type' => 'string', + 'enum' => ['Deleted', 'Submitted', 'Pending', 'Running'], + 'example' => 'Running', + 'title' => '', + ], + 'taskBizId' => ['description' => 'The data development task ID.', 'type' => 'string', 'example' => 'TSK-682e0112f6f24d9f9305b92174846985', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve ray job information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetRayJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"submissionId\\": \\"rj-xxxxxxxxxx\\",\\n \\"name\\": \\"myRayCluster\\",\\n \\"displayReleaseVersion\\": \\"err-1.2.0 (Ray 2.55.1, Python 3.12)\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"workflowId\\",\\n \\"value\\": \\"wf-123test\\"\\n }\\n ],\\n \\"status\\": \\"Running\\",\\n \\"message\\": \\"Job finished successfully.\\",\\n \\"entrypoint\\": \\"python main.py\\",\\n \\"submitTime\\": 1750327082303,\\n \\"startTime\\": 1750327083303,\\n \\"endTime\\": 1762949372000,\\n \\"duration\\": 2459764,\\n \\"networkServiceName\\": \\"vpc\\",\\n \\"runtimeEnvJson\\": \\"{\\\\\\"pip\\\\\\":[\\\\\\"requests==2.26.0\\\\\\",\\\\\\"pendulum==2.1.2\\\\\\"],\\\\\\"env_vars\\\\\\":{\\\\\\"KEY\\\\\\":\\\\\\"VALUE\\\\\\"}}\\",\\n \\"workingDir\\": \\"oss://mybucket/hello.zip\\",\\n \\"submissionMode\\": \\"HTTPMode\\",\\n \\"metadataJson\\": \\"{\\\\\\"owner\\\\\\": \\\\\\"alice\\\\\\"}\\",\\n \\"entrypointNumCpus\\": \\"1\\",\\n \\"entrypointNumGpus\\": \\"0\\",\\n \\"entrypointMemory\\": \\"4Gi\\",\\n \\"entrypointResources\\": \\"{\\\\\\"fpu\\\\\\": 1}\\",\\n \\"shutdownAfterJobFinishes\\": true,\\n \\"ttlSecondsAfterFinished\\": 60,\\n \\"activeDeadlineSeconds\\": 3600,\\n \\"volumeIds\\": [\\n \\"vol-123456789\\"\\n ],\\n \\"backoffLimit\\": 2,\\n \\"headSpec\\": {\\n \\"replica\\": 1,\\n \\"enableAutoScaling\\": true,\\n \\"idleTimeoutSeconds\\": 60,\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpu\\": \\"2\\",\\n \\"memory\\": \\"8Gi\\",\\n \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\"\\n },\\n \\"workerSpecs\\": [\\n {\\n \\"groupName\\": \\"WorkerGroup1\\",\\n \\"replica\\": 1,\\n \\"minReplica\\": 1,\\n \\"maxReplica\\": 10,\\n \\"queueName\\": \\"root_queue\\",\\n \\"cpu\\": \\"2\\",\\n \\"memory\\": \\"8Gi\\",\\n \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\"\\n }\\n ],\\n \\"extraParam\\": \\"{\\\\\\"userDefinedFiles\\\\\\": \\\\\\"oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json\\\\\\", \\\\\\"userRequirementsFile\\\\\\": \\\\\\"oss://mybucket/requirements.txt\\\\\\"}\\",\\n \\"creatorName\\": \\"Alice\\",\\n \\"dashboardUrl\\": \\"https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx\\",\\n \\"logBucketName\\": \\"ss-ray-cn-hangzhou\\",\\n \\"logPath\\": \\"w-xxxxxxx/ray/logs/xxxxxx/\\",\\n \\"cuHours\\": 1899,\\n \\"guHours\\": {\\n \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\",\\n \\"gpuHours\\": 2.6\\n },\\n \\"dashboardUrlExtra\\": [\\n \\"-\\"\\n ],\\n \\"clusterState\\": \\"Running\\",\\n \\"taskBizId\\": \\"TSK-682e0112f6f24d9f9305b92174846985\\"\\n}","type":"json"}]', + ], + 'GetRayLog' => [ + 'summary' => 'Retrieves the log of a Ray job.', + 'path' => '/api/interactive/v1/workspace/{workspaceId}/ray/{instanceId}/log', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '222269', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-790b443d72394bfc', 'title' => ''], ], [ - 'name' => 'livyComputeId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-i8xogcdfa4fk3yn1', - ], + 'schema' => ['description' => 'The ID of the Ray job.', 'type' => 'string', 'required' => false, 'example' => 'rj-xxxxxxxx', 'title' => ''], ], [ - 'name' => 'regionId', + 'name' => 'bucketName', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => false, 'example' => 'mybucket', 'title' => ''], + ], + [ + 'name' => 'path', + 'in' => 'query', + 'schema' => ['description' => 'The log file path.', 'type' => 'string', 'required' => false, 'example' => '/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/xxxx/rj-xxxx_driver.log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B06AADC1-1627-5B1C-B62F-A2226C122897'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates a successful request. Other values indicate a failed request. You can view the specific error description in the message parameter.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'accessUrl' => ['description' => 'The file download URL.', 'type' => 'string', 'example' => 'https://mybucket.cn-hangzhou.com/xxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get ray job log', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B06AADC1-1627-5B1C-B62F-A2226C122897\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"accessUrl\\": \\"https://mybucket.cn-hangzhou.com/xxxxxx\\"\\n }\\n}","type":"json"}]', ], - 'RefreshLivyComputeToken' => [ - 'summary' => '更新Livy Compute的token', - 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRunConfiguration' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/runs/{runId}/action/getRunConfiguration', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '222308', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], - ], + 'operationType' => 'read', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09151****', 'title' => ''], ], [ - 'name' => 'livyComputeId', + 'name' => 'runId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-i8xogcdfa4fk3yn1', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The job instance ID.', 'type' => 'string', 'required' => true, 'example' => 'jr-93d98d2f7061****', 'title' => ''], ], [ - 'name' => 'tokenId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Token ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'lctk-xxxxxxxx', - ], + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'token' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fe86812667f04v343', - ], - 'autoExpireConfiguration' => [ - 'description' => '', + 'runConfiguration' => [ 'type' => 'object', 'properties' => [ - 'enable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'runtimeConfigs' => [ + 'description' => 'The list of runtime parameters.', + 'type' => 'array', + 'items' => ['description' => 'The runtime parameter.', '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'expireDays' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', + 'applicationConfigs' => [ + 'description' => 'The list of Spark configuration parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'configFileName' => ['description' => 'The name of the application configuration file.', 'type' => 'string', 'title' => '', 'example' => 'spark-defaults.conf'], + 'configItemKey' => ['description' => 'The key of the configuration item.', 'type' => 'string', 'title' => '', 'example' => 'spark.driver.cores'], + 'configItemValue' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'title' => '', 'example' => '2'], + ], + 'description' => 'The Spark configuration parameter.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'logConfig' => [ + 'type' => 'object', + 'properties' => [ + 'LogLevel' => ['description' => 'The log level.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + 'LogPath' => ['description' => 'The log path.', 'type' => 'string', 'example' => 'oss://test', 'title' => ''], + ], + 'description' => 'The log configuration.', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => 'The run configuration.', + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], - 'required' => false, - ], - ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], - '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', - ], + 'title' => 'GetRunConfiguration', + 'summary' => 'Retrieves the configuration of a Spark job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetRunConfiguration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + '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"}]', ], - 'GetLivyComputeToken' => [ - 'summary' => '获取livy compute token', - 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSessionCluster' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters/{sessionClusterId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '222371', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203510', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], - ], - [ - 'name' => 'livyComputeId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-6mkvn01zrg8rqhhv', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-1234abcd', 'title' => '', 'required' => false], ], [ - 'name' => 'tokenId', + 'name' => 'sessionClusterId', 'in' => 'path', - 'schema' => [ - 'description' => 'Token ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'lctk-xxxxxxxx', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'emr-spark-demo-job', 'title' => '', 'required' => false], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The data returned.', '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' => '', + 'sessionCluster' => [ + 'description' => 'The session object.', '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' => '', + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-1234abcd', 'title' => ''], + 'sessionClusterId' => ['description' => 'The session cluster ID.', 'type' => 'string', 'example' => '1234abcd-12ab-34cd-56ef-1234567890ab', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123xxxxxxxx', 'title' => ''], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'dev_queue', 'title' => ''], + 'state' => [ + 'description' => 'The state of the job.'."\n" + ."\n" + .'- Starting: The job is starting.'."\n" + ."\n" + .'- Running: The job is running.'."\n" + ."\n" + .'- Stopping: The job is stopping.'."\n" + ."\n" + .'- Stopped: The job is stopped.'."\n" + ."\n" + .'- Error: The job failed.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'alice', - ], - 'createTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1749456094000', - ], - 'expireTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1749457994000', + 'example' => 'Running', + 'title' => '', ], - 'lastUsedTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1749456098000', + 'stateChangeReason' => [ + 'description' => 'The reason for the state change.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The state change code.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The state change message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'autoExpireConfiguration' => [ - 'description' => '', + 'autoStartConfiguration' => [ + 'description' => 'The auto-start configuration.', 'type' => 'object', 'properties' => [ 'enable' => [ - 'description' => '', + 'description' => 'Specifies whether to enable auto-start.'."\n" + ."\n" + .'- true: Auto-start is enabled.'."\n" + ."\n" + .'- false: Auto-start is disabled.', + 'enumValueTitles' => [], 'type' => 'boolean', 'example' => 'false', + 'title' => '', ], - 'expireDays' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', + ], + 'title' => '', + 'example' => '', + ], + 'autoStopConfiguration' => [ + 'description' => 'The auto-stop configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => 'Specifies whether to enable auto-stop.'."\n" + ."\n" + .'- true: Auto-stop is enabled.'."\n" + ."\n" + .'- false: Auto-stop is disabled.', + 'enumValueTitles' => [], + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', ], + 'idleTimeoutMinutes' => ['description' => 'The number of minutes a session can be idle before it is automatically stopped.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'applicationConfigs' => [ + 'description' => 'The list of Spark application configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Spark application configuration.', + 'type' => 'object', + 'properties' => [ + 'configFileName' => ['description' => 'The name of the configuration file.', 'type' => 'string', 'example' => 'spark-defaults.conf', 'title' => ''], + 'configItemKey' => ['description' => 'The configuration key.', 'type' => 'string', 'example' => 'spark.app.name', 'title' => ''], + 'configItemValue' => ['description' => 'The configuration value.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'releaseVersion' => ['description' => 'The Serverless Spark version.', 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', 'title' => ''], + 'name' => ['description' => 'The session name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'userName' => ['description' => 'The name of the user who created the session.', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'kind' => ['description' => 'The job type. This parameter is required and cannot be modified after the job is created.'."\n" + ."\n" + .'- SQLSCRIPT: an SQL job.'."\n" + ."\n" + .'- JAR: a JAR job.'."\n" + ."\n" + .'- PYTHON: a Python job.', 'type' => 'string', 'example' => 'SQL', 'title' => ''], + 'webUI' => ['description' => 'The URL of the Spark UI for the session.', 'type' => 'string', 'example' => 'https://spark-ui/link', 'title' => ''], + 'draftId' => ['description' => 'The ID of the developer job that is attached to the session.', 'type' => 'string', 'example' => 'TSK-xxxxxxxx', 'title' => ''], + 'domain' => ['description' => 'The domain name of the Spark UI for the session.', 'type' => 'string', 'example' => 'your.domain.com', 'title' => ''], + 'displayReleaseVersion' => ['description' => 'The version that is displayed in the console.', 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', 'title' => ''], + 'fusion' => ['description' => 'Specifies whether to enable acceleration using the Fusion engine.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'envId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => 'env-cpv569tlhtgndjl8****', 'title' => ''], + 'gmtCreate' => ['description' => 'The time when the session was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-01 06:23:01'."\n", 'title' => ''], + 'startTime' => ['description' => 'The time when the session started.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-09-01 06:23:01', 'title' => ''], + 'domainInner' => ['description' => 'The internal same-region endpoint.', 'type' => 'string', 'example' => 'emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com', 'title' => ''], + 'extra' => ['description' => 'The extra metadata of the session.', 'type' => 'string', 'example' => '{"extraInfoKey":"extraInfoValue"}', 'title' => ''], + 'publicEndpointEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'connectionToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'GetSessionCluster', + 'summary' => 'Retrieves session details.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetSessionCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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"}]', + '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\\": false,\\n \\"connectionToken\\": \\"\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', ], - 'CreateLivyComputeToken' => [ - 'summary' => '创建Livy Compute的token', - 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSqlStatement' => [ + 'summary' => 'Retrieves the details of an SQL query.', + 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement/{statementId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '222305', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224752', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'livyComputeId', + 'name' => 'statementId', '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, - ], + 'schema' => ['description' => 'The statement ID.', 'type' => 'string', 'required' => false, 'example' => 'st-2dadfhajk11cv****', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -5675,3960 +4568,3581 @@ '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' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'tokenId' => [ - 'description' => 'Token ID。', + 'statementId' => ['description' => 'The statement ID.', 'type' => 'string', 'example' => 'st-1231311abadfaa', 'title' => ''], + 'state' => [ + 'description' => 'The state of the query.', + 'enumValueTitles' => ['running' => 'running', 'available' => 'available', 'cancelled' => 'cancelled', 'error' => 'error', 'cancelling' => 'cancelling'], 'type' => 'string', - 'example' => 'lctk-xxxxxxxx', + 'enum' => ['running', 'error', 'waiting', 'cancelling', 'cancelled', 'available', 'success'], + 'example' => 'running', + 'title' => '', + ], + 'sqlOutputs' => [ + 'description' => 'A list of SQL query results.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single SQL query result.', + 'type' => 'object', + 'properties' => [ + 'rows' => ['description' => 'The query data. The data is a JSON-serialized string.', 'type' => 'string', 'example' => '[{\\"values\\":[\\"test_db\\",\\"test_table\\",false]}', 'title' => ''], + 'schema' => ['description' => 'The details of the schema. The details are a JSON-serialized string.', '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\\":{}}]}', 'title' => ''], + 'rowsFilePath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'sqlErrorCode' => ['description' => 'The error code for the SQL query.', 'type' => 'string', 'example' => 'ERROR-102', 'title' => ''], + 'sqlErrorMessage' => ['description' => 'The error message for the SQL query.', 'type' => 'string', 'example' => 'error message', 'title' => ''], + 'executionTime' => [ + 'description' => 'A list of execution times for the SQL query.', + 'type' => 'array', + 'items' => ['description' => 'The time consumed by each SQL query, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717138731701', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetSqlStatement', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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"}]', + '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"}]', ], - 'DeleteLivyComputeToken' => [ - 'summary' => '删除Livy Compute的token', - 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTemplate' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/template', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '222309', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191100', + 'abilityTreeNodes' => ['FEATUREemapreduceUECZZL'], ], 'parameters' => [ [ 'name' => 'workspaceBizId', 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], + ], + [ + 'name' => 'templateType', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The template type.', 'type' => 'string', + 'default' => 'TASK', + 'enum' => ['TASK', 'SESSION'], 'required' => false, - 'example' => 'w-8adde60aa809701f', + 'example' => 'TASK', + 'title' => '', ], ], [ - 'name' => 'livyComputeId', - 'in' => 'path', + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'templateBizId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-zm4dzdiubu73w2yx', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'httpStatusCode' => ['title' => 'Id of the request', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], + 'errorCode' => ['description' => '- If success is false, a business error code is returned.'."\n" + ."\n" + .'- If success is true, an empty value is returned.', 'type' => 'string', 'example' => '040003', 'title' => ''], + 'errorMessage' => ['description' => '- Returns an error message if success is false.'."\n" + ."\n" + .'- Returns an empty value if success is true.', 'type' => 'string', 'example' => 'InvalidUser.NotFound', 'title' => ''], + 'data' => ['description' => 'The returned data.', '$ref' => '#/components/schemas/Template', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '484D9DDA-300D-525E-AF7A-0CCCA5C64A7A', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetTemplate', + 'summary' => 'Retrieves a task template.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"httpStatusCode\\": \\"200\\",\\n \\"errorCode\\": \\"040003\\",\\n \\"errorMessage\\": \\"InvalidUser.NotFound\\",\\n \\"data\\": {\\n \\"templateType\\": \\"TASK\\",\\n \\"gmtModified\\": \\"2025-03-10T02:02:41.000+00:00\\",\\n \\"creator\\": 0,\\n \\"sparkLogLevel\\": \\"INFO\\",\\n \\"gmtCreated\\": \\"2025-03-10T02:02:41.000+00:00\\\\n\\",\\n \\"sparkDriverMemory\\": 1073741824,\\n \\"modifier\\": 0,\\n \\"sparkExecutorCores\\": 1,\\n \\"sparkConf\\": [\\n {\\n \\"value\\": \\"test_application\\",\\n \\"key\\": \\"spark.app.name\\"\\n }\\n ],\\n \\"sparkVersion\\": \\"esr-4.1.1\\",\\n \\"sparkExecutorMemory\\": 1073741824,\\n \\"fusion\\": true,\\n \\"isDefault\\": true,\\n \\"sparkDriverCores\\": 1,\\n \\"displaySparkVersion\\": \\"esr-4.1.1\\",\\n \\"sparkLogPath\\": \\"oss://your_bucket/path/to/your/log\\",\\n \\"name\\": \\"\\",\\n \\"bizId\\": \\"\\"\\n },\\n \\"success\\": true,\\n \\"requestId\\": \\"484D9DDA-300D-525E-AF7A-0CCCA5C64A7A\\"\\n}","type":"json"}]', + ], + 'GrantRoleToUsers' => [ + 'summary' => 'Assigns a specified role to users.', + 'path' => '/api/v1/auth/roles/grant', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'tokenId', - 'in' => 'path', + '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' => 'Token ID。', - 'type' => 'string', + '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', 'title' => ''], + '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****', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'lctk-xxxxxxxxxx', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + 'title' => 'GrantRoleToUsers', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GrantRoleToUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'ListCatalogs' => [ + 'summary' => 'View the list of data catalogs', + 'path' => '/api/v1/workspaces/{workspaceId}/catalogs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '222278', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213262', + 'abilityTreeNodes' => ['FEATUREemapreduceR6MU4Y'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'livyComputeId', - 'in' => 'path', + 'name' => 'environment', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The environment type.', + 'enumValueTitles' => ['dev' => 'dev', 'production' => 'production'], 'type' => 'string', 'required' => false, - 'example' => 'lc-6mkvn01zrg8rqhhv', + 'example' => 'dev', + 'title' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], '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', - ], + 'catalogs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'catalogId' => ['description' => 'The ID of the data catalog.', 'type' => 'string', 'example' => '15097**********', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155****'."\n", 'title' => ''], + 'environments' => [ + 'type' => 'array', + 'items' => ['description' => 'The environment type.', 'type' => 'string', 'example' => 'dev,production', 'title' => ''], + 'description' => 'The environment types.', + 'title' => '', + 'example' => '', + ], + 'catalogType' => ['description' => 'Indicates whether this is the default data catalog.', 'type' => 'string', 'example' => 'default_catalog', 'title' => ''], + 'catalogProvider' => ['description' => 'The provider of the data catalog.', 'type' => 'string', 'example' => 'HMS', 'title' => ''], + 'gmtCreate' => ['description' => 'The time when the resource was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760604889', 'title' => ''], + 'gmtModified' => ['description' => 'The time when the resource was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760604889', 'title' => ''], + 'resourceOwnerId' => ['description' => 'The ID of the resource owner.', 'type' => 'string', 'example' => '15097**********', 'title' => ''], + 'alias' => ['type' => 'string', 'example' => 'alias', 'description' => '', 'title' => ''], + 'extras' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Extra information.', 'type' => 'string', '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****************"}', 'title' => ''], + 'description' => 'Extra information.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The data catalog.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The data catalogs.', + 'title' => '', + 'example' => '', + ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListCatalogs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'ListExecutorLogs' => [ + 'summary' => 'Lists the log files for a job executor.', + 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}/executors/{executorId}/logs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '222370', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '231264', + 'abilityTreeNodes' => ['FEATUREemapreduceT8XN05'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'livyComputeId', + 'name' => 'jobRunId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-zm4dzdiubu73w2yx', - ], + 'schema' => ['description' => 'The ID of the job run.', 'type' => 'string', 'required' => true, 'example' => 'jr-f09a8fda2396****', 'title' => ''], + ], + [ + 'name' => 'executorId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the job executor.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. This is the `nextToken` from a previously truncated response.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'logType', + 'in' => 'query', + 'schema' => ['description' => 'The type of log. Only logs of this type are returned.', 'type' => 'string', 'required' => false, 'example' => 'log4j', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], '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', - ], - ], - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944'], + 'nextToken' => ['description' => 'The token to retrieve the next page of results. This value is null when there are no more results to return.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total count of log files.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'logs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'logName' => ['description' => 'The log name.', 'type' => 'string', 'example' => 'log4j.log', 'title' => ''], + 'logType' => ['description' => 'The log type.', 'type' => 'string', 'example' => 'log4j', 'title' => ''], + 'fileName' => ['description' => 'The full path of the log file.', 'type' => 'string', 'example' => 'oss://spark-*********/w-*******467/spark/logs/jr-581482ffa9f4e0e8/driver/stdout.log', 'title' => ''], + 'updateTime' => ['description' => 'The time the log file was last updated, as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1745390462', 'title' => ''], + 'fileSize' => ['description' => 'The size of the file, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '6383327', 'title' => ''], + ], + 'description' => 'A log file object.', + 'title' => '', + 'example' => '', ], + 'description' => 'The retrieved logs, sorted in contextual order. If no contextual logs are found based on the specified starting log, this parameter is empty.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListExecutorLogs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"nextToken\\": \\"2\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200,\\n \\"logs\\": [\\n {\\n \\"logName\\": \\"log4j.log\\",\\n \\"logType\\": \\"log4j\\",\\n \\"fileName\\": \\"oss://spark-*********/w-*******467/spark/logs/jr-581482ffa9f4e0e8/driver/stdout.log\\",\\n \\"updateTime\\": 1745390462,\\n \\"fileSize\\": 6383327\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListJobExecutors' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}/executors', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '222260', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '231260', + 'abilityTreeNodes' => ['FEATUREemapreduceT8XN05'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The workspace ID.', 'title' => '', 'example' => 'w-d2d82aa09155****'], ], [ - 'name' => 'livyComputeId', + 'name' => 'jobRunId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lc-i8xogcdfa4fk3yn1', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The job run ID.', 'title' => '', 'example' => 'jr-f09a8fda2396****'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The token for the next page of results.', 'required' => false, 'title' => '', 'example' => '2'], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of records to return in a single request.', 'required' => false, 'title' => '', 'example' => '20'], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The executor status.', 'required' => false, 'title' => '', 'example' => 'Dead'], + ], + [ + 'name' => 'executorType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The executor type.', 'required' => false, 'title' => '', 'example' => 'driver'], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The region ID.', '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', - ], + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['type' => 'string', 'description' => 'The token for the next page of results.', 'title' => '', 'example' => '2'], + 'maxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The maximum number of records returned.', 'title' => '', 'example' => '20'], + 'totalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of records.', 'title' => '', 'example' => '200'], + 'exexutors' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['type' => 'string', 'description' => 'The workspace ID.', 'title' => '', 'example' => 'w-78faee4da118f02e'], + 'jobRunId' => ['type' => 'string', 'description' => 'The job run ID.', 'title' => '', 'example' => 'jr-1fe145df8ade366a'], + 'executorId' => ['type' => 'string', 'description' => 'The job executor ID.', 'title' => '', 'example' => '1'], + 'status' => ['type' => 'string', 'description' => 'The running status of the executor.', 'title' => '', 'example' => 'Running'], + 'hostPort' => ['type' => 'string', 'description' => 'The address of the executor.', 'title' => '', 'example' => '21.10.x.x:1201x'], + 'rddBlocks' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of Resilient Distributed Dataset (RDD) blocks managed by the executor.', 'title' => '', 'example' => '10'], + 'memoryUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The memory usage of the executor.', 'title' => '', 'example' => '30'], + 'diskUsed' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The disk usage of the executor.', 'title' => '', 'example' => '20'], + 'totalCores' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total number of cores for the executor.', 'title' => '', 'example' => '4'], + 'activeTasks' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total number of active tasks that the executor is running.', 'title' => '', 'example' => '10'], + 'failedTasks' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total number of failed tasks that the executor has run.', 'title' => '', 'example' => '2'], + 'completedTasks' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total number of completed tasks that the executor has run.', 'title' => '', 'example' => '8'], + 'totalTasks' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total number of tasks that the executor has run.', 'title' => '', 'example' => '50'], + 'totalDuration' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total runtime of the executor.', 'title' => '', 'example' => '123'], + 'totalGCTime' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The total garbage collection (GC) time of the executor.', 'title' => '', 'example' => '3'], + 'totalInputBytes' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of bytes of input data for the executor.', 'title' => '', 'example' => '1024'], + 'totalShuffleRead' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of bytes read during the shuffle phase by the executor.', 'title' => '', 'example' => '2048'], + 'totalShuffleWrite' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The number of bytes written during the shuffle phase by the executor.', 'title' => '', 'example' => '2048'."\n"], + 'maxMemory' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The maximum memory of the executor.', 'title' => '', 'example' => '4294967296'], + 'addTime' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The time when the executor was created.', 'title' => '', 'example' => '1760601***'], + 'executorType' => ['type' => 'string', 'description' => 'The executor type.', 'title' => '', 'example' => 'driver'], + ], + 'description' => 'The information about a single executor.', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of executors.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListJobExecutors', + 'summary' => 'Lists the executors of a job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListJobExecutors', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'ListJobRuns' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '191100', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceUECZZL', - ], + 'abilityTreeCode' => '215800', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceBizId', + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The token that specifies the position from which to start the next read.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C89568980', 'title' => '', 'required' => false], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The maximum number of entries to return. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], + ], + [ + 'name' => 'workspaceId', 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'w-d2d82aa09155****', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'emr-spark-demo-job', 'title' => '', 'required' => false], + ], + [ + 'name' => 'creator', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The UID of the user who created the job.', 'type' => 'string', 'example' => '150976534701****', 'title' => '', 'required' => false], + ], + [ + 'name' => 'jobRunId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The job run ID.', 'type' => 'string', 'example' => 'j-xxx', 'title' => '', 'required' => false], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag object.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'tag_key', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'w-8adde60aa809701f', + 'example' => '', ], ], [ - 'name' => 'templateType', + 'name' => 'states', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => 'The template type.'."\n" + 'title' => '', + 'description' => 'The job run states.', + 'type' => 'array', + 'items' => ['description' => 'The state of the job run. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- Submitted: The job is submitted.'."\n" ."\n" - .'* TASK'."\n" - .'* SESSION'."\n", - 'type' => 'string', + .'- Pending: The job is pending.'."\n" + ."\n" + .'- Running: The job is running.'."\n" + ."\n" + .'- Success: The job is successful.'."\n" + ."\n" + .'- Failed: The job failed.'."\n" + ."\n" + .'- Cancelling: The job is being canceled.'."\n" + ."\n" + .'- Cancelled: The job is canceled.'."\n" + ."\n" + .'- CancelFailed: The job failed to be canceled.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], 'required' => false, - 'example' => 'TASK', - 'default' => 'TASK', - 'enum' => [ - 'TASK', - 'SESSION', - ], + 'example' => '["Running","Submitted"]', ], ], [ - 'name' => 'regionId', + 'name' => 'startTime', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'description' => 'The time range when the job run started.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start of the time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709740800000', 'title' => ''], + 'endTime' => ['description' => 'The end of the time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710432000000', 'title' => ''], + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'templateBizId', + 'name' => 'endTime', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The time range when the job run ended.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start of the time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1709740800000', 'title' => ''], + 'endTime' => ['description' => 'The end of the time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710432000000', 'title' => ''], + ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'resourceQueueId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource queue on which the Spark job runs.', 'type' => 'string', 'required' => false, 'example' => 'dev_queue', 'title' => ''], + ], + [ + 'name' => 'jobRunDeploymentId', + 'in' => 'query', + 'schema' => ['description' => 'The deployment ID of the streaming job.', 'type' => 'string', 'required' => false, 'example' => 'jd-b6d003f1930f****', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'minDuration', + 'in' => 'query', + 'schema' => ['description' => 'The minimum runtime of the job run, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000', 'title' => ''], + ], + [ + 'name' => 'isWorkflow', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the job is a workflow task.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'runtimeConfigs', + 'in' => 'query', + 'schema' => ['description' => 'The runtime configurations.', 'type' => 'string', 'required' => false, 'example' => '[{\\"key\\":\\"mainClass\\",\\"value\\":\\"yourClass\\"}]', 'title' => ''], + ], + [ + 'name' => 'applicationConfigs', + 'in' => 'query', + 'schema' => ['description' => 'The Spark configurations.', 'type' => 'string', 'required' => false, 'example' => '[{\\"key\\":\\"spark.app.name\\",\\"value\\":\\"test\\"}]', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The returned data.', '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', + 'jobRuns' => [ + 'description' => 'A list of Spark jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'A Spark job object.', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155****', 'title' => ''], + 'jobRunId' => ['description' => 'The job run ID.', 'type' => 'string', 'example' => 'jr-231231', 'title' => ''], + 'name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'jobName', 'title' => ''], + 'state' => ['description' => 'The state of the job run.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'stateChangeReason' => [ + 'description' => 'The reason for the state change.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'connection refused'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'submitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', 'title' => ''], + 'endTime' => ['description' => 'The time when the job ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684119314000', 'title' => ''], + 'codeType' => ['description' => 'The code type of the job. Valid values:'."\n" + ."\n" + .'SQL'."\n" + ."\n" + .'JAR'."\n" + ."\n" + .'PYTHON', 'type' => 'string', 'example' => 'SQL', 'title' => ''], + 'webUI' => ['description' => 'The web UI of the job.', 'type' => 'string', 'title' => '', 'example' => 'http://spark-ui'], + 'executionTimeoutSeconds' => ['description' => 'The timeout period for the job execution, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'creator' => ['description' => 'The UID of the user who created the job.', 'type' => 'string', 'example' => '150978934701****', 'title' => ''], + 'tags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => ['description' => 'A job tag.', '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'log' => ['description' => 'The path of the run log.', '$ref' => '#/components/schemas/RunLog', 'title' => '', 'example' => ''], + 'releaseVersion' => ['description' => 'The version of the Spark engine that is used to run the job.', 'type' => 'string', 'example' => 'esr-3.0.0 (Spark 3.4.3, Scala 2.12, Native Runtime)', 'title' => ''], + 'jobDriver' => ['description' => 'The information about the Spark driver. This parameter is not returned by the ListJobRuns operation.', '$ref' => '#/components/schemas/JobDriver', 'title' => '', 'example' => ''], + 'configurationOverrides' => [ + 'description' => 'The advanced Spark configurations. This parameter is not returned by the ListJobRuns operation.', + 'type' => 'object', + 'properties' => [ + 'configurations' => [ + 'description' => 'A list of Spark configurations.', + 'type' => 'array', + 'items' => ['description' => 'A Spark configuration object.', '$ref' => '#/components/schemas/Configuration', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'displayReleaseVersion' => ['description' => 'The display version of the Spark engine that is used to run the job.', 'type' => 'string', 'example' => 'esr-3.0.0 (Spark 3.4.3, Scala 2.12)', 'title' => ''], + 'fusion' => ['description' => 'Indicates whether the Fusion engine is enabled for acceleration.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'vcoreSeconds' => ['description' => 'The total number of vCores allocated to the job run, multiplied by the runtime in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '8236', 'title' => ''], + 'mbSeconds' => ['description' => 'The total memory in MB allocated to the job run, multiplied by the runtime in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '33030784', 'title' => ''], + 'cuHours' => ['description' => 'The number of CUs consumed by the job run. This is an estimated value. The actual value is reflected in your bill.', 'type' => 'number', 'format' => 'double', 'example' => '2.059', 'title' => ''], + 'resourceQueueId' => ['type' => 'string', 'example' => 'dev_queue', 'description' => '', 'title' => ''], + 'priority' => ['type' => 'string', 'example' => '5', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned for the current request.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries that match the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - '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', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListJobRuns', + 'summary' => 'Call the ListJobRuns operation to retrieve a list of Spark jobs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListJobRuns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"oss://bucket/path/to/stdout\\",\\n \\"driverStdError\\": \\"oss://bucket/path/to/stderr\\",\\n \\"driverSyslog\\": \\"oss://bucket/path/to/syslog\\",\\n \\"driverStartup\\": \\"oss://bucket/path/to/startup\\"\\n },\\n \\"releaseVersion\\": \\"esr-3.0.0 (Spark 3.4.3, Scala 2.12, Native Runtime)\\",\\n \\"jobDriver\\": {\\n \\"sparkSubmit\\": {\\n \\"entryPoint\\": \\"oss://bucket/path/to/entrypoint.jar\\",\\n \\"entryPointArguments\\": [\\n \\"arg1\\"\\n ],\\n \\"sparkSubmitParameters\\": \\"--conf spark.app.name=test\\"\\n }\\n },\\n \\"configurationOverrides\\": {\\n \\"configurations\\": [\\n {\\n \\"configFileName\\": \\"common.conf\\",\\n \\"configItemKey\\": \\"hive.metastore.type\\",\\n \\"configItemValue\\": \\"USER_RDS\\"\\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 \\"priority\\": \\"5\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', + ], + 'ListKyuubiServices' => [ + 'path' => '/api/v1/kyuubi/{workspaceId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '224753', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], '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', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'kyuubiServices' => [ + 'description' => 'A list of Kyuubi servers.', + 'type' => 'array', + 'items' => [ + 'description' => 'A Kyuubi server record.', + 'type' => 'object', + 'properties' => [ + 'kyuubiConfigs' => ['description' => 'The Kyuubi server configurations.', 'type' => 'string', 'title' => '', 'example' => 'kyuubi.conf.key=value1'."\n" + .'kyuubi.conf.key1=value2'], + 'sparkConfigs' => ['description' => 'The default configurations for Spark applications launched by the Kyuubi server.', 'type' => 'string', 'title' => '', 'example' => 'spark.conf.key=value1'."\n" + .'spark.conf.key1=value2'], + 'state' => ['description' => 'The status of the Kyuubi server.', 'type' => 'string', 'title' => '', 'example' => 'Running'], + 'name' => ['description' => 'The name of the Kyuubi server.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'queue' => ['description' => 'The queue name.', 'type' => 'string', 'title' => '', 'example' => 'dev_queue'], + 'createTime' => ['description' => 'The time when the server was created.', 'type' => 'string', 'title' => '', 'example' => '2025-03-11T08:21:58Z'], + 'startTime' => ['description' => 'The time when the Kyuubi server was last started.', 'type' => 'string', 'title' => '', 'example' => '2024-11-23 09:22:00'], + 'creator' => ['description' => 'The UID of the user who created the server.', 'type' => 'string', 'title' => '', 'example' => '103*******'], + 'kyuubiServiceId' => ['description' => 'The Kyuubi server ID.', 'type' => 'string', 'title' => '', 'example' => 'kb-070104e7631242448d12a1377c309f30'], + 'innerEndpoint' => ['description' => 'The internal endpoint.', 'type' => 'string', 'title' => '', 'example' => 'kyuubi-cn-hangzhou-internal.spark.emr.aliyuncs.com'], + 'publicEndpoint' => ['description' => 'The public endpoint.', 'type' => 'string', 'title' => '', 'example' => 'emr-spark-kyuubi-gateway-cn-hangzhou.aliyuncs.com'], + 'releaseVersion' => ['description' => 'The version number of the Spark engine.', 'type' => 'string', 'title' => '', 'example' => 'esr-4.2.0 (Spark 3.5.2, Scala 2.12)'."\n"], + 'computeInstance' => ['description' => 'The instance type of the Kyuubi server.', 'type' => 'string', 'title' => '', 'example' => '4C16G'], + 'replica' => ['description' => 'The number of replicas for the Kyuubi server.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'kyuubiReleaseVersion' => ['type' => 'string', 'description' => 'The version of the Kyuubi server.', 'title' => '', 'example' => '1.9.2-0.0.1'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListKyuubiServices', + 'summary' => 'Lists Kyuubi Gateways.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListKyuubiServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', - 'title' => 'TerminateSqlStatement', + '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"}]', ], - 'CreateSqlStatement' => [ - 'summary' => 'Creates an SQL query task.', - 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListKyuubiSparkApplications' => [ + 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/applications', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '224750', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-26ca1703f6d****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'flat', + 'name' => 'kyuubiServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The Kyuubi service ID.', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', 'title' => ''], + ], + [ + 'name' => 'applicationId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Spark application submitted by Kyuubi, used for searching.', 'type' => 'string', 'required' => false, 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', 'title' => ''], + ], + [ + 'name' => 'applicationName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Spark application submitted by Kyuubi, used for searching.', 'type' => 'string', 'required' => false, 'example' => 'kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****', 'title' => ''], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The time range when the task started.', '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', - ], + 'startTime' => ['description' => 'The start of the time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1709740800000', 'required' => false, 'title' => ''], + 'endTime' => ['description' => 'The end of the time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710432000000', 'required' => false, 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'regionId', + 'name' => 'resourceQueueId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'root_queue', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'minDuration', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '60000', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'orderBy', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'startTime', 'description' => '', 'required' => false, 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'asc', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'startTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '1774209636', 'description' => '', 'title' => ''], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '1774209636', 'description' => '', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'states', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '["ERROR"]', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'latestSqlStatementStatuses', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '["SUCCESS"]', 'description' => '', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The format of the response.', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'statementId' => [ - 'description' => 'The interactive query ID.'."\n", - 'type' => 'string', - 'example' => 'st-1231dfafadfa***', + 'applications' => [ + 'description' => 'A list of application details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The application details.', + 'type' => 'object', + 'properties' => [ + 'applicationId' => ['description' => 'The ID of the Spark application submitted by Kyuubi.', 'type' => 'string', 'example' => 'spark-339f844005b6404c95f9f7c7a13b****', 'title' => ''], + 'applicationName' => ['description' => 'The name of the Spark application submitted by Kyuubi.', 'type' => 'string', 'example' => 'kyuubi-connection-spark-sql-anonymous-fa9a5e73-b4b1-474a-b****', 'title' => ''], + 'webUI' => ['description' => 'The URL of the Spark application UI.', '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****', 'title' => ''], + 'state' => ['description' => 'The status of the Spark application.'."\n" + ."\n" + .'- STARTING: The application is starting.'."\n" + ."\n" + .'- RUNNING: The application is running.'."\n" + ."\n" + .'- TERMINATED: The application is terminated.', 'type' => 'string', 'example' => 'STARTING', 'title' => ''], + 'startTime' => ['description' => 'The time when the task started.', 'type' => 'string', 'example' => '2025-02-12 19:59:16', 'title' => ''], + 'endTime' => ['description' => 'The time when the task ended.', 'type' => 'string', 'example' => '2025-02-12 20:02:02', 'title' => ''], + 'cuHours' => ['description' => 'The number of CUs consumed during the task lifecycle. This is an estimated value. The final amount is subject to your bill.', 'type' => 'number', 'format' => 'double', 'example' => '0.238302', 'title' => ''], + 'mbSeconds' => ['description' => 'The total memory allocated to the task in MB, multiplied by the number of seconds the task ran.', 'type' => 'integer', 'format' => 'int64', 'example' => '3513900', 'title' => ''], + 'vcoreSeconds' => ['description' => 'The total vCores allocated to the task, multiplied by the number of seconds the task ran.', 'type' => 'integer', 'format' => 'int64', 'example' => '780', 'title' => ''], + 'resourceQueueId' => ['description' => 'The name of the resource queue where the Spark task runs.', 'type' => 'string', 'example' => 'dev_queue', 'title' => ''], + 'exitReason' => ['description' => 'The exit code.', 'type' => 'string', 'example' => 'Exit Code: 137, Exit Reason: OOMKilled', 'title' => ''], + 'latestSqlStatementStatus' => ['description' => 'The status of the last task execution in the session.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'runLog' => ['$ref' => '#/components/schemas/RunLog', 'description' => '', 'title' => '', 'example' => ''], + 'kyuubiServiceId' => ['type' => 'string', 'example' => 'kb-2b93ec*******c9440c', 'description' => '', 'title' => ''], + 'tags' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Tag', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'priority' => ['type' => 'string', 'example' => '5', 'description' => '', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListKyuubiSparkApplications', + 'summary' => 'Lists Kyuubi Spark applications.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListKyuubiSparkApplications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"statementId\\": \\"st-1231dfafadfa***\\"\\n },\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', - 'title' => 'CreateSqlStatement', + '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\\": \\"oss://bucket/path/to/stdout\\",\\n \\"driverStdError\\": \\"oss://bucket/path/to/stderr\\",\\n \\"driverSyslog\\": \\"oss://bucket/path/to/syslog\\",\\n \\"driverStartup\\": \\"oss://bucket/path/to/startup\\"\\n },\\n \\"kyuubiServiceId\\": \\"kb-2b93ec*******c9440c\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"workflowId\\",\\n \\"value\\": \\"wf-123test\\"\\n }\\n ],\\n \\"priority\\": \\"5\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', ], - 'GetSqlStatement' => [ - 'summary' => 'Queries the status of an SQL query task.', - 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement/{statementId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListKyuubiToken' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '224752', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'statementId', + 'name' => 'kyuubiServiceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The interactive query ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'st-2dadfhajk11cv****', - ], + 'schema' => ['description' => 'The Kyuubi service ID.', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], 'data' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', '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", + 'tokens' => [ + 'description' => 'A list of tokens.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A token record.', '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]}', + 'tokenId' => ['description' => 'The token ID.', 'type' => 'string', 'example' => 'tk-zpi0*****hdv4y', 'title' => ''], + 'name' => ['description' => 'The token name.', 'type' => 'string', 'example' => 'dev_serverless_spark', 'title' => ''], + 'token' => ['description' => 'The masked token.', 'type' => 'string', 'example' => 'dxj**********wfg', 'title' => ''], + 'createdBy' => ['description' => 'The creator\'s name.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1755496031000', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1787033891000', 'title' => ''], + 'lastUsedTime' => ['description' => 'The last used time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760366232121', 'title' => ''], + 'memberArns' => [ + 'type' => 'array', + 'items' => ['description' => 'The ARN of an authorized user.', 'type' => 'string', 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311', 'title' => ''], + 'description' => 'The ARNs of authorized users.', + 'title' => '', + 'example' => '', ], - '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\\":{}}]}', + 'accountNames' => [ + 'type' => 'array', + 'items' => ['description' => 'The name of an authorized RAM user.', 'type' => 'string', 'example' => 'dev-serverless-spark', 'title' => ''], + 'description' => 'The names of authorized RAM users.', + 'title' => '', + 'example' => '', ], - 'rowsFilePath' => [ - 'type' => 'string', + 'sparkRole' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - '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', - ], + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListKyuubiToken', + 'summary' => 'Lists KyuubiServer authentication tokens.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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 \\"sparkRole\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListLivyCompute' => [ + 'summary' => 'Lists Livy Gateways.', + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceLNUXSK', - ], + 'abilityTreeCode' => '222250', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], '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', + 'name' => 'workspaceBizId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-72704d9fb0******', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], ], [ - 'name' => 'nextToken', + 'name' => 'environmentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ev-cq31c7tlhtgm9nrrlj4g'], ], [ - 'name' => 'maxResults', + 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'sqlStatementContents' => [ - 'description' => '', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request is successful. For other values, see the message parameter for error details.', 'type' => 'string', 'title' => '', 'example' => '1000000'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'description' => 'The returned data.', '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', + 'livyComputes' => [ + 'description' => 'A list of Livy Gateways.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'computeId' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'title' => '', 'example' => 'lc-xxxxxxxxxxxx'], + 'name' => ['description' => 'The name.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'title' => '', 'example' => 'root_queue'], + 'status' => [ + 'description' => 'The running status.', + 'type' => 'string', + 'enum' => ['RUNNING', 'STOPPED', 'STARTING', 'STOPPING', 'FAILED'], + 'title' => '', + 'example' => 'RUNNING', + ], + 'endpoint' => ['description' => 'The public endpoint.', 'type' => 'string', 'title' => '', 'example' => 'emr-spark-livy-gateway-cn-hangzhou.data.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx'], + 'createdBy' => ['description' => 'The name of the creator.', 'type' => 'string', 'title' => '', 'example' => 'alice'], + 'gmtCreate' => ['description' => 'The time when the resource was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749456094000'], + 'startTime' => ['description' => 'The time when the resource was started.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749456094000'], + 'endpointInner' => ['description' => 'The internal endpoint.', 'type' => 'string', 'title' => '', 'example' => 'emr-spark-livy-gateway-cn-hangzhou-internal.aliyun.com/api/v1/workspace/w-xxxxxxxxx/livycompute/lc-xxxxxxxxxxx'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n", + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'ListLivyComputeSessions' => [ + 'summary' => 'Lists the historical sessions for a Livy Gateway.', + 'path' => '/api/v1/workspaces/{workspaceId}/livycompute/{livyComputeId}/session', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '191902', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '246258', + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '不支持', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, - 'style' => 'json', + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d80f373d3ace824f', 'title' => ''], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', 'title' => ''], + ], + [ + 'name' => 'pageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Minimum value: 1. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8FAA8EEC-3026-5D15-8733-4E2A3DD970A1'], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'sessions' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'key' => [ - 'type' => 'string', - ], - 'value' => [ + 'name' => ['description' => 'The session name.', 'type' => 'string', 'example' => 'test_session', 'title' => ''], + 'computeId' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'example' => 'lc-xxxxxx', 'title' => ''], + 'sessionId' => ['description' => 'The ID of the Livy Gateway session.', 'type' => 'string', 'example' => 'livy-xxxxxx', 'title' => ''], + 'sparkConf' => ['description' => 'The Spark job configuration.', 'type' => 'string', 'example' => '{'."\n" + .' "proxyUser": "test",'."\n" + .' "conf": {'."\n" + .' "spark.driver.cores": 1'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'state' => [ + 'description' => 'The session state.'."\n" + ."\n" + .'- starting: The session is starting.'."\n" + ."\n" + .'- running: The session is running.'."\n" + ."\n" + .'- terminating: The session is being terminated.'."\n" + ."\n" + .'- terminated: The session is terminated.'."\n" + ."\n" + .'- error: The session failed.', 'type' => 'string', + 'enum' => ['starting', 'running', 'error', 'terminated', 'terminating'], + 'example' => 'running', + 'title' => '', ], + 'info' => ['description' => 'The runtime information.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'createTime' => ['description' => 'The time when the session was created. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1768213240000', 'title' => ''], + 'webUI' => ['description' => 'The web UI URL of the session.', 'type' => 'string', 'example' => 'http://emr-spark-ui-cn-hangzhou.data.aliyun.com', 'title' => ''], + 'endTime' => ['description' => 'The time when the session ended. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1768213240000', 'title' => ''], + 'queue' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'cuHours' => ['description' => 'The number of compute units (CUs) consumed during the task execution. This is an estimated value. The actual value is subject to the bill.', 'type' => 'number', 'format' => 'double', 'example' => '322.5', 'title' => ''], + 'vcoreSeconds' => ['description' => 'The total number of vCores allocated to the task multiplied by the number of seconds the task has been running.', 'type' => 'integer', 'format' => 'int64', 'example' => '343', 'title' => ''], + 'mbSeconds' => ['description' => 'The total amount of memory in MB allocated to the task multiplied by the number of seconds the task has been running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1098888', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'maxItems' => 20, + 'description' => 'The list of sessions.', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListLivyComputeSessions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLivyComputeSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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"}]', + ], + 'ListLivyComputeToken' => [ + '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' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-zm4dzdiubu73w2yx', 'title' => ''], + ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response schema.', '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****', + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. See the message parameter for failure details.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'tokens' => [ + 'description' => 'The list of tokens.', + 'type' => 'array', + 'items' => [ + 'description' => 'The token information.', + 'type' => 'object', + 'properties' => [ + 'tokenId' => ['description' => 'The token ID.', 'type' => 'string', 'example' => 'lctk-xxxxxxxxxxx', 'title' => ''], + 'name' => ['description' => 'The token name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'token' => ['description' => 'The token content.', 'type' => 'string', 'example' => '5d37843fb6f1e8', 'title' => ''], + 'createdby' => ['description' => 'The user who created the token.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'createTime' => ['description' => 'The time when the token was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456094000', 'title' => ''], + 'expireTime' => ['description' => 'The time when the token expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456994000', 'title' => ''], + 'lastUsedTime' => ['description' => 'The time when the token was last used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749456098000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListLivyComputeToken', + 'summary' => 'Lists Livy Gateway tokens.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '192019', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '194779', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'nextToken', + 'name' => 'fileName', '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', - ], + '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', 'title' => ''], ], [ - 'name' => 'maxResults', + 'name' => 'offset', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => 'The maximum number of entries returned.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Start line for query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'length', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the workspace. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_workspace', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Length of the log.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9999', 'title' => ''], ], [ - 'name' => 'state', - 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the workspace.', - 'type' => 'string', - 'required' => false, - 'example' => 'running', - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-72704d9fb0******', 'title' => ''], ], [ '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, - ], + 'schema' => ['title' => '区域ID。', 'description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'description' => 'Returned data', '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.', + 'listLogContent' => [ + 'description' => 'Log content.', + 'type' => 'object', + 'properties' => [ + 'contents' => [ + 'description' => 'List of log line contents.', + 'type' => 'array', + 'items' => [ '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', - ], - ], + 'LineContent' => ['description' => 'Log line content.', 'type' => 'string', 'example' => 'spark pi is 3.14\\n', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'totalLength' => ['description' => 'Total number of log lines.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - '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', - ], + 'requestId' => ['title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], + 'example' => '', ], ], ], - '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', + '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLogContents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListMembers' => [ + 'path' => '/api/v1/auth/{workspaceId}/members', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '192786', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce0SZW92'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', + 'name' => 'nextToken', + 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-26ca1703f6d71e6e', - ], + 'schema' => ['description' => 'The token that marks the start of the next page of results.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], ], [ - 'name' => 'environment', + 'name' => 'maxResults', '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', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], + ], + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'w-975bcfda9625****', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'queues' => [ - 'description' => 'The list of queues.'."\n", + 'members' => [ + 'description' => 'The list of members.', 'type' => 'array', 'items' => [ - 'description' => 'The queue details.'."\n", + 'description' => 'A member.', '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", + 'memberArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the user.', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:member/202265*****276', 'title' => ''], + 'userName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'jia***test@195*****7311.onaliyun.com', 'title' => ''], + 'displayName' => ['description' => 'The display name of the user.', 'type' => 'string', 'example' => 'jia***test', 'title' => ''], + 'userType' => [ + 'description' => 'The type of the user.', + 'enumValueTitles' => ['ROLE' => 'ROLE', 'MEMBER' => 'MEMBER'], 'type' => 'string', - 'example' => '237109', + 'example' => 'MEMBER', + 'title' => '', ], - 'allowActions' => [ - 'title' => '队列允许的操作', - 'description' => 'The operations allowed for the queue.'."\n", + 'roles' => [ + 'title' => '', + 'description' => 'The list of roles in the workspace.', 'type' => 'array', 'items' => [ - 'description' => 'The operation allowed for the queue.'."\n", + 'description' => 'A user role.', '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", + 'roleArn' => ['description' => 'The ARN of the role.', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:role/DataScience', 'title' => ''], + 'roleName' => ['description' => 'The name of the role.', 'type' => 'string', 'example' => 'DataScience', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'DataScience', 'title' => ''], + 'createTime' => ['description' => 'The time when the role was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753412502000', 'title' => ''], + 'actions' => [ + 'title' => '', + 'description' => 'The list of permissions.', 'type' => 'array', 'items' => [ - 'description' => 'The dependency of the operation.'."\n", - 'type' => 'string', - 'example' => 'view', + 'type' => 'object', + 'properties' => [ + 'actionArn' => ['description' => 'The ARN of the action.', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:action/add_MEMBER', 'title' => ''], + 'actionName' => ['description' => 'The name of the permission.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'displayName' => ['description' => 'The display name of the permission.', 'type' => 'string', 'example' => 'add members', 'title' => ''], + 'description' => ['description' => 'The description of the action.', 'type' => 'string', 'example' => 'add members'."\n", 'title' => ''], + 'dependencies' => [ + 'title' => '', + 'description' => 'The list of action dependencies.', + 'type' => 'array', + 'items' => ['description' => 'A dependency.', 'type' => 'string', 'example' => 'VIEW', 'title' => ''], + 'example' => '["view"]', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => '["view"]', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'environments' => [ - 'description' => 'The environment types of the queue.'."\n", + 'actions' => [ + 'title' => '', + 'description' => 'The list of operations allowed for this user.', 'type' => 'array', 'items' => [ - 'description' => 'The environment type of the queue.'."\n", - 'type' => 'string', - 'example' => 'production', + 'type' => 'object', + 'properties' => [ + 'actionArn' => ['description' => 'The ARN of the action.', 'type' => 'string', 'example' => 'acs:emr::w-1234****abcd:action/add_MEMBER', 'title' => ''], + 'actionName' => ['description' => 'The name of the permission.', 'type' => 'string', 'example' => 'add', 'title' => ''], + 'displayName' => ['description' => 'The display name of the permission.', 'type' => 'string', 'example' => 'add members', 'title' => ''], + 'description' => ['description' => 'The description of the action.', 'type' => 'string', 'example' => 'add members', 'title' => ''], + 'dependencies' => [ + 'title' => '', + 'description' => 'The list of action dependencies.', + 'type' => 'array', + 'items' => ['description' => 'A dependency.', 'type' => 'string', 'example' => 'VIEW', 'title' => ''], + 'example' => '["view"]', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - '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', - ], + 'visible' => ['description' => 'Indicates whether the member is visible.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'createTime' => ['description' => 'The time when the member was created.', 'type' => 'string', 'example' => '1753412502000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMembers', + 'summary' => 'Retrieves the list of members in the workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'ListNetworkServices' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/networkServices', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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', + 'operationType' => 'list', + 'abilityTreeCode' => '208335', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'workspaceId', + 'in' => 'path', '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, - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'queues' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'w-d2d82aa09155****', 'title' => ''], + 'networkServiceId' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'ns-d7a1d02045fb****'."\n", 'title' => ''], + 'name' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'type' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'NetworkService', 'title' => ''], + 'vpcId' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'vpc-uf6k2anfa9nzbm4cj****', 'title' => ''], + 'vswitchIds' => [ + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'vsw-bp1yc4kfdjxq9s1zn****', 'title' => ''], + 'description' => 'This parameter is deprecated.', + 'title' => '', + 'example' => '', + ], + 'state' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'stateChangeReason' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'code', 'title' => ''], + 'message' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'message', 'title' => ''], + ], + 'description' => 'This parameter is deprecated.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'This parameter is deprecated.', + 'title' => '', + 'example' => '', + ], + 'description' => 'This parameter is deprecated.', + 'title' => '', + 'example' => '', ], + 'networkServices' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'w-d2d82aa09155****'."\n", 'title' => ''], + 'networkServiceId' => ['description' => 'The ID of the network connection.', 'type' => 'string', 'example' => 'ns-d7a1d02045fb****', 'title' => ''], + 'name' => ['description' => 'The name of the network connection.', 'type' => 'string', 'example' => 'vpc_test', 'title' => ''], + 'type' => ['description' => 'The type of the network connection.', 'type' => 'string', 'example' => 'NetworkService', 'title' => ''], + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1vt6r7o1w4tw7j6****', 'title' => ''], + 'vswitchIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1yc4kfdjxq9s1zn****', 'title' => ''], + 'description' => 'The list of vSwitch IDs.', + 'title' => '', + 'example' => '', + ], + 'state' => ['description' => 'The state of the network connection.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'stateChangeReason' => [ + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'code', 'title' => ''], + 'message' => ['description' => 'The message that provides details about the state change.', 'type' => 'string', 'example' => 'message', 'title' => ''], + ], + 'description' => 'The reason for the state change.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A network connection.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of network connections.', + 'title' => '', + 'example' => '', + ], + 'nextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '18C7775A-7995-128A-A10C-9116EA87****', 'title' => ''], ], + 'title' => '', + 'description' => 'The response structure.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListNetworkServices', + 'summary' => 'Lists network connections.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', - 'title' => 'EditWorkspaceQueue', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"queues\\": [\\n {\\n \\"workspaceId\\": \\"w-d2d82aa09155****\\",\\n \\"networkServiceId\\": \\"ns-d7a1d02045fb****\\\\n\\",\\n \\"name\\": \\"test\\",\\n \\"type\\": \\"NetworkService\\",\\n \\"vpcId\\": \\"vpc-uf6k2anfa9nzbm4cj****\\",\\n \\"vswitchIds\\": [\\n \\"vsw-bp1yc4kfdjxq9s1zn****\\"\\n ],\\n \\"state\\": \\"running\\",\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"code\\",\\n \\"message\\": \\"message\\"\\n }\\n }\\n ],\\n \\"networkServices\\": [\\n {\\n \\"workspaceId\\": \\"w-d2d82aa09155****\\\\n\\",\\n \\"networkServiceId\\": \\"ns-d7a1d02045fb****\\",\\n \\"name\\": \\"vpc_test\\",\\n \\"type\\": \\"NetworkService\\",\\n \\"vpcId\\": \\"vpc-bp1vt6r7o1w4tw7j6****\\",\\n \\"vswitchIds\\": [\\n \\"vsw-bp1yc4kfdjxq9s1zn****\\"\\n ],\\n \\"state\\": \\"running\\",\\n \\"stateChangeReason\\": {\\n \\"code\\": \\"code\\",\\n \\"message\\": \\"message\\"\\n }\\n }\\n ],\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200,\\n \\"requestId\\": \\"18C7775A-7995-128A-A10C-9116EA87****\\"\\n}","type":"json"}]', ], - 'ListReleaseVersions' => [ - 'summary' => 'Queries the list of published versions of E-MapReduce (EMR) Serverless Spark.', - 'path' => '/api/v1/releaseVersions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRayCluster' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '192442', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], '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' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'title' => '', 'required' => false], ], [ - 'name' => 'workspaceId', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], [ - 'name' => 'regionId', + 'name' => 'pageNum', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'releaseVersions' => [ - 'description' => 'The versions.'."\n", + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', 'title' => ''], + 'rayClusters' => [ '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', + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'ray-uiulpgow9xljimm1', 'title' => ''], + 'name' => ['description' => 'The name of the Ray cluster.', 'type' => 'string', 'example' => 'testRayCluster', 'title' => ''], + 'displayReleaseVersion' => ['description' => 'The Ray engine version.', 'type' => 'string', 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Ray Cluster for dev.', 'title' => ''], + 'networkServiceName' => ['description' => 'The name of the network connectivity service.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'headSpec' => [ + 'type' => 'object', + 'properties' => [ + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'memory' => ['description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'title' => ''], + 'enableAutoScaling' => ['description' => 'Indicates whether automatic scaling is enabled for worker nodes.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'idleTimeoutSeconds' => ['description' => 'The idle timeout period for worker nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'replica' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The information about the head node of the Ray cluster.', + 'example' => '', ], - 'cpuArchitectures' => [ - 'description' => 'The CPU architectures.'."\n", + 'workerSpec' => [ 'type' => 'array', 'items' => [ - 'description' => 'The CPU architecture.'."\n", - 'type' => 'string', - 'example' => 'x86', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the worker group.', 'type' => 'string', 'example' => 'Group1', 'title' => ''], + 'workerType' => [ + 'description' => 'The worker type.', + 'type' => 'string', + 'example' => 'CPU', + 'enum' => ['CPU'], + 'title' => '', + ], + 'replica' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'title' => ''], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'memory' => ['description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'title' => ''], + 'minReplica' => ['description' => 'The minimum number of worker nodes after automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'maxReplica' => ['description' => 'The maximum number of worker nodes after automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'description' => 'The struct of the worker node information for the Ray cluster.', + 'example' => '', ], + 'title' => '', + 'description' => 'The information about the worker nodes of the Ray cluster.', + 'example' => '', ], - 'displayReleaseVersion' => [ - 'description' => 'The version number.'."\n", + 'state' => [ + 'description' => 'The cluster state.'."\n" + ."\n" + .'- Starting: The cluster is starting.'."\n" + ."\n" + .'- Running: The cluster is running.'."\n" + ."\n" + .'- Stopping: The cluster is stopping.'."\n" + ."\n" + .'- Stopped: The cluster is stopped.'."\n" + ."\n" + .'- Error: The cluster has failed.', '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', - ], - ], + 'example' => 'Running', + 'enum' => ['Starting', 'Running', 'Stopping', 'Stopped', 'Error'], + 'title' => '', + ], + 'createTime' => ['description' => 'The time when the cluster was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723722279800', 'title' => ''], + 'modifiedTime' => ['description' => 'The time when the cluster was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723722279800', 'title' => ''], + 'creator' => ['description' => 'The UID of the user who created the cluster.', 'type' => 'string', 'example' => '202077646755123991', 'title' => ''], + 'creatorName' => ['description' => 'The nickname of the creator.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'modifier' => ['description' => 'The UID of the user who last updated the cluster.', 'type' => 'string', 'example' => '202077646755123991', 'title' => ''], + 'modifierName' => ['description' => 'The nickname of the modifier.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'userId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'dashboardUrl' => ['description' => 'The URL of the Ray cluster dashboard.', 'type' => 'string', 'example' => 'https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx', 'title' => ''], + 'modified' => ['description' => 'Indicates whether the configuration has been modified.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the Ray cluster instance.', 'type' => 'string', 'example' => 'ray-uiulpgow9xljimm1-xxxxxxx', 'title' => ''], + 'startTime' => ['description' => 'The startup time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723722279800', 'title' => ''], + 'grpcEndpoint' => ['description' => 'The gRPC endpoint for the internal network. The domain name can also be used to submit Ray jobs.', 'type' => 'string', 'example' => 'ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80', 'title' => ''], + ], + 'title' => '', + 'description' => 'The Ray cluster struct.', + 'example' => '', ], - ], - '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', + 'title' => '', + 'description' => 'The list of Ray clusters.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListRayCluster', + 'summary' => 'Lists Ray clusters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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 \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\"\\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 \\"gpuSpec\\": \\"ecs.gn6i-c4g1.xlarge\\"\\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"}]', + ], + 'ListRayJob' => [ + 'summary' => 'Lists Ray Job information.', + 'path' => '/api/v1/workspaces/{workspaceId}/rayJob', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '231260', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceT8XN05', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-d2d82aa09155****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'required' => false], ], [ - 'name' => 'jobRunId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'jr-f09a8fda2396****', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ - 'name' => 'nextToken', + 'name' => 'pageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ - 'name' => 'maxResults', + 'name' => 'submissionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The submission ID of the Ray Job.', 'type' => 'string', 'required' => false, 'example' => 'rj-xxxxxxxxxxx', 'title' => ''], ], [ - 'name' => 'status', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Dead', - ], + 'schema' => ['description' => 'The name of the Ray Job (exact match).', 'type' => 'string', 'required' => false, 'example' => 'myrayjob', 'title' => ''], ], [ - 'name' => 'executorType', + 'name' => 'submitTime', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The submit time range.', + 'type' => 'object', + 'properties' => [ + 'startTime' => ['description' => 'The start of the submit time range. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1780017822000', 'title' => ''], + 'endTime' => ['description' => 'The end of the submit time range. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1780018822000', 'title' => ''], + ], 'required' => false, - 'example' => 'driver', + 'example' => '', ], ], [ - 'name' => 'regionId', + 'name' => 'taskBizId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The data development node ID.', 'type' => 'string', 'required' => false, 'example' => 'TSK-db8b870d901e443ba0aebba40c923e02', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944'], + 'totalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'rayJobs' => [ + 'title' => '', + 'description' => 'The list of Ray Jobs.', 'type' => 'array', 'items' => [ - 'description' => '', + 'title' => '', + 'description' => 'The Ray Job struct.', 'type' => 'object', 'properties' => [ - 'workspaceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w-78faee4da118f02e', - ], - 'jobRunId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'jr-1fe145df8ade366a', - ], - 'executorId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'submissionId' => ['title' => '', 'description' => 'The ID of the Ray Job.', 'type' => 'string', 'example' => 'rj-uiulpgow9xljimm1'], + 'name' => ['title' => '', 'description' => 'The name of the Ray Job.', 'type' => 'string', 'example' => 'testRayJob'], 'status' => [ - 'description' => '', + 'title' => '', + 'description' => 'The job status. Valid values:'."\n" + .'- Submitted: submitted.'."\n" + .'- Pending: the cluster is being created.'."\n" + .'- Running: the job is running.'."\n" + .'- Succeeded: the job succeeded.'."\n" + .'- Failed: the job failed.'."\n" + .'- Cancelling: the job is being canceled.'."\n" + .'- Cancelled: the job is canceled.'."\n" + .'- Timeout: the job timed out and was canceled.', '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', + 'enum' => ['Submitted', 'Pending', 'Running', 'Succeeded', 'Failed', 'Cancelling', 'Cancelled', 'Timeout'], + ], + 'resourceQueue' => ['title' => '', 'description' => 'The Ray DPI engine version.', 'type' => 'string', 'example' => 'err-1.2.0 (Ray 2.55.1, Python 3.12)'], + 'submitTime' => ['description' => 'The time when the job was submitted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1776945399000', 'title' => ''], + 'startTime' => ['description' => 'The time when the job was started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1776945499000', 'title' => ''], + 'endTime' => ['description' => 'The time when the job ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1776945509000', 'title' => ''], + 'duration' => ['description' => 'The execution duration of the job. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3564', 'title' => ''], + 'creatorName' => ['title' => '', 'description' => 'The nickname of the creator.', 'type' => 'string', 'example' => 'Alice'], + 'dashboardUrl' => ['title' => '', 'description' => 'The URL of the Ray cluster dashboard. When the Ray cluster is in the Running state, the URL points to the Runtime UI. After the cluster is in the Deleted state, the URL points to the History UI. The History UI is supported only in err-1.2.0 and later versions.', 'type' => 'string', 'example' => 'https://emr-ray-gateway.aliyuncs.com?token=xxxxxxxxx'], + 'cuHours' => ['description' => 'The number of compute units (CUs) consumed during the job execution cycle. This value is an estimate. The actual value is subject to the bill.', 'type' => 'number', 'format' => 'double', 'example' => '120', 'title' => ''], + 'clusterState' => [ + 'description' => 'The status of the corresponding Ray cluster. Valid values:'."\n" + .'- Deleted: deleted.'."\n" + .'- Submitted: submitted but not yet being created.'."\n" + .'- Pending: being created.'."\n" + .'- Running: running.', + 'type' => 'string', + 'enum' => ['Deleted', 'Running', 'Submitted', 'Pending'], + 'example' => 'Running', + 'title' => '', ], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List ray job information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListRayJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"totalCount\\": 200,\\n \\"rayJobs\\": [\\n {\\n \\"submissionId\\": \\"rj-uiulpgow9xljimm1\\",\\n \\"name\\": \\"testRayJob\\",\\n \\"status\\": \\"Running\\",\\n \\"resourceQueue\\": \\"err-1.2.0 (Ray 2.55.1, Python 3.12)\\",\\n \\"submitTime\\": 1776945399000,\\n \\"startTime\\": 1776945499000,\\n \\"endTime\\": 1776945509000,\\n \\"duration\\": 3564,\\n \\"creatorName\\": \\"Alice\\",\\n \\"dashboardUrl\\": \\"https://emr-ray-gateway.aliyuncs.com?token=xxxxxxxxx\\",\\n \\"cuHours\\": 120,\\n \\"clusterState\\": \\"Running\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListLogContents' => [ - 'summary' => 'Get Log Content', - 'path' => '/api/v1/workspaces/{workspaceId}/action/listLogContents', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRayLogs' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceId}/ray/{instanceId}/logs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '194779', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ - 'name' => 'fileName', + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Ray job.', 'type' => 'string', 'required' => false, 'example' => 'rj-311d343123', 'title' => ''], + ], + [ + 'name' => 'bucketName', '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', - ], + 'schema' => ['description' => 'The bucket name.', 'type' => 'string', 'required' => false, 'example' => 'mybucket', 'title' => ''], ], [ - 'name' => 'offset', + 'name' => 'prefix', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Start line for query.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The prefix that the keys of the returned files must start with.', 'type' => 'string', 'required' => false, 'example' => '/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/ ', 'title' => ''], ], [ - 'name' => 'length', + 'name' => 'marker', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Length of the log.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9999', - ], + 'schema' => ['description' => 'The marker after which the returned objects are listed in alphabetical order.', 'type' => 'string', 'required' => false, 'example' => 'test1.txt', 'title' => ''], ], [ - 'name' => 'workspaceId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'Workspace ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'w-72704d9fb0******', - ], + 'name' => 'delimiter', + 'in' => 'query', + 'schema' => ['description' => 'The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character appears for the first time are grouped as a set of elements (CommonPrefixes).', 'type' => 'string', 'required' => false, 'example' => '/', 'title' => ''], ], [ - 'name' => 'regionId', + 'name' => 'maxKeys', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'Region ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The maximum number of objects to return. If the listing cannot be completed in a single request due to the max-keys setting, a NextMarker element is included in the response as the marker for the next listing request.'."\n" + ."\n" + .'Valid values: greater than 0 and less than 1000.'."\n" + ."\n" + .'Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'Returned data', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'listLogContent' => [ - 'description' => 'Log content.', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944'], + 'code' => ['description' => 'The response status code. The value 1000000 indicates success.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'contents' => [ - 'description' => 'List of log line contents.', + 'bucketName' => ['description' => 'The OSS bucket name.', 'type' => 'string', 'example' => 'mybucket', 'title' => ''], + 'prefix' => ['description' => 'The prefix that the keys of the returned files must start with.', 'type' => 'string', 'example' => '/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/', 'title' => ''], + 'marker' => ['description' => 'The marker after which the returned objects are listed in alphabetical order.', 'type' => 'string', 'example' => 'test1.txt', 'title' => ''], + 'maxKeys' => ['description' => 'The maximum number of objects to return.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'delimiter' => ['description' => 'The character used to group object names. All objects whose names contain the specified prefix and between which the delimiter character appears for the first time are grouped as a set of elements (CommonPrefixes).', 'type' => 'string', 'example' => '/', 'title' => ''], + 'isTruncated' => ['description' => 'Indicates whether the results returned in the request are truncated.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'nextMarker' => ['description' => 'The marker from which the next listing of files starts.', 'type' => 'string', 'example' => 'test2.txt', 'title' => ''], + 'objectList' => [ + 'description' => 'The list of object metadata.', 'type' => 'array', 'items' => [ + 'description' => 'The object data.', 'type' => 'object', 'properties' => [ - 'LineContent' => [ - 'description' => 'Log line content.', - 'type' => 'string', - 'example' => 'spark pi is 3.14\\n', - ], + 'name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'test1.txt', 'title' => ''], + 'path' => ['description' => 'The file path.', 'type' => 'string', 'example' => '/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/test1.txt', 'title' => ''], + 'isDir' => ['description' => 'Indicates whether the entry is a directory.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'timeModified' => ['description' => 'The modification time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '17344656363434', 'title' => ''], + 'size' => ['description' => 'The file size, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '535345', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'totalLength' => [ - 'description' => 'Total number of log lines.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], - ], - 'requestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List ray logs', + 'summary' => 'Lists Ray logs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\",\\n \\"data\\": {\\n \\"bucketName\\": \\"mybucket\\",\\n \\"prefix\\": \\"/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/\\",\\n \\"marker\\": \\"test1.txt\\",\\n \\"maxKeys\\": 50,\\n \\"delimiter\\": \\"/\\",\\n \\"isTruncated\\": true,\\n \\"nextMarker\\": \\"test2.txt\\",\\n \\"objectList\\": [\\n {\\n \\"name\\": \\"test1.txt\\",\\n \\"path\\": \\"/w-xxxxxxx/ray/logs/rj-xxxxxxxxxx_default/test1.txt\\",\\n \\"isDir\\": false,\\n \\"timeModified\\": 17344656363434,\\n \\"size\\": 535345\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListReleaseVersions' => [ + 'path' => '/api/v1/releaseVersions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceT8XN05', - ], + 'abilityTreeCode' => '192442', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-dsa23*****', - ], + 'name' => 'serviceFilter', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'queue', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the queue.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'root_queue', - ], + 'name' => 'releaseVersion', + 'in' => 'query', + 'schema' => ['description' => 'The EMR Serverless Spark version.', 'type' => 'string', 'required' => false, 'example' => 'esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)', 'title' => ''], ], [ - 'name' => 'startTime', + 'name' => 'releaseVersionStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The start time of the query time range.'."\n", + 'description' => 'The status of the version.', + 'enumValueTitles' => ['ONLINE' => 'Online', 'OFFLINE' => 'Offline'], 'type' => 'string', - 'required' => true, - 'example' => '2024-01-01 00:00:00', + 'required' => false, + 'example' => 'ONLINE', + 'title' => '', ], ], [ - 'name' => 'endTime', + 'name' => 'releaseType', 'in' => 'query', 'schema' => [ - 'description' => 'The end time of the query time range.'."\n", + 'description' => 'The type of the version.', + 'enumValueTitles' => ['stable' => 'Stable', 'beta' => 'Beta'], 'type' => 'string', - 'required' => true, - 'example' => '2024-01-08 00:00:00', + 'required' => false, + 'example' => 'stable', + 'title' => '', ], ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned.', '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}', + 'releaseVersions' => [ + 'description' => 'The list of versions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the version.', + 'type' => 'object', + 'properties' => [ + 'releaseVersion' => ['description' => 'The version number.', 'type' => 'string', 'example' => 'esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)', 'title' => ''], + 'state' => ['description' => 'The status of the version.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'type' => ['description' => 'The type of the version.', 'type' => 'string', 'example' => 'stable', 'title' => ''], + 'iaasType' => ['description' => 'The type of the IaaS layer.', 'type' => 'string', 'example' => 'ASI', 'title' => ''], + 'gmtCreate' => ['description' => 'The time when the version was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716215854101', 'title' => ''], + 'scalaVersion' => ['description' => 'The Scala version.', 'type' => 'string', 'example' => '2.12', 'title' => ''], + 'communityVersion' => ['description' => 'The community version number of Spark.', 'type' => 'string', 'example' => 'Spark 3.3.1', 'title' => ''], + 'cpuArchitectures' => [ + 'description' => 'The list of CPU architectures.', + 'type' => 'array', + 'items' => ['description' => 'The CPU architecture.', 'type' => 'string', 'example' => 'x86', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'displayReleaseVersion' => ['description' => 'The version number.', 'type' => 'string', 'example' => 'esr-2.1 (Spark 3.3.1, Scala 2.12)', 'title' => ''], + 'fusion' => [ + 'description' => 'Indicates whether the Fusion engine is enabled for acceleration.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], ], + 'title' => '', + 'example' => '', ], - '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" - .'}', + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of records to return on a single page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ListReleaseVersions', + 'summary' => 'Retrieves a list of release versions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListReleaseVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', + '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"}]', ], - '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', - ], + 'ListSessionClusters' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '193399', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce60H0RM', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '202905', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The token that marks the start of the next page of results.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], + ], + [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-1234abcd', 'title' => '', 'required' => false], ], [ - 'name' => 'runId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jr-d2d82aa09155****', - ], + 'name' => 'sessionClusterId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'emr-spark-demo-job', 'title' => '', 'required' => false], ], [ - 'name' => 'queryTime', + 'name' => 'queueName', 'in' => 'query', - 'schema' => [ - 'description' => 'The query time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01', - ], + 'schema' => ['description' => 'The queue name.', 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''], ], [ - 'name' => 'locale', + 'name' => 'kind', 'in' => 'query', 'schema' => [ - 'description' => 'The language of diagnostic information.'."\n", + 'description' => 'The session type.', + 'enumValueTitles' => ['NOTEBOOK' => 'NOTEBOOK', 'THRIFT' => 'THRIFT', 'SQL' => 'SQL'], 'type' => 'string', + 'default' => 'SQL', 'required' => false, - 'example' => 'zh-CN', - 'default' => 'zh-CN', + 'example' => 'SQL', + 'title' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', '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', + 'sessionClusters' => [ + 'description' => 'A list of sessions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The session details.', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-1234abcd', 'title' => ''], + 'sessionClusterId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'sc-123131', 'title' => ''], + 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123131', 'title' => ''], + 'queueName' => ['description' => 'The name of the queue in which the session runs.', 'type' => 'string', 'example' => 'dev_queue', 'title' => ''], + 'state' => ['description' => 'The session state.'."\n" + ."\n" + .'- Starting: The session is starting.'."\n" + ."\n" + .'- Running: The session is running.'."\n" + ."\n" + .'- Stopping: The session is stopping.'."\n" + ."\n" + .'- Stopped: The session is stopped.'."\n" + ."\n" + .'- Error: The session has failed.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'stateChangeReason' => [ + 'description' => 'The details of the last state change of the session.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The state change code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'message' => ['description' => 'The state change message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - ], + 'autoStartConfiguration' => [ + 'description' => 'The auto-start configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Indicates whether auto-start is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'autoStopConfiguration' => [ + 'description' => 'The auto-stop configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Indicates whether auto-stop is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'idleTimeoutMinutes' => ['description' => 'The number of minutes of inactivity before the session is automatically stopped.', 'type' => 'integer', 'format' => 'int32', 'example' => '45', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'applicationConfigs' => [ + 'description' => 'The session configurations. These are equivalent to the configurations of the underlying Spark job.', + 'type' => 'array', + 'items' => [ + 'description' => 'The SQL Compute configurations. These are equivalent to the configurations of the underlying Spark job.', + 'type' => 'object', + 'properties' => [ + 'configFileName' => ['description' => 'The configuration file name.', 'type' => 'string', 'example' => 'spark-default.conf', 'title' => ''], + 'configItemKey' => ['description' => 'The configuration key.', 'type' => 'string', 'example' => 'spark.app.name', 'title' => ''], + 'configItemValue' => ['description' => 'The configuration value.', 'type' => 'string', 'example' => 'test_application', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The session name.', 'type' => 'string', 'example' => 'adhoc_query', 'title' => ''], + 'userName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'test_user', 'title' => ''], + 'kind' => [ + 'description' => 'The session type.', + 'enumValueTitles' => ['NOTEBOOK' => 'NOTEBOOK', 'THRIFT' => 'THRIFT', 'SQL' => 'SQL'], + 'type' => 'string', + 'example' => 'SQL', + 'title' => '', + ], + 'webUI' => ['description' => 'The URL of the Spark UI for the session.', 'type' => 'string', 'example' => 'http://spark-ui-xxxx', 'title' => ''], + 'releaseVersion' => ['description' => 'The Serverless Spark version.', 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', 'title' => ''], + 'draftId' => ['description' => 'The ID of the developer job that is attached to the session.', 'type' => 'string', 'example' => 'TSK-xxxxxxxxx'."\n", 'title' => ''], + 'domain' => ['description' => 'The public endpoint of the Thrift server.', 'type' => 'string', 'example' => 'emr-spark-gateway-cn-hangzhou.data.aliyun.com', 'title' => ''], + 'displayReleaseVersion' => ['description' => 'The version displayed in the console.', 'type' => 'string', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)', 'title' => ''], + 'fusion' => ['description' => 'Indicates whether acceleration by the Fusion engine is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'gmtCreate' => ['description' => 'The time when the session was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1732267598000', 'title' => ''], + 'startTime' => ['description' => 'The time when the session was started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1732267598000', 'title' => ''], + 'domainInner' => ['description' => 'The internal same-region endpoint of the Thrift server.', 'type' => 'string', 'example' => 'emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com', 'title' => ''], + 'extra' => ['description' => 'The extra metadata of the session.', 'type' => 'string', 'example' => '{"extraInfoKey":"extraInfoValue"}', 'title' => ''], + 'publicEndpointEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'connectionToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token that marks the start of the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned for the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of entries that match the query criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'ListSessionClusters', + 'summary' => 'Retrieves a list of session clusters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListSessionClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"suggestions\\": [\\n \\"正常。\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDoctorApplication', + '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\\": false,\\n \\"connectionToken\\": \\"\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', ], - 'CancelJobRun' => [ - 'summary' => 'Terminates a Spark job.', - 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSqlStatementContents' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/action/listSqlStatementContents', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '215798', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceLNUXSK'], ], 'parameters' => [ [ + 'name' => 'fileName', + 'in' => 'query', + 'schema' => ['description' => 'The full path of the file.', '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', 'title' => ''], + ], + [ 'name' => 'workspaceId', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-1234abcd', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-72704d9fb0******', 'title' => ''], ], [ - 'name' => 'jobRunId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '任务实例ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'jr-231231', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that specifies the position from which to start reading the results.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'regionId', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The maximum number of records to return for a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The data returned.', '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****', + 'sqlStatementContents' => [ + 'description' => 'The content of the SQL execution result.', + 'type' => 'object', + 'properties' => [ + 'contents' => ['description' => 'A list of the SQL execution results.', 'type' => 'string', 'example' => '[{\\"values\\":[\\"wj*****\\",\\"test\\",\\"2025-04-15\\"]}]', 'title' => ''], + 'nextToken' => ['description' => 'The token that specifies the position from which to start reading the results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of records returned for a single request.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], + 'totalCount' => ['description' => 'The total number of rows in the result.', 'type' => 'integer', 'format' => 'int32', 'example' => '40000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n"], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListSqlStatementContents', + 'summary' => 'Retrieves the execution results of an SQL statement.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListSqlStatementContents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + ], + 'ListTemplate' => [ + 'summary' => 'Lists job templates.', + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/template/listing', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '215800', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '191100', + 'abilityTreeNodes' => ['FEATUREemapreduceUECZZL'], ], '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' => 'workspaceBizId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], ], [ - 'name' => 'maxResults', + 'name' => 'regionId', 'in' => 'query', - 'allowEmptyValue' => false, + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => 'The maximum number of entries to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'type' => 'object', + 'properties' => [ + 'httpStatusCode' => ['type' => 'string', 'title' => '', 'description' => 'The HTTP status code.', 'example' => '200'], + 'errorCode' => ['type' => 'string', 'description' => '- If the value of success is false, an error code is returned.'."\n" + ."\n" + .'- If the value of success is true, this parameter is empty.', 'title' => '', 'example' => 'ERR-00000000'], + 'errorMessage' => ['type' => 'string', 'description' => '- If the value of success is false, an error message is returned.'."\n" + ."\n" + .'- If the value of success is true, this parameter is empty.', 'title' => '', 'example' => 'ok'], + 'data' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Template', 'description' => 'The Spark job template object.', 'title' => '', 'example' => ''], + 'description' => 'The data list.', + 'title' => '', + 'example' => '', + ], + 'success' => ['type' => 'boolean', 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'title' => '', 'example' => 'true'], + 'requestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n"], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListTemplate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-1234abcd', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"httpStatusCode\\": \\"200\\",\\n \\"errorCode\\": \\"ERR-00000000\\",\\n \\"errorMessage\\": \\"ok\\",\\n \\"data\\": [\\n {\\n \\"templateType\\": \\"TASK\\",\\n \\"gmtModified\\": \\"2025-03-10T02:02:41.000+00:00\\",\\n \\"creator\\": 0,\\n \\"sparkLogLevel\\": \\"INFO\\",\\n \\"gmtCreated\\": \\"2025-03-10T02:02:41.000+00:00\\\\n\\",\\n \\"sparkDriverMemory\\": 1073741824,\\n \\"modifier\\": 0,\\n \\"sparkExecutorCores\\": 1,\\n \\"sparkConf\\": [\\n {\\n \\"value\\": \\"test_application\\",\\n \\"key\\": \\"spark.app.name\\"\\n }\\n ],\\n \\"sparkVersion\\": \\"esr-4.1.1\\",\\n \\"sparkExecutorMemory\\": 1073741824,\\n \\"fusion\\": true,\\n \\"isDefault\\": true,\\n \\"sparkDriverCores\\": 1,\\n \\"displaySparkVersion\\": \\"esr-4.1.1\\",\\n \\"sparkLogPath\\": \\"oss://your_bucket/path/to/your/log\\",\\n \\"name\\": \\"\\",\\n \\"bizId\\": \\"\\"\\n }\\n ],\\n \\"success\\": true,\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', + ], + 'ListWorkspaceQueues' => [ + 'summary' => 'Lists the queues in a workspace.', + 'path' => '/api/v1/workspaces/{workspaceId}/queues', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'name', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '作业名称。', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr-spark-demo-job', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192786', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + ], + 'parameters' => [ [ - 'name' => 'creator', - 'in' => 'query', + 'name' => 'workspaceId', + 'in' => 'path', 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '创建用户Uid。', - 'description' => 'The ID of the user who created the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1509789347011222', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-26ca1703f6d7****', 'title' => ''], ], [ - 'name' => 'jobRunId', + 'name' => 'environment', 'in' => 'query', - 'allowEmptyValue' => false, 'schema' => [ - 'title' => '作业id。', - 'description' => 'The job ID.'."\n", + 'description' => 'The environment type.', + 'enumValueTitles' => ['dev' => 'dev', 'production' => 'production'], 'type' => 'string', 'required' => false, - 'example' => 'j-xxx', + 'example' => 'production', + 'title' => '', ], ], [ - 'name' => 'tags', + 'name' => 'regionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'json', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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', + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'queues' => [ + 'description' => 'The list of queues.', + 'type' => 'array', + 'items' => [ + 'description' => 'The queue details.', + 'type' => 'object', + 'properties' => [ + 'regionId' => ['title' => 'regionId。', 'description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'dev_queue', 'title' => ''], + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-1234abcd', 'title' => ''], + 'queueType' => ['description' => 'The queue type. Valid values:'."\n" + ."\n" + .'- instance: A queue for a single task.'."\n" + ."\n" + .'- instanceChildren: A queue for a parent task.', 'type' => 'string', 'example' => 'instance', 'title' => ''], + 'properties' => ['description' => 'The queue label.', 'type' => 'string', 'example' => 'dev_queue', 'title' => ''], + 'queueScope' => ['description' => 'The queue architecture.', 'type' => 'string', 'example' => '{"arch": "x86"}', 'title' => ''], + 'maxResource' => ['description' => 'The maximum resource capacity of the queue.', 'type' => 'string', 'example' => '{"cpu": "2","memory": "2Gi"}', 'title' => ''], + 'minResource' => ['description' => 'The minimum resource capacity of the queue.', 'type' => 'string', 'example' => '{"cpu": "2","memory": "2Gi"}', 'title' => ''], + 'usedResource' => ['description' => 'The used resource capacity of the queue.', 'type' => 'string', 'example' => '{"cpu": "2","memory": "2Gi"}', 'title' => ''], + 'queueStatus' => ['description' => 'The queue status.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'creator' => ['description' => 'The UID of the user who created the queue.', 'type' => 'string', 'example' => '237109', 'title' => ''], + 'allowActions' => [ + 'title' => '', + 'description' => 'The list of allowed operations for the queue.', + 'type' => 'array', + 'items' => [ + 'description' => 'An allowed operation for the queue.', + 'type' => 'object', + 'properties' => [ + 'actionArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the behavior.', 'type' => 'string', 'example' => 'acs:emr::workspaceId:action/create_queue', 'title' => ''], + 'actionName' => ['description' => 'The permission name.', 'type' => 'string', 'example' => 'view', 'title' => ''], + 'displayName' => ['description' => 'The display name of the permission.', 'type' => 'string', 'example' => '文件目录遍历、文件浏览', 'title' => ''], + 'description' => ['description' => 'The action description.', 'type' => 'string', 'example' => 'Directory traversal and file browsing', 'title' => ''], + 'dependencies' => [ + 'title' => '', + 'description' => 'The list of action dependencies.', + 'type' => 'array', + 'items' => ['description' => 'The action dependency.', 'type' => 'string', 'example' => 'view', 'title' => ''], + 'example' => '["view"]', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'environments' => [ + 'description' => 'The list of environment types for the queue.', + 'type' => 'array', + 'items' => ['description' => 'The environment type of the queue.', 'type' => 'string', 'example' => 'production', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'paymentType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- PayAsYouGo: pay-as-you-go'."\n" + ."\n" + .'- Pre: subscription', 'type' => 'string', 'example' => 'PayAsYouGo', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684115879955', 'title' => ''], + 'preheat' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'queueCategory' => ['type' => 'string', 'example' => 'CPU', 'description' => '', 'title' => ''], + 'gpuSpec' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'ecs.gn7i-c8g1.2xlarge', 'description' => '', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of records to return in a single request.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], - [ - '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', + ], + '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\\": \\"Directory traversal and file browsing\\",\\n \\"dependencies\\": [\\n \\"view\\"\\n ]\\n }\\n ],\\n \\"environments\\": [\\n \\"production\\"\\n ],\\n \\"paymentType\\": \\"PayAsYouGo\\",\\n \\"createTime\\": 1684115879955,\\n \\"preheat\\": false,\\n \\"queueCategory\\": \\"CPU\\",\\n \\"gpuSpec\\": [\\n \\"ecs.gn7i-c8g1.2xlarge\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', + 'title' => 'ListWorkspaceQueues', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListWorkspaceQueues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'example' => '["Running","Submitted"]', ], ], + ], + 'translator' => 'manual', + ], + 'ListWorkspaces' => [ + 'summary' => 'Call `ListWorkspaces` to get a list of workspaces.', + 'path' => '/api/v1/workspaces', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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, - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192019', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + ], + 'parameters' => [ [ - 'name' => 'endTime', + 'name' => 'nextToken', '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, - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], ], [ - 'name' => 'resourceQueueId', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource queue on which the Spark jobs run.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dev_queue', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'required' => false], ], [ - 'name' => 'jobRunDeploymentId', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The job run ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jd-b6d003f1930f****', - ], + 'schema' => ['description' => 'The name of the workspace. Fuzzy search is supported.', 'type' => 'string', 'example' => 'test_workspace', 'required' => false, 'title' => ''], ], [ - 'name' => 'regionId', + 'name' => 'state', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The state of the workspace.', 'type' => 'string', 'example' => 'running', 'required' => false, 'title' => ''], ], [ - 'name' => 'minDuration', + 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum running duration of the job. Unit: ms.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60000', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'isWorkflow', + 'name' => 'tag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'cn-shenzhen-finance.edas.config.server', 'required' => false, 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'iPhone disk space remaining rate', 'required' => false, 'title' => ''], + ], + 'required' => false, + 'description' => 'A tag object.', + 'title' => '', + 'example' => '', + ], 'required' => false, + 'description' => 'Filters the results by one or more tags.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'runtimeConfigs', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'applicationConfigs', + 'name' => 'resourceGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-aek2thxggoqhmhq', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'jobRuns' => [ - 'description' => 'The Spark jobs.'."\n", + 'workspaces' => [ + 'description' => 'Workspace list.', 'type' => 'array', 'items' => [ - 'description' => 'The Spark job.'."\n", + 'description' => 'Workspace details.', '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', - ], + 'workspaceId' => ['description' => 'Workspace ID.', 'type' => 'string', 'example' => 'w-******', 'title' => ''], + 'workspaceName' => ['description' => 'Workspace name.', 'type' => 'string', 'example' => 'Spark batch workspace-1', 'title' => ''], + 'resourceSpec' => ['description' => 'Resource specification.', 'type' => 'string', 'title' => '', 'example' => '100cu'], + 'storage' => ['description' => 'OSS path.', 'type' => 'string', 'example' => 'spark-result', 'title' => ''], + 'dlfCatalogId' => ['description' => 'DLF Catalog information.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'paymentType' => ['description' => 'Billing method.', 'type' => 'string', 'example' => 'PayAsYouGo or Subscription', 'title' => ''], + 'paymentDurationUnit' => ['description' => 'Subscription period (Required for the prepaid billing method).', 'type' => 'string', 'example' => 'YEAR, MONTH, WEEK, DAY, HOUR, MINUTE', 'title' => ''], + 'duration' => ['description' => 'The subscription period quantity is required for the prepaid billing method.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'autoRenew' => ['description' => 'Specifies whether to enable auto-renewal (required for the prepaid billing method).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'autoRenewPeriod' => ['description' => 'Auto-renewal duration (Required for the prepaid billing method).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'autoRenewPeriodUnit' => ['description' => 'Auto-renewal period (Required for the prepaid billing method).', 'type' => 'string', 'example' => 'YEAR, MONTH, WEEK, DAY, HOUR, MINUTE', 'title' => ''], + 'workspaceStatus' => ['description' => 'Workspace status.', 'type' => 'string', 'example' => 'STARTING,RUNNING,TERMINATED', 'title' => ''], + 'failReason' => ['description' => 'Failure reason.', 'type' => 'string', 'example' => 'out of stock', 'title' => ''], + 'paymentStatus' => ['description' => 'Payment status.', 'type' => 'string', 'example' => 'PAID/UNPAID', 'title' => ''], + 'regionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'createTime' => ['description' => 'Workspace creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684115879955', 'title' => ''], + 'endTime' => ['description' => 'Workspace release time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1687103999999', 'title' => ''], 'stateChangeReason' => [ - 'description' => 'The reason of the job status change.'."\n", + 'description' => 'Information about changes to the workspace status.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'code' => ['description' => 'Error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - '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', + 'releaseType' => ['description' => 'Workspace release reason.', 'type' => 'string', 'example' => 'SERVICE_RELEASE', 'title' => ''], + 'dlfType' => ['description' => 'Bind a dlf type.', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'prePaidQuota' => [ + 'description' => 'Information about prepaid resource quotas.', + 'type' => 'object', + 'properties' => [ + 'usedResource' => ['description' => 'The amount of resources currently in use.', 'type' => 'string', 'example' => '{\\"cpu\\":\\"0\\",\\"memory\\":\\"0Gi\\",\\"cu\\":\\"0\\"}', 'title' => ''], + 'maxResource' => ['description' => 'The maximum amount of resources.', 'type' => 'string', 'example' => '{\\"cpu\\":\\"1\\",\\"memory\\":\\"4Gi\\",\\"cu\\":\\"1\\"}', 'title' => ''], + 'allocatedResource' => ['description' => 'The amount of resources that are currently allocated.', 'type' => 'string', 'example' => '{\\"cpu\\":\\"1\\",\\"memory\\":\\"4Gi\\",\\"cu\\":\\"1\\"}', 'title' => ''], + 'createTime' => ['description' => 'The creation time of the resource quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1745683200000', 'title' => ''], + 'expireTime' => ['description' => 'The expiration time of the resource quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1740537153000', 'title' => ''], + 'autoRenewal' => ['description' => 'Whether auto-renewal is enabled for the resource.'."\n" + ."\n" + .'- true: Enables auto-renewal. The resource is automatically renewed after it expires.'."\n" + ."\n" + .'- false: Auto-renewal is disabled. The resource is stopped upon expiration.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'paymentStatus' => ['description' => 'The payment status of the current resource. The possible values are as follows:'."\n" + ."\n" + .'- NORMAL: Active.'."\n" + ."\n" + .'- WAIT\\_FOR\\_EXPIRE: Will expire.'."\n" + ."\n" + .'- EXPIRED: The item has expired.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'instanceId' => ['description' => 'The resource instance ID that is associated with the quota.', 'type' => 'string', 'example' => 'i-abc12345', 'title' => ''], + 'orderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], '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', - ], + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => ''], + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'A tag.', + 'title' => '', + 'example' => '', ], + 'description' => 'The tags of the workspace.', + 'title' => '', + 'example' => '', ], - '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', + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxxxxxxx', 'title' => ''], + 'gpuSpec' => [ + 'type' => 'array', + 'items' => ['description' => 'A GPU specification.', 'type' => 'string', 'example' => 'ecs.gn7i-c8g1.2xlarge', 'title' => ''], + 'description' => 'The GPU specifications.', + 'title' => '', + 'example' => '', ], - 'resourceQueueId' => [ - 'title' => '运行任务的队列名称。', - 'type' => 'string', - 'example' => 'dev_queue', + 'ipWhiteList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => '0.0.0.1', 'description' => '', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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', - ], + 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'nextToken' => ['description' => 'Next page token.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of records to retrieve at one time.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'totalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'ListWorkspaces', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workspaces\\": [\\n {\\n \\"workspaceId\\": \\"w-******\\",\\n \\"workspaceName\\": \\"Spark batch workspace-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 \\"resourceGroupId\\": \\"rg-xxxxxxxxxx\\",\\n \\"gpuSpec\\": [\\n \\"ecs.gn7i-c8g1.2xlarge\\"\\n ],\\n \\"ipWhiteList\\": [\\n \\"0.0.0.1\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"maxResults\\": 20,\\n \\"totalCount\\": 200\\n}","type":"json"}]', ], - 'GetJobRun' => [ - 'summary' => 'Obtain the job details.', - 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns/{jobRunId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RefreshLivyComputeToken' => [ + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/token/{tokenId}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215794', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '222308', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ - 'name' => 'workspaceId', + 'name' => 'workspaceBizId', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-1234abcd', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], ], [ - 'name' => 'jobRunId', + 'name' => 'livyComputeId', 'in' => 'path', - 'allowEmptyValue' => false, + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', 'title' => ''], + ], + [ + 'name' => 'tokenId', + 'in' => 'path', + 'schema' => ['description' => 'The token ID.', 'type' => 'string', 'required' => false, 'example' => 'lctk-xxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '任务实例ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'jr-231231', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'token' => ['description' => 'The token must be 16 or more characters in length.', 'type' => 'string', 'required' => false, 'example' => 'fe86812667f04v343', 'title' => ''], + 'autoExpireConfiguration' => [ + 'description' => 'The information about token expiration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether the token automatically expires.'."\n" + ."\n" + .'- true: The token automatically expires.'."\n" + ."\n" + .'- false: The token does not automatically expire.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'expireDays' => ['description' => 'The expiration period in days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'regionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The status code. A value of 1000000 indicates that the request was successful. For other values, the request failed. For more information, see the message parameter.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + ], + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RefreshLivyComputeToken', + 'summary' => 'Refreshes the token for a Livy Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:RefreshLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + ], + 'StartCacheCluster' => [ + 'path' => '/api/v1/cache/{cacheClusterId}/start', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'cacheClusterId', + 'in' => 'path', + 'schema' => ['description' => 'Cache cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'spc-xxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', '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****', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n"], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Start Cache Cluster', + 'summary' => 'Start CacheCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', ], 'StartJobRun' => [ - 'summary' => 'Starts a Spark job.', + 'summary' => 'Starts a Spark Job.', 'path' => '/api/v1/workspaces/{workspaceId}/jobRuns', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '215792', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ @@ -9636,314 +8150,242 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.'."\n", + 'description' => 'The request body of the Spark job.', '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', - ], + 'releaseVersion' => ['description' => 'The version of the Spark engine.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-3.3.1'], + 'jobId' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'jr-12345'], + 'name' => ['description' => 'The job name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark_job_name'], + 'resourceQueueId' => ['description' => 'The resource queue on which the Spark job runs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'dev_queue'], + 'codeType' => ['description' => 'The job type. Valid values:'."\n" + ."\n" + .'- SQL'."\n" + ."\n" + .'- JAR'."\n" + ."\n" + .'- PYTHON', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'SQL'], + 'executionTimeoutSeconds' => ['description' => 'The timeout period for the job.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], 'configurationOverrides' => [ - 'description' => 'The advanced configurations of Spark.'."\n", + 'description' => 'The advanced Spark configurations.', 'type' => 'object', 'properties' => [ 'configurations' => [ - 'description' => 'The SparkConf objects.'."\n", + 'description' => 'The list of Spark configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The SparkConf object.'."\n", + 'description' => 'A Spark configuration object.', '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', - ], + 'configFileName' => ['description' => 'The configuration file to which the Spark configuration belongs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark-defaults.conf'], + 'configItemKey' => ['description' => 'The key of the Spark configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark.app.name'], + 'configItemValue' => ['description' => 'The value of the Spark configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test_app'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'tags' => [ - 'description' => 'The tags of the job.'."\n", + 'description' => 'The list of job tags.', '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', + 'items' => ['description' => 'A tag object.', 'required' => false, '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], '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', + 'title' => '', + 'example' => '', ], + 'clientToken' => ['description' => 'The idempotence token.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '8e6aae2810c8f67229ca70bb31cd****'], + 'jobDriver' => ['description' => 'The information about the Spark driver.', 'required' => false, '$ref' => '#/components/schemas/JobDriver', 'title' => '', 'example' => ''], + 'displayReleaseVersion' => ['description' => 'The version that is displayed in the console.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-3.3.1'."\n"], + 'fusion' => ['description' => 'Specifies whether to enable the Fusion engine for acceleration.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-123213123131', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-d2d82aa09155****'], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned.', '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****', - ], + 'jobRunId' => ['description' => 'The job run ID.', 'type' => 'string', 'title' => '', 'example' => 'jr-f09a8fda2396****'], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], + 'example' => '', ], ], ], - '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartJobRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobRunId\\": \\"jr-f09a8fda2396****\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'StartKyuubiService' => [ + 'summary' => 'Starts the Kyuubi Gateway.', + 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/start', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], + ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '工作空间id。', - 'description' => '工作空间id。', - 'type' => 'string', - 'required' => true, - 'example' => 'w-d2d82aa09151****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The workspace ID.', 'title' => '', 'example' => 'w-cea2c314a****'], ], [ - 'name' => 'runId', + 'name' => 'kyuubiServiceId', 'in' => 'path', - 'allowEmptyValue' => false, + 'schema' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'required' => false, 'title' => '', 'example' => 'kb-415ddee******f1d1eac0388b86'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '任务实例ID。', - 'description' => '任务实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'jr-93d98d2f7061****', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => ['type' => 'any', 'description' => 'The returned data.', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'description' => 'The response struct.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartKyuubiService', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'StartLivyCompute' => [ + 'summary' => 'Starts a Livy gateway.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy gateway.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'lc-i8xogcdfa4fk3yn1'], + ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回数据', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Response schema', '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****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. For details about the error, see the message parameter.', 'type' => 'string', 'title' => '', 'example' => '1000000'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], ], + 'example' => '', ], ], ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartLivyCompute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', ], 'StartProcessInstance' => [ - 'summary' => 'Manually runs a workflow.', 'path' => '/dolphinscheduler/projects/{bizId}/executors/start-process-instance', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9956,893 +8398,1193 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192046', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceT8XN05', - ], + 'abilityTreeNodes' => ['FEATUREemapreduceT8XN05'], ], 'parameters' => [ [ 'name' => 'productNamespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SS', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SS'], ], [ 'name' => 'bizId', 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-d8********', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-d8********'], ], [ 'name' => 'processDefinitionCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12***********', - ], + 'schema' => ['description' => 'The workflow definition ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '12***********'], ], [ 'name' => 'versionNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The version number of the workflow definition.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', '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', - ], + 'schema' => ['description' => 'Specifies whether the workflow runs in a production environment.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], ], [ 'name' => 'runtimeQueue', 'in' => 'query', - 'schema' => [ - 'description' => 'The queue on which the workflow runs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'root_queue', - ], + 'schema' => ['description' => 'The runtime queue.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'root_queue'], ], [ 'name' => 'versionHashCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The hash code of the version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dh*********', - ], + 'schema' => ['description' => 'The hash code of the version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'dh*********'], ], [ 'name' => 'regionId', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'interval', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'action', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'comments', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'email', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The return code from the backend.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1400009'], + 'msg' => ['description' => 'The detailed description of the return code.', 'type' => 'string', 'title' => '', 'example' => 'No permission for resource action'], + 'data' => ['description' => 'The returned data.', 'type' => 'any', 'title' => '', 'example' => 'null'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'failed' => ['description' => 'Indicates whether the manual workflow run failed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartProcessInstance', + 'summary' => 'Starts a workflow manually.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartProcessInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], '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', - ], + 'StartRayCluster' => [ + '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', - 'abilityTreeCode' => '191361', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'title' => '', 'required' => false], + ], + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => ['description' => 'The Ray cluster ID.', 'type' => 'string', 'example' => 'ray-uiulagow9xljimm0', 'title' => '', 'required' => false], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => 'The token used to ensure idempotence.', 'type' => 'string', 'example' => 'c533e141-bf99-4236-8b6b-30e133db113c', 'title' => '', 'required' => false], + ], + 'title' => '', + 'description' => 'The request struct.', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8CE06D75-E6A2-505D-9B4B-31DEE3D98A04', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartRayCluster', + 'summary' => 'Starts a Ray cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8CE06D75-E6A2-505D-9B4B-31DEE3D98A04\\"\\n}","type":"json"}]', + ], + 'StartSessionCluster' => [ + 'summary' => 'Starts a session cluster.', + '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' => 'productNamespace', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SS', + 'description' => 'The request struct.', + 'type' => 'object', + 'properties' => [ + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'root_queue'], + 'sessionClusterId' => ['description' => 'The session cluster ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'sc-xxxxxxxxxxx'], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'bizId', + 'name' => 'workspaceId', 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-d8********'."\n", + 'title' => '', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'sessionClusterId' => ['title' => 'Workspace Id。', 'description' => 'The session cluster ID.', 'type' => 'string', 'example' => 'w-******'], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + ], + 'example' => '', ], ], + ], + 'title' => 'StartSessionCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartSessionCluster'], + ], + ], + 'ramActions' => [ [ - 'name' => 'name', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusterId\\": \\"w-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'StopCacheCluster' => [ + 'path' => '/api/v1/cache/{cacheClusterId}/stop', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'cacheClusterId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Cache cluster.', 'type' => 'string', 'required' => false, 'example' => 'spc-xxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'regionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ods_batch_workflow'."\n", + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop a cache cluster', + 'summary' => 'Stops a CacheCluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'StopKyuubiService' => [ + 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}/stop', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'code', + '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' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], + ], + [ + 'name' => 'kyuubiServiceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'required' => false, 'title' => '', 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12************', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n"], + 'data' => ['type' => 'any', 'description' => 'The returned data.', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'description' => 'The response struct.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopKyuubiService', + 'summary' => 'Stops a Kyuubi Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'StopLivyCompute' => [ + 'summary' => 'Stops a Livy Gateway.', + 'path' => '/api/interactive/v1/workspace/{workspaceBizId}/livycompute/{livyComputeId}/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'description', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '222278', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + ], + 'parameters' => [ + [ + 'name' => 'workspaceBizId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'w-8adde60aa809701f'], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'lc-6mkvn01zrg8rqhhv'], + ], + [ + 'name' => 'regionId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ods batch workflow', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '484D9DDA-300D-525E-AF7A-0CCCA5C64A7A'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request is successful. Other values indicate that the request failed. For more information about an error, see the message parameter.', 'type' => 'string', 'title' => '', 'example' => '1000000'], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'ok'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"484D9DDA-300D-525E-AF7A-0CCCA5C64A7A\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + 'title' => 'StopLivyCompute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StopLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'StopRayCluster' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}/stop', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'timeout', - 'in' => 'query', + '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' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'title' => '', 'required' => false], + ], + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => ['description' => 'The Ray cluster ID.', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91', 'title' => '', 'required' => false], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The default timeout period of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The ID of the Ray cluster instance.', 'type' => 'string', 'example' => 'ray-k7nm8ahl5te4tg91-ey7blpbg', 'title' => '', 'required' => false], + ], + 'title' => '', + 'description' => 'The request struct.', 'required' => false, - 'example' => '300', + 'example' => '', ], ], - [ - 'name' => 'taskDefinitionJson', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ '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, + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', 'title' => ''], ], - 'required' => true, + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopRayCluster', + 'summary' => 'Stops a Ray cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\"\\n}","type":"json"}]', + ], + 'StopSessionCluster' => [ + 'summary' => 'Stops a session.', + 'path' => '/api/v1/workspaces/{workspaceId}/sessionClusters/action/stopSessionCluster', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'taskRelationJson', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, '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, + 'description' => 'The request struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'queueName' => ['description' => 'The queue name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root_queue', 'title' => ''], + 'sessionClusterId' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sc-xxxxxxxxxxxx', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'executionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PARALLEL', - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], ], [ - 'name' => 'alertEmailAddress', + 'name' => 'regionId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The email address to receive alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'foo_bar@spark.alert.invalid.com', + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'sessionClusterId' => ['title' => 'Workspace Id。', 'description' => 'The session ID.', 'type' => 'string', 'example' => 'w-******'], + 'requestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sessionClusterId\\": \\"w-******\\",\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + 'title' => 'StopSessionCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StopSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SubmitRayJob' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/rayJob', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'schedule', - 'in' => 'query', + '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' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'required' => false], + ], + [ + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The scheduling settings.'."\n", + 'title' => '', + 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'startTime' => [ - 'description' => 'The start time of the scheduling.'."\n", - 'type' => 'string', + 'entrypoint' => ['title' => '', 'description' => 'The startup command.', 'type' => 'string', 'example' => 'python -c "print(\'hello ray job\')"', 'required' => false], + 'name' => ['title' => '', 'description' => 'The job name.', 'type' => 'string', 'example' => 'my-job', 'required' => false], + 'displayReleaseVersion' => ['title' => '', 'description' => 'The Ray DPI engine version number.', 'type' => 'string', 'example' => 'err-1.2.0 (Ray 2.55.1, Python 3.12)', 'required' => false], + 'tags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key.', 'type' => 'string', 'required' => false, 'example' => 'jobname', 'title' => ''], + 'value' => ['description' => 'The value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '2024-12-23 16:13:27'."\n", - ], - 'endTime' => [ - 'description' => 'The end time of the scheduling.'."\n", - 'type' => 'string', + 'example' => '', + ], + 'networkServiceName' => ['title' => '', 'description' => 'The network connectivity name.', 'type' => 'string', 'example' => 'vpc', 'required' => false], + 'runtimeEnvJson' => ['title' => '', 'description' => 'The Ray runtime environment JSON string.', 'type' => 'string', 'example' => '{"pip":["requests==2.26.0","pendulum==2.1.2"],"env_vars":{"KEY":"VALUE"}}', 'required' => false], + 'workingDir' => ['title' => '', 'description' => 'The URL of the job code working directory.', 'type' => 'string', 'example' => 'oss://mybucket/rayjob.zip', 'required' => false], + 'metadataJson' => ['title' => '', 'description' => 'The job metadata JSON string.', 'type' => 'string', 'example' => '{"resourceName": "test"}', 'required' => false], + 'submissionMode' => ['title' => '', 'description' => 'The job submission mode.', 'type' => 'string', 'example' => 'HTTPMode', 'required' => false], + 'entrypointNumCpus' => ['title' => '', 'description' => 'The number of CPUs requested by the entrypoint task.', 'type' => 'string', 'example' => '1', 'required' => false], + 'entrypointNumGpus' => ['title' => '', 'description' => 'The number of GPUs requested by the entrypoint task.', 'type' => 'string', 'example' => '0', 'required' => false], + 'entrypointMemory' => ['title' => '', 'description' => 'The memory size requested by the entrypoint task.', 'type' => 'string', 'example' => '4Gi', 'required' => false], + 'entrypointResources' => ['title' => '', 'description' => 'The custom resource request JSON string for the entrypoint task.', 'type' => 'string', 'example' => '{"fpu": 1}', 'required' => false], + 'shutdownAfterJobFinishes' => ['title' => '', 'description' => 'Specifies whether to automatically destroy the temporary cluster after the job is completed. Default value: true.', 'type' => 'boolean', 'example' => 'true', 'required' => false], + 'ttlSecondsAfterFinished' => ['title' => '', 'description' => 'The number of seconds to wait before destroying the cluster. This parameter takes effect only when shutdownAfterJobFinishes is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'required' => false], + 'activeDeadlineSeconds' => ['title' => '', 'description' => 'The timeout period of the job, which includes the cluster creation time and job runtime. The job is canceled if this period is exceeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'required' => false], + 'volumeIds' => [ + 'title' => '', + 'description' => 'The list of mount volume IDs.', + 'type' => 'array', + 'items' => ['description' => 'The managed file ID.', 'type' => 'string', 'example' => 'vol-12345678', 'required' => false, 'title' => ''], 'required' => false, - 'example' => '2025-12-23 16:13:27'."\n", + 'example' => '', ], - 'crontab' => [ - 'description' => 'The CRON expression that is used for scheduling.'."\n", - 'type' => 'string', + 'headSpec' => [ + 'title' => '', + 'description' => 'The Ray cluster head node parameters.', + 'type' => 'object', + 'properties' => [ + 'queueName' => ['title' => '', 'description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'required' => false], + 'cpu' => ['title' => '', 'description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'required' => false], + 'memory' => ['title' => '', 'description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'required' => false], + 'enableAutoScaling' => ['title' => '', 'description' => 'Specifies whether to enable automatic worker scaling.', 'type' => 'boolean', 'example' => 'true', 'required' => false], + 'idleTimeoutSeconds' => ['title' => '', 'description' => 'The worker idle timeout period after automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'required' => false], + 'gpuSpec' => ['title' => '', 'description' => 'The GPU instance type.', 'type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'required' => false], + ], 'required' => false, - 'example' => ' '."\n" - .'0 0 0 * * ?'."\n", + 'example' => '', ], - 'timezoneId' => [ - 'description' => 'The ID of the time zone.'."\n", - 'type' => 'string', + 'workerSpec' => [ + 'title' => '', + 'description' => 'The Ray cluster worker node parameters.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The worker node struct.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['title' => '', 'description' => 'The worker group name.', 'type' => 'string', 'example' => 'WorkerGroup1', 'required' => false], + 'workerType' => [ + 'title' => '', + 'description' => 'The worker type.', + 'type' => 'string', + 'example' => 'CPU', + 'enum' => ['CPU'], + 'required' => false, + ], + 'replica' => ['title' => '', 'description' => 'The number of workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'required' => false], + 'queueName' => ['title' => '', 'description' => 'The queue name.', 'type' => 'string', 'example' => 'root_queue', 'required' => false], + 'cpu' => ['title' => '', 'description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '4', 'required' => false], + 'memory' => ['title' => '', 'description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '16Gi', 'required' => false], + 'minReplica' => ['title' => '', 'description' => 'The minimum number of workers after automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'maxReplica' => ['title' => '', 'description' => 'The maximum number of workers after automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], + 'gpuSpec' => ['title' => '', 'description' => 'The GPU instance type.', 'type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => 'Asia/Shanghai'."\n", + 'example' => '', ], + 'extraParam' => ['title' => '', 'description' => 'The extra parameter JSON string.', 'type' => 'string', 'example' => '{"userDefinedFiles": "oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json", "userRequirementsFile": "oss://mybucket/requirements.txt"}', 'required' => false], ], 'required' => false, + 'example' => '', ], ], - [ - 'name' => 'retryTimes', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944'], + 'submissionId' => ['title' => '', 'description' => 'Ray Job ID。', 'type' => 'string', 'example' => 'rj-k7nm8ahl5te4tg91'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Submit a ray job', + 'summary' => 'Submits a Ray job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\",\\n \\"submissionId\\": \\"rj-k7nm8ahl5te4tg91\\"\\n}","type":"json"}]', + ], + 'TerminateSqlStatement' => [ + 'summary' => 'Terminates an SQL query task.', + 'path' => '/api/interactive/v1/workspace/{workspaceId}/statement/{statementId}/terminate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'taskParallelism', - 'in' => 'query', - 'schema' => [ - 'description' => 'The node parallelism.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '224753', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], + ], + 'parameters' => [ [ - 'name' => 'tags', + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****', 'title' => ''], + ], + [ + 'name' => 'statementId', + 'in' => 'path', + 'schema' => ['description' => 'The interactive query ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'st-abcadfadf12****', 'title' => ''], + ], + [ + 'name' => 'regionId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => ' '."\n" - .'“{\\"tagkey\\":\\"tagvalue\\"}”'."\n", - 'description' => 'The tag. The value is a JSON string.'."\n", + 'properties' => [ + 'requestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], - [ - 'name' => 'resourceQueue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource queue.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'root_queue', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + 'title' => 'TerminateSqlStatement', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:TerminateSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateKyuubiService' => [ + 'path' => '/api/v1/kyuubi/{workspaceId}/{kyuubiServiceId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'releaseState', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ONLINE', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], + ], + 'parameters' => [ [ - 'name' => 'runAs', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '113***************'."\n", - ], + 'name' => 'workspaceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => 'The workspace ID.', 'required' => false, 'title' => '', 'example' => 'w-d2d82aa09155****'], ], [ - 'name' => 'publish', - 'in' => 'query', + 'name' => 'kyuubiServiceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => 'The Kyuubi service ID.', 'required' => false, 'title' => '', 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to publish the workflow.'."\n", - 'type' => 'boolean', + 'type' => 'object', + 'properties' => [ + 'kyuubiConfigs' => ['type' => 'string', 'description' => 'The Kyuubi service configuration.', 'required' => false, 'title' => '', 'example' => '[]'], + 'sparkConfigs' => ['type' => 'string', 'description' => 'The Spark configuration.', 'required' => false, 'title' => '', 'example' => '[]'], + 'name' => ['type' => 'string', 'description' => 'The name.', 'required' => false, 'title' => '', 'example' => 'dev_serverless_spark'."\n"], + 'queue' => ['type' => 'string', 'description' => 'The queue in which the Kyuubi service runs.', 'required' => false, 'title' => '', 'example' => 'dev_queue'], + 'releaseVersion' => ['type' => 'string', 'description' => 'The version of the Spark engine.', 'required' => false, 'title' => '', 'example' => 'esr-4.6.0 (Spark 3.5.2, Scala 2.12)'], + 'computeInstance' => ['type' => 'string', 'description' => 'The specifications of the Kyuubi service.', 'required' => false, 'title' => '', 'example' => '2c8g'], + 'publicEndpointEnabled' => ['type' => 'boolean', 'default' => 'false', 'description' => 'Specifies whether to enable public network access.', 'required' => false, 'title' => '', 'example' => 'true'], + 'replica' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of replicas for high availability (HA).', 'required' => false, 'title' => '', 'example' => '0'], + 'kyuubiReleaseVersion' => ['type' => 'string', 'description' => 'The Kyuubi service engine version.', 'required' => false, 'title' => '', 'example' => '1.9.2-0.0.2'], + 'restart' => ['type' => 'boolean', 'description' => 'Specifies whether to restart the service.', 'required' => false, 'title' => '', 'example' => 'false'], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'regionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => ['type' => 'any', 'description' => 'The returned data.', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'description' => 'The response struct.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateKyuubiService', + 'summary' => 'Updates a Kyuubi Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'UpdateKyuubiToken' => [ + 'path' => '/api/v1/workspaces/{workspaceId}/kyuubiService/{kyuubiServiceId}/token/{tokenId}', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'globalParams', - 'in' => 'query', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-d2d82aa09155****'."\n", 'title' => ''], + ], + [ + 'name' => 'kyuubiServiceId', + 'in' => 'path', + 'schema' => ['description' => 'The Kyuubi service ID.', 'type' => 'string', 'required' => false, 'example' => 'kb-c7141f10c3f549fc9f8b8ae562b8****'."\n", 'title' => ''], + ], + [ + 'name' => 'tokenId', + 'in' => 'path', + 'schema' => ['description' => 'The token ID.', 'type' => 'string', 'required' => false, 'example' => 'tk-zpi0*****hdv4y'."\n", 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', '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, + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The token name.', 'type' => 'string', 'required' => false, 'example' => 'dev_serverless_spark'."\n", 'title' => ''], + 'token' => ['description' => 'The token. It must be 32 characters long and contain only lowercase letters and digits.', 'type' => 'string', 'required' => false, 'example' => 'rjy7ejhej9gkzjjuun49jnx2xk8if2cu', 'title' => ''], + 'autoExpireConfiguration' => [ + 'description' => 'The auto-expiration settings.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether to enable automatic expiration for the token.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'expireDays' => ['description' => 'The expiration period, in days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'memberArns' => [ + 'description' => 'The ARNs of authorized users.', + 'type' => 'array', + 'items' => ['description' => 'The ARN of an authorized user.', 'type' => 'string', 'required' => false, 'example' => 'acs:emr::w-d2d82aa09155****:member/195****7311', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'sparkRole' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'."\n"], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateKyuubiToken', + 'summary' => 'Updates a Kyuubi Gateway authentication token.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\\\n\\"\\n}","type":"json"}]', + ], + 'UpdateLivyCompute' => [ + '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' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-8adde60aa809701f', 'title' => ''], + ], + [ + 'name' => 'livyComputeId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Livy Gateway.', 'type' => 'string', 'required' => false, 'example' => 'lc-i8xogcdfa4fk3yn1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'livyVersion' => [ + 'description' => 'The Livy version.', + 'enumValueTitles' => ['0.8.0' => '0.8.0'], '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', + 'enum' => ['0.8.0'], + 'required' => false, + 'example' => '0.8.0', + 'title' => '', ], - 'msg' => [ - 'description' => 'The description of the returned code.'."\n", + 'releaseVersion' => ['description' => 'The version number of the Spark engine. This parameter is deprecated. Use displayReleaseVersion instead.', 'type' => 'string', 'required' => false, 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12, Java Runtime)'."\n", 'title' => ''], + 'queueName' => ['description' => 'The queue name.', 'type' => 'string', 'required' => false, 'example' => 'root_queue', 'title' => ''], + 'cpuLimit' => [ + 'description' => 'The number of vCPUs for the Livy server.'."\n" + ."\n" + .'- 1'."\n" + ."\n" + .'- 2'."\n" + ."\n" + .'- 4', + 'enumValueTitles' => [1 => '1', '2', 4 => '4'], 'type' => 'string', - 'example' => 'No permission for resource action', + 'required' => false, + 'example' => '1', + 'title' => '', ], - 'success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", + 'memoryLimit' => [ + 'description' => 'The memory size of the Livy server.', + 'enumValueTitles' => ['16Gi' => '16 Gi', '4Gi' => '4 Gi', '8Gi' => '8 Gi'], 'type' => 'string', - 'example' => 'true', + 'required' => false, + 'example' => '4Gi', + 'title' => '', ], - 'failed' => [ - 'description' => 'Indicates whether the request failed.'."\n", - 'type' => 'string', - 'example' => 'false', + 'autoStartConfiguration' => [ + 'description' => 'The auto-start configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'Specifies whether to automatically start the Livy Gateway after it is created.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'data' => [ - 'description' => 'The data returned.'."\n", + 'autoStopConfiguration' => [ + 'description' => 'The auto-stop configuration.', '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*********', - ], + 'enable' => ['description' => 'Specifies whether to enable auto-stop for the Livy Gateway.'."\n" + ."\n" + .'- true: Yes.'."\n" + ."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'idleTimeoutMinutes' => ['description' => 'The number of minutes after which the Livy Gateway is automatically stopped if it is idle.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'authType' => [ + 'description' => 'The authentication method.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Token'], + 'required' => false, + 'example' => 'Token', + 'title' => '', ], + 'displayReleaseVersion' => ['description' => 'The version number of the Spark engine.', 'type' => 'string', 'required' => false, 'example' => 'esr-4.3.0 (Spark 3.5.2, Scala 2.12)'."\n", 'title' => ''], + 'fusion' => ['description' => 'Specifies whether to enable the Fusion engine for acceleration.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'environmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => false, 'example' => 'ev-cq146allhtgkulp5smk0', 'title' => ''], + 'networkName' => ['description' => 'The name of the network connection.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'livyServerConf' => ['description' => 'The configurations of the Livy Gateway. This parameter is in JSON format and supports the following files:'."\n" + ."\n" + .'- sparkDefaultsConf'."\n" + ."\n" + .'- sparkBlackListConf'."\n" + ."\n" + .'- livyConf'."\n" + ."\n" + .'- livyClientConf', '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" + .'}', 'title' => ''], + 'enablePublic' => ['description' => 'The status of the switch for the Internet endpoint.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The response code. A value of 1000000 indicates that the request was successful. Other values indicate that the request failed. For more information about the cause of the error, see the message parameter.', 'type' => 'string', 'example' => '1000000', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + ], + 'example' => '', + ], + ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateLivyCompute', + 'summary' => 'Updates a Livy Gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"code\\": \\"1000000\\",\\n \\"message\\": \\"ok\\"\\n}","type":"json"}]', + ], + 'UpdateProcessDefinitionWithSchedule' => [ + 'summary' => 'Updates a workflow definition and its timed scheduling.', + 'path' => '/dolphinscheduler/projects/{bizId}/process-definition/{code}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10854,477 +9596,244 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '191322', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceTW58EL', - ], + 'abilityTreeCode' => '191361', + 'abilityTreeNodes' => ['FEATUREemapreduceTW58EL'], ], 'parameters' => [ [ 'name' => 'productNamespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SS', - ], + 'schema' => ['description' => 'The product code.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'SS'], ], [ 'name' => 'bizId', 'in' => 'path', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'w-d8********', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-d8********'."\n"], ], [ 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ods_batch_workflow', - ], + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ods_batch_workflow'."\n"], + ], + [ + 'name' => 'code', + 'in' => 'path', + 'schema' => ['description' => 'The workflow definition ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '12************'], ], [ 'name' => 'description', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ods batch workflow', - ], + 'schema' => ['description' => 'The workflow description.', 'type' => 'string', 'required' => false, 'title' => '', '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, - ], + 'schema' => ['description' => 'The default timeout period for the workflow execution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '300'], ], [ 'name' => 'taskDefinitionJson', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The descriptions of all nodes in the workflow.'."\n", + 'description' => 'A JSON array of task definitions. This array contains the descriptive information for all tasks in the workflow.', 'type' => 'array', 'items' => [ - 'description' => 'The description of the node in the workflow.'."\n", + 'description' => 'A JSON object for a task definition. This object contains the descriptive information for a task in the workflow.', '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', - ], + 'code' => ['description' => 'The task definition ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '23************'], + 'description' => ['description' => 'The description of the task definition.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ods transform task'."\n"], + 'alertEmailAddress' => ['description' => 'The email address for alerts.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'foo_bar@spark.alert.invalid.com'."\n"], + 'startAlertEnable' => ['description' => 'Specifies whether to enable alerts when the task starts.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + 'failAlertEnable' => ['description' => 'Specifies whether to enable alerts when the task fails.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + 'failRetryTimes' => ['description' => 'The number of times to retry the task if it fails.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'name' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ods_transform_task'."\n"], 'taskParams' => [ - 'description' => 'The job parameters.'."\n", + 'description' => 'The parameters for the task definition.', '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', - ], + 'workspaceBizId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'w-d8********'."\n"], + 'taskBizId' => ['description' => 'The ID of the Data Development task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'TSK-d87******************'."\n"], + 'resourceQueueId' => ['description' => 'The name of the queue on which the task runs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'root_queue'], + 'sparkDriverCores' => ['description' => 'The number of cores for the Spark driver.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'sparkExecutorCores' => ['description' => 'The number of cores for each Spark executor.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], + 'sparkDriverMemory' => ['description' => 'The memory size of the Spark driver.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '4g'], + 'sparkExecutorMemory' => ['description' => 'The memory size of each Spark executor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '4g'], 'sparkConf' => [ - 'description' => 'The configurations of the Spark job.'."\n", + 'description' => 'The Spark task configurations.', 'type' => 'array', 'items' => [ + 'description' => 'A Spark task configuration.', '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', - ], + 'key' => ['description' => 'The key of the Spark configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'spark.dynamicAllocation.enabled'."\n"], + 'value' => ['description' => 'The value of the Spark configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'true'], ], 'required' => false, - 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - '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', - ], + 'sparkVersion' => ['description' => 'The Spark engine version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)'."\n"], + 'sparkLogLevel' => ['description' => 'The Spark log level.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'INFO'], + 'sparkLogPath' => ['description' => 'The path to store Spark task logs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ' '."\n" + .'oss://data***/spark/logs'."\n"], + 'displaySparkVersion' => ['description' => 'The display version of the Spark engine.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'esr-4.0.0 (Spark 3.5.2, Scala 2.12)'], + 'fusion' => ['description' => 'Specifies whether to enable the Fusion engine for acceleration.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'false'], + 'environmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ev-h*************'], + 'type' => ['description' => 'The Spark job type.', 'type' => 'string', 'required' => false, 'title' => '', '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, - ], + 'prop' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'direct' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'type' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], - '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', - ], + 'taskType' => ['description' => 'The type of the workflow node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'EMR-SERVERLESS-SPARK'], + 'timeout' => ['description' => 'The default timeout period for the task execution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '30'], 'tags' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The tags.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '“{\\"tagkey\\":\\"tagvalue\\"}”', - 'description' => 'The tag. The value is a JSON string.'."\n", - ], + 'additionalProperties' => ['type' => 'string', 'description' => 'A JSON string of tag key-value pairs.', 'title' => '', 'example' => ' '."\n" + .'“{\\"tagkey\\":\\"tagvalue\\"}”'."\n"], + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'executionType', + 'name' => 'taskRelationJson', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The execution policy'."\n", - 'type' => 'string', + 'description' => 'A JSON array that defines the dependencies between tasks in the workflow. \\`preTaskCode\\` specifies the upstream task ID, and \\`postTaskCode\\` specifies the downstream task ID. Each task must have a unique ID. For a task node without an upstream task, add a dependency and set \\`preTaskCode\\` to 0.', + 'type' => 'array', + 'items' => [ + 'description' => 'A JSON object that defines a task dependency. \\`preTaskCode\\` specifies the upstream task ID, and \\`postTaskCode\\` specifies the downstream task ID. Each task must have a unique ID. For a task node without an upstream task, add a dependency and set \\`preTaskCode\\` to 0.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the task topology. You can use the workflow name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ods batch workflow'."\n"], + 'preTaskCode' => ['description' => 'The upstream task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '16************'."\n"], + 'preTaskVersion' => ['description' => 'The upstream task version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], + 'postTaskCode' => ['description' => 'The downstream task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '19************'."\n"], + 'postTaskVersion' => ['description' => 'The downstream task version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'PARALLEL', + 'title' => '', + 'example' => '', ], ], [ + 'name' => 'executionType', + 'in' => 'query', + 'schema' => ['description' => 'The execution policy.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'schema' => ['description' => 'The email address for alerts.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'foo_bar@spark.alert.invalid.com'], ], [ 'name' => 'schedule', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The scheduling settings.'."\n", + 'description' => 'The scheduling configuration.', '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', - ], + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2024-12-23 16:13:27'."\n"], + 'endTime' => ['description' => 'The end time of the schedule.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-12-23 16:13:27'."\n"], + 'crontab' => ['description' => 'The cron expression for scheduling.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ' '."\n" + .'0 0 0 * * ?'."\n"], + 'timezoneId' => ['description' => 'The time zone ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Asia/Shanghai'."\n"], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'retryTimes', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of retries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', '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', - ], + 'schema' => ['description' => 'The degree of concurrent execution for workflow nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The tags.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '“{\\"tagkey\\":\\"tagvalue\\"}”', - 'description' => 'The tag. The value is a JSON string.'."\n", - ], + 'additionalProperties' => ['type' => 'string', 'description' => 'A JSON string of tag key-value pairs.', 'title' => '', 'example' => ' '."\n" + .'“{\\"tagkey\\":\\"tagvalue\\"}”'."\n"], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'publish', + 'name' => 'resourceQueue', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to publish the workflow.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The resource queue.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'root_queue'], ], [ - 'name' => 'regionId', + 'name' => 'releaseState', 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The release state of the workflow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ONLINE'], ], [ '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***************', - ], + 'schema' => ['description' => 'The user to run the workflow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '113***************'."\n"], + ], + [ + 'name' => 'publish', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to publish the workflow.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], + ], + [ + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'globalParams', @@ -11335,26 +9844,20 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'prop' => [ - 'type' => 'string', - 'required' => false, - ], - 'value' => [ - 'type' => 'string', - 'required' => false, - ], - 'direct' => [ - 'type' => 'string', - 'required' => false, - ], - 'type' => [ - 'type' => 'string', - 'required' => false, - ], + 'prop' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'value' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'direct' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'type' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -11362,2054 +9865,1353 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'code' => ['description' => 'The return code from the backend API.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1400009'], + 'msg' => ['description' => 'The detailed description that corresponds to the return code.', 'type' => 'string', 'title' => '', 'example' => 'No permission for resource action'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'title' => '', 'example' => 'true'], + 'failed' => ['description' => 'The number of failed operations.', 'type' => 'string', 'title' => '', 'example' => 'false'], 'data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The returned data.', '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************', - ], + 'id' => ['description' => 'The workflow definition number.', 'type' => 'string', 'title' => '', 'example' => '123223'], + 'code' => ['description' => 'The workflow definition ID.', 'type' => 'string', 'title' => '', 'example' => '12***********'], + 'name' => ['description' => 'The name of the workflow definition.', 'type' => 'string', 'title' => '', 'example' => 'ods_batch_workflow'], + 'version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'releaseState' => ['description' => 'The release state of the workflow.', 'type' => 'string', 'title' => '', 'example' => 'ONLINE'], + 'bizId' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => 'alicloud_ack_one_cluster'], + 'description' => ['description' => 'The description of the workflow definition.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'createTime' => ['description' => 'The time when the workflow definition was created.', 'type' => 'string', 'title' => '', 'example' => '2024-09-05T02:03:19Z'], + 'updateTime' => ['description' => 'The time when the workflow definition was updated.', 'type' => 'string', 'title' => '', 'example' => '2024-03-05T06:24:27Z'], + 'userId' => ['description' => 'The ID of the user who scheduled the workflow.', 'type' => 'string', 'title' => '', 'example' => '113*********'], + 'userName' => ['description' => 'The name of the user who scheduled the workflow.', 'type' => 'string', 'title' => '', 'example' => 'w-********'], + 'projectName' => ['description' => 'The name of the project to which the workflow belongs.', 'type' => 'string', 'title' => '', 'example' => 'w-********'], + 'executionType' => ['description' => 'The execution policy.', 'type' => 'string', 'title' => '', 'example' => 'SERIAL'], + 'alertEmailAddress' => ['description' => 'The email address for alerts.', 'type' => 'string', 'title' => '', 'example' => 'foo_bar@spark.alert.invalid.com'."\n"], + 'startTime' => ['description' => 'The start time of the schedule.', 'type' => 'string', 'title' => '', 'example' => '0'], + 'endTime' => ['description' => 'The end time of the schedule.', 'type' => 'string', 'title' => '', 'example' => '1710432000000'], + 'timezoneId' => ['description' => 'The time zone ID.', 'type' => 'string', 'title' => '', 'example' => 'Asia/Shanghai'."\n"], + 'crontab' => ['description' => 'The cron expression for scheduling.', 'type' => 'string', 'title' => '', 'example' => '0 0 0 * * ?'."\n"], + 'versionHashCode' => ['description' => 'The hash code of the version.', 'type' => 'string', 'title' => '', 'example' => 'dwerf*********'], ], + 'title' => '', + 'example' => '', ], - 'httpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], ], + 'example' => '', ], ], ], - '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'], + 'title' => 'UpdateProcessDefinitionWithSchedule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateProcessDefinitionWithSchedule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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"}]', + '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"}]', ], 'UpdateRayCluster' => [ - 'summary' => '更新Ray集群', 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster/{clusterId}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce8QU4HW'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-d2d82aa09155', 'title' => '', 'required' => false], ], [ 'name' => 'clusterId', 'in' => 'path', - 'schema' => [ - 'title' => '集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ray-uiulpgow9xljimm1', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'ray-uiulpgow9xljimm1', 'title' => '', 'required' => false], ], [ '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', - ], + 'name' => ['description' => 'The name of the Ray cluster. The name must be 1 to 64 characters in length.', 'type' => 'string', 'example' => 'myRayCluster', 'title' => '', 'required' => false], + 'displayReleaseVersion' => ['description' => 'Ray engine version.', 'type' => 'string', 'example' => 'ray-1.0.0 (Ray 2.47.1, Python 3.12)', 'title' => '', 'required' => false], + 'description' => ['description' => 'Description of the cluster.', 'type' => 'string', 'example' => 'Ray Cluster for dev.', 'title' => '', 'required' => false], + 'networkServiceName' => ['description' => 'The name of the network service.', 'type' => 'string', 'example' => 'vpc', 'title' => '', 'required' => false], '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', - ], + 'queueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'root_queue', 'title' => '', 'required' => false], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => '', 'required' => false], + 'memory' => ['description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'title' => '', 'required' => false], + 'enableAutoScaling' => ['description' => 'Specifies whether to enable automatic scaling.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], + 'idleTimeoutSeconds' => ['description' => 'The idle timeout in seconds for workers. This parameter is effective only when automatic scaling is enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => '', 'required' => false], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], ], + 'title' => '', + 'description' => 'The information about the head node of the Ray cluster.', 'required' => false, + 'example' => '', ], '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', - ], + 'groupName' => ['description' => 'The name of the worker group.', 'type' => 'string', 'example' => 'WorkerGroup1', 'title' => '', 'required' => false], 'workerType' => [ - 'title' => 'Worker类型。', - 'description' => '', + 'description' => 'The type of worker.', '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', + 'enum' => ['CPU'], + 'title' => '', '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', ], + 'replica' => ['description' => 'The number of workers. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'required' => false], + 'queueName' => ['description' => 'The name of the queue.', 'type' => 'string', 'example' => 'root_queue', 'title' => '', 'required' => false], + 'cpu' => ['description' => 'The number of CPU cores.', 'type' => 'string', 'example' => '2', 'title' => '', 'required' => false], + 'memory' => ['description' => 'The memory size. Unit: Gi.', 'type' => 'string', 'example' => '8Gi', 'title' => '', 'required' => false], + 'minReplica' => ['description' => 'The minimum number of workers. The minimum value is 1. This value must be less than or equal to maxReplica.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + 'maxReplica' => ['description' => 'The maximum number of workers. The minimum value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], + 'gpuSpec' => ['type' => 'string', 'example' => 'ecs.gn6i-c4g1.xlarge', 'description' => '', 'title' => ''], ], + 'title' => '', + 'description' => 'The information for the worker node.', 'required' => false, + 'example' => '', ], + 'title' => '', + 'description' => 'The information about the worker nodes of the Ray cluster. You can specify up to 50 groups.', 'required' => false, + 'example' => '', ], - 'extraParam' => [ - 'title' => '额外参数，json格式。'."\n", + 'extraParam' => ['description' => 'The extra parameters. This must be in JSON format.', 'type' => 'string', 'example' => '{}', 'title' => '', 'required' => false], + 'volumeIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'vol-1234567890', 'description' => '', 'title' => ''], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The request body.', 'required' => false, + 'example' => '', ], ], ], '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944', 'title' => ''], + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'ray-xxxxxxxxxxx', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateRayCluster', + 'summary' => 'Updates a Ray cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], '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', - ], + 'UpdateWorkspace' => [ + 'summary' => 'Update workspace properties', + 'path' => '/api/v1/workspaces/update', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', - ], + 'abilityTreeCode' => '209094', + 'abilityTreeNodes' => ['FEATUREemapreduce5JTF6C'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'w-975bcfda9625****', 'title' => ''], + 'workspaceName' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + 'cu' => ['description' => 'The resource cap for the workspace.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5000', 'title' => ''], + 'subscription' => [ + 'type' => 'object', + 'properties' => [ + 'queue' => [ + 'type' => 'array', + 'items' => ['description' => 'A queue to convert to the subscription plan.', 'type' => 'string', 'required' => false, 'example' => 'dev_queue', 'title' => ''], + 'description' => 'The queues to convert to the subscription plan.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'paymentDurationUnit' => ['description' => 'The unit of the subscription period.', 'type' => 'string', 'required' => false, 'example' => 'MONTH', 'title' => ''], + 'duration' => ['description' => 'The subscription duration. This parameter is required for subscription plans.', 'type' => 'string', 'required' => false, 'example' => '1799', 'title' => ''], + 'autoRenew' => ['description' => 'Indicates whether to enable auto-renewal. Required for subscription plans.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'autoRenewPeriod' => ['description' => 'The auto-renewal duration. Required for subscription plans.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'autoRenewPeriodUnit' => ['description' => 'The unit for the auto-renewal duration. Required for subscription plans.', 'type' => 'string', 'required' => false, 'example' => 'MONTH', 'title' => ''], + 'clientToken' => ['description' => 'A unique, case-sensitive token to ensure request idempotence.', 'type' => 'string', 'required' => false, 'example' => 'my-token-asxkxxxxxxx', 'title' => ''], + ], + 'description' => 'Details for converting a pay-as-you-go workspace to a subscription plan.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmwpi66knkxny', 'title' => ''], + 'gpu' => ['description' => 'The number of GPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => '', 'required' => false], + 'gpuSpec' => [ + 'type' => 'array', + 'items' => ['description' => 'The GPU specification.', 'type' => 'string', 'required' => false, 'example' => 'ecs-gpu-8x-large', 'title' => ''], + 'description' => 'The GPU specifications.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ipWhiteList' => [ + 'type' => 'array', + 'items' => ['description' => 'An IP address to include in the IP whitelist.', 'type' => 'string', 'example' => '0.0.0.1', 'title' => ''], + 'description' => 'The IP whitelist.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', 'required' => false, - 'example' => 'w-d2d82aa09155', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'clusterId', - 'in' => 'path', - 'schema' => [ - 'title' => '集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ray-xxxxxxxxxx', - ], + 'name' => 'regionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], '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' => '', + 'requestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'data' => [ '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', - ], - ], + 'orderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '1005565802416783361', 'title' => ''], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], - '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', - ], + 'orderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '979071171373334529', 'title' => ''], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateWorkspace', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"data\\": {\\n \\"orderId\\": \\"1005565802416783361\\"\\n },\\n \\"orderId\\": \\"979071171373334529\\"\\n}","type":"json"}]', ], - 'ListRayCluster' => [ - 'summary' => '列出Ray集群', - 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster', - 'methods' => [ - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-beijing.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-beijing.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-wulanchabu.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-hangzhou.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-hangzhou.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-shanghai.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-shanghai.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-shenzhen.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-shenzhen.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-chengdu.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-chengdu.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.cn-hongkong.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.cn-hongkong.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.ap-northeast-1.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.ap-northeast-1.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.ap-southeast-1.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.ap-southeast-1.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emr-serverless-spark.ap-southeast-5.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.ap-southeast-5.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'emr-serverless-spark.na-south-1.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.na-south-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'emr-serverless-spark.eu-central-1.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.eu-central-1.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'emr-serverless-spark.us-west-1.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.us-west-1.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'emr-serverless-spark.us-east-1.aliyuncs.com', 'endpoint' => 'emr-serverless-spark.us-east-1.aliyuncs.com', 'vpc' => 'emr-serverless-spark-vpc.us-east-1.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartSessionCluster'], + ], + ], + 'ram' => [ + 'productCode' => 'EmrServerlessSpark', + 'productName' => 'E-MapReduce', + 'ramCodes' => ['emr-serverless-spark'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'UpdateWorkspace', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetRayJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetRayJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetRayCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetAICenterState', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetAICenterState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetSessionCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetSessionCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListKyuubiServices', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListKyuubiServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155', + [ + 'apiName' => 'SubmitRayJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:SubmitRayJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '返回结果的分页数。默认值：20。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'UpdateRayCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'pageNum', - 'in' => 'query', - 'schema' => [ - 'title' => '页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListLivyComputeToken', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListSessionClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListSessionClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'ListWorkspaces', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListWorkspaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateSessionCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListJobRuns', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListJobRuns', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'EditWorkspaceQueue', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:EditWorkspaceQueue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GenerateTaskCodes', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GenerateTaskCodes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListKyuubiToken', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155', + [ + 'apiName' => 'CancelKyuubiSparkApplication', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CancelKyuubiSparkApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'clusterId', - 'in' => 'path', - 'schema' => [ - 'title' => 'Ray集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ray-k7nm8ahl5te4tg91', + ], + [ + 'apiName' => 'CreateKyuubiService', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateKyuubiService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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, + ], + [ + 'apiName' => 'GrantRoleToUsers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GrantRoleToUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'GetJobRun', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetJobRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetLivyComputeToken', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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', + [ + 'apiName' => 'ListLogContents', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLogContents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'AddMembers', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:AddMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateProcessDefinitionWithSchedule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateProcessDefinitionWithSchedule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'CreateProcessDefinitionWithSchedule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateProcessDefinitionWithSchedule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'StartProcessInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartProcessInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteKyuubiToken', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteKyuubiService', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteKyuubiService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155', + [ + 'apiName' => 'GetLivyCompute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'clusterId', - 'in' => 'path', - 'schema' => [ - 'title' => 'Ray集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ray-uiulagow9xljimm0', + ], + [ + 'apiName' => 'DeleteLivyCompute', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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, + ], + [ + 'apiName' => 'GetDoctorApplication', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetDoctorApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'ListLivyComputeSessions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLivyComputeSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListJobExecutors', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListJobExecutors', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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', + [ + 'apiName' => 'ListCatalogs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListSqlStatementContents', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListSqlStatementContents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'StartLivyCompute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'CreateRayCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListRayCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', + [ + 'apiName' => 'GetCacheCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetCacheCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-26ca1703f6d11', + [ + 'apiName' => 'StartKyuubiService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartKyuubiService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'clusterId', - 'in' => 'path', - 'schema' => [ - 'title' => 'Ray集群ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ray-k7nm8ahl5te4tg91', + ], + [ + 'apiName' => 'RefreshLivyComputeToken', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:RefreshLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'GetTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateKyuubiService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateKyuubiService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944\\"\\n}","type":"json"}]', - ], - 'CreateRayCluster' => [ - 'summary' => '创建Ray集群', - 'path' => '/api/v1/workspaces/{workspaceId}/rayCluster', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteLivyComputeToken', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:DeleteLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'StartJobRun', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartJobRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'GetRunConfiguration', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetRunConfiguration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'StopKyuubiService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StopKyuubiService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateKyuubiToken', + 'description' => '', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce8QU4HW', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155', + [ + 'apiName' => 'UpdateLivyCompute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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, + ], + [ + 'apiName' => 'CancelJobRun', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CancelJobRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'StopSessionCluster', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StopSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateWorkspace', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateWorkspace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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', + [ + 'apiName' => 'ListWorkspaceQueues', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListWorkspaceQueues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetKyuubiToken', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'StartSessionCluster', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLivyCompute', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetKyuubiService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetKyuubiService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'StartRayCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StartRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListKyuubiSparkApplications', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListKyuubiSparkApplications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'ListMembers', + 'description' => '', 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '213262', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceR6MU4Y', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'path', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-d2d82aa09155****', + [ + 'apiName' => 'ListRayJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListRayJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'environment', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'dev' => 'dev', - 'production' => 'production', - ], - 'example' => 'dev', + ], + [ + 'apiName' => 'CreateNetworkService', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateNetworkService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'ListReleaseVersions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListReleaseVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'StopRayCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StopRayCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListExecutorLogs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListExecutorLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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', + [ + 'apiName' => 'CreateSqlStatement', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ActivateAICenter', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ActivateAICenter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateLivyComputeToken', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:CreateLivyComputeToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'UpdateKyuubiToken', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:UpdateKyuubiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'StopLivyCompute', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:StopLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '191100', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceUECZZL', + [ + 'apiName' => 'ListLivyCompute', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListLivyCompute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceBizId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-8adde60aa809701f', + [ + 'apiName' => 'ListNetworkServices', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:ListNetworkServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'regionId', - 'in' => 'query', - 'schema' => [ - 'title' => '区域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'TerminateSqlStatement', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:TerminateSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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", - ], - ], + [ + 'apiName' => 'GetSqlStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetCuHours', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emr-serverless-spark:GetCuHours', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrServerlessSpark', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:emr:{#regionId}:{#accountId}:'], + ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:emrserverlessspark:{#regionId}:{#accountId}:workspace/{#WorkspaceId}'], + ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:emr-serverless-spark:{#regionId}:{#accountId}:workspace/*'], ], ], ]; |