diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/ververica/2022-07-18/api-docs.php | |
| download | acs-metadata-full-b5cdc3380f379f7c0246858ac091f04334b7fb8d.tar.gz acs-metadata-full-b5cdc3380f379f7c0246858ac091f04334b7fb8d.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/ververica/2022-07-18/api-docs.php')
| -rw-r--r-- | data/zh_cn/ververica/2022-07-18/api-docs.php | 15403 |
1 files changed, 15403 insertions, 0 deletions
diff --git a/data/zh_cn/ververica/2022-07-18/api-docs.php b/data/zh_cn/ververica/2022-07-18/api-docs.php new file mode 100644 index 0000000..3fbb9f4 --- /dev/null +++ b/data/zh_cn/ververica/2022-07-18/api-docs.php @@ -0,0 +1,15403 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'ververica', + 'version' => '2022-07-18', + ], + 'directories' => [ + [ + 'id' => 364574, + 'title' => '作业草稿文件夹', + 'type' => 'directory', + 'children' => [ + 'CreateFolder', + 'UpdateFolder', + 'DeleteFolder', + 'GetFolder', + ], + ], + [ + 'id' => 364579, + 'title' => '作业草稿', + 'type' => 'directory', + 'children' => [ + 'ValidateDeploymentDraftAsync', + 'GetValidateDeploymentDraftResult', + 'CreateDeploymentDraft', + 'UpdateDeploymentDraft', + 'DeleteDeploymentDraft', + 'GetDeploymentDraft', + 'ListDeploymentDrafts', + 'GetDeploymentDraftLock', + 'DeployDeploymentDraftAsync', + 'GetDeployDeploymentDraftResult', + 'ValidateSqlStatement', + ], + ], + [ + 'id' => 364591, + 'title' => '自定义函数', + 'type' => 'directory', + 'children' => [ + 'CreateUdfArtifact', + 'UpdateUdfArtifact', + 'GetUdfArtifacts', + 'DeleteUdfArtifact', + 'DeleteUdfFunction', + 'RegisterUdfFunction', + ], + ], + [ + 'id' => 364598, + 'title' => '自定义连接器', + 'type' => 'directory', + 'children' => [ + 'ListCustomConnectors', + 'RegisterCustomConnector', + 'DeleteCustomConnector', + ], + ], + [ + 'id' => 364602, + 'title' => '元数据', + 'type' => 'directory', + 'children' => [ + 'GetDatabases', + 'GetTables', + 'GetCatalogs', + 'ExecuteSqlStatement', + ], + ], + [ + 'id' => 364607, + 'title' => '快照', + 'type' => 'directory', + 'children' => [ + 'CreateSavepoint', + 'GetSavepoint', + 'DeleteSavepoint', + 'ListSavepoints', + ], + ], + [ + 'id' => 364612, + 'title' => '已部署作业', + 'type' => 'directory', + 'children' => [ + 'GetDeploymentsByName', + 'GetDeploymentsByLabel', + 'GetDeploymentsByIp', + 'CreateDeployment', + 'UpdateDeployment', + 'GetDeployment', + 'ListDeployments', + 'DeleteDeployment', + 'GetEvents', + ], + ], + [ + 'id' => 364622, + 'title' => '作业实例', + 'type' => 'directory', + 'children' => [ + 'GetJob', + 'ListJobs', + 'StartJobWithParams', + 'StopJob', + 'DeleteJob', + 'HotUpdateJob', + 'GetHotUpdateJobResult', + 'GetLatestJobStartLog', + 'GetJobDiagnosis', + 'StartJob', + ], + ], + [ + 'id' => 364633, + 'title' => '定时计划', + 'type' => 'directory', + 'children' => [ + 'CreateScheduledPlan', + 'UpdateScheduledPlan', + 'DeleteScheduledPlan', + 'ListScheduledPlan', + 'ApplyScheduledPlan', + 'StopApplyScheduledPlan', + 'GetAppliedScheduledPlan', + 'ListScheduledPlanExecutedHistory', + ], + ], + [ + 'id' => 364642, + 'title' => 'Session集群', + 'type' => 'directory', + 'children' => [ + 'CreateSessionCluster', + 'UpdateSessionCluster', + 'DeleteSessionCluster', + 'GetSessionCluster', + 'ListSessionClusters', + 'StartSessionCluster', + 'StopSessionCluster', + ], + ], + [ + 'id' => 364650, + 'title' => '作业部署目标', + 'type' => 'directory', + 'children' => [ + 'CreateDeploymentTarget', + 'UpdateDeploymentTarget', + 'DeleteDeploymentTarget', + 'ListDeploymentTargets', + ], + ], + 'UpdateDeploymentTargetV2', + 'CreateDeploymentTargetV2', + [ + 'id' => 364657, + 'title' => '成员管理', + 'type' => 'directory', + 'children' => [ + 'CreateMember', + 'UpdateMember', + 'DeleteMember', + 'GetMember', + 'ListMembers', + ], + ], + [ + 'id' => 364663, + 'title' => '变量', + 'type' => 'directory', + 'children' => [ + 'UpdateVariable', + 'CreateVariable', + 'DeleteVariable', + 'ListVariables', + ], + ], + [ + 'id' => 364668, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListEngineVersionMetadata', + 'GenerateResourcePlanWithFlinkConfAsync', + 'GetGenerateResourcePlanResult', + 'FlinkApiProxy', + 'GetLineageInfo', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AiModel' => [ + 'type' => 'object', + 'properties' => [ + 'outputSchema' => [ + '$ref' => '#/components/schemas/Schema', + ], + 'inputSchema' => [ + '$ref' => '#/components/schemas/Schema', + ], + 'name' => [ + 'type' => 'string', + 'required' => true, + ], + 'comment' => [ + 'type' => 'string', + ], + 'options' => [ + 'type' => 'object', + 'required' => true, + 'additionalProperties' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'Artifact' => [ + 'title' => '作业内容模版', + 'description' => 'Artifact承载了用户启动一个已部署作业所必需的用户侧信息，没有Artifact信息已部署作业无法创建。对于SQL作业是SQL文本以及依赖的udf/connector等，对于JAR作业是使用到的全部的JAR包和依赖文件，对于Python作业是要使用到的py文件以及zip包。', + 'type' => 'object', + 'properties' => [ + 'sqlArtifact' => [ + 'title' => 'SQL作业', + 'description' => 'SQL作业必填信息。', + '$ref' => '#/components/schemas/SqlArtifact', + ], + 'jarArtifact' => [ + 'title' => 'Jar作业', + 'description' => 'JAR作业必填信息。', + '$ref' => '#/components/schemas/JarArtifact', + ], + 'pythonArtifact' => [ + 'title' => 'Python作业', + 'description' => 'Python作业必填信息。', + '$ref' => '#/components/schemas/PythonArtifact', + ], + 'kind' => [ + 'title' => '生效作业类型', + 'description' => '生效作业类型，必填，创建后无法修改。'."\n" + .'- SQLSCRIPT：SQL作业。'."\n" + .'- JAR：JAR作业。'."\n" + .'- PYTHON：Python作业。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQLSCRIPT', + 'enum' => [ + 'SQLSCRIPT', + 'JAR', + 'PYTHON', + ], + ], + ], + ], + 'AsyncDraftDeployResult' => [ + 'title' => 'A short description of struct', + 'description' => '异步部署作业草稿结果。', + 'type' => 'object', + 'properties' => [ + 'ticketStatus' => [ + 'title' => '执行状态', + 'description' => '执行状态。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'artifactValidationDetail' => [ + 'description' => 'SQL校验结果。', + '$ref' => '#/components/schemas/ValidateStatementResult', + ], + 'deploymentId' => [ + 'title' => '已部署作业ID', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '部署是否成功', + 'description' => '是否部署成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'message' => [ + 'title' => '部署结果信息', + 'description' => '部署结果信息。', + 'type' => 'string', + 'example' => '"Validation error: SQL validate failed"', + ], + ], + ], + 'AsyncDraftValidateResult' => [ + 'type' => 'object', + 'properties' => [ + 'ticketStatus' => [ + 'type' => 'string', + ], + 'success' => [ + 'type' => 'boolean', + ], + 'message' => [ + 'type' => 'string', + ], + 'draftValidationDetail' => [ + '$ref' => '#/components/schemas/DraftValidationDetail', + ], + ], + ], + 'AsyncResourcePlanOperationResult' => [ + 'title' => '细粒度资源异步操作结果', + 'description' => '本数据结构代表专家模式的资源配置计划。', + 'type' => 'object', + 'properties' => [ + 'ticketStatus' => [ + 'title' => '执行状态', + 'description' => '异步工单状态。'."\n" + .'- EXECUTING：执行中。'."\n" + .'- FINISHED：执行完成。'."\n" + .'- FAILED：执行失败。', + 'type' => 'string', + 'enumValueTitles' => [ + 'EXECUTING' => 'EXECUTING', + 'FAILED' => 'FAILED', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'FINISHED', + 'enum' => [ + 'INIT', + 'EXECUTING', + 'FINISHED', + 'FAILED', + ], + ], + 'plan' => [ + 'title' => '细粒度资源值', + 'description' => '专家模式的资源配置计划，ticketStatus状态为FINISHED时返回。', + 'type' => 'string', + 'example' => '{\\"ssgProfiles\\":[{\\"name\\":\\"default\\",\\"cpu\\":1.13,\\"heap\\":\\"1 gb\\",\\"offHeap\\":\\"32 mb\\",\\"managed\\":{},\\"extended\\":{}}],\\"nodes\\":[{\\"id\\":1,\\"type\\":\\"StreamExecTableSourceScan\\",\\"desc\\":\\"Source: datagen_source[78]\\",\\"profile\\":{\\"group\\":\\"default\\",\\"parallelism\\":1,\\"maxParallelism\\":32768,\\"minParallelism\\":1}},{\\"id\\":2,\\"type\\":\\"StreamExecSink\\",\\"desc\\":\\"Sink: blackhole_sink[79]\\",\\"profile\\":{\\"group\\":\\"default\\",\\"parallelism\\":1,\\"maxParallelism\\":32768,\\"minParallelism\\":1}}],\\"edges\\":[{\\"source\\":1,\\"target\\":2,\\"mode\\":\\"PIPELINED\\",\\"strategy\\":\\"FORWARD\\"}],\\"vertices\\":{\\"717c7b8afebbfb7137f6f0f99beb2a94\\":[1,2]}}', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => '工单信息，ticketStatus为FAILED或EXECUTING状态时返回。', + 'type' => 'string', + 'example' => '"create resource plan failed"', + ], + ], + ], + 'BasicResourceSetting' => [ + 'title' => '作业通用资源设置', + 'description' => '本数据结构表示用户使用的社区版本常用的基础模式资源配置，有别于商业版本提供的专家模式资源配置。', + 'type' => 'object', + 'properties' => [ + 'parallelism' => [ + 'title' => '并发度', + 'description' => '并发度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'jobmanagerResourceSettingSpec' => [ + 'title' => 'JobManager资源设置', + 'description' => 'JobManager资源设置。', + '$ref' => '#/components/schemas/BasicResourceSettingSpec', + ], + 'taskmanagerResourceSettingSpec' => [ + 'title' => 'TaskManager资源设置', + 'description' => 'TaskManager资源设置。', + '$ref' => '#/components/schemas/BasicResourceSettingSpec', + ], + ], + ], + 'BasicResourceSettingSpec' => [ + 'title' => '作业基础源', + 'description' => '本数据结构表示对作业使用CPU和内存资源的包装，依据本数据结构可以生成对JM/TM资源的粗粒度的描述。', + 'type' => 'object', + 'properties' => [ + 'cpu' => [ + 'title' => 'CPU', + 'description' => 'CPU核数。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.0', + ], + 'memory' => [ + 'title' => '内存', + 'description' => '内存，单位GiB。', + 'type' => 'string', + 'example' => '4 GiB', + ], + ], + ], + 'BatchResourceSetting' => [ + 'title' => '批作业资源设置', + 'description' => '本数据结构代表批模式资源设置信息。', + 'type' => 'object', + 'properties' => [ + 'maxSlot' => [ + 'title' => '最大slot数', + 'description' => '最大slot数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'basicResourceSetting' => [ + 'title' => '基础资源设置', + 'description' => '基础模式资源设置。', + '$ref' => '#/components/schemas/BasicResourceSetting', + ], + ], + ], + 'BriefDeploymentTarget' => [ + 'title' => 'A short description of struct', + 'description' => '本数据结构用在Deployment数据结构中，用来描述部署目标。', + 'type' => 'object', + 'properties' => [ + 'mode' => [ + 'title' => 'mode', + 'description' => '部署模式。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SESSION' => 'SESSION', + 'PER_JOB' => 'PER_JOB', + ], + 'example' => 'PER_JOB', + 'enum' => [ + 'PER_JOB', + ], + ], + 'name' => [ + 'title' => 'name', + 'description' => '- perjob类型：使用部署目标名称，可通过ListDeploymentTargets接口获取。'."\n" + .'- session类型：使用session集群名称。', + 'type' => 'string', + 'example' => 'default-queue ', + ], + ], + ], + 'BriefResourceSetting' => [ + 'title' => '作业资源设置', + 'description' => '本数据结构用来描述作业在流/批两种模式下能使用的资源情况。', + 'type' => 'object', + 'properties' => [ + 'flinkConf' => [ + 'title' => 'flink配置设置', + 'description' => 'Flink配置。', + 'type' => 'object', + 'example' => '“execution.checkpointing.interval: 180s”', + ], + 'batchResourceSetting' => [ + 'title' => '批作业资源设置', + 'description' => '运行批模式的资源设置，选择批模式时必填。', + '$ref' => '#/components/schemas/BatchResourceSetting', + ], + 'streamingResourceSetting' => [ + 'title' => '流作业资源设置', + 'description' => '运行流模式的资源设置，选择流模式时必填。', + '$ref' => '#/components/schemas/StreamingResourceSetting', + ], + ], + ], + 'Catalog' => [ + 'title' => 'A short description of struct', + 'description' => 'catalog结构。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => 'catalog名称', + 'description' => 'catalog名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon-test', + ], + 'properties' => [ + 'title' => 'catalog配置参数', + 'description' => 'catalog配置参数。', + 'type' => 'object', + 'required' => true, + ], + 'extensionConf' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Cell' => [ + 'type' => 'object', + 'properties' => [ + 'value' => [ + 'type' => 'string', + ], + ], + ], + 'Connector' => [ + 'title' => 'A short description of struct', + 'description' => '自定义连接器connector。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => 'connector名称', + 'description' => 'connector名称。', + 'type' => 'string', + 'example' => 'mysql-test', + ], + 'type' => [ + 'title' => 'connector类型', + 'description' => 'connector类型。', + 'type' => 'string', + 'example' => 'mysql-test', + ], + 'source' => [ + 'title' => '是否为source', + 'description' => '是否可以作为source。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'sink' => [ + 'title' => '是否为sink', + 'description' => '是否可以作为sink。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'lookup' => [ + 'title' => '是否为lookup', + 'description' => '是否可以作为lookup。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'properties' => [ + 'title' => '配置信息', + 'description' => '参数配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'connector参数。', + '$ref' => '#/components/schemas/Property', + ], + ], + 'supportedFormats' => [ + 'title' => '支持的格式', + 'description' => '支持的格式组。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的格式。', + 'type' => 'string', + 'example' => 'Json', + ], + ], + 'dependencies' => [ + 'title' => '依赖', + 'description' => '附加依赖文件组。', + 'type' => 'array', + 'items' => [ + 'description' => '附加依赖文件。', + 'type' => 'string', + 'example' => 'oss://bucket/add.jar', + ], + ], + 'creator' => [ + 'title' => '创建者UID', + 'description' => '创建者UID。', + 'type' => 'string', + 'example' => '183899668*******', + ], + 'creatorName' => [ + 'title' => '创建者昵称', + 'description' => '创建者昵称。', + 'type' => 'string', + 'example' => 'userA', + ], + 'modifier' => [ + 'title' => '修改者UID', + 'description' => '修改者UID。', + 'type' => 'string', + 'example' => '183899668*******', + ], + 'modifierName' => [ + 'title' => '修改者昵称', + 'description' => '修改者昵称。', + 'type' => 'string', + 'example' => 'userA', + ], + ], + ], + 'CreateUdfArtifactResult' => [ + 'title' => 'A short description of struct', + 'description' => '创建UdfArtifact返回数据。', + 'type' => 'object', + 'properties' => [ + 'createSuccess' => [ + 'title' => '创建是否成功', + 'description' => '创建是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'message' => [ + 'title' => '创建信息', + 'description' => '创建信息。', + 'type' => 'string', + 'example' => '“”', + ], + 'udfArtifact' => [ + 'title' => '创建的udfArtifact', + 'description' => '创建的udfArtifact。', + '$ref' => '#/components/schemas/UdfArtifact', + ], + 'collidingClasses' => [ + 'title' => '存在冲突的class', + 'description' => '存在冲突的全部类。', + 'type' => 'array', + 'items' => [ + 'description' => '存在冲突的类名称。', + '$ref' => '#/components/schemas/UdfClass', + ], + ], + ], + ], + 'Database' => [ + 'title' => 'A short description of struct', + 'description' => 'database结构。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => 'database名称', + 'description' => 'database名称。', + 'type' => 'string', + 'example' => 'database-test', + ], + 'properties' => [ + 'title' => 'database配置参数', + 'description' => 'database配置参数。', + 'type' => 'object', + 'example' => '“”', + ], + 'comment' => [ + 'title' => '备注', + 'description' => '备注。', + 'type' => 'string', + 'example' => '测试数据库。', + ], + ], + ], + 'DeleteUdfArtifactResult' => [ + 'title' => 'A short description of struct', + 'description' => '删除UdfArtifact返回数据。', + 'type' => 'object', + 'properties' => [ + 'deleteSuccess' => [ + 'title' => '删除是否成功', + 'description' => '删除是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'message' => [ + 'title' => '删除信息', + 'description' => '删除信息。', + 'type' => 'string', + 'example' => '“”', + ], + 'referencedClasses' => [ + 'title' => '相关联的class', + 'description' => '相关联的全部类。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义函数类名。', + '$ref' => '#/components/schemas/UdfClass', + ], + ], + ], + ], + 'Deployment' => [ + 'title' => '作业信息', + 'description' => '本数据结构用来描述一个完整的已部署作业的数据结构。', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '作业ID', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012312****', + ], + 'namespace' => [ + 'title' => '项目空间', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'name' => [ + 'title' => '作业名称', + 'description' => '已部署作业名称。', + 'type' => 'string', + 'example' => 'deploymentName', + ], + 'engineVersion' => [ + 'title' => '引擎版本', + 'description' => '引擎版本。', + 'type' => 'string', + 'example' => 'vvr-6.0.0-flink-1.15', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'this is a deployment description', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者。', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'creatorName' => [ + 'title' => '创建者名称', + 'description' => '创建者名称。', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifier' => [ + 'title' => '修改者', + 'description' => '修改者。', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'description' => '修改者名称。', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'deploymentHasChanged' => [ + 'title' => '作业启动后是否被修改', + 'description' => '已部署作业启动后是否被修改。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'artifact' => [ + 'title' => 'artifact', + 'description' => '用户启动已部署作业必填的数据结构。', + '$ref' => '#/components/schemas/Artifact', + ], + 'flinkConf' => [ + 'title' => 'Flink配置', + 'description' => 'Flink配置。', + 'type' => 'object', + 'example' => '{"taskmanager.numberOfTaskSlots":"1"}', + ], + 'logging' => [ + 'title' => '日志配置', + 'description' => '日志配置。', + '$ref' => '#/components/schemas/Logging', + ], + 'jobSummary' => [ + 'title' => '实例信息汇总', + 'description' => '已部署作业下的作业实例信息汇总。', + '$ref' => '#/components/schemas/JobSummary', + ], + 'deploymentTarget' => [ + 'title' => '部署目标', + 'description' => '部署目标。', + '$ref' => '#/components/schemas/BriefDeploymentTarget', + ], + 'executionMode' => [ + 'title' => '执行模式，支持STREAMING或者BATCH', + 'description' => '执行模式。'."\n" + .'- STREAMING：流模式。'."\n" + .'- BATCH：批模式。', + 'type' => 'string', + 'example' => 'STREAMING', + 'enum' => [ + 'STREAMING', + 'BATCH', + ], + ], + 'streamingResourceSetting' => [ + 'title' => '流作业资源设置', + 'description' => '流作业资源设置。', + '$ref' => '#/components/schemas/StreamingResourceSetting', + ], + 'batchResourceSetting' => [ + 'title' => '批作业资源设置', + 'description' => '批作业资源设置。', + '$ref' => '#/components/schemas/BatchResourceSetting', + ], + 'labels' => [ + 'title' => '作业标签', + 'description' => '作业标签', + 'type' => 'object', + ], + 'localVariables' => [ + 'title' => '作业变量', + 'description' => '作业变量', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LocalVariable', + ], + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1714058507'."\n", + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '1714058843', + ], + 'referencedDeploymentDraftId' => [ + 'title' => '关联作业草稿ID', + 'description' => '关联作业草稿ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000000003', + ], + ], + ], + 'DeploymentDraft' => [ + 'title' => 'A short description of struct', + 'description' => '作业草稿。', + 'type' => 'object', + 'properties' => [ + 'deploymentDraftId' => [ + 'title' => '作业草稿ID', + 'description' => '作业草稿ID。', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-00000012****', + ], + 'name' => [ + 'title' => '作业草稿名称', + 'description' => '作业草稿名称。', + 'type' => 'string', + 'example' => 'test-draft', + ], + 'parentId' => [ + 'title' => '父目录ID', + 'description' => '父文件夹目录ID。', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-00000013****', + ], + 'referencedDeploymentId' => [ + 'title' => '关联的已部署作业ID', + 'description' => '关联的已部署作业ID。', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012312****', + ], + 'executionMode' => [ + 'title' => '执行模式', + 'description' => '执行模式。', + 'type' => 'string', + 'example' => 'STREAMING', + 'enum' => [ + 'STREAMING', + 'BATCH', + ], + ], + 'artifact' => [ + 'description' => 'SQL作业文本内容，仅支持SQLSCRIPT类型。', + '$ref' => '#/components/schemas/Artifact', + ], + 'engineVersion' => [ + 'title' => '引擎版本', + 'description' => '引擎版本。', + 'type' => 'string', + 'example' => 'vvr-6.0.7-flink-1.15', + ], + 'localVariables' => [ + 'title' => '作业变量', + 'description' => '作业变量。', + 'type' => 'array', + 'items' => [ + 'description' => '作业变量。', + '$ref' => '#/components/schemas/LocalVariable', + ], + ], + 'labels' => [ + 'title' => '作业标签', + 'description' => '作业标签。', + 'type' => 'object', + ], + 'lock' => [ + 'title' => '作业草稿锁', + 'description' => '作业草稿锁。', + '$ref' => '#/components/schemas/Lock', + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'namespace' => [ + 'title' => '项目空间', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者。', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'creatorName' => [ + 'title' => '创建者名称', + 'description' => '创建者名称。', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifier' => [ + 'title' => '修改者', + 'description' => '修改者。', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'description' => '修改者名称。', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + ], + ], + ], + 'DeploymentRestoreStrategy' => [ + 'title' => '作业启动位点', + 'description' => '本数据结构代表已部署作业的启动策略。', + 'type' => 'object', + 'properties' => [ + 'kind' => [ + 'title' => '启动位点类型', + 'description' => '启动位点类型。'."\n" + .'- NONE：无状态启动。'."\n" + .'- LATEST_SAVEPOINT：最新的作业快照启动。'."\n" + .'- FROM_SAVEPOINT：从指定快照启动。'."\n" + .'- LATEST_STATE：最新状态启动'."\n" + ."\n\n", + 'type' => 'string', + 'example' => 'LATEST_STATE', + 'enum' => [ + 'NONE', + 'LATEST_SAVEPOINT', + 'FROM_SAVEPOINT', + 'LATEST_STATE', + ], + ], + 'allowNonRestoredState' => [ + 'title' => '是否无状态启动', + 'description' => '允许忽略部分算子状态。仅当Python类型或者Jar类型作业选择有状态恢复时需要设置。', + 'type' => 'boolean', + 'example' => 'TRUE', + ], + 'jobStartTimeInMs' => [ + 'title' => '无状态启动时间，当选择无状态启动时，可以设置本参数让所有支持startTime 的源表均从该时刻开始读取数据', + 'description' => '无状态启动时间，需输入13位时间戳。当选择无状态启动时，可以设置本参数让所有支持startTime的源表均从该时刻开始读取数据。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660293803155', + ], + 'savepointId' => [ + 'title' => '启动作业快照ID', + 'description' => '启动作业快照ID，启动策略为FROM_SAVEPOINT时必填。', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + ], + ], + ], + 'DeploymentTarget' => [ + 'title' => '作业部署目标详情', + 'description' => '本数据结构用来描述集群中设置的perjob类型的部署目标相关信息。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '部署目标名称', + 'description' => 'perjob类型部署目标名称。', + 'type' => 'string', + 'example' => 'deployment target', + ], + 'namespace' => [ + 'title' => '项目空间名称', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'namespace', + ], + 'quota' => [ + 'title' => '资源配额', + 'description' => '资源配额', + '$ref' => '#/components/schemas/ResourceQuota', + ], + ], + ], + 'DraftDeployParams' => [ + 'title' => 'A short description of struct', + 'description' => '作业草稿部署参数。', + 'type' => 'object', + 'properties' => [ + 'skipValidate' => [ + 'title' => '是否跳过深度校验', + 'description' => '是否跳过深度校验。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'deploymentTarget' => [ + 'title' => '部署目标', + 'description' => '部署目标。', + '$ref' => '#/components/schemas/BriefDeploymentTarget', + ], + 'deploymentDraftId' => [ + 'title' => '作业草稿ID', + 'description' => '作业草稿ID。', + 'type' => 'string', + 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51****', + ], + ], + ], + 'DraftDeployResult' => [ + 'title' => 'A short description of struct', + 'description' => '作业草稿部署结果。', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'title' => '部署结果', + 'description' => '是否部署成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'message' => [ + 'title' => '部署信息', + 'description' => '部署信息。', + 'type' => 'string', + 'example' => '""', + ], + 'deploymentId' => [ + 'title' => '已部署作业ID', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + 'artifactValidationDetail' => [ + 'description' => 'SQL校验结果。', + '$ref' => '#/components/schemas/ValidateStatementResult', + ], + ], + ], + 'DraftMetaInfoErrorDetail' => [ + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'type' => 'string', + ], + 'reason' => [ + 'type' => 'string', + ], + ], + ], + 'DraftValidateParams' => [ + 'type' => 'object', + 'properties' => [ + 'deploymentDraftId' => [ + 'type' => 'string', + ], + 'deploymentTargetName' => [ + 'type' => 'string', + ], + ], + ], + 'DraftValidationDetail' => [ + 'type' => 'object', + 'properties' => [ + 'draftMetaInfoErrorDetails' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DraftMetaInfoErrorDetail', + ], + ], + 'sqlValidationResult' => [ + 'type' => 'string', + ], + 'sqlErrorDetail' => [ + '$ref' => '#/components/schemas/ValidationErrorDetails', + ], + ], + ], + 'Edge' => [ + 'title' => 'A short description of struct', + 'description' => '血缘边信息。', + 'type' => 'object', + 'properties' => [ + 'tableLineage' => [ + 'title' => '表关系', + 'description' => '表关系。', + 'type' => 'array', + 'items' => [ + 'description' => '关联表信息。', + '$ref' => '#/components/schemas/Relation', + ], + ], + 'columnLineage' => [ + 'title' => '列关系', + 'description' => '字段关系。', + 'type' => 'array', + 'items' => [ + 'description' => '关联字段信息。', + '$ref' => '#/components/schemas/Relation', + ], + ], + ], + ], + 'EditableNamespace' => [ + 'title' => '有编辑权限的项目空间对象', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'title' => '用户角色', + 'type' => 'string', + ], + 'WorkspaceId' => [ + 'title' => '工作空间ID', + 'type' => 'string', + ], + 'Namespace' => [ + 'title' => '项目空间名字', + 'type' => 'string', + ], + ], + ], + 'EngineVersionMetadata' => [ + 'title' => '引擎版本基础信息。', + 'description' => '本数据结构代表作业引擎版本的基础信息。', + 'type' => 'object', + 'properties' => [ + 'engineVersion' => [ + 'title' => '引擎版本名称。', + 'description' => '引擎版本名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'vvr-6.0.0-flink-1.15', + ], + 'status' => [ + 'title' => '该引擎版本状态。', + 'description' => '该引擎版本状态。'."\n" + ."\n" + .'- STABLE：稳定版本。'."\n" + .'- BETA：测试版本。'."\n" + .'- DEPRECATED：废弃版本。'."\n" + .'- EXPIRED：过期版本。', + 'type' => 'string', + 'required' => true, + 'example' => 'STABLE', + 'enum' => [ + 'STABLE', + 'BETA', + 'DEPRECATED', + 'EXPIRED', + ], + ], + 'features' => [ + 'title' => '该引擎版本所支持的特性。', + 'description' => '该引擎版本所支持的特性。', + '$ref' => '#/components/schemas/EngineVersionSupportedFeatures', + ], + ], + ], + 'EngineVersionMetadataIndex' => [ + 'title' => '引擎版本的总体信息。', + 'description' => '本数据结构代表作业引擎版本的汇总信息。', + 'type' => 'object', + 'properties' => [ + 'defaultEngineVersion' => [ + 'title' => '默认使用的引擎版本。', + 'description' => '默认使用的引擎版本。', + 'type' => 'string', + 'example' => 'vvr-6.0.1-flink-1.15', + ], + 'engineVersionMetadata' => [ + 'title' => '所有支持的引擎版本信息。', + 'description' => '所有支持的引擎版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '引擎版本基础信息。', + '$ref' => '#/components/schemas/EngineVersionMetadata', + ], + ], + ], + ], + 'EngineVersionSupportedFeatures' => [ + 'title' => '引擎版本所支持的特性。', + 'description' => '本数据结构代表该引擎版本支持的特性描述。', + 'type' => 'object', + 'properties' => [ + 'useForSqlDeployments' => [ + 'title' => '该引擎版本是否具备提交Sql作业能力。', + 'description' => '该引擎版本是否具备提交SQL作业能力。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportNativeSavepoint' => [ + 'title' => '该引擎版本是否具备支持native savepoint的能力。', + 'description' => '该引擎版本是否具备支持原生快照的能力。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'ErrorDetails' => [ + 'title' => 'Sql作业代码校验错误细节', + 'description' => 'Sql作业代码校验错误细节。', + 'type' => 'object', + 'properties' => [ + 'lineNumber' => [ + 'title' => '错误开始行数', + 'description' => '错误开始行数。', + 'type' => 'string', + 'example' => '3', + ], + 'columnNumber' => [ + 'title' => '错误开始列数', + 'description' => '错误开始列数。', + 'type' => 'string', + 'example' => '2', + ], + 'endLineNumber' => [ + 'title' => '错误结束行数', + 'description' => '错误结束行数。', + 'type' => 'string', + 'example' => '5', + ], + 'endColumnNumber' => [ + 'title' => '错误结束列数', + 'description' => '错误结束列数。', + 'type' => 'string', + 'example' => '11', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '""', + ], + 'invalidflinkConf' => [ + 'title' => '无效flink conf', + 'description' => '无效flink conf列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无效flink conf信息。', + 'type' => 'string', + 'example' => '{"k:v"}', + ], + ], + ], + ], + 'Event' => [ + 'title' => '运行事件', + 'description' => 'event', + 'type' => 'object', + 'properties' => [ + 'eventId' => [ + 'title' => '运行事件ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000000001', + ], + 'jobId' => [ + 'title' => '作业实例ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000005043', + ], + 'createdAt' => [ + 'type' => 'string', + ], + 'workspace' => [ + 'title' => '工作空间', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'deploymentId' => [ + 'title' => '作业ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000680003', + ], + 'namespace' => [ + 'title' => '项目空间', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'eventName' => [ + 'title' => '运行事件名称', + 'type' => 'string', + 'example' => 'STATE_TRANSITION_IS_COMPLETED', + ], + 'message' => [ + 'title' => '运行事件信息', + 'type' => 'string', + ], + ], + ], + 'ExpertResourceSetting' => [ + 'title' => '细粒度资源设置', + 'description' => '本数据结构代表作业专家模式资源配置的信息。', + 'type' => 'object', + 'properties' => [ + 'jobmanagerResourceSettingSpec' => [ + 'title' => 'JobManager基础资源设置', + 'description' => 'JobManager基础资源设置。', + '$ref' => '#/components/schemas/BasicResourceSettingSpec', + ], + 'resourcePlan' => [ + 'title' => '细粒度资源计划', + 'description' => '专家模式资源配置计划。', + 'type' => 'string', + 'example' => '{\\"ssgProfiles\\":[{\\"name\\":\\"default\\",\\"cpu\\":1.13,\\"heap\\":\\"1 gb\\",\\"offHeap\\":\\"32 mb\\",\\"managed\\":{},\\"extended\\":{}}],\\"nodes\\":[{\\"id\\":1,\\"type\\":\\"StreamExecTableSourceScan\\",\\"desc\\":\\"Source: datagen_source[78]\\",\\"profile\\":{\\"group\\":\\"default\\",\\"parallelism\\":1,\\"maxParallelism\\":32768,\\"minParallelism\\":1}},{\\"id\\":2,\\"type\\":\\"StreamExecSink\\",\\"desc\\":\\"Sink: blackhole_sink[79]\\",\\"profile\\":{\\"group\\":\\"default\\",\\"parallelism\\":1,\\"maxParallelism\\":32768,\\"minParallelism\\":1}}],\\"edges\\":[{\\"source\\":1,\\"target\\":2,\\"mode\\":\\"PIPELINED\\",\\"strategy\\":\\"FORWARD\\"}],\\"vertices\\":{\\"717c7b8afebbfb7137f6f0f99beb2a94\\":[1,2]}}', + ], + ], + ], + 'FetchResult' => [ + 'type' => 'object', + 'properties' => [ + 'resultType' => [ + 'type' => 'string', + ], + 'resultMessage' => [ + 'type' => 'string', + ], + 'tableResults' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/TableResult', + ], + ], + ], + ], + 'FlinkConf' => [ + 'title' => 'Flink conf', + 'description' => 'flink配置参数', + 'type' => 'object', + 'example' => '{"taskmanager.numberOfTaskSlots":"1","table.exec.state.ttl":"128000s"}'."\n", + ], + 'Folder' => [ + 'title' => 'A short description of struct', + 'description' => '作业草稿文件夹。', + 'type' => 'object', + 'properties' => [ + 'folderId' => [ + 'title' => '文件夹id', + 'description' => '文件夹id。', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012312****', + ], + 'parentId' => [ + 'title' => '父级文件夹id', + 'description' => '父级文件夹id。', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012390****', + ], + 'name' => [ + 'title' => '文件夹名称', + 'description' => '文件夹名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'subFolder' => [ + 'title' => '子文件夹', + 'description' => '子文件夹列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子文件夹信息。', + '$ref' => '#/components/schemas/SubFolder', + ], + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间ID。', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'namespace' => [ + 'title' => '项目空间', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + ], + ], + ], + 'Function' => [ + 'type' => 'object', + 'properties' => [ + 'gmtModified' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + 'functionLanguage' => [ + 'title' => 'FUNCTION_LANGUAGE_INVALID: <code>FUNCTION_LANGUAGE_INVALID = 0;</code>, FUNCTION_LANGUAGE_JAVA: <code>FUNCTION_LANGUAGE_JAVA = 1;</code>, FUNCTION_LANGUAGE_SCALA: <code>FUNCTION_LANGUAGE_SCALA = 2;</code>, FUNCTION_LANGUAGE_PYTHON: '."\n" + .'<code>FUNCTION_LANGUAGE_PYTHON = 3;', + 'type' => 'string', + 'required' => true, + ], + 'name' => [ + 'type' => 'string', + 'required' => true, + ], + 'description' => [ + 'type' => 'string', + ], + 'className' => [ + 'title' => '', + 'type' => 'string', + 'required' => true, + ], + 'functionType' => [ + 'title' => 'FUNCTION_TYPE_INVALID: <code>FUNCTION_TYPE_INVALID = 0;</code>, FUNCTION_TYPE_FLINK: <code>FUNCTION_TYPE_FLINK = 1;</code>, FUNCTION_TYPE_UNKNOWN_EXTERNAL: <code>FUNCTION_TYPE_UNKNOWN_EXTERNAL = 2;</code>', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'GetLineageInfoParams' => [ + 'title' => 'A short description of struct', + 'description' => '数据血缘查询参数。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '作业id或表id', + 'description' => '作业实例id或表id。可通过listjobs接口获取作业实例ID或通过lisTables接口获取表ID。', + 'type' => 'string', + 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****', + ], + 'depth' => [ + 'title' => '血缘深度', + 'description' => '血缘深度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'idType' => [ + 'title' => '数据类型，JOB/TABLE', + 'description' => '数据类型，JOB/TABLE，需要和id设置一致。', + 'type' => 'string', + 'example' => 'JOB', + 'enum' => [ + 'TABLE', + 'JOB', + ], + ], + 'isColumnLevel' => [ + 'title' => '谱系类型，true为列级谱系，false为表级谱系', + 'description' => '谱系类型，true为字段级血缘，false为表级血缘。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'direction' => [ + 'title' => '血缘方向，UPSTREAM/DOWNSTREAM/BOTH', + 'description' => '血缘方向。'."\n" + ."\n" + .'- UPSTREAM：寻找上游节点。'."\n" + .'- DOWNSTREAM：寻找下游节点。'."\n" + .'- BOTH：同时寻找上下游节点。', + 'type' => 'string', + 'example' => 'Both', + 'enum' => [ + 'UPSTREAM', + 'DOWNSTREAM', + 'BOTH', + ], + ], + 'isTemporary' => [ + 'title' => '是否为临时表', + 'description' => '是否为临时表。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间ID。', + 'type' => 'string', + 'example' => 'a14bd5d90a****'."\n", + ], + 'namespace' => [ + 'title' => '项目空间', + 'description' => '项目空间。', + 'type' => 'string', + 'example' => 'default-namespace', + ], + ], + ], + 'GetPreSignedUrlForObjectResult' => [ + 'type' => 'object', + 'properties' => [ + 'preSignedUrl' => [ + 'title' => '签名URL', + 'type' => 'string', + ], + 'jarUrl' => [ + 'title' => 'jar存放路径', + 'type' => 'string', + ], + ], + ], + 'HotUpdateJobFailureInfo' => [ + 'title' => 'A short description of struct', + 'description' => '作业动态更新状态。', + 'type' => 'object', + 'properties' => [ + 'reason' => [ + 'title' => '错误原因', + 'description' => '错误原因。', + 'type' => 'string', + 'example' => '“”', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '“”', + ], + 'failureSeverity' => [ + 'title' => '错误等级', + 'description' => '错误等级。', + 'type' => 'string', + 'example' => 'LOW', + 'enum' => [ + 'CRITICAL', + 'LOW', + ], + ], + ], + ], + 'HotUpdateJobParams' => [ + 'title' => 'A short description of struct', + 'description' => '作业动态更新参数。', + 'type' => 'object', + 'properties' => [ + 'rescaleJobParam' => [ + 'description' => '资源动态更新。', + '$ref' => '#/components/schemas/RescaleJobParam', + ], + 'updateJobConfigParam' => [ + 'description' => '运行参数动态更新。', + '$ref' => '#/components/schemas/UpdateJobConfigParam', + ], + ], + ], + 'HotUpdateJobResult' => [ + 'title' => 'A short description of struct', + 'description' => '作业动态更新结果。', + 'type' => 'object', + 'properties' => [ + 'jobHotUpdateId' => [ + 'title' => '动态更新id', + 'description' => '动态更新id。', + 'type' => 'string', + 'example' => '123hashd****', + ], + 'jobId' => [ + 'title' => '作业id', + 'description' => '作业实例id。', + 'type' => 'string', + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + 'targetResourceSetting' => [ + 'title' => '目标作业资源', + 'description' => '目标作业资源配置。', + '$ref' => '#/components/schemas/BriefResourceSetting', + ], + 'hotUpdateParams' => [ + 'title' => '动态更新参数', + 'description' => '动态更新参数。', + '$ref' => '#/components/schemas/HotUpdateJobParams', + ], + 'status' => [ + 'title' => '动态更新状态', + 'description' => '动态更新状态。', + '$ref' => '#/components/schemas/HotUpdateJobStatus', + ], + ], + ], + 'HotUpdateJobStatus' => [ + 'title' => 'A short description of struct', + 'description' => '作业动态更新状态。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '动态更新状态', + 'description' => '动态更新状态。', + 'type' => 'string', + 'example' => 'HOT_UPDATED', + 'enum' => [ + 'INIT', + 'HOT_UPDATING', + 'FAILED', + 'HOT_UPDATED', + ], + ], + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'failure' => [ + 'title' => '动态更新错误信息', + 'description' => '动态更新错误信息。', + '$ref' => '#/components/schemas/HotUpdateJobFailureInfo', + ], + ], + ], + 'JarArtifact' => [ + 'title' => 'Jar作业结构', + 'description' => '本数据结构代表JAR类型作业必填的信息。', + 'type' => 'object', + 'properties' => [ + 'jarUri' => [ + 'title' => 'Jar作业URL全路径', + 'description' => 'JAR作业URL全路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/test.jar', + ], + 'entryClass' => [ + 'title' => '启动类，需要填写类的全称', + 'description' => '启动类，需要填写类的全称。', + 'type' => 'string', + 'example' => 'org.apapche.flink.test', + ], + 'mainArgs' => [ + 'title' => '启动类所需参数', + 'description' => '启动类所需参数。', + 'type' => 'string', + 'example' => 'start from main', + ], + 'additionalDependencies' => [ + 'title' => '附加依赖URL全路径，可以将Jar需要使用的其他依赖在这里填写', + 'description' => '附加依赖的URL全路径，可以将JAR需要使用的其他依赖在这里填写。', + 'type' => 'array', + 'items' => [ + 'description' => '附加依赖文件的URL全路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/addition.jar', + ], + ], + ], + ], + 'Job' => [ + 'title' => '作业运行实例', + 'description' => '本数据结构代表已部署作业生成的实例详情。', + 'type' => 'object', + 'properties' => [ + 'jobId' => [ + 'title' => '实例ID', + 'description' => '作业实例ID。', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + ], + 'deploymentId' => [ + 'title' => '作业ID', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + ], + 'deploymentName' => [ + 'title' => '作业名称', + 'description' => '已部署作业名称。', + 'type' => 'string', + 'example' => 'flinktest', + ], + 'namespace' => [ + 'title' => '项目空间名称', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'namespacetest', + ], + 'executionMode' => [ + 'title' => '实例运行模式', + 'description' => '作业实例运行模式。'."\n" + .'- STREAM：流模式。'."\n" + .'- BATCH：批模式。', + 'type' => 'string', + 'example' => 'BATCH', + 'enum' => [ + 'STREAMING', + 'BATCH', + ], + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者。', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'creatorName' => [ + 'title' => '创建者名称', + 'description' => '创建者名称。', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifier' => [ + 'title' => '修改者', + 'description' => '修改者。', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'description' => '修改者名称。', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'startTime' => [ + 'title' => '实例启动时间', + 'description' => '作业实例启动时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660190835', + ], + 'endTime' => [ + 'title' => '实例结束时间', + 'description' => '作业实例结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660277235', + ], + 'engineVersion' => [ + 'title' => '作业引擎版本', + 'description' => '作业引擎版本。', + 'type' => 'string', + 'example' => 'vvr-4.0.14-flink-1.13', + ], + 'flinkConf' => [ + 'title' => '作业配置', + 'description' => '作业实例全量参数配置。', + 'type' => 'object', + 'example' => '{execution.checkpointing.unaligned: false}', + ], + 'status' => [ + 'title' => '实例状态', + 'description' => '作业实例状态。', + '$ref' => '#/components/schemas/JobStatus', + ], + 'metric' => [ + 'title' => '实例资源信息', + 'description' => '作业实例资源信息。', + '$ref' => '#/components/schemas/JobMetric', + ], + 'sessionClusterName' => [ + 'title' => 'session集群名称', + 'description' => '如果作业实例运行在Session集群，展示该Session集群名称，否则为null。', + 'type' => 'string', + 'example' => 'null', + ], + 'artifact' => [ + 'title' => '作业内容模版', + 'description' => '作业实例内容模版。', + '$ref' => '#/components/schemas/Artifact', + ], + 'logging' => [ + 'title' => '作业日志配置', + 'description' => '作业实例日志配置。', + '$ref' => '#/components/schemas/Logging', + ], + 'batchResourceSetting' => [ + 'title' => 'batchResourceSetting', + 'description' => '批模式资源设置。', + '$ref' => '#/components/schemas/BatchResourceSetting', + ], + 'streamingResourceSetting' => [ + 'title' => '批作业资源设置', + 'description' => '流模式资源设置。', + '$ref' => '#/components/schemas/StreamingResourceSetting', + ], + 'restoreStrategy' => [ + 'title' => '流作业资源设置', + 'description' => '作业实例启动策略。', + '$ref' => '#/components/schemas/DeploymentRestoreStrategy', + ], + 'userFlinkConf' => [ + 'title' => '用户作业配置', + 'description' => '用户作业参数配置。', + '$ref' => '#/components/schemas/FlinkConf', + ], + 'localVariables' => [ + 'title' => '作业变量', + 'description' => '作业变量。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LocalVariable', + ], + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1714058507', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '1714058800', + ], + ], + ], + 'JobDiagnosis' => [ + 'title' => '作业诊断结果', + 'description' => '作业诊断结果', + 'type' => 'object', + 'properties' => [ + 'symptoms' => [ + 'title' => '诊断详情', + 'description' => '诊断详情', + '$ref' => '#/components/schemas/JobDiagnosisSymptoms', + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间', + 'type' => 'string', + 'example' => 'a14bd5d90a****', + ], + 'riskLevel' => [ + 'title' => '风险等级', + 'description' => '风险等级', + 'type' => 'string', + 'enumValueTitles' => [ + 'RISK_LEVEL_HIGH' => 'RISK_LEVEL_HIGH', + 'RISK_LEVEL_MID' => 'RISK_LEVEL_MID', + 'RISK_LEVEL_LOW' => 'RISK_LEVEL_LOW', + ], + 'example' => 'RISK_LEVEL_LOW', + ], + 'diagnoseId' => [ + 'title' => '诊断ID', + 'description' => '诊断ID', + 'type' => 'string', + 'example' => 'ba30cd99-37a5-4a20-8cd9-ed4b*****', + ], + 'namespace' => [ + 'title' => '项目空间', + 'description' => '项目空间', + 'type' => 'string', + 'example' => 'default-namespace-*****', + ], + 'diagnoseTime' => [ + 'title' => '诊断时间', + 'description' => '诊断时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740389560871', + ], + ], + ], + 'JobDiagnosisSymptom' => [ + 'title' => '诊断内容', + 'description' => '诊断项', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '诊断名称', + 'description' => '诊断名称', + 'type' => 'string', + 'example' => '启动速度分析', + ], + 'description' => [ + 'title' => '诊断结果', + 'description' => '诊断结果', + 'type' => 'string', + 'example' => 'JM资源配置过低导致作业启动慢', + ], + 'recommendation' => [ + 'title' => '修复建议', + 'description' => '修复建议', + 'type' => 'string', + 'example' => '将 JOBManager 内存从 1Gi 改为 4Gi', + ], + ], + ], + 'JobDiagnosisSymptoms' => [ + 'title' => '诊断详情', + 'description' => '作业所有诊断项。', + 'type' => 'object', + 'properties' => [ + 'autopilot' => [ + 'title' => '资源诊断详情', + 'description' => '作业资源诊断。', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'startup' => [ + 'title' => '启动诊断详情', + 'description' => '启动过程诊断。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断项详情。', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + ], + 'runtime' => [ + 'title' => '运行诊断详情', + 'description' => '运行情况诊断。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断项详情。', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + ], + 'troubleshooting' => [ + 'title' => '异常诊断详情', + 'description' => '底层异常诊断。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断项详情。', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + ], + 'state' => [ + 'title' => '作业State诊断详情', + 'description' => '作业状态诊断。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断项详情。', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + ], + 'others' => [ + 'title' => '其它诊断详情', + 'description' => '其它项目诊断。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断项详情。', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + ], + ], + ], + 'JobFailure' => [ + 'title' => '实例失败信息', + 'description' => '本数据结构代表作业失败信息。', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '失败信息详情', + 'description' => '失败信息详情。', + 'type' => 'string', + 'example' => 'Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.', + ], + 'reason' => [ + 'title' => '失败原因', + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'KubernetesDeploymentNotProgressing', + ], + 'failedAt' => [ + 'title' => '失败时间', + 'description' => '失败时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660120062', + ], + ], + ], + 'JobInfo' => [ + 'title' => 'A short description of struct', + 'description' => '作业信息。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '作业id', + 'description' => '作业实例id。', + 'type' => 'string', + 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****'."\n", + ], + 'properties' => [ + 'title' => '作业信息', + 'description' => '作业详情。', + 'type' => 'object', + 'example' => '{"id:xxx","createTime:v"}', + ], + ], + ], + 'JobMetric' => [ + 'title' => '作业运行指标', + 'description' => '本数据结构表示作业运行实例上资源的指标信息。', + 'type' => 'object', + 'properties' => [ + 'totalMemoryByte' => [ + 'title' => '内存，单位是Byte', + 'description' => '内存，单位是Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096', + ], + 'totalCpu' => [ + 'title' => 'CPU', + 'description' => 'CPU。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + ], + ], + ], + 'JobStartParameters' => [ + 'title' => '启动运行实例参数', + 'description' => '启动作业参数', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '作业ID', + 'description' => '作业ID', + 'type' => 'string', + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + 'restoreStrategy' => [ + 'title' => '作业启动位点设置', + 'description' => '作业启动位点设置', + '$ref' => '#/components/schemas/DeploymentRestoreStrategy', + ], + 'resourceQueueName' => [ + 'title' => '作业运行的资源队列', + 'description' => '作业运行的资源队列', + 'type' => 'string', + 'example' => 'default-queue', + ], + 'localVariables' => [ + 'title' => '作业变量', + 'description' => '作业变量', + 'type' => 'array', + 'items' => [ + 'description' => '作业变量', + '$ref' => '#/components/schemas/LocalVariable', + ], + ], + 'jobId' => [ + 'title' => '作业实例 ID', + 'description' => '作业实例 ID', + 'type' => 'string', + ], + ], + ], + 'JobStatus' => [ + 'title' => '实例状态', + 'description' => '本数据结构代表作业下生成实例的状态。', + 'type' => 'object', + 'properties' => [ + 'running' => [ + 'title' => '实例运行信息', + 'description' => '实例运行信息。当作业状态为RUNNING的时候，该数据结构有值。', + '$ref' => '#/components/schemas/JobStatusRunning', + ], + 'riskLevel' => [ + 'type' => 'string', + ], + 'failure' => [ + 'title' => '实例失败信息', + 'description' => '实例失败信息。当作业状态为FAILED的时候，该数据结构有值。', + '$ref' => '#/components/schemas/JobFailure', + ], + 'currentJobStatus' => [ + 'title' => '当前实例的运行状态', + 'description' => '当前实例的状态。'."\n" + .'- STARTING：启动中。'."\n" + .'- RUNNING：运行中。'."\n" + .'- CANCELLING：停止中。'."\n" + .'- FAILED：已失败。'."\n" + .'- CANCELLED：已停止。'."\n" + .'- FINISHED：已完成。', + 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => [ + 'STARTING', + 'RUNNING', + 'CANCELLING', + 'FAILED', + 'CANCELLED', + 'FINISHED', + ], + ], + 'healthScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'JobStatusRunning' => [ + 'title' => '实例运行信息', + 'description' => '本数据结构表示实例的运行状态。', + 'type' => 'object', + 'properties' => [ + 'observedFlinkJobRestarts' => [ + 'title' => '实力重启次数', + 'description' => '实例重启次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'observedFlinkJobStatus' => [ + 'title' => '当前Flink作业状态', + 'description' => '当前Flink实例状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + ], + ], + 'JobSummary' => [ + 'title' => '实例汇总信息', + 'description' => '本数据结构代表作业下所有实例状态的汇总。', + 'type' => 'object', + 'properties' => [ + 'starting' => [ + 'title' => '启动中实例数', + 'description' => '启动中实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'running' => [ + 'title' => '运行中实例数', + 'description' => '运行中实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'cancelling' => [ + 'title' => '停止中实例数', + 'description' => '停止中实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'cancelled' => [ + 'title' => '已停止实例数', + 'description' => '已停止实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'finished' => [ + 'title' => '已完成实例数', + 'description' => '已完成实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'failed' => [ + 'title' => '已失败实例数', + 'description' => '已失败实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + ], + ], + 'LineageColumn' => [ + 'title' => 'A short description of struct', + 'description' => '血缘列信息。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '列id', + 'description' => '列字段ID。', + 'type' => 'string', + 'example' => '123ss3', + ], + 'columnName' => [ + 'title' => '列名', + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'nullable' => [ + 'title' => '是否为空', + 'description' => '是否为空。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'description' => [ + 'title' => '描述信息', + 'description' => '描述信息。', + 'type' => 'string', + 'example' => '订单用户名称', + ], + 'columnType' => [ + 'title' => '列类型', + 'description' => '列类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'columnNativeType' => [ + 'title' => '列原始类型', + 'description' => '列原始类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者。', + 'type' => 'string', + 'example' => 'userA', + ], + 'modifier' => [ + 'title' => '修改者', + 'description' => '修改者。', + 'type' => 'string', + 'example' => 'userA', + ], + ], + ], + 'LineageInfo' => [ + 'title' => 'A short description of struct', + 'description' => '血缘详细信息。', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'title' => '节点', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + '$ref' => '#/components/schemas/Node', + ], + ], + 'edges' => [ + 'title' => '边', + 'description' => '边信息。', + '$ref' => '#/components/schemas/Edge', + ], + 'jobInfos' => [ + 'title' => '作业信息', + 'description' => '作业列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业信息。', + '$ref' => '#/components/schemas/JobInfo', + ], + ], + ], + ], + 'LineageTable' => [ + 'title' => 'A short description of struct', + 'description' => '血缘表信息。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '表id', + 'description' => '表id。', + 'type' => 'string', + 'example' => '434508', + ], + 'tableName' => [ + 'title' => '表名称', + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'order-test', + ], + 'with' => [ + 'title' => '表参数', + 'description' => '表参数。', + 'type' => 'object', + ], + 'properties' => [ + 'title' => '表信息', + 'description' => '表信息。包括创建者和修改者，最近创建时间和修改时间。', + 'type' => 'object', + ], + 'columns' => [ + 'title' => '列', + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '列信息详情。', + '$ref' => '#/components/schemas/LineageColumn', + ], + ], + ], + ], + 'LocalVariable' => [ + 'title' => 'A short description of struct', + 'description' => '作业变量', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '作业变量名称', + 'description' => '作业变量名称', + 'type' => 'string', + 'example' => 'test', + ], + 'value' => [ + 'title' => '作业变量值', + 'description' => '作业变量值', + 'type' => 'string', + 'example' => 'datagen', + ], + ], + ], + 'Lock' => [ + 'title' => 'A short description of struct', + 'description' => '作业草稿锁信息。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '锁ID', + 'description' => '锁ID。', + 'type' => 'string', + 'example' => 'stt-fu1658tbk6mnkk2****', + ], + 'workspace' => [ + 'title' => '工作空间ID', + 'description' => '工作空间ID。', + 'type' => 'string', + 'example' => 'a14bd5d90a****', + ], + 'namespace' => [ + 'title' => '项目空间名称', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'holderId' => [ + 'title' => '锁持有者ID', + 'description' => '锁持有者ID。', + 'type' => 'string', + 'example' => '18389966****', + ], + 'holderName' => [ + 'title' => '锁持有者用户名', + 'description' => '锁持有者用户名。', + 'type' => 'string', + 'example' => 'userA', + ], + ], + ], + 'Log4jLogger' => [ + 'title' => '日志log4j的配置', + 'description' => '本数据结构代表作业实例上日志输出的相关配置信息。', + 'type' => 'object', + 'properties' => [ + 'loggerName' => [ + 'title' => '输出日志的累的名称', + 'description' => '输出日志的类的名称。', + 'type' => 'string', + 'example' => 'StdOutErrConsoleAppender', + ], + 'loggerLevel' => [ + 'title' => '输出日志的级别', + 'description' => '输出日志的级别。', + 'type' => 'string', + 'example' => 'ERROR', + 'enum' => [ + 'TRACE', + 'DEBUG', + 'INFO', + 'WARN', + 'ERROR', + ], + ], + ], + ], + 'LogReservePolicy' => [ + 'title' => '日志保存策略', + 'description' => '本数据结构代表作业实例上日志保存的相关配置。', + 'type' => 'object', + 'properties' => [ + 'openHistory' => [ + 'title' => '是否开启日志保存', + 'description' => '是否开启日志保存。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'expirationDays' => [ + 'title' => '开启日志保存后，日志保存天数', + 'description' => '开启日志保存后，日志保存天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + ], + ], + 'Logging' => [ + 'title' => '作业日志配置', + 'description' => '本数据结构代表作业日志配置的相关信息。', + 'type' => 'object', + 'properties' => [ + 'loggingProfile' => [ + 'title' => '系统日志模版类型', + 'description' => '系统日志默认模版。', + 'type' => 'string', + 'enumValueTitles' => [ + 'default' => 'default', + ], + 'example' => 'default', + 'enum' => [ + 'default', + 'oss', + ], + ], + 'log4j2ConfigurationTemplate' => [ + 'title' => '自定义日志模版', + 'description' => '自定义日志模版。', + 'type' => 'string', + 'example' => 'xml格式文本', + ], + 'log4jLoggers' => [ + 'title' => 'log4j配置', + 'description' => 'log4j配置。', + 'type' => 'array', + 'items' => [ + 'description' => '作业实例上日志输出相关配置信息。', + '$ref' => '#/components/schemas/Log4jLogger', + ], + ], + 'logReservePolicy' => [ + 'title' => '日志保存策略', + 'description' => '日志保存策略。', + '$ref' => '#/components/schemas/LogReservePolicy', + ], + ], + ], + 'Member' => [ + 'title' => '成员', + 'description' => '成员数据结构。', + 'type' => 'object', + 'properties' => [ + 'member' => [ + 'title' => '成员名称', + 'description' => '成员UID。', + 'type' => 'string', + 'required' => true, + 'example' => 'user: 181319557522****', + ], + 'role' => [ + 'title' => '成员角色', + 'description' => '成员角色', + 'type' => 'string', + 'enumValueTitles' => [ + 'EDITOR' => 'EDITOR', + 'OWNER' => 'OWNER', + 'VIEWER' => 'VIEWER', + ], + 'example' => 'VIEWER', + ], + ], + ], + 'MetadataInfo' => [ + 'title' => 'A short description of struct', + 'description' => '元信息。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '元信息字段', + 'description' => '元信息字段。', + 'type' => 'string', + 'example' => 'topic', + ], + 'virtual' => [ + 'title' => '是否仅可读', + 'description' => '是否仅可读。', + 'type' => 'boolean', + ], + ], + ], + 'Node' => [ + 'title' => 'A short description of struct', + 'description' => '血缘节点信息。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '节点id', + 'description' => '节点id。', + 'type' => 'string', + 'example' => '97383', + ], + 'catalogName' => [ + 'title' => 'catalog名称', + 'description' => 'catalog名称。', + 'type' => 'string', + 'example' => 'paimon', + ], + 'databaseName' => [ + 'title' => 'database名称', + 'description' => 'database名称。', + 'type' => 'string', + 'example' => 'paimon-ods', + ], + 'isTemporary' => [ + 'title' => '是否为临时表', + 'description' => '是否为临时表。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'connector' => [ + 'title' => '连接器', + 'description' => '连接器名称。', + 'type' => 'string', + 'example' => 'paimon', + ], + 'tables' => [ + 'title' => '表', + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表详情。', + '$ref' => '#/components/schemas/LineageTable', + ], + ], + ], + ], + 'NodeExecutionContextDTO' => [ + 'type' => 'object', + 'properties' => [ + 'context' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'NodeExecutionStatusDTO' => [ + 'type' => 'object', + 'properties' => [ + 'executionId' => [ + 'type' => 'string', + ], + 'workspace' => [ + 'type' => 'string', + ], + 'resourceId' => [ + 'type' => 'string', + ], + 'namespace' => [ + 'type' => 'string', + ], + 'type' => [ + 'type' => 'string', + ], + 'status' => [ + 'type' => 'string', + ], + ], + ], + 'PeriodicSchedulingPolicy' => [ + 'title' => '定时计划策略', + 'description' => '定时计划策略', + 'type' => 'object', + 'properties' => [ + 'onlyOnceTriggerTime' => [ + 'title' => '单次触发时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723195800000', + ], + 'onlyOnceTriggerTimeIsExpired' => [ + 'title' => '单次触发是否过期', + 'type' => 'boolean', + 'example' => 'true', + ], + 'periodicTriggerTime' => [ + 'title' => '周期触发时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723199340000', + ], + 'periodicSchedulingLevel' => [ + 'title' => '触发周期', + 'type' => 'string', + 'example' => 'DAY', + ], + 'periodicSchedulingValues' => [ + 'title' => '周期触发值', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + 'isFinished' => [ + 'title' => '单次触发是否完成', + 'type' => 'boolean', + ], + 'resourceSetting' => [ + 'title' => '作业资源设置', + '$ref' => '#/components/schemas/BriefResourceSetting', + ], + ], + ], + 'PrimaryKey' => [ + 'title' => 'A short description of struct', + 'description' => '表主键。', + 'type' => 'object', + 'properties' => [ + 'constraintName' => [ + 'title' => '约束名', + 'description' => '约束名。', + 'type' => 'string', + 'required' => true, + 'example' => 'pk', + ], + 'columns' => [ + 'title' => '列', + 'description' => '主键列组。', + 'type' => 'array', + 'items' => [ + 'description' => '列名称。', + 'type' => 'string', + 'example' => 'id', + ], + 'required' => true, + ], + 'constraintType' => [ + 'title' => 'CONSTRAINT_TYPE_INVALID;'."\n" + .'CONSTRAINT_TYPE_PRIMARY_KEY;'."\n" + .'CONSTRAINT_TYPE_UNIQUE;', + 'description' => 'CONSTRAINT_TYPE_INVALID;'."\n" + .'CONSTRAINT_TYPE_PRIMARY_KEY;'."\n" + .'CONSTRAINT_TYPE_UNIQUE;', + 'type' => 'string', + 'required' => true, + ], + 'enforced' => [ + 'type' => 'boolean', + 'required' => true, + ], + ], + 'required' => false, + ], + 'Property' => [ + 'title' => 'A short description of struct', + 'description' => 'connector配置信息。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key', + 'description' => '参数键名称。', + 'type' => 'string', + 'example' => 'username', + ], + 'defaultValue' => [ + 'title' => '默认值', + 'description' => '参数默认值。', + 'type' => 'string', + 'example' => 'userA', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'example' => '用户名', + ], + 'required' => [ + 'title' => '是否必填', + 'description' => '是否必填参数。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'definesFormat' => [ + 'title' => '是否定义格式', + 'description' => '是否定义格式。', + 'type' => 'boolean', + 'example' => 'flase', + ], + 'sensitive' => [ + 'title' => '是否为敏感数据', + 'description' => '是否为敏感数据。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'PythonArtifact' => [ + 'title' => 'python作业结构', + 'description' => '本数据结构代表Python类型作业必填的信息。', + 'type' => 'object', + 'properties' => [ + 'pythonArtifactUri' => [ + 'title' => 'python作业URL全路径', + 'description' => 'Python类型作业URL全路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/test.py', + ], + 'mainArgs' => [ + 'title' => '启动参数', + 'description' => '启动参数。', + 'type' => 'string', + 'example' => 'start from main', + ], + 'entryModule' => [ + 'title' => 'python的启动模块', + 'description' => 'Python的启动模块。', + 'type' => 'string', + 'example' => 'test.py', + ], + 'additionalDependencies' => [ + 'title' => '其他附件依赖文件URL路径', + 'description' => '其他附件依赖文件URL路径。', + 'type' => 'array', + 'items' => [ + 'description' => '依赖文件URL路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/addition.py', + ], + ], + 'additionalPythonLibraries' => [ + 'title' => '依赖的python lib文件URL路径', + 'description' => '依赖的Python lib文件。', + 'type' => 'array', + 'items' => [ + 'description' => 'Python lib文件的URL路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/additionlib.py', + ], + ], + 'additionalPythonArchives' => [ + 'title' => '依赖的python archives文件URL路径', + 'description' => '依赖的Python archives文件。', + 'type' => 'array', + 'items' => [ + 'description' => 'Python archive文件的URL路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/additionArchives.zip', + ], + ], + ], + ], + 'Relation' => [ + 'title' => 'A short description of struct', + 'description' => '血缘信息。', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'title' => '源', + 'description' => '源表信息。', + 'type' => 'string', + 'example' => 'TableA', + ], + 'destination' => [ + 'title' => '目标', + 'description' => '目标表信息。', + 'type' => 'string', + 'example' => 'TableB', + ], + 'jobId' => [ + 'title' => '作业id', + 'description' => '作业实例id。', + 'type' => 'string', + 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****', + ], + ], + ], + 'RescaleJobParam' => [ + 'title' => 'A short description of struct', + 'description' => '动态更新作业资源配置。', + 'type' => 'object', + 'properties' => [ + 'jobParallelism' => [ + 'title' => '并行度', + 'description' => '并行度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'Resource' => [ + 'type' => 'object', + 'properties' => [ + 'fixedResource' => [ + 'title' => '固定资源。', + 'required' => true, + '$ref' => '#/components/schemas/ResourceSpec', + ], + 'elasticResource' => [ + '$ref' => '#/components/schemas/ResourceSpec', + ], + ], + 'required' => true, + ], + 'ResourceQuota' => [ + 'title' => '资源配额', + 'description' => '资源配额', + 'type' => 'object', + 'properties' => [ + 'limit' => [ + 'title' => '已分配资源', + '$ref' => '#/components/schemas/ResourceSpec', + ], + 'used' => [ + 'title' => '已使用资源', + '$ref' => '#/components/schemas/ResourceSpec', + ], + 'request' => [ + 'title' => '保障资源', + '$ref' => '#/components/schemas/ResourceSpec', + ], + ], + ], + 'ResourceSpec' => [ + 'title' => '资源规范', + 'description' => '资源规范', + 'type' => 'object', + 'properties' => [ + 'cpu' => [ + 'title' => 'cpu大小', + 'description' => 'cpu大小', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'memory' => [ + 'title' => 'memory大小', + 'description' => 'memory大小', + 'type' => 'string', + 'example' => '4Gi', + ], + ], + ], + 'Row' => [ + 'type' => 'object', + 'properties' => [ + 'cells' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/Cell', + ], + ], + ], + ], + 'RowUpdate' => [ + 'type' => 'object', + 'properties' => [ + 'rowKind' => [ + 'type' => 'string', + ], + 'row' => [ + '$ref' => '#/components/schemas/Row', + ], + ], + ], + 'Savepoint' => [ + 'title' => '作业快照信息', + 'description' => '本数据结构代表作业快照相关信息。', + 'type' => 'object', + 'properties' => [ + 'savepointId' => [ + 'title' => '作业快照ID', + 'description' => '作业快照ID。', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + ], + 'deploymentId' => [ + 'title' => '作业ID', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'example' => '1d716b22-6aad-4be2-85c2-50cfc757****', + ], + 'jobId' => [ + 'title' => '实例ID', + 'description' => '作业实例ID。', + 'type' => 'string', + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + 'namespace' => [ + 'title' => '项目空间名称', + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'namespacetest', + ], + 'savepointOrigin' => [ + 'title' => '作业快照生成方式', + 'description' => '作业快照生成方式。'."\n" + .'- `USER_REQUEST`：用户手动生成。'."\n" + .'- `STOP_WITH_SAVEPOINT`：停止作业生成。'."\n" + .'- `RETAINED_CHECKPOINT`：返回的系统检查点。', + 'type' => 'string', + 'example' => 'USER_REQUEST', + 'enum' => [ + 'USER_REQUEST', + 'STOP_WITH_SAVEPOINT', + 'RETAINED_CHECKPOINT', + 'AUTO_TRIGGERED', + ], + ], + 'nativeFormat' => [ + 'title' => '作业快照是否原生模式', + 'description' => '作业快照是否原生模式。', + 'type' => 'boolean', + 'example' => 'TRUE', + ], + 'description' => [ + 'title' => '作业快照描述', + 'description' => '作业快照描述。', + 'type' => 'string', + 'example' => '作业快照1', + ], + 'stopWithDrainEnabled' => [ + 'title' => '是否使用stop-with-drain模式', + 'description' => '是否使用stop-with-drain模式。', + 'type' => 'boolean', + 'example' => 'TRUE', + ], + 'savepointLocation' => [ + 'title' => '作业快照存储路径', + 'description' => '作业快照存储路径。', + 'type' => 'string', + 'example' => 'https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285', + ], + 'status' => [ + 'title' => '作业快照状态', + 'description' => '作业快照状态。', + '$ref' => '#/components/schemas/SavepointStatus', + ], + 'createdAt' => [ + 'title' => 'savepoint创建时间', + 'description' => '作业快照创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659066711', + ], + 'modifiedAt' => [ + 'title' => 'savepoint最新修改时间', + 'description' => '作业快照最新修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659069473', + ], + ], + ], + 'SavepointFailure' => [ + 'title' => '作业快照失败详情', + 'description' => '本数据结构代表作业快照失败的相关信息。', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '失败信息', + 'description' => '失败信息。', + 'type' => 'string', + 'example' => 'create savepoint failed', + ], + 'reason' => [ + 'title' => '失败原因', + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'IO Exception', + ], + 'failedAt' => [ + 'title' => '失败时间点', + 'description' => '失败时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655006835', + ], + ], + ], + 'SavepointStatus' => [ + 'title' => '作业快照状态信息', + 'description' => '本数据结构代表作业快照的状态信息。', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'title' => '作业快照状态', + 'description' => '作业快照状态。'."\n" + .'- STARTED：生成中。'."\n" + .'- COMPLETED：已完成。'."\n" + .'- FAILED：已失败。', + 'type' => 'string', + 'example' => 'COMPLETED', + 'enum' => [ + 'STARTED', + 'COMPLETED', + 'FAILED', + ], + ], + 'failure' => [ + 'title' => '作业快照失败详情', + 'description' => '作业快照失败详情。', + '$ref' => '#/components/schemas/SavepointFailure', + ], + ], + ], + 'ScheduledPlan' => [ + 'title' => '定时计划', + 'description' => '定时计划策略', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => '工作空间ID', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'namespace' => [ + 'title' => '项目空间ID', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'type' => 'string', + 'example' => '1723197248', + ], + 'creator' => [ + 'title' => '创建者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'creatorName' => [ + 'title' => '创建者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifier' => [ + 'title' => '修改者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'type' => 'string', + 'example' => '1723197248', + ], + 'scheduledPlanId' => [ + 'title' => '定时计划ID', + 'type' => 'string', + 'example' => 'f3b4ec1e-85dc-4b1d-9726-1d7f4c37****', + ], + 'name' => [ + 'title' => '定时计划名称', + 'type' => 'string', + 'example' => 'test-scheduled-plan', + ], + 'deploymentId' => [ + 'title' => '作业实例ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000000001', + ], + 'updatedByUser' => [ + 'title' => '是否由用户更新', + 'type' => 'boolean', + 'example' => 'true', + ], + 'origin' => [ + 'title' => '定时计划来源', + 'type' => 'string', + 'example' => 'USER_DEFINED', + ], + 'periodicSchedulingPolicies' => [ + 'title' => '周期执行策略', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PeriodicSchedulingPolicy', + ], + ], + 'status' => [ + 'title' => '定时计划状态', + 'type' => 'string', + 'example' => 'FINISHED', + ], + ], + ], + 'ScheduledPlanAppliedInfo' => [ + 'title' => '定时计划应用信息', + 'description' => '定时计划执行信息', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => '工作空间ID', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'namespace' => [ + 'title' => '项目空间ID', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'modifier' => [ + 'title' => '修改者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'type' => 'string', + 'example' => '1723197248', + ], + 'scheduledPlanId' => [ + 'title' => '定时计划ID', + 'type' => 'string', + 'example' => 'f3b4ec1e-85dc-4b1d-9726-1d7f4c37****', + ], + 'scheduledPlanName' => [ + 'title' => '定时计划名称', + 'type' => 'string', + 'example' => 'test-scheduled-plan', + ], + 'deploymentId' => [ + 'title' => '作业ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000000001', + ], + 'expectedState' => [ + 'title' => '期望状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'statusState' => [ + 'title' => '实际状态', + 'type' => 'string', + 'example' => 'WAITING', + ], + ], + ], + 'ScheduledPlanExecutedInfo' => [ + 'title' => '作业资源变更信息', + 'description' => '作业执行信息', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => '工作空间ID', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'namespace' => [ + 'title' => '项目空间ID', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'type' => 'string', + 'example' => '1723197248', + ], + 'creator' => [ + 'title' => '创建者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'creatorName' => [ + 'title' => '创建者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifier' => [ + 'title' => '修改者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'type' => 'string', + 'example' => '1723197248', + ], + 'jobResourceUpgradingId' => [ + 'title' => '执行ID', + 'type' => 'string', + 'example' => '0e6d3bab-2277-4ed1-b573-9de6413d****', + ], + 'name' => [ + 'title' => '执行名称', + 'type' => 'string', + 'example' => 'test-scheduled-plan', + ], + 'origin' => [ + 'title' => '执行来源', + 'type' => 'string', + 'example' => 'SCHEDULED_PLAN', + ], + 'deploymentId' => [ + 'title' => '作业ID', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-000000000001', + ], + 'originJobId' => [ + 'title' => '作业实例ID', + 'type' => 'string', + 'example' => 'f8a2d5d9-9fc5-4273-bfcc-2a3cd354****', + ], + 'status' => [ + 'title' => '作业资源变更状态', + '$ref' => '#/components/schemas/ScheduledPlanExecutedStatus', + ], + ], + ], + 'ScheduledPlanExecutedStatus' => [ + 'title' => '定时计划执行状态', + 'description' => '定时计划执行状态', + 'type' => 'object', + 'properties' => [ + 'statusState' => [ + 'title' => '当前状态', + 'type' => 'string', + 'example' => 'UPGRADED', + ], + 'restartType' => [ + 'title' => '重启类型', + 'type' => 'string', + 'example' => 'HOT_UPDATE', + ], + ], + ], + 'Schema' => [ + 'title' => 'A short description of struct', + 'description' => '表schema信息。', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'title' => '列信息', + 'description' => '列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '表字段信息。', + '$ref' => '#/components/schemas/TableColumn', + ], + ], + 'watermarkSpecs' => [ + 'title' => 'watermark信息', + 'description' => 'watermark信息。', + 'type' => 'array', + 'items' => [ + 'description' => '水印信息。', + '$ref' => '#/components/schemas/WatermarkSpec', + ], + ], + 'primaryKey' => [ + 'description' => '主键信息。', + '$ref' => '#/components/schemas/PrimaryKey', + ], + ], + ], + 'SessionCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'SessionCluster', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => '工作空间', + 'type' => 'string', + 'example' => 'edcef******b4f', + ], + 'namespace' => [ + 'title' => '项目空间', + 'type' => 'string', + 'example' => 'default-namespace', + ], + 'creator' => [ + 'title' => '创建者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'creatorName' => [ + 'title' => '创建者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'modifier' => [ + 'title' => '修改者', + 'type' => 'string', + 'example' => '27846363877456****', + ], + 'modifierName' => [ + 'title' => '修改者名称', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'sessionClusterId' => [ + 'title' => 'session集群ID', + 'type' => 'string', + 'example' => '1f68a52c-1760-43c6-97fb-afe0674b****', + ], + 'name' => [ + 'title' => 'session集群名称', + 'type' => 'string', + 'example' => 'test-sessionCluster', + ], + 'deploymentTargetName' => [ + 'title' => '部署目标', + 'type' => 'string', + 'example' => 'default-queue', + ], + 'engineVersion' => [ + 'title' => '引擎版本', + 'type' => 'string', + 'example' => 'vvr-6.0.7-flink-1.15', + ], + 'labels' => [ + 'title' => '作业标签', + 'type' => 'object', + ], + 'basicResourceSetting' => [ + 'title' => '资源设置', + '$ref' => '#/components/schemas/BasicResourceSetting', + ], + 'flinkConf' => [ + 'title' => 'Flink配置', + 'type' => 'object', + 'example' => '{"taskmanager.numberOfTaskSlots":"1"}', + ], + 'logging' => [ + 'title' => '日志配置', + '$ref' => '#/components/schemas/Logging', + ], + 'status' => [ + 'title' => 'session集群状态信息', + '$ref' => '#/components/schemas/SessionClusterStatus', + ], + ], + ], + 'SessionClusterFailureInfo' => [ + 'title' => 'session集群失败信息', + 'description' => 'session集群失败信息', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '失败信息', + 'type' => 'string', + ], + 'reason' => [ + 'title' => '失败原因', + 'type' => 'string', + ], + 'failedAt' => [ + 'title' => '失败时间', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'SessionClusterRunningInfo' => [ + 'title' => 'session集群运行信息', + 'description' => 'session集群运行信息', + 'type' => 'object', + 'properties' => [ + 'startedAt' => [ + 'title' => '启动时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'lastUpdateTime' => [ + 'title' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'referenceDeploymentIds' => [ + 'title' => '运行在session集群上的部署作业id', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'SessionClusterStatus' => [ + 'title' => 'session集群状态信息', + 'description' => 'session集群状态信息', + 'type' => 'object', + 'properties' => [ + 'currentSessionClusterStatus' => [ + 'title' => 'session集群当前状态', + 'type' => 'string', + 'enum' => [ + 'STOPPED', + 'STARTING', + 'RUNNING', + 'UPDATING', + 'STOPPING', + 'FAILED', + ], + ], + 'failure' => [ + 'title' => 'session集群失败信息', + '$ref' => '#/components/schemas/SessionClusterFailureInfo', + ], + 'running' => [ + 'title' => 'session集群运行信息', + '$ref' => '#/components/schemas/SessionClusterRunningInfo', + ], + ], + ], + 'SqlArtifact' => [ + 'title' => 'SQL作业结构', + 'description' => '本数据结构代表SQL类型作业必填的信息。', + 'type' => 'object', + 'properties' => [ + 'sqlScript' => [ + 'title' => 'SQL作业文本内容', + 'description' => 'SQL作业文本内容。', + 'type' => 'string', + 'example' => 'CREATE TEMPORARY TABLE datagen_source( name VARCHAR ) WITH ( \'connector\' = \'datagen\' ); CREATE TEMPORARY TABLE blackhole_sink( name VARCHAR ) with ( \'connector\' = \'blackhole\' ); INSERT INTO blackhole_sink SELECT name from datagen_source;', + ], + 'additionalDependencies' => [ + 'title' => '附加文件URL全路径地址，如果您要是用未在VVP平台上注册的UDF/Connector/Format等依赖时，需要使用该方式添加，已注册的内容不需要使用本方式关联', + 'description' => '附加依赖文件，如果您要是用未在VVP平台上注册的UDF/Connector/Format等依赖时，需要使用该方式添加，已注册的内容不需要使用本方式关联。', + 'type' => 'array', + 'items' => [ + 'description' => '附加依赖文件的URL地址。', + 'type' => 'string', + 'example' => 'https://oss/bucket/addition.jar', + ], + ], + ], + ], + 'SqlStatementExecuteResult' => [ + 'title' => 'A short description of struct', + 'description' => 'sql statement执行返回结果。', + 'type' => 'object', + 'properties' => [ + 'executeSuccess' => [ + 'title' => '是否执行成功', + 'description' => '是否执行成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorDetails' => [ + 'description' => '执行错误信息。', + '$ref' => '#/components/schemas/ErrorDetails', + ], + 'statement' => [ + 'title' => '执行语句', + 'description' => '执行语句。', + 'type' => 'string', + 'example' => '“show create table order”', + ], + ], + ], + 'SqlStatementValidationResult' => [ + 'title' => 'Sql作业代码校验结果', + 'description' => 'Sql作业代码校验结果。', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'title' => '校验是否通过', + 'description' => '校验是否通过。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'message' => [ + 'title' => '校验信息', + 'description' => '校验信息。', + 'type' => 'string', + 'example' => '“”', + ], + 'validationResult' => [ + 'title' => '校验结果', + 'description' => '校验结果。', + 'type' => 'string', + 'example' => 'VALIDATION_RESULT_INVALID', + 'enum' => [ + 'VALIDATION_RESULT_INVALID', + 'VALIDATION_RESULT_INVALID_QUERY', + 'VALIDATION_RESULT_UNSUPPORTED_QUERY', + 'VALIDATION_RESULT_INVALID_CONNECTOR_CONFIG', + 'VALIDATION_RESULT_VALID_INSERT_QUERY', + 'VALIDATION_RESULT_VALID_SELECT_QUERY', + 'VALIDATION_RESULT_VALID_DDL_STATEMENT', + 'VALIDATION_RESULT_VALID_COMMAND_STATEMENT', + 'VALIDATION_RESULT_INVALID_FLINK_CONFIG', + ], + ], + 'errorDetails' => [ + 'title' => '校验错误信息', + 'description' => '校验错误信息。', + '$ref' => '#/components/schemas/ErrorDetails', + ], + ], + ], + 'SqlStatementWithContext' => [ + 'title' => '作业代码相关信息', + 'description' => '作业代码内容', + 'type' => 'object', + 'properties' => [ + 'statement' => [ + 'title' => '代码内容', + 'description' => '代码内容', + 'type' => 'string', + 'required' => true, + 'example' => 'CREATE TEMPORARY TABLE datagen_source ('."\n" + .' name VARCHAR,'."\n" + .' score BIGINT'."\n" + .') WITH ('."\n" + .' \'connector\' = \'datagen\''."\n" + .');', + ], + 'flinkConfiguration' => [ + 'title' => 'Flink配置', + 'description' => 'Flink配置', + 'type' => 'object', + ], + 'batchMode' => [ + 'title' => '是否为批作业', + 'description' => '是否为批作业', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + 'versionName' => [ + 'title' => '引擎版本', + 'description' => '引擎版本', + 'type' => 'string', + 'example' => 'vvr-8.0.6-flink-1.17', + ], + 'additionalDependencies' => [ + 'title' => '附加依赖', + 'description' => '附加依赖', + 'type' => 'array', + 'items' => [ + 'description' => '附加依赖文件的URL地址。', + 'type' => 'string', + 'example' => '"oss://xxx"', + ], + ], + ], + ], + 'StartJobRequestBody' => [ + 'title' => '作业启动结构体', + 'description' => '本数据结构代表作业启动的相关信息。', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '作业ID', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'example' => '5a19a71b-1c42-4f34-94fd-86cf6078****', + ], + 'resourceSettingSpec' => [ + 'title' => '作业资源设置', + 'description' => '作业资源设置。', + '$ref' => '#/components/schemas/BriefResourceSetting', + ], + 'restoreStrategy' => [ + 'title' => '作业启动位点设置', + 'description' => '作业实例启动位点设置。', + '$ref' => '#/components/schemas/DeploymentRestoreStrategy', + ], + ], + ], + 'StopJobRequestBody' => [ + 'title' => '作业停止结构', + 'description' => '本数据结构代表停止作业的请求信息。', + 'type' => 'object', + 'properties' => [ + 'stopStrategy' => [ + 'title' => '作业停止策略', + 'description' => '作业停止策略。'."\n" + .'- `NONE`：直接停止。'."\n" + .'- `STOP_WITH_SAVEPOINT`：生成作业快照后停止。'."\n" + .'- `STOP_WITH_DRAIN`：以drain的方式停止。', + 'type' => 'string', + 'required' => true, + 'example' => 'NONE', + 'enum' => [ + 'NONE', + 'STOP_WITH_SAVEPOINT', + 'STOP_WITH_DRAIN', + ], + ], + ], + ], + 'StreamingResourceSetting' => [ + 'title' => '流作业资源设置', + 'description' => '本数据结构代表作业运行流模式时的资源设置。', + 'type' => 'object', + 'properties' => [ + 'resourceSettingMode' => [ + 'title' => '流作业资源模式', + 'description' => '流模式使用的资源模式。'."\n" + .'- EXPERT：专家模式。'."\n" + .'- BASIC：基础模式。'."\n", + 'type' => 'string', + 'example' => 'EXPERT', + 'enum' => [ + 'BASIC', + 'EXPERT', + ], + ], + 'expertResourceSetting' => [ + 'title' => '细粒度资源设置', + 'description' => '专家模式资源设置。', + '$ref' => '#/components/schemas/ExpertResourceSetting', + ], + 'basicResourceSetting' => [ + 'title' => '基础资源设置', + 'description' => '基础模式资源设置。', + '$ref' => '#/components/schemas/BasicResourceSetting', + ], + ], + ], + 'SubFolder' => [ + 'title' => 'A short description of struct', + 'description' => '作业草稿子文件夹信息。', + 'type' => 'object', + 'properties' => [ + 'folderId' => [ + 'title' => '文件夹id', + 'description' => '文件夹id。', + 'type' => 'string', + 'example' => 'a579aec9-1d5e-3382-9d65-9887ff6cfaff', + ], + 'parentId' => [ + 'title' => '父级文件夹id', + 'description' => '父级文件夹id。', + 'type' => 'string', + 'example' => '95c0787c-408f-4e1f-88ba-ef0a84a2c2ee', + ], + 'name' => [ + 'title' => '文件夹名称', + 'description' => '文件夹名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'SubmitPreview' => [ + 'type' => 'object', + 'properties' => [ + 'queryName' => [ + 'title' => '查询id', + 'type' => 'string', + ], + 'sessionId' => [ + 'title' => 'session id', + 'type' => 'string', + ], + 'tableSchemas' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/TableSchema', + ], + ], + ], + ], + 'SubmitPreviewResult' => [ + 'type' => 'object', + 'properties' => [ + 'queryId' => [ + 'title' => '查询id', + 'type' => 'string', + ], + 'sessionId' => [ + 'title' => 'session id', + 'type' => 'string', + ], + 'tableSchemas' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/TableSchema', + ], + ], + ], + ], + 'Table' => [ + 'title' => 'A short description of struct', + 'description' => '表信息。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '表名', + 'description' => '表名。', + 'type' => 'string', + 'required' => true, + 'example' => 'order-test', + ], + 'schema' => [ + 'title' => '表schema信息', + 'description' => '表schema信息。', + 'required' => false, + '$ref' => '#/components/schemas/Schema', + ], + 'properties' => [ + 'title' => '配置', + 'description' => '表参数配置。', + 'type' => 'object', + ], + 'comment' => [ + 'title' => '备注', + 'description' => '备注。', + 'type' => 'string', + 'example' => '测试订单表', + ], + 'partitionKeys' => [ + 'title' => '分区键', + 'description' => '分区键。', + 'type' => 'array', + 'items' => [ + 'description' => '分区字段。', + 'type' => 'string', + 'example' => 'ad=xxxxx', + ], + ], + 'tableType' => [ + 'title' => ' TABLE;'."\n" + .' MATERIALIZED_TABLE;'."\n" + .' VIEW;', + 'description' => ' TABLE;'."\n" + .' MATERIALIZED_TABLE;'."\n" + .' VIEW;', + 'type' => 'string', + 'required' => true, + ], + 'metadata' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TableColumn' => [ + 'title' => 'A short description of struct', + 'description' => '列信息。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '列名', + 'description' => '列名。', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + 'metadataInfo' => [ + 'title' => '元信息', + 'description' => '元信息。', + '$ref' => '#/components/schemas/MetadataInfo', + ], + 'expression' => [ + 'title' => '表达式', + 'description' => '计算列。', + 'type' => 'string', + 'example' => '“”', + ], + 'type' => [ + 'title' => '字段类型', + 'description' => '字段类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'nullable' => [ + 'title' => '是否可为空', + 'description' => '是否可为空。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'logicalType' => [ + 'type' => 'string', + ], + ], + ], + 'TableMeta' => [ + 'title' => 'A short description of struct', + 'description' => 'Table元信息。', + 'type' => 'object', + 'properties' => [ + 'catalogName' => [ + 'title' => 'catalog名称', + 'description' => 'catalog名称。', + 'type' => 'string', + 'example' => 'paimon', + ], + 'databaseName' => [ + 'title' => 'database名称', + 'description' => 'database名称。', + 'type' => 'string', + 'example' => 'paimon-ods', + ], + 'tableName' => [ + 'title' => 'table名称', + 'description' => 'table名称。', + 'type' => 'string', + 'example' => 'order-table', + ], + ], + ], + 'TableResult' => [ + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'type' => 'string', + ], + 'rowUpdates' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/RowUpdate', + ], + ], + ], + ], + 'TableSchema' => [ + 'type' => 'object', + 'properties' => [ + 'tableName' => [ + 'type' => 'string', + ], + 'schema' => [ + '$ref' => '#/components/schemas/Schema', + ], + ], + ], + 'UdfArtifact' => [ + 'title' => 'A short description of struct', + 'description' => 'udfArtifact数据结构。', + 'type' => 'object', + 'properties' => [ + 'namespace' => [ + 'title' => '项目空间', + 'description' => '项目空间。', + 'type' => 'string', + 'example' => 'default-namespace'."\n", + ], + 'creator' => [ + 'title' => '创建者', + 'description' => '创建者。', + 'type' => 'string', + 'example' => 'userA', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723532876', + ], + 'modifiedAt' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537876', + ], + 'name' => [ + 'title' => 'udfArtifact名称', + 'description' => 'udfArtifact名称。', + 'type' => 'string', + 'example' => 'udfCollection.jar'."\n", + ], + 'jarUrl' => [ + 'title' => 'udfArtifact url', + 'description' => 'udfArtifact存储路径。', + 'type' => 'string', + 'example' => 'oss://bucket/udfCollection.jar'."\n", + ], + 'dependencyJarUris' => [ + 'title' => 'udfArtifact依赖url', + 'description' => 'udfArtifact附加依赖存储路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'udfArtifact附加依赖存储路径。', + 'type' => 'string', + 'example' => 'oss://bucket/addition/add.jar'."\n", + ], + ], + 'artifactType' => [ + 'title' => 'udfArtifact类型', + 'description' => 'udfArtifact类型。', + 'type' => 'string', + 'example' => 'ARTIFACT_TYPE_JAVA', + 'enum' => [ + 'ARTIFACT_TYPE_JAVA', + 'ARTIFACT_TYPE_PYTHON', + 'ARTIFACT_TYPE_UNKNOWN', + ], + ], + 'udfClasses' => [ + 'title' => 'udfArtifact类', + 'description' => 'udfArtifact类名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'udf类名称。', + '$ref' => '#/components/schemas/UdfClass', + ], + ], + ], + ], + 'UdfClass' => [ + 'title' => 'A short description of struct', + 'description' => 'udf类信息。', + 'type' => 'object', + 'properties' => [ + 'udfArtifactName' => [ + 'title' => 'udfArtifact名称', + 'description' => 'udfArtifact名称。', + 'type' => 'string', + 'example' => 'udfCollection.jar', + ], + 'className' => [ + 'title' => 'class名称', + 'description' => 'class名称。', + 'type' => 'string', + 'example' => 'myfunctionTest', + ], + 'classType' => [ + 'title' => 'class类型', + 'description' => 'class类型。', + 'type' => 'string', + 'example' => 'UDF_TYPE_TABLE_AGGREGATE', + 'enum' => [ + 'UDF_TYPE_INVALID', + 'UDF_TYPE_SCALAR', + 'UDF_TYPE_TABLE', + 'UDF_TYPE_AGGREGATE', + 'UDF_TYPE_TABLE_AGGREGATE', + 'UDF_TYPE_OTHER', + ], + ], + 'functionNames' => [ + 'title' => '函数名', + 'description' => '函数名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '函数名。', + 'type' => 'string', + 'example' => 'myfunction', + ], + ], + ], + ], + 'UdfFunction' => [ + 'title' => 'A short description of struct', + 'description' => 'udf函数。', + 'type' => 'object', + 'properties' => [ + 'functionName' => [ + 'title' => '函数名称', + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'myFunction', + ], + 'udfArtifactName' => [ + 'title' => 'udfArtifact名称', + 'description' => 'udfArtifact名称', + 'type' => 'string', + 'example' => 'udfCollection.jar', + ], + 'className' => [ + 'title' => 'class名称', + 'description' => 'class名称', + 'type' => 'string', + 'example' => 'myFunctionTest', + ], + ], + ], + 'UpdateJobConfigParam' => [ + 'title' => 'A short description of struct', + 'description' => '动态更新作业运行参数配置。', + 'type' => 'object', + 'properties' => [ + 'newFlinkConf' => [ + 'title' => '作业参数配置', + 'description' => '作业参数配置。', + 'type' => 'object', + 'example' => '{"table.exec.parallelism：4"}', + ], + ], + ], + 'UpdateUdfArtifactResult' => [ + 'title' => 'A short description of struct', + 'description' => '更新UdfArtifact返回数据', + 'type' => 'object', + 'properties' => [ + 'updateSuccess' => [ + 'title' => '更新是否成功', + 'type' => 'boolean', + ], + 'udfArtifact' => [ + 'title' => '更新的udfArtifact', + '$ref' => '#/components/schemas/UdfArtifact', + ], + 'message' => [ + 'title' => '更新信息', + 'type' => 'string', + ], + 'collidingClasses' => [ + 'title' => '存在冲突的class', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/UdfClass', + ], + ], + 'missingClasses' => [ + 'title' => '存在缺失的calss', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/UdfClass', + ], + ], + ], + ], + 'ValidateStatementResult' => [ + 'title' => 'A short description of struct', + 'description' => 'SQL校验结果。', + 'type' => 'object', + 'properties' => [ + 'validationResult' => [ + 'title' => '校验结果', + 'description' => '校验结果。', + 'type' => 'string', + 'example' => '"there have some errors""', + ], + 'errorDetails' => [ + 'description' => 'SQL校验错误详情。', + '$ref' => '#/components/schemas/ValidationErrorDetails', + ], + ], + ], + 'ValidationErrorDetails' => [ + 'title' => 'A short description of struct', + 'description' => 'SQL校验结果错误详情。', + 'type' => 'object', + 'properties' => [ + 'lineNumber' => [ + 'title' => '错误开始行数', + 'description' => '错误开始行数。', + 'type' => 'string', + 'example' => '3', + ], + 'columnNumber' => [ + 'title' => '错误开始列数', + 'description' => '错误开始列数。', + 'type' => 'string', + 'example' => '10', + ], + 'endLineNumber' => [ + 'title' => '错误结束行数', + 'description' => '错误结束行数。', + 'type' => 'string', + 'example' => '4', + ], + 'endColumnNumber' => [ + 'title' => '错误结束列数', + 'description' => '错误结束列数。', + 'type' => 'string', + 'example' => '5', + ], + 'message' => [ + 'title' => '错误信息', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '“”', + ], + ], + ], + 'Variable' => [ + 'title' => '变量替换结构', + 'description' => '本数据结构代表变量配置设置的信息。', + 'type' => 'object', + 'properties' => [ + 'kind' => [ + 'title' => '变量类型', + 'description' => '变量类型。明文类型为Clear，密文类型为Encrypted或者Plain', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Plain' => 'Plain', + 'Encrypted' => 'Encrypted', + 'Clear' => 'Clear', + ], + 'example' => 'Encrypted', + 'enum' => [ + 'Plain', + ], + ], + 'name' => [ + 'title' => '变量名称', + 'description' => '变量名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysqlPassword', + 'pattern' => '^[a-zA-Z0-9_-]{1,64}$', + ], + 'value' => [ + 'title' => '变量值', + 'description' => '变量值。', + 'type' => 'string', + 'required' => true, + 'example' => 'myPassword', + ], + 'description' => [ + 'title' => '变量描述', + 'description' => '变量描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'WatermarkSpec' => [ + 'title' => 'A short description of struct', + 'description' => 'Watermark信息。', + 'type' => 'object', + 'properties' => [ + 'column' => [ + 'title' => 'event time属性的列', + 'description' => 'event time属性的列。', + 'type' => 'string', + 'example' => 'time', + ], + 'watermarkExpression' => [ + 'title' => 'watermark表达式', + 'description' => 'watermark表达式。', + 'type' => 'string', + 'example' => 'INTERVAL \'5\' SECOND', + ], + 'watermarkType' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateFolder' => [ + 'summary' => '创建文件夹。', + 'path' => '/api/v2/namespaces/{namespace}/folder', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '223021', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '文件夹数据结构。', + 'required' => false, + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '创建文件夹返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '文件夹数据结构。', + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"folderId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-0000012390****\\",\\n \\"name\\": \\"test\\",\\n \\"subFolder\\": [\\n {\\n \\"folderId\\": \\"a579aec9-1d5e-3382-9d65-9887ff6cfaff\\",\\n \\"parentId\\": \\"95c0787c-408f-4e1f-88ba-ef0a84a2c2ee\\",\\n \\"name\\": \\"test\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建文件夹', + ], + 'UpdateFolder' => [ + 'summary' => '调用本API可完成对文件夹信息的更新。', + 'path' => '/api/v2/namespaces/{namespace}/folder/{folderId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '223054', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f89a0c1ca8****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'folderId', + 'in' => 'path', + 'schema' => [ + 'description' => '文件夹ID，可通过GetFolder接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '13803', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '文件夹数据结构。', + 'required' => true, + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '更新文件夹信息。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '更新文件夹后的信息。', + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"folderId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-0000012390****\\",\\n \\"name\\": \\"test\\",\\n \\"subFolder\\": [\\n {\\n \\"folderId\\": \\"a579aec9-1d5e-3382-9d65-9887ff6cfaff\\",\\n \\"parentId\\": \\"95c0787c-408f-4e1f-88ba-ef0a84a2c2ee\\",\\n \\"name\\": \\"test\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n}","type":"json"}]', + 'title' => '更新文件夹', + ], + 'DeleteFolder' => [ + 'summary' => '删除空文件夹，如果该文件夹下存在其他文件或文件夹则无法删除。', + 'path' => '/api/v2/namespaces/{namespace}/folder/{folderId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '223067', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c96306e2b****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'folderId', + 'in' => 'path', + 'schema' => [ + 'description' => '文件夹ID，可通过GetFloder接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '13803', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '删除文件夹', + ], + 'GetFolder' => [ + 'summary' => '获取文件夹的具体信息', + 'path' => '/api/v2/namespaces/{namespace}/folder', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '223029', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'folderId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件夹ID，为空返回根文件夹。', + 'type' => 'string', + 'required' => false, + 'example' => '89097', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '文件夹信息数据结构。', + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"folderId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-0000012390****\\",\\n \\"name\\": \\"test\\",\\n \\"subFolder\\": [\\n {\\n \\"folderId\\": \\"a579aec9-1d5e-3382-9d65-9887ff6cfaff\\",\\n \\"parentId\\": \\"95c0787c-408f-4e1f-88ba-ef0a84a2c2ee\\",\\n \\"name\\": \\"test\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n}","type":"json"}]', + 'title' => '获取文件夹信息', + ], + 'ValidateDeploymentDraftAsync' => [ + 'summary' => '异步进行Flink作业草稿深度检查，进行语法检查、资源配置等合法性检验', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/async-validate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '作业草稿参数对象。', + 'required' => false, + '$ref' => '#/components/schemas/DraftValidateParams', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'ticketId' => [ + 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'description' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'type' => 'string', + 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"ticketId\\": \\"b3dcdb25-bf36-457d-92ba-a36077e8****\\"\\n }\\n}","type":"json"}]', + 'title' => '异步进行作业草稿深度检查', + 'description' => '作业草稿异步进行深度校验接口，用于对尚未提交部署的作业草稿配置进行全链路合规性与兼容性检查。', + ], + 'GetValidateDeploymentDraftResult' => [ + 'summary' => '根据ticketId查询作业草稿深度校验的结果', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/tickets/{ticketId}/async-validate', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'ticketId', + 'in' => 'path', + 'schema' => [ + 'title' => '异步工单ID，可以通过提交异步操作获取。', + 'description' => '异步工单ID，可以通过提交异步操作获取。', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '作业草稿深度检查的执行结果对象', + '$ref' => '#/components/schemas/AsyncDraftValidateResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"ticketStatus\\": \\"\\",\\n \\"success\\": true,\\n \\"message\\": \\"\\",\\n \\"draftValidationDetail\\": {\\n \\"draftMetaInfoErrorDetails\\": [\\n {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\"\\n }\\n ],\\n \\"sqlValidationResult\\": \\"\\",\\n \\"sqlErrorDetail\\": {\\n \\"lineNumber\\": \\"\\",\\n \\"columnNumber\\": \\"\\",\\n \\"endLineNumber\\": \\"\\",\\n \\"endColumnNumber\\": \\"\\",\\n \\"message\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询深度检查结果', + ], + 'CreateDeploymentDraft' => [ + 'summary' => '创建SQL作业的草稿。', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '223181', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '作业草稿数据结构。', + 'required' => true, + '$ref' => '#/components/schemas/DeploymentDraft', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '作业草稿数据结构。', + '$ref' => '#/components/schemas/DeploymentDraft', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deploymentDraftId\\": \\"00000000-0000-0000-0000-00000012****\\",\\n \\"name\\": \\"test-draft\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-00000013****\\",\\n \\"referencedDeploymentId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lock\\": {\\n \\"id\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"holderId\\": \\"\\",\\n \\"holderName\\": \\"\\"\\n },\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n}","type":"json"}]', + 'title' => '创建作业草稿', + ], + 'UpdateDeploymentDraft' => [ + 'summary' => '更新SQL作业草稿。', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '223182', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentDraftId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业草稿ID，可通过ListDeploymentDrafts接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '更新作业草稿信息。', + 'required' => true, + '$ref' => '#/components/schemas/DeploymentDraft', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '返回作业草稿结果。', + '$ref' => '#/components/schemas/DeploymentDraft', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deploymentDraftId\\": \\"00000000-0000-0000-0000-00000012****\\",\\n \\"name\\": \\"test-draft\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-00000013****\\",\\n \\"referencedDeploymentId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lock\\": {\\n \\"id\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"holderId\\": \\"\\",\\n \\"holderName\\": \\"\\"\\n },\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n}","type":"json"}]', + 'title' => '更新作业草稿', + ], + 'DeleteDeploymentDraft' => [ + 'summary' => '删除SQL作业草稿，如该草稿存在已经上线或运行中的部署作业，则无法删除', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '223183', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentDraftId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业草稿ID，可通过ListDeploymentDrafts接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '删除作业草稿', + ], + 'GetDeploymentDraft' => [ + 'summary' => '获取sql作业草稿详情。', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '223184', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentDraftId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业草稿ID，可通过ListDeploymentDrafts接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '作业草稿信息。', + '$ref' => '#/components/schemas/DeploymentDraft', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deploymentDraftId\\": \\"00000000-0000-0000-0000-00000012****\\",\\n \\"name\\": \\"test-draft\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-00000013****\\",\\n \\"referencedDeploymentId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lock\\": {\\n \\"id\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"holderId\\": \\"\\",\\n \\"holderName\\": \\"\\"\\n },\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n}","type":"json"}]', + 'title' => '获取作业草稿详情', + ], + 'ListDeploymentDrafts' => [ + 'summary' => '获取SQL作业草稿的列表信息', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '223185', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，所请求页码的元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业草稿列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '作业草稿详情。', + '$ref' => '#/components/schemas/DeploymentDraft', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 69,\\n \\"data\\": [\\n {\\n \\"deploymentDraftId\\": \\"00000000-0000-0000-0000-00000012****\\",\\n \\"name\\": \\"test-draft\\",\\n \\"parentId\\": \\"00000000-0000-0000-0000-00000013****\\",\\n \\"referencedDeploymentId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lock\\": {\\n \\"id\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"holderId\\": \\"\\",\\n \\"holderName\\": \\"\\"\\n },\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看作业草稿列表', + ], + 'GetDeploymentDraftLock' => [ + 'summary' => '当您调用API编辑作业草稿时，为避免页面操作和API操作互相影响，您需要先获取编辑锁', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/getLock', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '223187', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentDraftId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业草稿ID，可通过ListDeploymentDrafts接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '编辑锁数据结构信息。', + '$ref' => '#/components/schemas/Lock', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"id\\": \\"\\",\\n \\"workspace\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"holderId\\": \\"\\",\\n \\"holderName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取作业草稿编辑锁', + ], + 'DeployDeploymentDraftAsync' => [ + 'summary' => 'SQL作业草稿部署上线', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/async-deploy', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '223188', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '作业草稿及部署阶段信息。', + 'required' => true, + '$ref' => '#/components/schemas/DraftDeployParams', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '当 success 为 true，返回异步操作结果信息。', + 'type' => 'object', + 'properties' => [ + 'ticketId' => [ + 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'description' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'type' => 'string', + 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"ticketId\\": \\"b3dcdb25-bf36-457d-92ba-a36077e8****\\"\\n }\\n}","type":"json"}]', + 'title' => '部署作业草稿', + ], + 'GetDeployDeploymentDraftResult' => [ + 'summary' => '根据作业草稿部署异步工单的ID信息，查看部署的结果', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/tickets/{ticketId}/async-deploy', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '223190', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'ticketId', + 'in' => 'path', + 'schema' => [ + 'title' => '异步工单ID，可以通过提交异步操作获取。', + 'description' => '异步工单ID，可以通过提交异步操作获取。', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务成功与否。如果非空且不是200，那么表示业务处理失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码。'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息。'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '作业草稿部署结果。', + '$ref' => '#/components/schemas/AsyncDraftDeployResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"ticketStatus\\": \\"FINISHED\\",\\n \\"artifactValidationDetail\\": {\\n \\"validationResult\\": \\"\\\\\\"there have some errors\\\\\\"\\\\\\"\\",\\n \\"errorDetails\\": {\\n \\"lineNumber\\": \\"\\",\\n \\"columnNumber\\": \\"\\",\\n \\"endLineNumber\\": \\"\\",\\n \\"endColumnNumber\\": \\"\\",\\n \\"message\\": \\"\\"\\n }\\n },\\n \\"deploymentId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"message\\": \\"\\\\\\"Validation error: SQL validate failed\\\\\\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取作业草稿部署结果', + ], + 'ValidateSqlStatement' => [ + 'summary' => '校验sql作业代码。', + 'path' => '/api/v2/namespaces/{namespace}/sql-statement/validate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206207', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => 'Deployment内容。', + 'description' => '待验证的sql内容。', + 'required' => true, + '$ref' => '#/components/schemas/SqlStatementWithContext', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-****-1D30-8A4F-882ED4DD5E02', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表sql验证结果详情。', + '$ref' => '#/components/schemas/SqlStatementValidationResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-****-1D30-8A4F-882ED4DD5E02\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"success\\": true,\\n \\"message\\": \\"\\",\\n \\"validationResult\\": \\"\\",\\n \\"errorDetails\\": {\\n \\"lineNumber\\": \\"\\",\\n \\"columnNumber\\": \\"\\",\\n \\"endLineNumber\\": \\"\\",\\n \\"endColumnNumber\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"invalidflinkConf\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '验证sql语句', + ], + 'CreateUdfArtifact' => [ + 'summary' => '通过对您上传的Jar/Python包的解析，解析您Jar/Python包中全部的UDF方法并为你创建自定义函数文件。', + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '230166', + 'abilityTreeNodes' => [ + 'FEATUREscOYA64T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '自定义函数资源文件。', + 'required' => true, + '$ref' => '#/components/schemas/UdfArtifact', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '创建自定义函数文件结果。', + '$ref' => '#/components/schemas/CreateUdfArtifactResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"createSuccess\\": true,\\n \\"message\\": \\"\\",\\n \\"udfArtifact\\": {\\n \\"namespace\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"name\\": \\"\\",\\n \\"jarUrl\\": \\"\\",\\n \\"dependencyJarUris\\": [\\n \\"\\"\\n ],\\n \\"artifactType\\": \\"\\",\\n \\"udfClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"collidingClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '创建自定义函数文件', + ], + 'UpdateUdfArtifact' => [ + 'summary' => '对已创建的自定义函数文件进行更新。', + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/{udfArtifactName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '230195', + 'abilityTreeNodes' => [ + 'FEATUREscOYA64T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'path', + 'schema' => [ + 'description' => '已创建的自定义函数文件名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-udf', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '自定义函数文件详情。', + 'required' => true, + '$ref' => '#/components/schemas/UdfArtifact', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '更新自定义函数文件详情。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '自定义函数文件更新结果。', + '$ref' => '#/components/schemas/UpdateUdfArtifactResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"updateSuccess\\": true,\\n \\"udfArtifact\\": {\\n \\"namespace\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"name\\": \\"\\",\\n \\"jarUrl\\": \\"\\",\\n \\"dependencyJarUris\\": [\\n \\"\\"\\n ],\\n \\"artifactType\\": \\"\\",\\n \\"udfClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"message\\": \\"\\",\\n \\"collidingClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"missingClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '更新自定义函数文件', + ], + 'GetUdfArtifacts' => [ + 'summary' => '获取您上传并创建的包含UDF的Jar或者Python文件的详情信息。', + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '230252', + 'abilityTreeNodes' => [ + 'FEATUREscOYA64T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8c34d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => [ + 'description' => 'UDF对应的Jar或者Python文件的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-udf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的UDF的Jar或者Python文件的详情；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义函数资源详情。', + '$ref' => '#/components/schemas/UdfArtifact', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"namespace\\": \\"\\",\\n \\"creator\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"name\\": \\"\\",\\n \\"jarUrl\\": \\"\\",\\n \\"dependencyJarUris\\": [\\n \\"\\"\\n ],\\n \\"artifactType\\": \\"\\",\\n \\"udfClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取自定义函数资源详情', + ], + 'DeleteUdfArtifact' => [ + 'summary' => '删除已经创建的自定义函数资源，删除前需要您先删除该资源下注册的自定义函数', + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/{udfArtifactName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '230197', + 'abilityTreeNodes' => [ + 'FEATUREscOYA64T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'path', + 'schema' => [ + 'description' => '自定义函数文件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'check', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '删除自定义函数文件结果。', + '$ref' => '#/components/schemas/DeleteUdfArtifactResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deleteSuccess\\": true,\\n \\"message\\": \\"\\",\\n \\"referencedClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\",\\n \\"classType\\": \\"\\",\\n \\"functionNames\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '删除自定义函数资源', + ], + 'DeleteUdfFunction' => [ + 'summary' => '删除已注册的自定义函数。', + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/function/{functionName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230205', + 'abilityTreeNodes' => [ + 'FEATUREscOYA64T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => '需删除的自定义函数名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'category', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的自定义函数对应的自定义函数资源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-udf', + ], + ], + [ + 'name' => 'className', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义函数对应的类名。', + 'type' => 'string', + 'required' => true, + 'example' => 'Category', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '删除自定义函数', + ], + 'RegisterUdfFunction' => [ + 'summary' => '通过本API可以选择已创建的自定义函数文件中解析出的自定义函数，选择其中的部分或全部函数进行注册，注册后可在SQL中使用。', + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/function:registerUdfFunction', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230203', + 'abilityTreeNodes' => [ + 'FEATUREscOYA64T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'query', + 'schema' => [ + 'description' => '函数名称，一般与类名称相同，您可以先选择自定义其他名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'orderRank', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义函数对应的Jar或者Python文件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-udf', + ], + ], + [ + 'name' => 'className', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义函数对应的类名。', + 'type' => 'string', + 'required' => true, + 'example' => 'orderRank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '自定义函数信息。', + '$ref' => '#/components/schemas/UdfFunction', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"functionName\\": \\"\\",\\n \\"udfArtifactName\\": \\"\\",\\n \\"className\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '注册自定义函数', + ], + 'ListCustomConnectors' => [ + 'summary' => '获取已注册的自定义连接器的列表信息。', + 'path' => '/api/v2/namespaces/{namespace}/connectors', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230268', + 'abilityTreeNodes' => [ + 'FEATUREsc2PXREJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回项目空间下自定义连接器的列表信息；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义连接器详情。', + '$ref' => '#/components/schemas/Connector', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"source\\": true,\\n \\"sink\\": true,\\n \\"lookup\\": true,\\n \\"properties\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"defaultValue\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"required\\": true,\\n \\"definesFormat\\": true,\\n \\"sensitive\\": true\\n }\\n ],\\n \\"supportedFormats\\": [\\n \\"\\"\\n ],\\n \\"dependencies\\": [\\n \\"\\"\\n ],\\n \\"creator\\": \\"\\",\\n \\"creatorName\\": \\"\\",\\n \\"modifier\\": \\"\\",\\n \\"modifierName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取自定义连接器列表', + ], + 'RegisterCustomConnector' => [ + 'summary' => '在项目空间下注册自定义连接器，注册的自定义连接器可以在SQL中使用。', + 'path' => '/api/v2/namespaces/{namespace}/connectors:register', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230266', + 'abilityTreeNodes' => [ + 'FEATUREsc2PXREJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jarUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义连接器Jar包存放的地址，需要平台可访问该地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://flink/connector/mysql123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义连接器信息。', + '$ref' => '#/components/schemas/Connector', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"source\\": true,\\n \\"sink\\": true,\\n \\"lookup\\": true,\\n \\"properties\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"defaultValue\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"required\\": true,\\n \\"definesFormat\\": true,\\n \\"sensitive\\": true\\n }\\n ],\\n \\"supportedFormats\\": [\\n \\"\\"\\n ],\\n \\"dependencies\\": [\\n \\"\\"\\n ],\\n \\"creator\\": \\"\\",\\n \\"creatorName\\": \\"\\",\\n \\"modifier\\": \\"\\",\\n \\"modifierName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '注册自定义连接器', + ], + 'DeleteCustomConnector' => [ + 'summary' => '删除已经注册的自定义连接器。', + 'path' => '/api/v2/namespaces/{namespace}/connectors/{connectorName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230270', + 'abilityTreeNodes' => [ + 'FEATUREsc2PXREJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-flink-bigdata-default', + ], + ], + [ + 'name' => 'connectorName', + 'in' => 'path', + 'schema' => [ + 'description' => '自定义连接器的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '展示使用自定义connector创建的表的信息。', + '$ref' => '#/components/schemas/TableMeta', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"catalogName\\": \\"\\",\\n \\"databaseName\\": \\"\\",\\n \\"tableName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '删除自定义连接器', + ], + 'GetDatabases' => [ + 'summary' => '获取指定Catalog下DataBase的信息或列出所有DataBase的信息', + 'path' => '/api/v2/namespaces/{namespace}/catalogs/{catalogName}/databases', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '230263', + 'abilityTreeNodes' => [ + 'FEATUREsc53OKIK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'catalogName', + 'in' => 'path', + 'schema' => [ + 'description' => 'catalog名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon', + ], + ], + [ + 'name' => 'databaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'database名称，为空时返回所有database信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'paimon-ods', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的database列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => 'Database信息详情。', + '$ref' => '#/components/schemas/Database', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"comment\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取Database信息', + ], + 'GetTables' => [ + 'summary' => '获取指定catalog的database下某张表的具体详情或者database下所有表的信息', + 'path' => '/api/v2/namespaces/{namespace}/catalogs/{catalogName}/databases/{databaseName}/tables', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '230264', + 'abilityTreeNodes' => [ + 'FEATUREsc53OKIK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'catalogName', + 'in' => 'path', + 'schema' => [ + 'description' => 'catalog名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon', + ], + ], + [ + 'name' => 'databaseName', + 'in' => 'path', + 'schema' => [ + 'description' => 'database名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon-ods', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名，表名为空返回所有表信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'item', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ECE641B2-AB0B-4174-9C3B-885881558637', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的表的列表和详情；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '表信息。', + '$ref' => '#/components/schemas/Table', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"ECE641B2-AB0B-4174-9C3B-885881558637\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"schema\\": {\\n \\"columns\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"metadataInfo\\": {\\n \\"key\\": \\"\\",\\n \\"virtual\\": true\\n },\\n \\"expression\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"nullable\\": true,\\n \\"logicalType\\": \\"\\"\\n }\\n ],\\n \\"watermarkSpecs\\": [\\n {\\n \\"column\\": \\"\\",\\n \\"watermarkExpression\\": \\"\\",\\n \\"watermarkType\\": \\"\\"\\n }\\n ],\\n \\"primaryKey\\": {\\n \\"constraintName\\": \\"\\",\\n \\"columns\\": [\\n \\"\\"\\n ],\\n \\"constraintType\\": \\"\\",\\n \\"enforced\\": true\\n }\\n },\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"comment\\": \\"\\",\\n \\"partitionKeys\\": [\\n \\"\\"\\n ],\\n \\"tableType\\": \\"\\",\\n \\"metadata\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取表信息', + ], + 'GetCatalogs' => [ + 'summary' => '获取指定或全部catalog详情GetCatalogs', + 'path' => '/api/v2/namespaces/{namespace}/catalogs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '230262', + 'abilityTreeNodes' => [ + 'FEATUREsc53OKIK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'catalogName', + 'in' => 'query', + 'schema' => [ + 'description' => 'catalog名称，为空时，列表所有catalog。', + 'type' => 'string', + 'required' => false, + 'example' => 'paimon', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的catalog列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => 'catalog信息详情。', + '$ref' => '#/components/schemas/Catalog', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"extensionConf\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取Catalog信息', + ], + 'ExecuteSqlStatement' => [ + 'summary' => '您可以通过本API完成元数据相关SQL的运行，仅支持DDL和DML，不支持DQL。', + 'path' => '/api/v2/namespaces/{namespace}/sql-statement/execute', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230265', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8c34d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '元数据相关SQL语句。', + 'required' => false, + '$ref' => '#/components/schemas/SqlStatementWithContext', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '元数据SQL执行结果。', + '$ref' => '#/components/schemas/SqlStatementExecuteResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"executeSuccess\\": true,\\n \\"errorDetails\\": {\\n \\"lineNumber\\": \\"\\",\\n \\"columnNumber\\": \\"\\",\\n \\"endLineNumber\\": \\"\\",\\n \\"endColumnNumber\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"invalidflinkConf\\": [\\n \\"\\"\\n ]\\n },\\n \\"statement\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '执行元数据SQL语句', + ], + 'CreateSavepoint' => [ + 'summary' => '创建快照。', + 'path' => '/api/v2/namespaces/{namespace}/savepoints', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '146960', + 'abilityTreeNodes' => [ + 'FEATUREscUX40QK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '触发savepoint参数。', + 'description' => '触发savepoint参数。', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '作业ID。', + 'description' => '作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + 'description' => [ + 'title' => 'savepoint描述信息。', + 'description' => 'savepoint描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => '作业快照描述', + ], + 'nativeFormat' => [ + 'title' => '是否使用nativeFormat模式。', + 'description' => '是否使用nativeFormat模式：'."\n" + ."\n" + .'- true：使用'."\n" + ."\n" + .'- false：不使用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回触发成功的savepoint信息；当success为false，该值为空。', + 'description' => '- 当success为true，返回触发成功的savepoint信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Savepoint', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"1d716b22-6aad-4be2-85c2-50cfc757****\\",\\n \\"jobId\\": \\"5af678c0-7db0-4650-94c2-d2604f0a****\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"savepointOrigin\\": \\"USER_REQUEST\\",\\n \\"nativeFormat\\": true,\\n \\"description\\": \\"\\",\\n \\"stopWithDrainEnabled\\": true,\\n \\"savepointLocation\\": \\"https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285\\",\\n \\"status\\": {\\n \\"state\\": \\"COMPLETED\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1655006835\\n }\\n },\\n \\"createdAt\\": 1659066711,\\n \\"modifiedAt\\": 1659069473\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSavepointResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>\\n <deploymentId>1d716b22-6aad-4be2-85c2-50cfc757****</deploymentId>\\n <jobId>5af678c0-7db0-4650-94c2-d2604f0a****</jobId>\\n <namespace>namespacetest</namespace>\\n <savepointOrigin>USER_REQUEST</savepointOrigin>\\n <nativeFormat>true</nativeFormat>\\n <stopWithDrainEnabled>true</stopWithDrainEnabled>\\n <savepointLocation>https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285</savepointLocation>\\n <status>\\n <state>COMPLETED</state>\\n </status>\\n <createdAt>1659066711</createdAt>\\n <modifiedAt>1659069473</modifiedAt>\\n </data>\\n</CreateSavepointResponse>","errorExample":""}]', + 'title' => '创建快照', + ], + 'GetSavepoint' => [ + 'summary' => '获取快照和系统检查点的详细信息。', + 'path' => '/api/v2/namespaces/{namespace}/savepoints/{savepointId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146997', + 'abilityTreeNodes' => [ + 'FEATUREscUX40QK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'savepointId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Savepoint ID。', + 'description' => 'Savepoint ID。', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => 'Savepoint信息。', + 'description' => '- 当success为true，返回快照信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Savepoint', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"1d716b22-6aad-4be2-85c2-50cfc757****\\",\\n \\"jobId\\": \\"5af678c0-7db0-4650-94c2-d2604f0a****\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"savepointOrigin\\": \\"USER_REQUEST\\",\\n \\"nativeFormat\\": true,\\n \\"description\\": \\"\\",\\n \\"stopWithDrainEnabled\\": true,\\n \\"savepointLocation\\": \\"https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285\\",\\n \\"status\\": {\\n \\"state\\": \\"COMPLETED\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1655006835\\n }\\n },\\n \\"createdAt\\": 1659066711,\\n \\"modifiedAt\\": 1659069473\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSavepointResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode> </errorCode>\\n <errorMessage> </errorMessage>\\n <data>\\n <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>\\n <deploymentId>1d716b22-6aad-4be2-85c2-50cfc757****</deploymentId>\\n <jobId>5af678c0-7db0-4650-94c2-d2604f0a****</jobId>\\n <namespace>namespacetest</namespace>\\n <savepointOrigin>USER_REQUEST</savepointOrigin>\\n <nativeFormat>true</nativeFormat>\\n <stopWithDrainEnabled>true</stopWithDrainEnabled>\\n <savepointLocation>https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285</savepointLocation>\\n <status>\\n <state>COMPLETED</state>\\n </status>\\n <createdAt>1659066711</createdAt>\\n <modifiedAt>1659069473</modifiedAt>\\n </data>\\n</GetSavepointResponse>","errorExample":""}]', + 'title' => '获取快照和系统检查点', + ], + 'DeleteSavepoint' => [ + 'summary' => '删除快照。', + 'path' => '/api/v2/namespaces/{namespace}/savepoints/{savepointId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '147041', + 'abilityTreeNodes' => [ + 'FEATUREscUX40QK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'savepointId', + 'in' => 'path', + 'schema' => [ + 'title' => '需要删除的savepoint ID。', + 'description' => '需要删除的Savepoint ID。', + 'type' => 'string', + 'required' => true, + 'example' => '907a8f0e-4f6c-412b-8a5e-7d4a065b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSavepointResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n</DeleteSavepointResponse>","errorExample":""}]', + 'title' => '删除快照', + 'extraInfo' => '补充。', + ], + 'ListSavepoints' => [ + 'summary' => '获取作业快照及最近系统检查点列表。', + 'path' => '/api/v2/namespaces/{namespace}/savepoints', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '147013', + 'abilityTreeNodes' => [ + 'FEATUREscUX40QK', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '作业ID，非必填。', + 'type' => 'string', + 'required' => false, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '实例ID，非必填。', + 'type' => 'string', + 'required' => false, + 'example' => '99a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，表示所请求页码元素数量，最大值为100，最小值为1，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，最小值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，所请求页码的元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回满足查询条件的savepoint列表；当success为false，该值为空。', + 'description' => '- 当success为true，返回满足查询条件的快照列表；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'array', + 'items' => [ + 'title' => 'savepoint数据。', + 'description' => '快照数据。', + '$ref' => '#/components/schemas/Savepoint', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageSize\\": 10,\\n \\"pageIndex\\": 1,\\n \\"totalSize\\": 1,\\n \\"data\\": [\\n {\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"1d716b22-6aad-4be2-85c2-50cfc757****\\",\\n \\"jobId\\": \\"5af678c0-7db0-4650-94c2-d2604f0a****\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"savepointOrigin\\": \\"USER_REQUEST\\",\\n \\"nativeFormat\\": true,\\n \\"description\\": \\"\\",\\n \\"stopWithDrainEnabled\\": true,\\n \\"savepointLocation\\": \\"https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285\\",\\n \\"status\\": {\\n \\"state\\": \\"COMPLETED\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1655006835\\n }\\n },\\n \\"createdAt\\": 1659066711,\\n \\"modifiedAt\\": 1659069473\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSavepointsResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <pageSize>100</pageSize>\\n <pageIndex>1</pageIndex>\\n <totalSize>500</totalSize>\\n <data>\\n <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>\\n <deploymentId>1d716b22-6aad-4be2-85c2-50cfc757****</deploymentId>\\n <jobId>5af678c0-7db0-4650-94c2-d2604f0a****</jobId>\\n <namespace>namespacetest</namespace>\\n <savepointOrigin>USER_REQUEST</savepointOrigin>\\n <nativeFormat>true</nativeFormat>\\n <stopWithDrainEnabled>true</stopWithDrainEnabled>\\n <savepointLocation>https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285</savepointLocation>\\n <status>\\n <state>COMPLETED</state>\\n </status>\\n <createdAt>1659066711</createdAt>\\n <modifiedAt>1659069473</modifiedAt>\\n </data>\\n</ListSavepointsResponse>","errorExample":""}]', + 'title' => '获取作业快照及系统检查点列表', + ], + 'GetDeploymentsByName' => [ + 'summary' => '本接口用于通过已部署作业名称搜索并获取指定工作空间和项目空间下匹配的已部署作业实例', + 'path' => '/api/v2/namespaces/{namespace}/deployments/name/{deploymentName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentName', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '已部署作业名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'ignoreJobSummary', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略返回结果中的作业摘要信息（如 jobName、status），仅返回 JobId，用于提升性能', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'true', + ], + ], + [ + 'name' => 'ignoreResourceSetting', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略资源配置信息（如 parallelism、CU 数量），减少返回数据体积', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构代表已部署作业生成的实例详情。', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '通过名称搜索已部署作业', + 'responseParamsDescription' => '由于 deploymentName 是用户自定义的逻辑标识，不保证唯一性，该接口将返回所有名称匹配的部署记录列表，按创建时间倒序排列，便于查看最新部署或对比历史版本。', + ], + 'GetDeploymentsByLabel' => [ + 'summary' => '本接口支持通过指定标签查询关联的已部署作业列表以及作业信息', + 'path' => '/api/v2/namespaces/{namespace}/deployments/getDeployments/byLabel', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'labelKey', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名，用于标签过滤，', + 'type' => 'string', + 'required' => true, + 'example' => 'key', + ], + ], + [ + 'name' => 'labelValue', + 'in' => 'query', + 'schema' => [ + 'description' => '标签值，支持多个值用 英文逗号 , 分隔，表示“或”关系', + 'type' => 'string', + 'required' => true, + 'example' => 'value', + ], + ], + [ + 'name' => 'ignoreJobSummary', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略返回结果中的作业摘要信息（如 jobName、status），仅返回 JobId，用于提升性能', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'ignoreResourceSetting', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略资源配置信息（如 parallelism、CU 数量），减少返回数据体积', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构用来描述一个完整的已部署作业的数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构用来描述一个完整的已部署作业的数据结构。', + 'example' => '"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint"', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '通过标签搜索已部署作业', + 'description' => '本接口用于通过指定作业标签查询被打标关联的已部署作业列表及其详细信息。支持按 labelKey 和 labelValue 精确匹配。', + 'requestParamsDescription' => '1. llabelKey 和 labelValue 组成一个键值对，用于筛选打上该标签的部署作业。'."\n" + .'2. 建议在大数据量场景下启用 ignoreJobSummary 或 ignoreResourceSetting 以降低系统负载。'."\n" + .'3. 目前仅支持单个标签键值对查询，不支持多标签逻辑组合（AND/OR）', + ], + 'GetDeploymentsByIp' => [ + 'summary' => '本接口支持通过指定IP查询该节点上已部署作业列表以及作业信息。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/getDeployments/byIp', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'srcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '源 IP 地址，用于匹配作业的输入源地址', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.100', + ], + ], + [ + 'name' => 'srcPort', + 'in' => 'query', + 'schema' => [ + 'description' => '源端口，配合 srcIp 使用，精确匹配连接', + 'type' => 'string', + 'required' => false, + 'example' => '54321', + ], + ], + [ + 'name' => 'dstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '目标 IP 地址，用于匹配作业的目标写入地址', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.2.200', + ], + ], + [ + 'name' => 'dstPort', + 'in' => 'query', + 'schema' => [ + 'description' => '目标端口，配合 dstIp 使用', + 'type' => 'string', + 'required' => false, + 'example' => '9092', + ], + ], + [ + 'name' => 'ignoreJobSummary', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略返回结果中的作业摘要信息，仅返回Deployment部署作业信息，用于提升性能', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'ignoreResourceSetting', + 'in' => 'query', + 'schema' => [ + 'description' => '是否忽略资源配置信息，减少返回数据体积', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '响应数据。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构用来描述一个完整的已部署作业的数据结构。', + 'example' => '"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint"', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '通过IP搜索已部署作业', + 'description' => '本接口用于通过网络连接中的 源 IP 与端口或 目标 IP 与端口 查询关联的 Flink 已部署作业。', + 'requestParamsDescription' => '- 至少需要填写 srcIp、dstIp 中的一个'."\n" + .'- 端口为可选，用于进一步缩小范围精确搜索定位作业，如需精准定位建议通过 srcIp + srcPort 组合查询'."\n" + .'- 支持组合查询，例如：'."\n" + .'只填 dstIp=10.100.2.200 → 查找所有写往该 IP 的作业'."\n" + .'同时填 srcIp 和 dstIp → 查找两点之间的数据链路作业'."\n" + ."\n" + .'- 建议生产环境调用时设置 ignoreJobSummary=true 或 ignoreResourceSetting=true 以降低响应延迟', + ], + 'CreateDeployment' => [ + 'summary' => '创建一个已部署作业。', + 'path' => '/api/v2/namespaces/{namespace}/deployments', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '146090', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => 'Deployment内容。', + 'description' => 'Deployment内容。', + 'required' => true, + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '响应数据。', + 'description' => '- 当success为true，返回创建的作业信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateDeploymentResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <deploymentId>00000000-0000-0000-0000-00000000****</deploymentId>\\n <namespace>default-namespace</namespace>\\n <name>deploymentName</name>\\n <engineVersion>vvr-6.0.0-flink-1.15</engineVersion>\\n <description>this is a deployment description</description>\\n <deploymentHasChanged>true</deploymentHasChanged>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>JAR</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <jobSummary>\\n <starting>1</starting>\\n <running>1</running>\\n <cancelling>1</cancelling>\\n <cancelled>1</cancelled>\\n <finished>1</finished>\\n <failed>1</failed>\\n </jobSummary>\\n <deploymentTarget>\\n <mode>PER_JOB</mode>\\n <name>vvp-workload</name>\\n </deploymentTarget>\\n <executionMode>STREAMING</executionMode>\\n </data>\\n</CreateDeploymentResponse>","errorExample":""}]', + 'title' => '创建已部署作业', + ], + 'UpdateDeployment' => [ + 'summary' => '更新已部署作业的信息。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '146804', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '需要更新的作业内容。', + 'description' => '需要更新的作业内容。', + 'required' => true, + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回更新后的作业内容；当success为false，该值为空。', + 'description' => '- 当success为true，返回更新后的作业信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateDeploymentResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <deploymentId>00000000-0000-0000-0000-00000000****</deploymentId>\\n <namespace>default-namespace</namespace>\\n <name>deploymentName</name>\\n <engineVersion>vvr-6.0.0-flink-1.15</engineVersion>\\n <description>this is a deployment description</description>\\n <deploymentHasChanged>true</deploymentHasChanged>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>JAR</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <jobSummary>\\n <starting>1</starting>\\n <running>1</running>\\n <cancelling>1</cancelling>\\n <cancelled>1</cancelled>\\n <finished>1</finished>\\n <failed>1</failed>\\n </jobSummary>\\n <deploymentTarget>\\n <mode>PER_JOB</mode>\\n <name>vvp-workload</name>\\n </deploymentTarget>\\n <executionMode>STREAMING</executionMode>\\n </data>\\n</UpdateDeploymentResponse>","errorExample":""}]', + 'title' => '更新已部署作业', + ], + 'GetDeployment' => [ + 'summary' => '获取已部署作业的详细信息。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146286', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回根据ID查询的作业；当success为false，该值为空。', + 'description' => '- 当success为true，返回查询的作业信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDeploymentResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <deploymentId>00000000-0000-0000-0000-00000000****</deploymentId>\\n <namespace>default-namespace</namespace>\\n <name>deploymentName</name>\\n <engineVersion>vvr-6.0.0-flink-1.15</engineVersion>\\n <description>this is a deployment description</description>\\n <deploymentHasChanged>true</deploymentHasChanged>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>SQLSCRIPT</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <jobSummary>\\n <starting>1</starting>\\n <running>1</running>\\n <cancelling>1</cancelling>\\n <cancelled>1</cancelled>\\n <finished>1</finished>\\n <failed>1</failed>\\n </jobSummary>\\n <deploymentTarget>\\n <mode>PER_JOB</mode>\\n <name>vvp-workload</name>\\n </deploymentTarget>\\n <executionMode>STREAMING</executionMode>\\n </data>\\n</GetDeploymentResponse>","errorExample":""}]', + 'title' => '获取已部署作业', + ], + 'ListDeployments' => [ + 'summary' => '获取所有已部署作业的信息。', + 'path' => '/api/v2/namespaces/{namespace}/deployments', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '146799', + 'abilityTreeNodes' => [ + 'FEATUREscB9XR98', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，表示所请求页码元素数量，最大值为100，最小值为1，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，最小值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => 'deployment名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vvp_ds_0522', + ], + ], + [ + 'name' => 'executionMode', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment执行模式。', + 'description' => 'deployment执行模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'STREAMING', + 'enum' => [ + 'BATCH', + 'STREAMING', + ], + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => 'deployment最新作业状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CANCELLED' => 'CANCELLED', + 'FAILED' => 'FAILED', + 'RUNNING' => 'RUNNING', + 'TRANSITIONING' => 'TRANSITIONING', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'creator', + 'in' => 'query', + 'schema' => [ + 'description' => '创建者UID。', + 'type' => 'string', + 'required' => false, + 'example' => '183899668*******', + ], + ], + [ + 'name' => 'modifier', + 'in' => 'query', + 'schema' => [ + 'description' => '修改者UID。', + 'type' => 'string', + 'required' => false, + 'example' => '183899668*******', + ], + ], + [ + 'name' => 'labelKey', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'labelValueArray', + 'in' => 'query', + 'schema' => [ + 'description' => '标签值，多个值使用分号隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1,value2', + ], + ], + [ + 'name' => 'sortName', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，支持按创建时间和修改时间倒序返回数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmt_create', + 'enum' => [ + 'gmt_create', + 'gmt_modified', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，表示所请求页码元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '- 当success为true，返回满足查询条件的作业列表；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'array', + 'items' => [ + 'title' => '作业数据。', + 'description' => '作业数据。', + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 1,\\n \\"data\\": [\\n {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"name\\": \\"deploymentName\\",\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"description\\": \\"this is a deployment description\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"deploymentHasChanged\\": true,\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"jobSummary\\": {\\n \\"starting\\": 1,\\n \\"running\\": 1,\\n \\"cancelling\\": 1,\\n \\"cancelled\\": 1,\\n \\"finished\\": 1,\\n \\"failed\\": 1\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"\\",\\n \\"name\\": \\"\\"\\n },\\n \\"executionMode\\": \\"STREAMING | BATCH\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDeploymentsResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <pageIndex>10</pageIndex>\\n <pageSize>1</pageSize>\\n <totalSize>1</totalSize>\\n <data>\\n <deploymentId>00000000-0000-0000-0000-00000000****</deploymentId>\\n <namespace>default-namespace</namespace>\\n <name>deploymentName</name>\\n <engineVersion>vvr-6.0.0-flink-1.15</engineVersion>\\n <description>this is a deployment description</description>\\n <deploymentHasChanged>true</deploymentHasChanged>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>JAR</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <jobSummary>\\n <starting>1</starting>\\n <running>1</running>\\n <cancelling>1</cancelling>\\n <cancelled>1</cancelled>\\n <finished>1</finished>\\n <failed>1</failed>\\n </jobSummary>\\n <deploymentTarget>\\n <mode>PER_JOB</mode>\\n <name>vvp-workload</name>\\n </deploymentTarget>\\n <executionMode>STREAMING</executionMode>\\n </data>\\n</ListDeploymentsResponse>","errorExample":""}]', + 'title' => '获取已部署作业列表', + ], + 'DeleteDeployment' => [ + 'summary' => '根据已部署作业ID删除已部署作业。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '146802', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5737ef81-d2f1-49cf-8752-30910809****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDeploymentResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n</DeleteDeploymentResponse>","errorExample":""}]', + 'title' => '删除已部署作业', + ], + 'GetEvents' => [ + 'summary' => '获取运行事件', + 'path' => '/api/v2/namespaces/{namespace}/events', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235188', + 'abilityTreeNodes' => [ + 'FEATUREscW7NIYA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，所请求页码的元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构用来代表已部署作业的运行事件。', + '$ref' => '#/components/schemas/Event', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 4,\\n \\"data\\": [\\n {\\n \\"eventId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"jobId\\": \\"00000000-0000-0000-0000-000000005043\\",\\n \\"createdAt\\": \\"\\",\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000680003\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"eventName\\": \\"STATE_TRANSITION_IS_COMPLETED\\",\\n \\"message\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取运行事件', + ], + 'GetJob' => [ + 'summary' => '获取作业实例的详细信息。', + 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146921', + 'abilityTreeNodes' => [ + 'FEATUREscU5EGD9', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '作业实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回查询的实例；当success为false，该值为空。', + 'description' => '- 当success为true，返回查询的实例信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Job', + ], + 'accessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentName\\": \\"flinktest\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"executionMode\\": \\"BATCH\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"startTime\\": 1660190835,\\n \\"endTime\\": 1660277235,\\n \\"engineVersion\\": \\"vvr-4.0.14-flink-1.13\\",\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": {\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"riskLevel\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"healthScore\\": 0\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"preview\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"restoreStrategy\\": {\\n \\"kind\\": \\"LATEST_STATE\\",\\n \\"allowNonRestoredState\\": true,\\n \\"jobStartTimeInMs\\": 1660293803155,\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\"\\n },\\n \\"userFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetJobResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <jobId>354dde66-a3ae-463e-967a-0b4107fd****</jobId>\\n <deploymentId>354dde66-a3ae-463e-967a-0b4107fd****</deploymentId>\\n <deploymentName>flinktest</deploymentName>\\n <namespace>namespacetest</namespace>\\n <executionMode>BATCH</executionMode>\\n <startTime>1660190835</startTime>\\n <endTime>1660277235</endTime>\\n <engineVersion>vvr-4.0.14-flink-1.13</engineVersion>\\n <status>\\n <currentJobStatus>RUNNING</currentJobStatus>\\n <running>\\n <observedFlinkJobRestarts>4</observedFlinkJobRestarts>\\n <observedFlinkJobStatus>RUNNING</observedFlinkJobStatus>\\n </running>\\n </status>\\n <metric>\\n <totalMemoryByte>4096</totalMemoryByte>\\n <totalCpu>2</totalCpu>\\n </metric>\\n <sessionClusterName>preview</sessionClusterName>\\n <artifact>\\n <sqlArtifact>\\n <sqlScript>CREATE TEMPORARY TABLE datagen_source( name VARCHAR ) WITH ( \'connector\' = \'datagen\' ); CREATE TEMPORARY TABLE blackhole_sink( name VARCHAR ) with ( \'connector\' = \'blackhole\' ); INSERT INTO blackhole_sink SELECT name from datagen_source;</sqlScript>\\n </sqlArtifact>\\n <kind>SQLSCRIPT</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <batchResourceSetting>\\n <maxSlot>10</maxSlot>\\n <basicResourceSetting>\\n <parallelism>4</parallelism>\\n <jobmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </jobmanagerResourceSettingSpec>\\n <taskmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </taskmanagerResourceSettingSpec>\\n </basicResourceSetting>\\n </batchResourceSetting>\\n <restoreStrategy>\\n <kind>LATEST_STATE</kind>\\n <allowNonRestoredState>true</allowNonRestoredState>\\n <jobStartTimeInMs>1660293803155</jobStartTimeInMs>\\n <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>\\n </restoreStrategy>\\n </data>\\n</GetJobResponse>","errorExample":""}]', + 'title' => '获取作业实例', + ], + 'ListJobs' => [ + 'summary' => '获取到某个已部署作业下所有作业实例的信息。', + 'path' => '/api/v2/namespaces/{namespace}/jobs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146903', + 'abilityTreeNodes' => [ + 'FEATUREscDX72HD', + 'FEATUREscU5EGD9', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，最小值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，表示所请求页码元素数量，最大值为100，最小值为1，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => '作业ID。', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + [ + 'name' => 'sortName', + 'in' => 'query', + 'schema' => [ + 'description' => '排序规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmt_create', + 'enum' => [ + 'gmt_create', + 'job_id', + 'status', + 'gmt_modified', + ], + ], + ], + [ + 'name' => 'sortOrder', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，表示所请求页码元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回所有满足条件的实例信息；当success为false，该值为空。', + 'description' => '- 当success为true，返回所有满足条件的实例信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'array', + 'items' => [ + 'title' => '实例数据。', + 'description' => '实例数据。', + '$ref' => '#/components/schemas/Job', + ], + ], + 'accessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 1,\\n \\"data\\": [\\n {\\n \\"jobId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentName\\": \\"flinktest\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"executionMode\\": \\"BATCH\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"startTime\\": 1660190835,\\n \\"endTime\\": 1660277235,\\n \\"engineVersion\\": \\"vvr-4.0.14-flink-1.13\\",\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": {\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"riskLevel\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"healthScore\\": 0\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"preview\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"restoreStrategy\\": {\\n \\"kind\\": \\"LATEST_STATE\\",\\n \\"allowNonRestoredState\\": true,\\n \\"jobStartTimeInMs\\": 1660293803155,\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\"\\n },\\n \\"userFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\"\\n }\\n ],\\n \\"accessDeniedDetail\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<ListJobsResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <httpCode>200</httpCode>\\n <pageIndex>1</pageIndex>\\n <pageSize>10</pageSize>\\n <totalSize>1</totalSize>\\n <data>\\n <jobId>354dde66-a3ae-463e-967a-0b4107fd****</jobId>\\n <deploymentId>354dde66-a3ae-463e-967a-0b4107fd****</deploymentId>\\n <deploymentName>flinktest</deploymentName>\\n <namespace>namespacetest</namespace>\\n <executionMode>BATCH</executionMode>\\n <startTime>1660190835</startTime>\\n <endTime>1660277235</endTime>\\n <engineVersion>vvr-4.0.14-flink-1.13</engineVersion>\\n <status>\\n <currentJobStatus>RUNNING</currentJobStatus>\\n <running>\\n <observedFlinkJobRestarts>4</observedFlinkJobRestarts>\\n <observedFlinkJobStatus>RUNNING</observedFlinkJobStatus>\\n </running>\\n </status>\\n <metric>\\n <totalMemoryByte>4096</totalMemoryByte>\\n <totalCpu>2</totalCpu>\\n </metric>\\n <sessionClusterName>preview</sessionClusterName>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>JAR</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <batchResourceSetting>\\n <maxSlot>10</maxSlot>\\n <basicResourceSetting>\\n <parallelism>4</parallelism>\\n <jobmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </jobmanagerResourceSettingSpec>\\n <taskmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </taskmanagerResourceSettingSpec>\\n </basicResourceSetting>\\n </batchResourceSetting>\\n </data>\\n</ListJobsResponse>","errorExample":""}]', + 'title' => '获取作业实例列表', + ], + 'StartJobWithParams' => [ + 'summary' => '启动一个作业实例。', + 'path' => '/api/v2/namespaces/{namespace}/jobs: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' => '196584', + 'abilityTreeNodes' => [ + 'FEATUREscFIKID5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****'."\n", + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '作业实例启动参数。', + 'description' => '作业实例启动参数。', + 'required' => false, + '$ref' => '#/components/schemas/JobStartParameters', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据结构。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'."\n", + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表已部署作业生成的实例详情。', + '$ref' => '#/components/schemas/Job', + ], + 'accessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\\\n\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentName\\": \\"flinktest\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"executionMode\\": \\"BATCH\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"startTime\\": 1660190835,\\n \\"endTime\\": 1660277235,\\n \\"engineVersion\\": \\"vvr-4.0.14-flink-1.13\\",\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": {\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"riskLevel\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"healthScore\\": 0\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"preview\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"restoreStrategy\\": {\\n \\"kind\\": \\"LATEST_STATE\\",\\n \\"allowNonRestoredState\\": true,\\n \\"jobStartTimeInMs\\": 1660293803155,\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\"\\n },\\n \\"userFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\"\\n },\\n \\"accessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'title' => '启动作业实例', + ], + 'StopJob' => [ + 'summary' => '停止一个作业实例。', + 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}:stop', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146949', + 'abilityTreeNodes' => [ + 'FEATUREscFIKID5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '作业实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '启动实例参数。', + 'description' => '停止作业实例参数。', + 'required' => true, + '$ref' => '#/components/schemas/StopJobRequestBody', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '启动生成的实例数据。', + 'description' => '- 当success为true，返回被停止实例的数据；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Job', + ], + 'accessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentName\\": \\"flinktest\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"executionMode\\": \\"BATCH\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"startTime\\": 1660190835,\\n \\"endTime\\": 1660277235,\\n \\"engineVersion\\": \\"vvr-4.0.14-flink-1.13\\",\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": {\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"riskLevel\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"healthScore\\": 0\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"preview\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"restoreStrategy\\": {\\n \\"kind\\": \\"LATEST_STATE\\",\\n \\"allowNonRestoredState\\": true,\\n \\"jobStartTimeInMs\\": 1660293803155,\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\"\\n },\\n \\"userFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<StopJobResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <jobId>354dde66-a3ae-463e-967a-0b4107fd****</jobId>\\n <deploymentId>354dde66-a3ae-463e-967a-0b4107fd****</deploymentId>\\n <deploymentName>flinktest</deploymentName>\\n <namespace>namespacetest</namespace>\\n <executionMode>BATCH</executionMode>\\n <startTime>1660190835</startTime>\\n <endTime>1660277235</endTime>\\n <engineVersion>vvr-4.0.14-flink-1.13</engineVersion>\\n <status>\\n <currentJobStatus>RUNNING</currentJobStatus>\\n <running>\\n <observedFlinkJobRestarts>4</observedFlinkJobRestarts>\\n <observedFlinkJobStatus>RUNNING</observedFlinkJobStatus>\\n </running>\\n </status>\\n <metric>\\n <totalMemoryByte>4096</totalMemoryByte>\\n <totalCpu>2</totalCpu>\\n </metric>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>JAR</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <batchResourceSetting>\\n <maxSlot>10</maxSlot>\\n <basicResourceSetting>\\n <parallelism>4</parallelism>\\n <jobmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </jobmanagerResourceSettingSpec>\\n <taskmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </taskmanagerResourceSettingSpec>\\n </basicResourceSetting>\\n </batchResourceSetting>\\n <restoreStrategy>\\n <kind>LATEST_STATE</kind>\\n <allowNonRestoredState>true</allowNonRestoredState>\\n <jobStartTimeInMs>1660293803155</jobStartTimeInMs>\\n <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>\\n </restoreStrategy>\\n </data>\\n</StopJobResponse>","errorExample":""}]', + 'title' => '停止作业实例', + ], + 'DeleteJob' => [ + 'summary' => '删除一个作业下非运行状态的作业实例信息。', + 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '146926', + 'abilityTreeNodes' => [ + 'FEATUREscB9XR98', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间ID。', + 'description' => '项目空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '作业实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteJobResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n</DeleteJobResponse>","errorExample":""}]', + 'title' => '删除作业实例', + ], + 'HotUpdateJob' => [ + 'summary' => '对正在运行的作业进行参数或资源的动态更新。', + 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}:hotUpdate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '229978', + 'abilityTreeNodes' => [ + 'FEATUREscU5EGD9', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回动态更新结果；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '动态更新结果。', + '$ref' => '#/components/schemas/HotUpdateJobResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobHotUpdateId\\": \\"\\",\\n \\"jobId\\": \\"\\",\\n \\"targetResourceSetting\\": {\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n },\\n \\"hotUpdateParams\\": {\\n \\"rescaleJobParam\\": {\\n \\"jobParallelism\\": 0\\n },\\n \\"updateJobConfigParam\\": {\\n \\"newFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"status\\": \\"\\",\\n \\"requestId\\": \\"\\",\\n \\"failure\\": {\\n \\"reason\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"failureSeverity\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '动态更新作业', + ], + 'GetHotUpdateJobResult' => [ + 'summary' => '对作业进行动态更新时，可通过本API获取作业动态更新的结果', + 'path' => '/api/v2/namespaces/{namespace}/jobs/hot-updates/{jobHotUpdateId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '229982', + 'abilityTreeNodes' => [ + 'FEATUREscU5EGD9', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobHotUpdateId', + 'in' => 'path', + 'schema' => [ + 'description' => '动态更新ID。调用HotUpdateJob后可获取本ID信息。', + 'type' => 'string', + 'required' => true, + 'example' => '123hashd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回获取结果；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '动态更新结果信息。', + '$ref' => '#/components/schemas/HotUpdateJobResult', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobHotUpdateId\\": \\"\\",\\n \\"jobId\\": \\"\\",\\n \\"targetResourceSetting\\": {\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n },\\n \\"hotUpdateParams\\": {\\n \\"rescaleJobParam\\": {\\n \\"jobParallelism\\": 0\\n },\\n \\"updateJobConfigParam\\": {\\n \\"newFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"status\\": \\"\\",\\n \\"requestId\\": \\"\\",\\n \\"failure\\": {\\n \\"reason\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"failureSeverity\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取作业动态更新结果', + ], + 'GetLatestJobStartLog' => [ + 'summary' => '获取作业实例最新的启动日志。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}/latest_jobmanager_start_log', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206199', + 'abilityTreeNodes' => [ + 'FEATUREscIA7S9T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '当success为false时，该值不为空，表示最新作业运行日志；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint"', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": \\"\\\\\\"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\\\\\\\\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '获取最新作业实例的启动日志', + ], + 'GetJobDiagnosis' => [ + 'summary' => '智能诊断作业，获取异常诊断项信息', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}/jobs/{jobId}/job-diagnoses/lite', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249132', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '诊断结果。', + 'example' => '如返回示例所示', + '$ref' => '#/components/schemas/JobDiagnosis', + ], + 'accessDeniedDetail' => [ + 'description' => '异常诊断项详情。', + 'type' => 'string', + 'example' => '“”', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"symptoms\\": {\\n \\"autopilot\\": {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"recommendation\\": \\"\\"\\n },\\n \\"startup\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"recommendation\\": \\"\\"\\n }\\n ],\\n \\"runtime\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"recommendation\\": \\"\\"\\n }\\n ],\\n \\"troubleshooting\\": [],\\n \\"state\\": [],\\n \\"others\\": []\\n },\\n \\"workspace\\": \\"\\",\\n \\"riskLevel\\": \\"\\",\\n \\"diagnoseId\\": \\"\\",\\n \\"namespace\\": \\"\\",\\n \\"diagnoseTime\\": 0\\n },\\n \\"accessDeniedDetail\\": \\"“”\\"\\n}","type":"json"}]', + 'title' => '获取作业诊断详情', + ], + 'StartJob' => [ + 'summary' => '创建并启动一个作业实例。', + 'path' => '/api/v2/namespaces/{namespace}/jobs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146938', + 'abilityTreeNodes' => [ + 'FEATUREscFIKID5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '启动实例参数。', + 'required' => true, + '$ref' => '#/components/schemas/StartJobRequestBody', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '- 当success为true，返回创建的实例信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Job', + ], + 'accessDeniedDetail' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ververica::2022-07-18::StartJobWithParams', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\",\\n \\"deploymentName\\": \\"flinktest\\",\\n \\"namespace\\": \\"namespacetest\\",\\n \\"executionMode\\": \\"BATCH\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"startTime\\": 1660190835,\\n \\"endTime\\": 1660277235,\\n \\"engineVersion\\": \\"vvr-4.0.14-flink-1.13\\",\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"status\\": {\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"riskLevel\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"healthScore\\": 0\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"preview\\",\\n \\"artifact\\": {\\n \\"sqlArtifact\\": {\\n \\"sqlScript\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss//bucket//test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss//bucket//test.py\\",\\n \\"mainArgs\\": \\"\\",\\n \\"entryModule\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n },\\n \\"restoreStrategy\\": {\\n \\"kind\\": \\"LATEST_STATE\\",\\n \\"allowNonRestoredState\\": true,\\n \\"jobStartTimeInMs\\": 1660293803155,\\n \\"savepointId\\": \\"354dde66-a3ae-463e-967a-0b4107fd****\\"\\n },\\n \\"userFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"\\",\\n \\"modifiedAt\\": \\"\\"\\n },\\n \\"accessDeniedDetail\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<StartJobResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <jobId>354dde66-a3ae-463e-967a-0b4107fd****</jobId>\\n <deploymentId>354dde66-a3ae-463e-967a-0b4107fd****</deploymentId>\\n <deploymentName>flinktest</deploymentName>\\n <namespace>namespacetest</namespace>\\n <executionMode>BATCH</executionMode>\\n <startTime>1660190835</startTime>\\n <endTime>1660277235</endTime>\\n <engineVersion>vvr-4.0.14-flink-1.13</engineVersion>\\n <status>\\n <currentJobStatus>RUNNING</currentJobStatus>\\n <running>\\n <observedFlinkJobRestarts>4</observedFlinkJobRestarts>\\n <observedFlinkJobStatus>RUNNING</observedFlinkJobStatus>\\n </running>\\n </status>\\n <metric>\\n <totalMemoryByte>4096</totalMemoryByte>\\n <totalCpu>2</totalCpu>\\n </metric>\\n <artifact>\\n <jarArtifact>\\n <jarUri>https://oss//bucket//test.jar</jarUri>\\n <entryClass>org.apapche.flink.test</entryClass>\\n </jarArtifact>\\n <kind>JAR</kind>\\n </artifact>\\n <logging>\\n <loggingProfile>oss</loggingProfile>\\n <log4j2ConfigurationTemplate>xml格式文本</log4j2ConfigurationTemplate>\\n <log4jLoggers>\\n <loggerName>StdOutErrConsoleAppender</loggerName>\\n <loggerLevel>ERROR</loggerLevel>\\n </log4jLoggers>\\n <logReservePolicy>\\n <openHistory>true</openHistory>\\n <expirationDays>7</expirationDays>\\n </logReservePolicy>\\n </logging>\\n <batchResourceSetting>\\n <maxSlot>10</maxSlot>\\n <basicResourceSetting>\\n <parallelism>4</parallelism>\\n <jobmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </jobmanagerResourceSettingSpec>\\n <taskmanagerResourceSettingSpec>\\n <cpu>2</cpu>\\n <memory>4Gi</memory>\\n </taskmanagerResourceSettingSpec>\\n </basicResourceSetting>\\n </batchResourceSetting>\\n <restoreStrategy>\\n <kind>LATEST_STATE</kind>\\n <allowNonRestoredState>true</allowNonRestoredState>\\n <jobStartTimeInMs>1660293803155</jobStartTimeInMs>\\n <savepointId>354dde66-a3ae-463e-967a-0b4107fd****</savepointId>\\n </restoreStrategy>\\n </data>\\n</StartJobResponse>","errorExample":""}]', + 'title' => '启动作业实例（废弃）', + ], + 'CreateScheduledPlan' => [ + 'summary' => '创建定时计划', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '235220', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '本数据结构代表创建的定时计划。', + 'required' => false, + '$ref' => '#/components/schemas/ScheduledPlan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表创建的定时计划。', + '$ref' => '#/components/schemas/ScheduledPlan', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": \\"1723197248\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"name\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"updatedByUser\\": true,\\n \\"origin\\": \\"USER_DEFINED\\",\\n \\"periodicSchedulingPolicies\\": [\\n {\\n \\"onlyOnceTriggerTime\\": 1723195800000,\\n \\"onlyOnceTriggerTimeIsExpired\\": true,\\n \\"periodicTriggerTime\\": 1723199340000,\\n \\"periodicSchedulingLevel\\": \\"DAY\\",\\n \\"periodicSchedulingValues\\": [\\n 0\\n ],\\n \\"isFinished\\": true,\\n \\"resourceSetting\\": {\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', + 'title' => '创建定时计划', + ], + 'UpdateScheduledPlan' => [ + 'summary' => '更新定时计划', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '235221', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => [ + 'description' => '定时计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '本数据结构代表更新的定时计划。', + 'required' => false, + '$ref' => '#/components/schemas/ScheduledPlan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表更新的定时计划。', + '$ref' => '#/components/schemas/ScheduledPlan', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": \\"1723197248\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"name\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"updatedByUser\\": true,\\n \\"origin\\": \\"USER_DEFINED\\",\\n \\"periodicSchedulingPolicies\\": [\\n {\\n \\"onlyOnceTriggerTime\\": 1723195800000,\\n \\"onlyOnceTriggerTimeIsExpired\\": true,\\n \\"periodicTriggerTime\\": 1723199340000,\\n \\"periodicSchedulingLevel\\": \\"DAY\\",\\n \\"periodicSchedulingValues\\": [\\n 0\\n ],\\n \\"isFinished\\": true,\\n \\"resourceSetting\\": {\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', + 'title' => '更新定时计划', + ], + 'DeleteScheduledPlan' => [ + 'summary' => '删除定时计划', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '235222', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => [ + 'description' => '定时计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表删除的定时计划。', + '$ref' => '#/components/schemas/ScheduledPlan', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": \\"1723197248\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"name\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"updatedByUser\\": true,\\n \\"origin\\": \\"USER_DEFINED\\",\\n \\"periodicSchedulingPolicies\\": [\\n {\\n \\"onlyOnceTriggerTime\\": 1723195800000,\\n \\"onlyOnceTriggerTimeIsExpired\\": true,\\n \\"periodicTriggerTime\\": 1723199340000,\\n \\"periodicSchedulingLevel\\": \\"DAY\\",\\n \\"periodicSchedulingValues\\": [\\n 0\\n ],\\n \\"isFinished\\": true,\\n \\"resourceSetting\\": {\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', + 'title' => '删除定时计划', + ], + 'ListScheduledPlan' => [ + 'summary' => '获取定时计划的列表信息', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '235223', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，所请求页码的元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构代表定时计划。', + '$ref' => '#/components/schemas/ScheduledPlan', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 4,\\n \\"data\\": [\\n {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": \\"1723197248\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"name\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"updatedByUser\\": true,\\n \\"origin\\": \\"USER_DEFINED\\",\\n \\"periodicSchedulingPolicies\\": [\\n {\\n \\"onlyOnceTriggerTime\\": 1723195800000,\\n \\"onlyOnceTriggerTimeIsExpired\\": true,\\n \\"periodicTriggerTime\\": 1723199340000,\\n \\"periodicSchedulingLevel\\": \\"DAY\\",\\n \\"periodicSchedulingValues\\": [\\n 0\\n ],\\n \\"isFinished\\": true,\\n \\"resourceSetting\\": {\\n \\"flinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"batchResourceSetting\\": {\\n \\"maxSlot\\": 10,\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"resourcePlan\\": \\"\\"\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取定时计划列表', + ], + 'ApplyScheduledPlan' => [ + 'summary' => '执行定时计划', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}:apply', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '235224', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => [ + 'description' => '定时计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表应用的定时计划。', + '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"scheduledPlanName\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"expectedState\\": \\"RUNNING\\",\\n \\"statusState\\": \\"WAITING\\"\\n }\\n}","type":"json"}]', + 'title' => '应用定时计划', + ], + 'StopApplyScheduledPlan' => [ + 'summary' => '停止应用定时计划', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}:stop', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '235225', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => [ + 'description' => '定时计划ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表定时计划应用信息。', + '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"scheduledPlanName\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"expectedState\\": \\"RUNNING\\",\\n \\"statusState\\": \\"WAITING\\"\\n }\\n}","type":"json"}]', + 'title' => '停止应用定时计划', + ], + 'GetAppliedScheduledPlan' => [ + 'summary' => '获取应用的执行计划', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans:getExecutedScheduledPlan', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '235226', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5737ef81-d2f1-49cf-8752-30910809****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表应用的定时计划。', + '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"scheduledPlanId\\": \\"f3b4ec1e-85dc-4b1d-9726-1d7f4c37****\\",\\n \\"scheduledPlanName\\": \\"test-scheduled-plan\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"expectedState\\": \\"RUNNING\\",\\n \\"statusState\\": \\"WAITING\\"\\n }\\n}","type":"json"}]', + 'title' => '获取应用的定时计划', + ], + 'ListScheduledPlanExecutedHistory' => [ + 'summary' => '获取定时计划执行历史', + 'path' => '/api/v2/namespaces/{namespace}/job-resource-upgradings', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235227', + 'abilityTreeNodes' => [ + 'FEATUREsc6GKYF1', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => '已部署作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + [ + 'name' => 'origin', + 'in' => 'query', + 'schema' => [ + 'description' => '执行来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'SCHEDULED_PLAN', + 'default' => 'SCHEDULED_PLAN', + 'enum' => [ + 'SCHEDULED_PLAN', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，所请求页码的元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构代表定时计划执行信息。', + '$ref' => '#/components/schemas/ScheduledPlanExecutedInfo', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 4,\\n \\"data\\": [\\n {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"createdAt\\": \\"1723197248\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifiedAt\\": \\"1723197248\\",\\n \\"jobResourceUpgradingId\\": \\"0e6d3bab-2277-4ed1-b573-9de6413d****\\",\\n \\"name\\": \\"test-scheduled-plan\\",\\n \\"origin\\": \\"SCHEDULED_PLAN\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000000001\\",\\n \\"originJobId\\": \\"f8a2d5d9-9fc5-4273-bfcc-2a3cd354****\\",\\n \\"status\\": {\\n \\"statusState\\": \\"UPGRADED\\",\\n \\"restartType\\": \\"HOT_UPDATE\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取定时计划执行历史', + ], + 'CreateSessionCluster' => [ + 'summary' => '创建Session集群', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '本数据结构代表创建的Session集群。', + 'required' => false, + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表创建的Session集群。', + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"sessionClusterId\\": \\"1f68a52c-1760-43c6-97fb-afe0674b****\\",\\n \\"name\\": \\"test-sessionCluster\\",\\n \\"deploymentTargetName\\": \\"default-queue\\",\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"status\\": {\\n \\"currentSessionClusterStatus\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 0\\n },\\n \\"running\\": {\\n \\"startedAt\\": 0,\\n \\"lastUpdateTime\\": 0,\\n \\"referenceDeploymentIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建Session集群', + ], + 'UpdateSessionCluster' => [ + 'summary' => '更新Session集群', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '237096', + 'abilityTreeNodes' => [ + 'FEATUREscBWKRDZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8c34d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Session集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '本数据结构代表更新的Session集群。', + 'required' => false, + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表更新的Session集群。', + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"sessionClusterId\\": \\"1f68a52c-1760-43c6-97fb-afe0674b****\\",\\n \\"name\\": \\"test-sessionCluster\\",\\n \\"deploymentTargetName\\": \\"default-queue\\",\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"status\\": {\\n \\"currentSessionClusterStatus\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 0\\n },\\n \\"running\\": {\\n \\"startedAt\\": 0,\\n \\"lastUpdateTime\\": 0,\\n \\"referenceDeploymentIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '更新Session集群', + ], + 'DeleteSessionCluster' => [ + 'summary' => '删除Session集群', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '237098', + 'abilityTreeNodes' => [ + 'FEATUREscBWKRDZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Session集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表删除的Session集群。', + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"sessionClusterId\\": \\"1f68a52c-1760-43c6-97fb-afe0674b****\\",\\n \\"name\\": \\"test-sessionCluster\\",\\n \\"deploymentTargetName\\": \\"default-queue\\",\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"status\\": {\\n \\"currentSessionClusterStatus\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 0\\n },\\n \\"running\\": {\\n \\"startedAt\\": 0,\\n \\"lastUpdateTime\\": 0,\\n \\"referenceDeploymentIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '删除Session集群', + ], + 'GetSessionCluster' => [ + 'summary' => '获取Session集群', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '237093', + 'abilityTreeNodes' => [ + 'FEATUREscBWKRDZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Session集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构代表获取的Session集群。', + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"sessionClusterId\\": \\"1f68a52c-1760-43c6-97fb-afe0674b****\\",\\n \\"name\\": \\"test-sessionCluster\\",\\n \\"deploymentTargetName\\": \\"default-queue\\",\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"status\\": {\\n \\"currentSessionClusterStatus\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 0\\n },\\n \\"running\\": {\\n \\"startedAt\\": 0,\\n \\"lastUpdateTime\\": 0,\\n \\"referenceDeploymentIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取Session集群', + ], + 'ListSessionClusters' => [ + 'summary' => '获取Session集群的列表信息', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '237091', + 'abilityTreeNodes' => [ + 'FEATUREscBWKRDZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'type' => 'array', + 'items' => [ + 'description' => '本数据结构代表获取的Session集群。', + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"creator\\": \\"27846363877456****\\",\\n \\"creatorName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"modifier\\": \\"27846363877456****\\",\\n \\"modifierName\\": \\"****@streamcompute.onaliyun.com\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"sessionClusterId\\": \\"1f68a52c-1760-43c6-97fb-afe0674b****\\",\\n \\"name\\": \\"test-sessionCluster\\",\\n \\"deploymentTargetName\\": \\"default-queue\\",\\n \\"engineVersion\\": \\"vvr-6.0.7-flink-1.15\\",\\n \\"labels\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4Gi\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"oss\\",\\n \\"log4j2ConfigurationTemplate\\": \\"xml格式文本\\",\\n \\"log4jLoggers\\": [\\n {\\n \\"loggerName\\": \\"StdOutErrConsoleAppender\\",\\n \\"loggerLevel\\": \\"ERROR\\"\\n }\\n ],\\n \\"logReservePolicy\\": {\\n \\"openHistory\\": true,\\n \\"expirationDays\\": 7\\n }\\n },\\n \\"status\\": {\\n \\"currentSessionClusterStatus\\": \\"\\",\\n \\"failure\\": {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"failedAt\\": 0\\n },\\n \\"running\\": {\\n \\"startedAt\\": 0,\\n \\"lastUpdateTime\\": 0,\\n \\"referenceDeploymentIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取Session集群列表', + ], + 'StartSessionCluster' => [ + 'summary' => '启动Session集群', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}:start', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '237099', + 'abilityTreeNodes' => [ + 'FEATUREscBWKRDZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Session集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '启动Session集群', + ], + 'StopSessionCluster' => [ + 'summary' => '停止Session集群', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}:stop', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '237100', + 'abilityTreeNodes' => [ + 'FEATUREscBWKRDZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Session集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '停止Session集群', + ], + 'CreateDeploymentTarget' => [ + 'summary' => '创建部署目标', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '235197', + 'abilityTreeNodes' => [ + 'FEATUREscRC0N9T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentTargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '部署目标名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dt', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '本数据结构代表部署目标的资源。', + 'required' => false, + '$ref' => '#/components/schemas/ResourceSpec', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构用来代表创建的部署目标。', + '$ref' => '#/components/schemas/DeploymentTarget', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"name\\": \\"deployment target\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"quota\\": {\\n \\"limit\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"used\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"request\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建部署目标', + ], + 'UpdateDeploymentTarget' => [ + 'summary' => '更新部署目标', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/{deploymentTargetName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '235200', + 'abilityTreeNodes' => [ + 'FEATUREscR3E3VD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentTargetName', + 'in' => 'path', + 'schema' => [ + 'description' => '部署目标名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dt', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '本数据结构代表更新的部署目标资源。', + 'required' => false, + '$ref' => '#/components/schemas/ResourceSpec', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构用来代表更新的部署目标。', + '$ref' => '#/components/schemas/DeploymentTarget', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"name\\": \\"deployment target\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"quota\\": {\\n \\"limit\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"used\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"request\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '更新部署目标', + ], + 'DeleteDeploymentTarget' => [ + 'summary' => '删除部署目标', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/{deploymentTargetName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '235201', + 'abilityTreeNodes' => [ + 'FEATUREscR3E3VD', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentTargetName', + 'in' => 'path', + 'schema' => [ + 'description' => '部署目标名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '本数据结构用来代表删除的部署目标。', + '$ref' => '#/components/schemas/DeploymentTarget', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"name\\": \\"deployment target\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"quota\\": {\\n \\"limit\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"used\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"request\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '删除部署目标', + ], + 'ListDeploymentTargets' => [ + 'summary' => '获取作业可部署目标的列表，部署目标是session集群或者perjob集群。', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '146855', + 'abilityTreeNodes' => [ + 'FEATUREscYYH6D4', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值1000。', + 'description' => '分页参数，表示所请求页码元素数量，最大值为100，最小值为1，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，最小值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，表示所请求页码元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'pageIndex' => [ + 'title' => '页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回所有满足条件的幕布目标信息；当success为false，该值为空。', + 'description' => '- 当success为true，返回满足查询条件的部署目标列表；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'array', + 'items' => [ + 'title' => '部署目标信息。', + 'description' => '部署目标信息。', + '$ref' => '#/components/schemas/DeploymentTarget', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageSize\\": 10,\\n \\"pageIndex\\": 1,\\n \\"totalSize\\": 1,\\n \\"data\\": [\\n {\\n \\"name\\": \\"deployment target\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"quota\\": {\\n \\"limit\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"used\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"request\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDeploymentTargetsResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <pageSize>10</pageSize>\\n <pageIndex>1</pageIndex>\\n <totalSize>1</totalSize>\\n <data>\\n <name>deployment target</name>\\n <namespace>namespace</namespace>\\n </data>\\n</ListDeploymentTargetsResponse>","errorExample":""}]', + 'title' => '获取部署目标列表', + ], + 'UpdateDeploymentTargetV2' => [ + 'summary' => '更新部署目标', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/support-elastic/{deploymentTargetName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235200', + 'abilityTreeNodes' => [ + 'FEATUREscRC0N9T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentTargetName', + 'in' => 'path', + 'schema' => [ + 'description' => '部署目标名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dt', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '部署目标资源。', + 'required' => false, + '$ref' => '#/components/schemas/Resource', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '部署目标详情。', + 'example' => '如返回示例所示', + '$ref' => '#/components/schemas/DeploymentTarget', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"name\\": \\"deployment target\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"quota\\": {\\n \\"limit\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"used\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"request\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '更新部署目标（V2）', + 'description' => '原更新部署目标的接口仅支持创建固定资源或弹性资源的部署目标，新接口支持更新固定资源、弹性资源或者混合模式的部署目标。', + ], + 'CreateDeploymentTargetV2' => [ + 'summary' => '创建部署目标', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/support-elastic', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235197', + 'abilityTreeNodes' => [ + 'FEATUREscRC0N9T', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentTargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '部署目标名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-dt', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '部署目标资源。', + 'required' => false, + '$ref' => '#/components/schemas/Resource', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '部署目标详情。', + 'example' => '{ "jobs": [ { "jid": "4df35f8e54554b23bf7dcd38a151****", "name": "69d001d5-419a-4bfc-9c2e-849cacd3****", "state": "RUNNING", "start-time": 1659154942068, "end-time": -1, "duration": 188161756, "last-modification": 1659154968305, "tasks": { "total": 2, "created": 0, "scheduled": 0, "deploying": 0, "running": 2, "finished": 0, "canceling": 0, "canceled": 0, "failed": 0, "reconciling": 0, "initializing": 0 } } ] }', + '$ref' => '#/components/schemas/DeploymentTarget', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"name\\": \\"deployment target\\",\\n \\"namespace\\": \\"namespace\\",\\n \\"quota\\": {\\n \\"limit\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"used\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n },\\n \\"request\\": {\\n \\"cpu\\": 1,\\n \\"memory\\": \\"4Gi\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '创建部署目标（V2版本）', + 'description' => '原创建部署目标的接口仅支持创建固定资源或弹性资源的部署目标，新接口支持创建固定资源、弹性资源或者混合模式的部署目标。', + ], + 'CreateMember' => [ + 'summary' => '将一个用户添加到对应项目空间下并授予对应权限。', + 'path' => '/gateway/v2/namespaces/{namespace}/members', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177220', + 'abilityTreeNodes' => [ + 'FEATUREscWQDSD2', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ca84d539167d4d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '成员内容。', + 'description' => '成员账号和权限对应关系。', + 'required' => false, + '$ref' => '#/components/schemas/Member', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F989CA70-2925-5A94-92B7-20F5762B71C8', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的成员；当success为false，该值为空。', + 'description' => '- 当success为false，返回空值；'."\n" + ."\n" + .'- 当success为true，返回授权信息。', + '$ref' => '#/components/schemas/Member', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F989CA70-2925-5A94-92B7-20F5762B71C8\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"member\\": \\"user: 181319557522****\\",\\n \\"role\\": \\"VIEWER\\"\\n }\\n}","type":"json"}]', + 'title' => '新增成员授权', + ], + 'UpdateMember' => [ + 'summary' => '更新特定项目空间下某个或某些用户的权限。', + 'path' => '/gateway/v2/namespaces/{namespace}/members', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177223', + 'abilityTreeNodes' => [ + 'FEATUREscWQDSD2', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '成员信息。', + 'description' => '成员授权信息详情。', + 'required' => false, + '$ref' => '#/components/schemas/Member', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的成员；当success为false，该值为空。', + 'description' => '当success为true，返回创建的成员；当success为false，该值为空。', + '$ref' => '#/components/schemas/Member', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"member\\": \\"user: 181319557522****\\",\\n \\"role\\": \\"VIEWER\\"\\n }\\n}","type":"json"}]', + 'title' => '更新用户授权信息', + ], + 'DeleteMember' => [ + 'summary' => '删除指定的用户权限信息。', + 'path' => '/gateway/v2/namespaces/{namespace}/members/{member}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177280', + 'abilityTreeNodes' => [ + 'FEATUREscWQDSD2', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8c34d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'member', + 'in' => 'path', + 'schema' => [ + 'title' => '成员名称。', + 'description' => '成员UID。', + 'type' => 'string', + 'required' => true, + 'example' => 'user:223769', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'title' => '删除用户权限', + ], + 'GetMember' => [ + 'summary' => '查看用户授权详情。', + 'path' => '/gateway/v2/namespaces/{namespace}/members/{member}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177281', + 'abilityTreeNodes' => [ + 'FEATUREscWQDSD2', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'member', + 'in' => 'path', + 'schema' => [ + 'title' => '成员名称。', + 'description' => '成员名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'user:223769', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回成员信息；当success为false，该值为空。', + 'description' => '- 当success为false，返回空值；'."\n" + ."\n" + .'- 当success为true，返回授权信息。', + '$ref' => '#/components/schemas/Member', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"member\\": \\"user: 181319557522****\\",\\n \\"role\\": \\"VIEWER\\"\\n }\\n}","type":"json"}]', + 'title' => '查看成员授权信息', + ], + 'ListMembers' => [ + 'summary' => '查看特定项目下用户UID和授权的对应关系。', + 'path' => '/gateway/v2/namespaces/{namespace}/members', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177185', + 'abilityTreeNodes' => [ + 'FEATUREscWQDSD2', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，所请求页码的元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'data' => [ + 'title' => '当success为true，返回所有满足条件的成员信息；当success为false，该值为空。', + 'description' => '- 当success为false，返回空值；'."\n" + ."\n" + .'- 当success为true，返回授权信息。', + 'type' => 'array', + 'items' => [ + 'title' => '成员数据。', + 'description' => '成员数据。', + '$ref' => '#/components/schemas/Member', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageIndex\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalSize\\": 50,\\n \\"data\\": [\\n {\\n \\"member\\": \\"user: 181319557522****\\",\\n \\"role\\": \\"VIEWER\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看项目下成员授权列表', + ], + 'UpdateVariable' => [ + 'summary' => '修改项目级别的变量。', + 'path' => '/api/v2/namespaces/{namespace}/variables/{name}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREscGTCR1G', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'vvp_ds_0522', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '创建变量的数据内容。', + 'description' => '修改后变量全部的数据内容。', + 'required' => true, + '$ref' => '#/components/schemas/Variable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的变量；当success为false，该值为空。', + 'description' => '修改后的变量结构。', + '$ref' => '#/components/schemas/Variable', + ], + 'accessDeniedDetail' => [ + 'description' => '访问拒绝详细信息，出现在用户无权限操作的场景。', + 'type' => 'string', + 'example' => '“”', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"kind\\": \\"Plain\\",\\n \\"name\\": \\"variableName\\",\\n \\"value\\": \\"variableValue\\",\\n \\"description\\": \\"This is a variable description\\"\\n },\\n \\"accessDeniedDetail\\": \\"“”\\"\\n}","type":"json"}]', + 'title' => '修改项目变量', + ], + 'CreateVariable' => [ + 'summary' => '创建变量。', + 'path' => '/api/v2/namespaces/{namespace}/variables', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '147069', + 'abilityTreeNodes' => [ + 'FEATUREscGTCR1G', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '创建变量的数据内容。', + 'description' => '创建变量的数据内容。', + 'required' => true, + '$ref' => '#/components/schemas/Variable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的变量；当success为false，该值为空。', + 'description' => '- 当success为true，返回创建的变量；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/Variable', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"kind\\": \\"Plain\\",\\n \\"name\\": \\"variableName\\",\\n \\"value\\": \\"variableValue\\",\\n \\"description\\": \\"This is a variable description\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateVariableResponse>\\n <requestId>CBC799F0-ABCD-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <kind>Plain</kind>\\n <name>variableName</name>\\n <value>variableValue</value>\\n <description>This is a variable description</description>\\n </data>\\n</CreateVariableResponse>","errorExample":""}]', + 'title' => '创建变量', + ], + 'DeleteVariable' => [ + 'summary' => '删除变量。', + 'path' => '/api/v2/namespaces/{namespace}/variables/{name}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '147071', + 'abilityTreeNodes' => [ + 'FEATUREscGTCR1G', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'title' => '变量名称。', + 'description' => '需要删除的变量名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'variableName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteVariableResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n</DeleteVariableResponse>","errorExample":""}]', + 'title' => '删除变量', + ], + 'ListVariables' => [ + 'summary' => '获取变量列表。', + 'path' => '/api/v2/namespaces/{namespace}/variables', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '147070', + 'abilityTreeNodes' => [ + 'FEATUREscGTCR1G', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，最大值为100，默认值为10。', + 'description' => '分页参数，表示所请求页码元素数量，最大值为100，最小值为1，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '分页参数，页码索引，表示所请求页码，最小值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => '分页参数，表示所请求页码元素数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => '分页参数，页码索引，表示所请求页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => '满足查询条件的所有元素的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回满足查询条件的所有变量；当success为false，该值为空。', + 'description' => '- 当success为true，返回满足查询条件的变量列表；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'array', + 'items' => [ + 'title' => '变量数据。', + 'description' => '变量数据。', + '$ref' => '#/components/schemas/Variable', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"pageSize\\": 10,\\n \\"pageIndex\\": 1,\\n \\"totalSize\\": 1,\\n \\"data\\": [\\n {\\n \\"kind\\": \\"Plain\\",\\n \\"name\\": \\"variableName\\",\\n \\"value\\": \\"variableValue\\",\\n \\"description\\": \\"This is a variable description\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListVariablesResponse>\\n <requestId>CBC799F0-ABCF-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <pageSize>10</pageSize>\\n <pageIndex>1</pageIndex>\\n <totalSize>1</totalSize>\\n <data>\\n <kind>Plain</kind>\\n <name>variableName</name>\\n <value>variableValue</value>\\n <description>This is a variable description</description>\\n </data>\\n</ListVariablesResponse>","errorExample":""}]', + 'title' => '获取变量列表', + ], + 'ListEngineVersionMetadata' => [ + 'summary' => '获取系统支持的引擎版本列表。', + 'path' => '/api/v2/engine-version-meta.json', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '146861', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回系统支持的引擎版本总体信息；当success为false，该值为空。', + 'description' => '- 当success为true，返回系统支持的引擎版本总体信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/EngineVersionMetadataIndex', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"defaultEngineVersion\\": \\"vvr-6.0.1-flink-1.15\\",\\n \\"engineVersionMetadata\\": [\\n {\\n \\"engineVersion\\": \\"vvr-6.0.0-flink-1.15\\",\\n \\"status\\": \\"STABLE\\",\\n \\"features\\": {\\n \\"useForSqlDeployments\\": true,\\n \\"supportNativeSavepoint\\": true\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListEngineVersionMetadataResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <defaultEngineVersion>vvr-6.0.1-flink-1.15</defaultEngineVersion>\\n <engineVersionMetadata>\\n <engineVersion>vvr-6.0.0-flink-1.15</engineVersion>\\n <status>STABLE</status>\\n <features>\\n <useForSqlDeployments>true</useForSqlDeployments>\\n <supportNativeSavepoint>true</supportNativeSavepoint>\\n </features>\\n </engineVersionMetadata>\\n </data>\\n</ListEngineVersionMetadataResponse>","errorExample":""}]', + 'title' => '获取引擎版本列表', + ], + 'GenerateResourcePlanWithFlinkConfAsync' => [ + 'summary' => '提交异步生成resource plan工单，返回一个异步工单ID用于查询工单结果。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}/resource-plan:asyncGenerate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '151658', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => 'deploymentId信息，deployment唯一标识。', + 'description' => 'deploymentId，deployment的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '生成resource plan需要的Flink configuration。', + 'required' => false, + '$ref' => '#/components/schemas/FlinkConf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '- 当success为true，返回异步操作结果信息；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'object', + 'properties' => [ + 'ticketId' => [ + 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'description' => '回执ID，用于查询异步操作结果。', + 'type' => 'string', + 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"ticketId\\": \\"b3dcdb25-bf36-457d-92ba-a36077e8****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GenerateResourcePlanWithFlinkConfAsyncResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <ticketId>b3dcdb25-bf36-457d-92ba-a36077e8****</ticketId>\\n </data>\\n</GenerateResourcePlanWithFlinkConfAsyncResponse>","errorExample":""}]', + 'title' => '异步生成细粒度资源', + ], + 'GetGenerateResourcePlanResult' => [ + 'summary' => '根据异步工单ID获取异步生成细粒度资源结果。', + 'path' => '/api/v2/namespaces/{namespace}/deployments/tickets/{ticketId}/resource-plan:asyncGenerate', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '147081', + 'abilityTreeNodes' => [ + 'FEATUREscWKZGIA', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'ticketId', + 'in' => 'path', + 'schema' => [ + 'title' => '异步工单ID，可以通过提交异步操作获取。', + 'description' => '回执ID，调用GenerateResourcePlanWithFlinkConfAsync API获取。', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '异步操作结果。', + 'description' => '- 当success为true，返回异步操作结果；'."\n" + ."\n" + .'- 当success为false，返回空值。', + '$ref' => '#/components/schemas/AsyncResourcePlanOperationResult', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"ticketStatus\\": \\"FINISHED\\",\\n \\"plan\\": \\"{\\\\\\\\\\\\\\"ssgProfiles\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\":1.13,\\\\\\\\\\\\\\"heap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1 gb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"offHeap\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"32 mb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"managed\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"extended\\\\\\\\\\\\\\":{}}],\\\\\\\\\\\\\\"nodes\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"StreamExecTableSourceScan\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Source: datagen_source[78]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"profile\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"group\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parallelism\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"maxParallelism\\\\\\\\\\\\\\":32768,\\\\\\\\\\\\\\"minParallelism\\\\\\\\\\\\\\":1}},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"StreamExecSink\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Sink: blackhole_sink[79]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"profile\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"group\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parallelism\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"maxParallelism\\\\\\\\\\\\\\":32768,\\\\\\\\\\\\\\"minParallelism\\\\\\\\\\\\\\":1}}],\\\\\\\\\\\\\\"edges\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"source\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"target\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"mode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PIPELINED\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"strategy\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"FORWARD\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"vertices\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"717c7b8afebbfb7137f6f0f99beb2a94\\\\\\\\\\\\\\":[1,2]}}\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetGenerateResourcePlanResultResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <success>true</success>\\n <httpCode>200</httpCode>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>\\n <ticketStatus>FINISHED</ticketStatus>\\n <plan>{\\\\\\"ssgProfiles\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"default\\\\\\",\\\\\\"cpu\\\\\\":1.13,\\\\\\"heap\\\\\\":\\\\\\"1 gb\\\\\\",\\\\\\"offHeap\\\\\\":\\\\\\"32 mb\\\\\\",\\\\\\"managed\\\\\\":{},\\\\\\"extended\\\\\\":{}}],\\\\\\"nodes\\\\\\":[{\\\\\\"id\\\\\\":1,\\\\\\"type\\\\\\":\\\\\\"StreamExecTableSourceScan\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Source: datagen_source[78]\\\\\\",\\\\\\"profile\\\\\\":{\\\\\\"group\\\\\\":\\\\\\"default\\\\\\",\\\\\\"parallelism\\\\\\":1,\\\\\\"maxParallelism\\\\\\":32768,\\\\\\"minParallelism\\\\\\":1}},{\\\\\\"id\\\\\\":2,\\\\\\"type\\\\\\":\\\\\\"StreamExecSink\\\\\\",\\\\\\"desc\\\\\\":\\\\\\"Sink: blackhole_sink[79]\\\\\\",\\\\\\"profile\\\\\\":{\\\\\\"group\\\\\\":\\\\\\"default\\\\\\",\\\\\\"parallelism\\\\\\":1,\\\\\\"maxParallelism\\\\\\":32768,\\\\\\"minParallelism\\\\\\":1}}],\\\\\\"edges\\\\\\":[{\\\\\\"source\\\\\\":1,\\\\\\"target\\\\\\":2,\\\\\\"mode\\\\\\":\\\\\\"PIPELINED\\\\\\",\\\\\\"strategy\\\\\\":\\\\\\"FORWARD\\\\\\"}],\\\\\\"vertices\\\\\\":{\\\\\\"717c7b8afebbfb7137f6f0f99beb2a94\\\\\\":[1,2]}}</plan>\\n <message>\\"\\"</message>\\n </data>\\n</GetGenerateResourcePlanResultResponse>","errorExample":""}]', + 'title' => '获取异步生成细粒度资源结果', + ], + 'FlinkApiProxy' => [ + 'summary' => '您可以使用flink rest api的方式来调用本接口，获取session集群或者运行作业的相关信息。注意本接口仅支持您获取相关信息，无法对session集群和作业进行操作或管理。', + 'path' => '/flink-ui/v2/proxy', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '146918', + 'abilityTreeNodes' => [ + 'FEATUREscO1AVSF', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => '项目空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型，支持以下类型：'."\n" + .'-jobs', + 'description' => '资源类型，支持以下类型：'."\n" + .'<ul>'."\n" + .'<li>'."\n" + .'jobs'."\n" + .'</li>'."\n" + .'<li>'."\n" + .'sessionclusters'."\n" + .'</li>'."\n" + .'</ul>', + 'type' => 'string', + 'required' => true, + 'example' => 'jobs', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源ID。', + 'description' => '资源类型是jobs，则使用jobid；资源类型是sessionclusters，则使用session名称。', + 'type' => 'string', + 'required' => true, + 'example' => '5a27a3aa-c5b9-4dc1-8c86-be57d2d6****', + ], + ], + [ + 'name' => 'flinkApiPath', + 'in' => 'query', + 'schema' => [ + 'title' => 'flink-ui路径。', + 'description' => 'flink rest api路径。如/jobs/jobid/config可以获取jobid对应作业的配置信息，更多使用可查看[flink社区 rest api文档](https://nightlies.apache.org/flink/flink-docs-release-1.19/zh/docs/ops/rest_api/)。', + 'type' => 'string', + 'required' => true, + 'example' => '/jobs/:4df35f8e54554b23bf7dcd38a151****/config', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'Flink请求的返回值。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'httpCode' => [ + 'description' => '固定值200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'success' => [ + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。 ', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回代理请求结果；当success为false，该值为空。', + 'description' => '- 当success为true，返回代理请求结果；'."\n" + ."\n" + .'- 当success为false，返回空值。', + 'type' => 'string', + 'example' => '{ "jobs": [ { "jid": "4df35f8e54554b23bf7dcd38a151****", "name": "69d001d5-419a-4bfc-9c2e-849cacd3****", "state": "RUNNING", "start-time": 1659154942068, "end-time": -1, "duration": 188161756, "last-modification": 1659154968305, "tasks": { "total": 2, "created": 0, "scheduled": 0, "deploying": 0, "running": 2, "finished": 0, "canceling": 0, "canceled": 0, "failed": 0, "reconciling": 0, "initializing": 0 } } ] }', + ], + ], + 'example' => '{ "jobs": [ { "jid": "4df35f8e54554b23bf7dcd38a15135f4", "name": "69d001d5-419a-4bfc-9c2e-849cacd31658", "state": "RUNNING", "start-time": 1659154942068, "end-time": -1, "duration": 188161756, "last-modification": 1659154968305, "tasks": { "total": 2, "created": 0, "scheduled": 0, "deploying": 0, "running": 2, "finished": 0, "canceling": 0, "canceled": 0, "failed": 0, "reconciling": 0, "initializing": 0 } } ] }', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"httpCode\\": 200,\\n \\"success\\": true,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": \\"{ \\\\\\"jobs\\\\\\": [ { \\\\\\"jid\\\\\\": \\\\\\"4df35f8e54554b23bf7dcd38a151****\\\\\\", \\\\\\"name\\\\\\": \\\\\\"69d001d5-419a-4bfc-9c2e-849cacd3****\\\\\\", \\\\\\"state\\\\\\": \\\\\\"RUNNING\\\\\\", \\\\\\"start-time\\\\\\": 1659154942068, \\\\\\"end-time\\\\\\": -1, \\\\\\"duration\\\\\\": 188161756, \\\\\\"last-modification\\\\\\": 1659154968305, \\\\\\"tasks\\\\\\": { \\\\\\"total\\\\\\": 2, \\\\\\"created\\\\\\": 0, \\\\\\"scheduled\\\\\\": 0, \\\\\\"deploying\\\\\\": 0, \\\\\\"running\\\\\\": 2, \\\\\\"finished\\\\\\": 0, \\\\\\"canceling\\\\\\": 0, \\\\\\"canceled\\\\\\": 0, \\\\\\"failed\\\\\\": 0, \\\\\\"reconciling\\\\\\": 0, \\\\\\"initializing\\\\\\": 0 } } ] }\\"\\n}","errorExample":""},{"type":"xml","example":"<FlinkApiProxyResponse>\\n <requestId>CBC799F0-AS7S-1D30-8A4F-882ED4DD****</requestId>\\n <httpCode>200</httpCode>\\n <success>true</success>\\n <errorCode>\\"\\"</errorCode>\\n <errorMessage>\\"\\"</errorMessage>\\n <data>{ \\"jobs\\": [ { \\"jid\\": \\"4df35f8e54554b23bf7dcd38a151****\\", \\"name\\": \\"69d001d5-419a-4bfc-9c2e-849cacd3****\\", \\"state\\": \\"RUNNING\\", \\"start-time\\": 1659154942068, \\"end-time\\": -1, \\"duration\\": 188161756, \\"last-modification\\": 1659154968305, \\"tasks\\": { \\"total\\": 2, \\"created\\": 0, \\"scheduled\\": 0, \\"deploying\\": 0, \\"running\\": 2, \\"finished\\": 0, \\"canceling\\": 0, \\"canceled\\": 0, \\"failed\\": 0, \\"reconciling\\": 0, \\"initializing\\": 0 } } ] }</data>\\n</FlinkApiProxyResponse>","errorExample":""}]', + 'title' => 'Flink Rest API代理', + ], + 'GetLineageInfo' => [ + 'summary' => '通过本API可以获取作业和数据的血缘信息。', + 'path' => '/meta/v2/lineage', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '230001', + 'abilityTreeNodes' => [ + 'FEATUREscDYS18E', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => [ + 'title' => '工作空间ID。', + 'description' => '工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '血缘信息参数结构体。', + 'required' => false, + '$ref' => '#/components/schemas/GetLineageInfoParams', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '当success为true，返回项目空间下指定的血缘信息；当success为false，该值为空。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '表示业务请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误码；'."\n" + .' '."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '- 当success为false，返回业务错误信息；'."\n" + ."\n" + .'- 当success为true，返回空值。', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '血缘信息详情。', + '$ref' => '#/components/schemas/LineageInfo', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"nodes\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"catalogName\\": \\"\\",\\n \\"databaseName\\": \\"\\",\\n \\"isTemporary\\": true,\\n \\"connector\\": \\"\\",\\n \\"tables\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"tableName\\": \\"\\",\\n \\"with\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"columns\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"columnName\\": \\"\\",\\n \\"nullable\\": true,\\n \\"description\\": \\"\\",\\n \\"columnType\\": \\"\\",\\n \\"columnNativeType\\": \\"\\",\\n \\"createdAt\\": 0,\\n \\"modifiedAt\\": 0,\\n \\"creator\\": \\"\\",\\n \\"modifier\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"edges\\": {\\n \\"tableLineage\\": [\\n {\\n \\"source\\": \\"\\",\\n \\"destination\\": \\"\\",\\n \\"jobId\\": \\"\\"\\n }\\n ],\\n \\"columnLineage\\": [\\n {\\n \\"source\\": \\"\\",\\n \\"destination\\": \\"\\",\\n \\"jobId\\": \\"\\"\\n }\\n ]\\n },\\n \\"jobInfos\\": [\\n {\\n \\"id\\": \\"\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取血缘信息', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ververica.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ververica.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ververica.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ververica.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ververica.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ververica.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ververica.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ververica.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ververica.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ververica.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ververica.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ververica.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ververica.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'ververica.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ververica.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ververica.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ververica.ap-northeast-1.aliyuncs.com', + ], + ], +]; |