diff options
Diffstat (limited to 'data/en_us/ververica/2022-07-18')
| -rw-r--r-- | data/en_us/ververica/2022-07-18/api-docs.php | 15259 |
1 files changed, 15259 insertions, 0 deletions
diff --git a/data/en_us/ververica/2022-07-18/api-docs.php b/data/en_us/ververica/2022-07-18/api-docs.php new file mode 100644 index 0000000..b8a6ecc --- /dev/null +++ b/data/en_us/ververica/2022-07-18/api-docs.php @@ -0,0 +1,15259 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'ververica', + 'version' => '2022-07-18', + ], + 'directories' => [ + [ + 'id' => 364574, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateFolder', + 'UpdateFolder', + 'DeleteFolder', + 'GetFolder', + ], + ], + [ + 'id' => 364579, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ValidateDeploymentDraftAsync', + 'GetValidateDeploymentDraftResult', + 'CreateDeploymentDraft', + 'UpdateDeploymentDraft', + 'DeleteDeploymentDraft', + 'GetDeploymentDraft', + 'ListDeploymentDrafts', + 'GetDeploymentDraftLock', + 'DeployDeploymentDraftAsync', + 'GetDeployDeploymentDraftResult', + 'ValidateSqlStatement', + ], + ], + [ + 'id' => 364591, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateUdfArtifact', + 'UpdateUdfArtifact', + 'GetUdfArtifacts', + 'DeleteUdfArtifact', + 'DeleteUdfFunction', + 'RegisterUdfFunction', + ], + ], + [ + 'id' => 364598, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListCustomConnectors', + 'RegisterCustomConnector', + 'DeleteCustomConnector', + ], + ], + [ + 'id' => 364602, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDatabases', + 'GetTables', + 'GetCatalogs', + 'ExecuteSqlStatement', + ], + ], + [ + 'id' => 364607, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSavepoint', + 'GetSavepoint', + 'DeleteSavepoint', + 'ListSavepoints', + ], + ], + [ + 'id' => 364612, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetDeploymentsByName', + 'GetDeploymentsByLabel', + 'GetDeploymentsByIp', + 'CreateDeployment', + 'UpdateDeployment', + 'GetDeployment', + 'ListDeployments', + 'DeleteDeployment', + 'GetEvents', + ], + ], + [ + 'id' => 364622, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetJob', + 'ListJobs', + 'StartJobWithParams', + 'StopJob', + 'DeleteJob', + 'HotUpdateJob', + 'GetHotUpdateJobResult', + 'GetLatestJobStartLog', + 'GetJobDiagnosis', + 'StartJob', + ], + ], + [ + 'id' => 364633, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateScheduledPlan', + 'UpdateScheduledPlan', + 'DeleteScheduledPlan', + 'ListScheduledPlan', + 'ApplyScheduledPlan', + 'StopApplyScheduledPlan', + 'GetAppliedScheduledPlan', + 'ListScheduledPlanExecutedHistory', + ], + ], + [ + 'id' => 364642, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSessionCluster', + 'UpdateSessionCluster', + 'DeleteSessionCluster', + 'GetSessionCluster', + 'ListSessionClusters', + 'StartSessionCluster', + 'StopSessionCluster', + ], + ], + [ + 'id' => 364650, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDeploymentTarget', + 'UpdateDeploymentTarget', + 'DeleteDeploymentTarget', + 'ListDeploymentTargets', + ], + ], + 'UpdateDeploymentTargetV2', + 'CreateDeploymentTargetV2', + [ + 'id' => 364657, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateMember', + 'UpdateMember', + 'DeleteMember', + 'GetMember', + 'ListMembers', + ], + ], + [ + 'id' => 364663, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'UpdateVariable', + 'CreateVariable', + 'DeleteVariable', + 'ListVariables', + ], + ], + [ + 'id' => 364668, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListEngineVersionMetadata', + 'GenerateResourcePlanWithFlinkConfAsync', + 'GetGenerateResourcePlanResult', + 'FlinkApiProxy', + 'GetLineageInfo', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Artifact' => [ + 'title' => '', + 'description' => 'Artifacts are used to provide the information that is required to start a deployment. A deployment cannot be created without the artifact information. For an SQL deployment, artifacts serve as SQL texts and user-defined functions (UDFs) or connectors on which the deployment depends. For a JAR deployment, artifacts serve as JAR packages or dependency files. For a Python deployment, artifacts serve as .py files or .zip files.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'sqlArtifact' => [ + 'title' => '', + 'description' => 'The information required for the JAR deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'sqlArtifact', + '$ref' => '#/components/schemas/SqlArtifact', + ], + 'jarArtifact' => [ + 'title' => '', + 'description' => 'The information required for the SQL deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'jarArtifact', + '$ref' => '#/components/schemas/JarArtifact', + ], + 'pythonArtifact' => [ + 'title' => '', + 'description' => 'The information required for the Python deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'pythonArtifact', + '$ref' => '#/components/schemas/PythonArtifact', + ], + 'kind' => [ + 'title' => '', + 'description' => 'The type of the deployment. This parameter is required and cannot be modified after the deployment is created.'."\n" + ."\n" + .'* SQLSCRIPT'."\n" + .'* JAR'."\n" + .'* PYTHON'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SQLSCRIPT', + 'backendName' => 'kind', + 'enum' => [ + 'SQLSCRIPT', + 'JAR', + 'PYTHON', + ], + ], + ], + ], + 'AsyncDraftDeployResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The deployment result based on the ID of the asynchronous ticket.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ticketStatus' => [ + 'title' => '', + 'description' => 'The state of the execution.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'FINISHED', + 'backendName' => 'ticketStatus', + ], + 'artifactValidationDetail' => [ + 'description' => 'The verification result of the SQL syntax.'."\n", + 'visibility' => 'Public', + 'backendName' => 'sqlArtifactValidation', + '$ref' => '#/components/schemas/ValidateStatementResult', + ], + 'deploymentId' => [ + 'title' => '', + 'description' => 'The deployment ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + 'backendName' => 'deploymentId', + ], + 'success' => [ + 'title' => '', + 'description' => 'Indicates whether the request was successful.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'success', + ], + 'message' => [ + 'title' => '', + 'description' => 'The information about the deployment result.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '"Validation error: SQL validate failed"', + 'backendName' => 'message', + ], + ], + ], + 'AsyncResourcePlanOperationResult' => [ + 'title' => '', + 'description' => 'The resource configuration plan of a deployment that works in expert mode.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'ticketStatus' => [ + 'title' => '', + 'description' => 'The status of the ticket that applies for an asynchronous operation. Valid values:'."\n" + ."\n" + .'* EXECUTING'."\n" + .'* FINISHED'."\n" + .'* FAILED'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'EXECUTING' => 'EXECUTING', + 'FAILED' => 'FAILED', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'FINISHED', + 'backendName' => 'ticketStatus', + 'enum' => [ + 'INIT', + 'EXECUTING', + 'FINISHED', + 'FAILED', + ], + ], + 'plan' => [ + 'title' => '', + 'description' => 'The resource configuration plan of the deployment in expert mode. The value of this parameter is returned when the value of the ticketStatus parameter is FINISHED.'."\n", + 'visibility' => 'public', + '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]}}', + 'backendName' => 'plan', + ], + 'message' => [ + 'title' => '', + 'description' => 'The information about the ticket. The value of this parameter is returned when the value of the ticketStatus parameter is FAILED or EXECUTING.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '"create resource plan failed"', + 'backendName' => 'message', + ], + ], + ], + 'BasicResourceSetting' => [ + 'title' => '', + 'description' => 'The resource configuration in basic mode that is commonly used in community versions. The resource configuration in basic mode is different from the resource configuration in expert mode provided in commercial versions.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'parallelism' => [ + 'title' => '', + 'description' => 'The parallelism for a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + 'backendName' => 'parallelism', + ], + 'jobmanagerResourceSettingSpec' => [ + 'title' => '', + 'description' => 'The resource configuration of the JobManager.'."\n", + 'visibility' => 'public', + 'backendName' => 'jobmanagerResourceSettingSpec', + '$ref' => '#/components/schemas/BasicResourceSettingSpec', + ], + 'taskmanagerResourceSettingSpec' => [ + 'title' => '', + 'description' => 'The resource configuration of a TaskManager.'."\n", + 'visibility' => 'public', + 'backendName' => 'taskmanagerResourceSettingSpec', + '$ref' => '#/components/schemas/BasicResourceSettingSpec', + ], + ], + ], + 'BasicResourceSettingSpec' => [ + 'title' => '', + 'description' => 'The configurations of CPU and memory resources for a deployment. A coarse-grained description of the JobManager or TaskManager resources can be generated based on the data structure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'cpu' => [ + 'title' => 'CPU', + 'description' => 'The number of CPU cores.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.0', + 'backendName' => 'cpu', + ], + 'memory' => [ + 'title' => '', + 'description' => 'The capacity of the memory. Unit: GiB.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '4 GiB', + 'backendName' => 'memory', + ], + ], + ], + 'BatchResourceSetting' => [ + 'title' => '', + 'description' => 'The resource parameters for a deployment in batch mode.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'maxSlot' => [ + 'title' => '', + 'description' => 'The maximum number of slots.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'maxSlot', + ], + 'basicResourceSetting' => [ + 'title' => '', + 'description' => 'The resource parameters in basic mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'basicResourceSetting', + '$ref' => '#/components/schemas/BasicResourceSetting', + ], + ], + ], + 'BriefDeploymentTarget' => [ + 'title' => 'A short description of struct', + 'description' => 'The description of the per-job cluster on which a deployment is run. This data structure is used in the Deployment data structure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'mode' => [ + 'title' => 'mode', + 'description' => 'The deployment mode.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'PER_JOB', + 'backendName' => 'mode', + 'enum' => [ + 'PER_JOB', + ], + ], + 'name' => [ + 'title' => 'name', + 'description' => 'The name of the queue used for the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vvp-workload', + 'backendName' => 'name', + ], + ], + ], + 'BriefResourceSetting' => [ + 'title' => '', + 'description' => 'The resources for a deployment in streaming or batch mode.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'flinkConf' => [ + 'title' => '', + 'description' => 'The Realtime Compute for Apache Flink configuration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '“execution.checkpointing.interval: 180s”', + 'backendName' => 'flinkConf', + ], + 'batchResourceSetting' => [ + 'title' => '', + 'description' => 'The resource configuration for the deployment in batch mode. This parameter is required for a deployment in batch mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'batchResourceSetting', + '$ref' => '#/components/schemas/BatchResourceSetting', + ], + 'streamingResourceSetting' => [ + 'title' => '', + 'description' => 'The resource configuration for the deployment in streaming mode. This parameter is required for a deployment in streaming mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'streamingResourceSetting', + '$ref' => '#/components/schemas/StreamingResourceSetting', + ], + ], + ], + 'Catalog' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'paimon-test', + 'backendName' => 'name', + ], + 'properties' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'properties', + ], + ], + ], + 'Connector' => [ + 'title' => 'A short description of struct', + 'description' => 'The custom connector.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The name of the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'mysql-test', + 'backendName' => 'name', + ], + 'type' => [ + 'title' => '', + 'description' => 'The type of the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'mysql-test', + 'backendName' => 'type', + ], + 'source' => [ + 'title' => '', + 'description' => 'Indicates whether the connector can be used as the source.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'flase', + 'backendName' => 'source', + ], + 'sink' => [ + 'title' => '', + 'description' => 'Indicates whether the connector can be used as the sink.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'sink', + ], + 'lookup' => [ + 'title' => '', + 'description' => 'Indicates whether the connector can be used as a lookup table.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'lookup', + ], + 'properties' => [ + 'title' => '', + 'description' => 'The parameter configurations.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameters of the connector.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Property', + ], + 'backendName' => 'properties', + ], + 'supportedFormats' => [ + 'title' => '', + 'description' => 'The array of formats that are supported by the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The supported formats.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Json', + 'extendType' => 'true', + ], + 'backendName' => 'supportedFormats', + ], + 'dependencies' => [ + 'title' => '', + 'description' => 'The additional dependency files.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The additional dependency file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://bucket/add.jar', + 'extendType' => 'true', + ], + 'backendName' => 'dependencies', + ], + 'creator' => [ + 'title' => '', + 'description' => 'The ID of the user who creates the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '183899668*******', + 'backendName' => 'creator', + ], + 'creatorName' => [ + 'title' => '', + 'description' => 'The nickname of the user who creates the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'creatorName', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'The ID of the user who modifies the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '183899668*******', + 'backendName' => 'modifier', + ], + 'modifierName' => [ + 'title' => '', + 'description' => 'The nickname of the user who modifies the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'modifierName', + ], + ], + ], + 'CreateUdfArtifactResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The returned result of creating the JAR file of the user-defined function (UDF).'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'createSuccess' => [ + 'title' => '', + 'description' => 'Indicates whether the JAR file was created.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'createSuccess', + ], + 'message' => [ + 'title' => '', + 'description' => 'The message used to create the JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'message', + ], + 'udfArtifact' => [ + 'title' => '', + 'description' => 'The JAR file that you created.'."\n", + 'visibility' => 'Public', + 'backendName' => 'udfArtifact', + '$ref' => '#/components/schemas/UdfArtifact', + ], + 'collidingClasses' => [ + 'title' => '', + 'description' => 'All classes in conflict.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the class in conflict.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/UdfClass', + ], + 'backendName' => 'collidingClasses', + ], + ], + ], + 'Database' => [ + 'title' => 'A short description of struct', + 'description' => 'The structure of the database.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The name of the database.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'database-test', + 'backendName' => 'name', + ], + 'properties' => [ + 'title' => '', + 'description' => 'The parameters of the database.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'example' => '“”', + 'backendName' => 'properties', + ], + 'comment' => [ + 'title' => '', + 'description' => 'The comment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'comment', + ], + ], + ], + 'DeleteUdfArtifactResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The returned result of deleting the JAR file of the user-defined function (UDF).'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'deleteSuccess' => [ + 'title' => '', + 'description' => 'Indicates whether the JAR file was deleted.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'deleteSuccess', + ], + 'message' => [ + 'title' => '', + 'description' => 'The message used to delete the JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'message', + ], + 'referencedClasses' => [ + 'title' => '', + 'description' => 'All associated classes.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The class name of the UDF.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/UdfClass', + ], + 'backendName' => 'referencedClasses', + ], + ], + ], + 'Deployment' => [ + 'title' => '', + 'description' => 'The parameters of a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '', + 'description' => 'The ID of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012312****', + 'backendName' => 'deploymentId', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'default-namespace', + 'backendName' => 'namespace', + ], + 'name' => [ + 'title' => '', + 'description' => 'The name of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'deploymentName', + 'backendName' => 'name', + ], + 'engineVersion' => [ + 'title' => '', + 'description' => 'The engine version of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vvr-6.0.0-flink-1.15', + 'backendName' => 'engineVersion', + ], + 'description' => [ + 'title' => '', + 'description' => 'The description of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'this is a deployment description', + 'backendName' => 'description', + ], + 'creator' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to create the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '27846363877456****', + 'backendName' => 'creator', + ], + 'creatorName' => [ + 'title' => '', + 'description' => 'The name of the account that is used to create the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + 'backendName' => 'creatorName', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to modify the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '27846363877456****', + 'backendName' => 'modifier', + ], + 'modifierName' => [ + 'title' => '', + 'description' => 'The name of the account that is used to modify the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + 'backendName' => 'modifierName', + ], + 'deploymentHasChanged' => [ + 'title' => '', + 'description' => 'Specifies whether the deployment is modified after the deployment is started.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'deploymentHasChanged', + ], + 'artifact' => [ + 'title' => 'artifact', + 'description' => 'The parameters that are required for starting a deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'artifact', + '$ref' => '#/components/schemas/Artifact', + ], + 'flinkConf' => [ + 'title' => '', + 'description' => 'The Realtime Compute for Apache Flink configuration.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"taskmanager.numberOfTaskSlots":"1"}', + 'backendName' => 'flinkConf', + ], + 'logging' => [ + 'title' => '', + 'description' => 'The logging configuration.'."\n", + 'visibility' => 'public', + 'backendName' => 'logging', + '$ref' => '#/components/schemas/Logging', + ], + 'jobSummary' => [ + 'title' => '', + 'description' => 'The summary of jobs in the deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'jobSummary', + '$ref' => '#/components/schemas/JobSummary', + ], + 'deploymentTarget' => [ + 'title' => '', + 'description' => 'The cluster on which the deployment is deployed.'."\n", + 'visibility' => 'public', + 'backendName' => 'deploymentTarget', + '$ref' => '#/components/schemas/BriefDeploymentTarget', + ], + 'executionMode' => [ + 'title' => '', + 'description' => 'The execution mode of the deployment. Valid values:'."\n" + ."\n" + .'* STREAMING'."\n" + .'* BATCH'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'STREAMING', + 'backendName' => 'executionMode', + 'enum' => [ + 'STREAMING', + 'BATCH', + ], + ], + 'streamingResourceSetting' => [ + 'title' => '', + 'description' => 'The resource configuration of the streaming deployment.'."\n", + 'visibility' => 'Public', + 'backendName' => 'streamingResourceSetting', + '$ref' => '#/components/schemas/StreamingResourceSetting', + ], + 'batchResourceSetting' => [ + 'title' => '', + 'description' => 'The resource configuration of the batch deployment.'."\n", + 'visibility' => 'Public', + 'backendName' => 'batchResourceSetting', + '$ref' => '#/components/schemas/BatchResourceSetting', + ], + 'localVariables' => [ + 'title' => '', + 'description' => 'The variables of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LocalVariable', + 'description' => '', + ], + 'backendName' => 'localVariables', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace to which the deployment belongs.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'edcef******b4f', + 'backendName' => 'workspace', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The time at which the deployment was created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1714058507'."\n", + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The time at which the deployment was modified.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1714058843', + 'backendName' => 'modifiedAt', + ], + ], + ], + 'DeploymentDraft' => [ + 'title' => 'A short description of struct', + 'description' => 'The draft.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'deploymentDraftId' => [ + 'title' => '', + 'description' => 'The draft ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-00000012****', + 'backendName' => 'deploymentDraftId', + ], + 'name' => [ + 'title' => '', + 'description' => 'The name of the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test-draft', + 'backendName' => 'name', + ], + 'parentId' => [ + 'title' => '', + 'description' => 'The ID of the parent folder.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-00000013****', + 'backendName' => 'parentId', + ], + 'referencedDeploymentId' => [ + 'title' => '', + 'description' => 'The ID of the associated deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012312****', + 'backendName' => 'referencedDeploymentId', + ], + 'executionMode' => [ + 'title' => '', + 'description' => 'The execution mode.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'STREAMING', + 'backendName' => 'executionMode', + 'enum' => [ + 'STREAMING', + 'BATCH', + ], + ], + 'artifact' => [ + 'description' => 'The script of the SQL deployment.'."\n", + 'visibility' => 'Public', + 'backendName' => 'artifact', + '$ref' => '#/components/schemas/Artifact', + ], + 'engineVersion' => [ + 'title' => '', + 'description' => 'The engine version of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'vvr-6.0.7-flink-1.15', + 'backendName' => 'engineVersion', + ], + 'localVariables' => [ + 'title' => '', + 'description' => 'The variables.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The variables.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LocalVariable', + ], + 'backendName' => 'localVariables', + ], + 'labels' => [ + 'title' => '', + 'description' => 'The labels of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'labels', + ], + 'lock' => [ + 'title' => '', + 'description' => 'The lock of the draft.'."\n", + 'visibility' => 'Public', + 'backendName' => 'lock', + '$ref' => '#/components/schemas/Lock', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'edcef******b4f', + 'backendName' => 'workspace', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'default-namespace', + 'backendName' => 'namespace', + ], + 'creator' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to create the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '27846363877456****', + 'backendName' => 'creator', + ], + 'creatorName' => [ + 'title' => '', + 'description' => 'The name of the account that is used to create the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + 'backendName' => 'creatorName', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to modify the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '27846363877456****', + 'backendName' => 'modifier', + ], + 'modifierName' => [ + 'title' => '', + 'description' => 'The name of the account that is used to modify the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + 'backendName' => 'modifierName', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The time when the draft was created.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The time when the draft was modified.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + 'backendName' => 'modifiedAt', + ], + ], + ], + 'DeploymentRestoreStrategy' => [ + 'title' => '', + 'description' => 'The startup strategy for a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'kind' => [ + 'title' => '', + 'description' => 'The type of the start offset. Valid values:'."\n" + ."\n" + .'* NONE: The deployment is started without states.'."\n" + .'* LATEST_SAVEPOINT: The deployment is started from the latest savepoint.'."\n" + .'* FROM_SAVEPOINT: The deployment is started from the specified savepoint.'."\n" + .'* LATEST_STATE: The deployment is started from the latest state of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'LATEST_STATE', + 'backendName' => 'kind', + 'enum' => [ + 'NONE', + 'LATEST_SAVEPOINT', + 'FROM_SAVEPOINT', + 'LATEST_STATE', + ], + ], + 'allowNonRestoredState' => [ + 'title' => '', + 'description' => 'Specifies whether to allow specific operator states to be skipped. This parameter is required only when a Python deployment or a JAR deployment is resumed with state data.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'TRUE', + 'backendName' => 'allowNonRestoredState', + ], + 'jobStartTimeInMs' => [ + 'title' => '', + 'description' => 'The time point at which the deployment is started without states. You must enter a 13-digit timestamp. If you set the kind parameter to NONE, you can configure this parameter to allow all source tables for which the startTime parameter is configured to read data from the specified time point.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660293803155', + 'backendName' => 'jobStartTimeInMs', + ], + 'savepointId' => [ + 'title' => '', + 'description' => 'The ID of the savepoint for starting the deployment. This parameter is required when the kind parameter is set to FROM_SAVEPOINT.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + 'backendName' => 'savepointId', + ], + ], + ], + 'DeploymentTarget' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'deployment target', + 'backendName' => 'name', + ], + 'namespace' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'namespace', + 'backendName' => 'namespace', + ], + ], + ], + 'DraftDeployParams' => [ + 'title' => 'A short description of struct', + 'description' => 'The parameters that are used to deploy a draft.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'skipValidate' => [ + 'title' => '', + 'description' => 'Specifies whether to skip the syntax check.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'skipValidate', + ], + 'deploymentTarget' => [ + 'title' => '', + 'description' => 'The cluster on which the deployment is deployed.'."\n", + 'visibility' => 'Public', + 'backendName' => 'deploymentTarget', + '$ref' => '#/components/schemas/BriefDeploymentTarget', + ], + 'deploymentDraftId' => [ + 'title' => '', + 'description' => 'The draft ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51****', + 'backendName' => 'deploymentDraftId', + ], + ], + ], + 'DraftDeployResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The deployment result of the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'title' => '', + 'description' => 'Indicates whether the request was successful.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'success', + ], + 'message' => [ + 'title' => '', + 'description' => 'The deployment information.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '""', + 'backendName' => 'message', + ], + 'deploymentId' => [ + 'title' => '', + 'description' => 'The deployment ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + 'backendName' => 'deploymentId', + ], + 'artifactValidationDetail' => [ + 'description' => 'The verification result of the SQL syntax.'."\n", + 'visibility' => 'Public', + 'backendName' => 'sqlArtifactValidation', + '$ref' => '#/components/schemas/ValidateStatementResult', + ], + ], + ], + 'Edge' => [ + 'title' => 'A short description of struct', + 'description' => 'The edges of data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'tableLineage' => [ + 'title' => '', + 'description' => 'The table-level data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the associated table.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Relation', + ], + 'backendName' => 'tableLineage', + ], + 'columnLineage' => [ + 'title' => '', + 'description' => 'The field-level data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the associated fields.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Relation', + ], + 'backendName' => 'columnLineage', + ], + ], + ], + 'EngineVersionMetadata' => [ + 'title' => '', + 'description' => 'The basic information about the engine version of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'engineVersion' => [ + 'title' => '', + 'description' => 'The engine version.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'vvr-6.0.0-flink-1.15', + 'backendName' => 'engineVersion', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the engine version.'."\n" + ."\n" + .'* STABLE'."\n" + .'* BETA'."\n" + .'* DEPRECATED'."\n" + .'* EXPIRED'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'STABLE', + 'checkBlank' => true, + 'backendName' => 'status', + 'enum' => [ + 'STABLE', + 'BETA', + 'DEPRECATED', + 'EXPIRED', + ], + ], + 'features' => [ + 'title' => '', + 'description' => 'The features supported by the engine version.'."\n", + 'visibility' => 'public', + 'backendName' => 'features', + '$ref' => '#/components/schemas/EngineVersionSupportedFeatures', + ], + ], + ], + 'EngineVersionMetadataIndex' => [ + 'title' => '', + 'description' => 'The summary information about the engine version of a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'defaultEngineVersion' => [ + 'title' => '', + 'description' => 'The default engine version that is used for a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vvr-6.0.1-flink-1.15', + 'backendName' => 'defaultEngineVersion', + ], + 'engineVersionMetadata' => [ + 'title' => '', + 'description' => 'The information about all supported engine versions.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The basic information about the engine version.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/EngineVersionMetadata', + ], + 'backendName' => 'engineVersionMetadata', + ], + ], + ], + 'EngineVersionSupportedFeatures' => [ + 'title' => '', + 'description' => 'The description of the features supported by the engine version.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'useForSqlDeployments' => [ + 'title' => '', + 'description' => 'Specifies whether the engine version can be used to submit an SQL deployment.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'useForSqlDeployments', + ], + 'supportNativeSavepoint' => [ + 'title' => '', + 'description' => 'Specifies whether the engine version can be used to create a native savepoint.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'supportNativeSavepoint', + ], + ], + ], + 'ErrorDetails' => [ + 'title' => '', + 'description' => 'The error details of the verification result of the SQL deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'lineNumber' => [ + 'title' => '', + 'description' => 'The number the row at which the error starts.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '3', + 'backendName' => 'line_number', + ], + 'columnNumber' => [ + 'title' => '', + 'description' => 'The number of the column at which the error starts.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '2', + 'backendName' => 'column_number', + ], + 'endLineNumber' => [ + 'title' => '', + 'description' => 'The number of the row at which the error ends.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '5', + 'backendName' => 'end_line_number', + ], + 'endColumnNumber' => [ + 'title' => '', + 'description' => 'The number of the column at which the error ends.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '11', + 'backendName' => 'end_column_number', + ], + 'message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '""', + 'backendName' => 'message', + ], + 'invalidflinkConf' => [ + 'title' => '', + 'description' => 'The list of invalid configurations of Realtime Compute for Apache Flink.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the invalid configurations of Realtime Compute for Apache Flink.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{"k:v"}', + 'extendType' => 'true', + ], + 'backendName' => 'invalid_flink_conf', + ], + ], + ], + 'ExpertResourceSetting' => [ + 'title' => '', + 'description' => 'The information about the resource configuration of a deployment in expert mode.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'jobmanagerResourceSettingSpec' => [ + 'title' => '', + 'description' => 'The basic resource configuration of the JobManager.'."\n", + 'visibility' => 'public', + 'backendName' => 'jobmanagerResourceSettingSpec', + '$ref' => '#/components/schemas/BasicResourceSettingSpec', + ], + 'resourcePlan' => [ + 'title' => '', + 'description' => 'The resource configuration plan of the deployment in expert mode.'."\n", + 'visibility' => 'public', + '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]}}', + 'backendName' => 'resourcePlan', + ], + ], + ], + 'FlinkConf' => [ + 'title' => 'Flink conf', + 'description' => 'The Realtime Compute for Apache Flink configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{"taskmanager.numberOfTaskSlots":"1","table.exec.state.ttl":"128000s"}'."\n", + 'parseType' => 'struct', + ], + 'Folder' => [ + 'title' => 'A short description of struct', + 'description' => 'The draft folder.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'folderId' => [ + 'title' => '', + 'description' => 'The ID of the folder.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012312****', + 'backendName' => 'folderId', + ], + 'parentId' => [ + 'title' => '', + 'description' => 'The ID of the parent folder.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '00000000-0000-0000-0000-0000012390****', + 'backendName' => 'parentId', + ], + 'name' => [ + 'title' => '', + 'description' => 'The name of the folder.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'name', + ], + 'subFolder' => [ + 'title' => '', + 'description' => 'The list of subfolders.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the subfolder.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/SubFolder', + ], + 'backendName' => 'children', + 'itemName' => 'children', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'edcef******b4f', + 'backendName' => 'workspace', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'default-namespace', + 'backendName' => 'namespace', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The time when the folder was created.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The time when the folder was modified.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + 'backendName' => 'modifiedAt', + ], + ], + ], + 'GetLineageInfoParams' => [ + 'title' => 'A short description of struct', + 'description' => 'The parameters used to query the data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => 'The job ID or the table ID. You can call the ListJobs operation to obtain the job ID or call the ListTables operation to obtain the table ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****', + 'backendName' => 'id', + ], + 'depth' => [ + 'title' => '', + 'description' => 'The depth of the data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'backendName' => 'depth', + ], + 'idType' => [ + 'title' => '', + 'description' => 'The data type of the job or table. If the id parameter is set to the job ID, the value of this parameter is the data type of the job. If the id parameter is set to the table ID, the value of this parameter is the data type of the table.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'JOB', + 'backendName' => 'idType', + 'enum' => [ + 'TABLE', + 'JOB', + ], + ], + 'isColumnLevel' => [ + 'title' => '', + 'description' => 'The lineage type. The value true indicates a field-level lineage. The value false indicates a table-level lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'isColumnLevel', + ], + 'direction' => [ + 'title' => '', + 'description' => 'The direction of the lineage. Valid values:'."\n" + ."\n" + .'* UPSTREAM: searches for upstream operators.'."\n" + .'* DOWNSTREAM: searches for downstream operators.'."\n" + .'* BOTH: searches for both upstream and downstream operators.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Both', + 'backendName' => 'direction', + 'enum' => [ + 'UPSTREAM', + 'DOWNSTREAM', + 'BOTH', + ], + ], + 'isTemporary' => [ + 'title' => '', + 'description' => 'Indicates whether the table was a temporary table.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'isTemporary', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'a14bd5d90a****'."\n", + 'backendName' => 'workspace', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'default-namespace', + 'backendName' => 'namespace', + ], + ], + ], + 'HotUpdateJobFailureInfo' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'reason' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'reason', + ], + 'message' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'message', + ], + 'failureSeverity' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'LOW', + 'backendName' => 'failureSeverity', + 'enum' => [ + 'CRITICAL', + 'LOW', + ], + ], + ], + ], + 'HotUpdateJobParams' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'rescaleJobParam' => [ + 'description' => '', + 'visibility' => 'Public', + 'backendName' => 'rescaleJobParam', + '$ref' => '#/components/schemas/RescaleJobParam', + ], + 'updateJobConfigParam' => [ + 'description' => '', + 'visibility' => 'Public', + 'backendName' => 'updateJobConfigParam', + '$ref' => '#/components/schemas/UpdateJobConfigParam', + ], + ], + ], + 'HotUpdateJobResult' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'jobHotUpdateId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '123hashd****', + 'backendName' => 'jobHotUpdateId', + ], + 'jobId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + 'backendName' => 'jobId', + ], + 'targetResourceSetting' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'backendName' => 'targetResourceSetting', + '$ref' => '#/components/schemas/BriefResourceSetting', + ], + 'hotUpdateParams' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'backendName' => 'hotUpdateParams', + '$ref' => '#/components/schemas/HotUpdateJobParams', + ], + 'status' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'backendName' => 'status', + '$ref' => '#/components/schemas/HotUpdateJobStatus', + ], + ], + ], + 'HotUpdateJobStatus' => [ + 'title' => 'A short description of struct', + 'description' => 'The dynamic update status of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '', + 'description' => 'The status of the dynamic update.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'HOT_UPDATED', + 'backendName' => 'status', + 'enum' => [ + 'INIT', + 'HOT_UPDATING', + 'FAILED', + 'HOT_UPDATED', + ], + ], + 'requestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + 'backendName' => 'requestId', + ], + 'failure' => [ + 'title' => '', + 'description' => 'The error message of the dynamical update.'."\n", + 'visibility' => 'Public', + 'backendName' => 'failure', + '$ref' => '#/components/schemas/HotUpdateJobFailureInfo', + ], + ], + ], + 'JarArtifact' => [ + 'title' => '', + 'description' => 'The information required for a JAR deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'jarUri' => [ + 'title' => '', + 'description' => 'The full URL for the JAR deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/test.jar', + 'backendName' => 'jarUri', + ], + 'entryClass' => [ + 'title' => '', + 'description' => 'The entry class. You must enter the full name of the class.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'org.apapche.flink.test', + 'backendName' => 'entryClass', + ], + 'mainArgs' => [ + 'title' => '', + 'description' => 'The parameters required by the entry class.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'start from main', + 'backendName' => 'mainArgs', + ], + 'additionalDependencies' => [ + 'title' => '', + 'description' => 'The full URL of the additional dependency file. You can enter the dependency file for the JAR deployment.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The full URL of the additional dependency file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/addition.jar', + 'extendType' => 'true', + ], + 'backendName' => 'additionalDependencies', + ], + ], + ], + 'Job' => [ + 'title' => '', + 'description' => 'The details of jobs generated in a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'jobId' => [ + 'title' => '', + 'description' => 'The job ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + 'backendName' => 'jobId', + ], + 'deploymentId' => [ + 'title' => '', + 'description' => 'The deployment ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + 'backendName' => 'deploymentId', + ], + 'deploymentName' => [ + 'title' => '', + 'description' => 'The name of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'flinktest', + 'backendName' => 'deploymentName', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'namespacetest', + 'backendName' => 'namespace', + ], + 'executionMode' => [ + 'title' => '', + 'description' => 'The execution mode of the job. Valid values:'."\n" + ."\n" + .'* STREAM'."\n" + .'* BATCH'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'BATCH', + 'backendName' => 'executionMode', + 'enum' => [ + 'STREAMING', + 'BATCH', + ], + ], + 'creator' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to create the job.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '27846363877456****', + 'backendName' => 'creator', + ], + 'creatorName' => [ + 'title' => '', + 'description' => 'The name of the account that is used to create the job.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + 'backendName' => 'creatorName', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to modify the job.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '27846363877456****', + 'backendName' => 'modifier', + ], + 'modifierName' => [ + 'title' => '', + 'description' => 'The name of the account that is used to modify the job.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '****@streamcompute.onaliyun.com', + 'backendName' => 'modifierName', + ], + 'startTime' => [ + 'title' => '', + 'description' => 'The start time of the job.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660190835', + 'backendName' => 'startTime', + ], + 'endTime' => [ + 'title' => '', + 'description' => 'The end time of the job.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660277235', + 'backendName' => 'endTime', + ], + 'engineVersion' => [ + 'title' => '', + 'description' => 'The engine version of the deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'vvr-4.0.14-flink-1.13', + 'backendName' => 'engineVersion', + ], + 'flinkConf' => [ + 'title' => '', + 'description' => 'The configuration of the job.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'example' => '{execution.checkpointing.unaligned: false}', + 'backendName' => 'flinkConf', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the job.'."\n", + 'visibility' => 'public', + 'backendName' => 'status', + '$ref' => '#/components/schemas/JobStatus', + ], + 'metric' => [ + 'title' => '', + 'description' => 'The resource information of the job.'."\n", + 'visibility' => 'public', + 'backendName' => 'metric', + '$ref' => '#/components/schemas/JobMetric', + ], + 'sessionClusterName' => [ + 'title' => '', + 'description' => 'If the job runs in a session cluster, the value of this parameter is the name of the session cluster. Otherwise, the value of this parameter is null.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'preview', + 'backendName' => 'sessionClusterName', + ], + 'artifact' => [ + 'title' => '', + 'description' => 'The content template of the job.'."\n", + 'visibility' => 'public', + 'backendName' => 'artifact', + '$ref' => '#/components/schemas/Artifact', + ], + 'logging' => [ + 'title' => '', + 'description' => 'The logging configuration of the job.'."\n", + 'visibility' => 'public', + 'backendName' => 'logging', + '$ref' => '#/components/schemas/Logging', + ], + 'batchResourceSetting' => [ + 'title' => 'batchResourceSetting', + 'description' => 'The resource configuration of the job in batch mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'batchResourceSetting', + '$ref' => '#/components/schemas/BatchResourceSetting', + ], + 'streamingResourceSetting' => [ + 'title' => '', + 'description' => 'The resource configuration of the job in streaming mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'streamingResourceSetting', + '$ref' => '#/components/schemas/StreamingResourceSetting', + ], + 'restoreStrategy' => [ + 'title' => '', + 'description' => 'The startup strategy of the job.'."\n", + 'visibility' => 'public', + 'backendName' => 'restoreStrategy', + '$ref' => '#/components/schemas/DeploymentRestoreStrategy', + ], + 'userFlinkConf' => [ + 'title' => '', + 'description' => 'The Flink configuration.'."\n", + 'visibility' => 'Public', + 'backendName' => 'userFlinkConf', + '$ref' => '#/components/schemas/FlinkConf', + ], + 'localVariables' => [ + 'title' => '', + 'description' => 'The variables.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LocalVariable', + 'description' => '', + ], + 'backendName' => 'localVariables', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'edcef******b4f', + 'backendName' => 'workspace', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The time when the job was created.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1714058507', + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The time when the job was modified.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1714058800', + 'backendName' => 'modifiedAt', + ], + ], + ], + 'JobDiagnosis' => [ + 'title' => '', + 'description' => 'The diagnostic result of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'symptoms' => [ + 'title' => '', + 'description' => 'The diagnostic details.'."\n", + 'visibility' => 'Public', + 'backendName' => 'symptoms', + '$ref' => '#/components/schemas/JobDiagnosisSymptoms', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace to which the deployment belongs.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'a14bd5d90a****', + 'backendName' => 'workspace', + ], + 'riskLevel' => [ + 'title' => '', + 'description' => 'The severity level of the risk.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RISK_LEVEL_HIGH'."\n" + .'* RISK_LEVEL_MID'."\n" + .'* RISK_LEVEL_LOW'."\n", + 'visibility' => 'Public', + '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', + 'backendName' => 'riskLevel', + ], + 'diagnoseId' => [ + 'title' => '', + 'description' => 'The diagnostic task ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ba30cd99-37a5-4a20-8cd9-ed4b*****', + 'backendName' => 'diagnoseId', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The namespace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'default-namespace-*****', + 'backendName' => 'namespace', + ], + 'diagnoseTime' => [ + 'title' => '', + 'description' => 'The time when the deployment is diagnosed.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1740389560871', + 'backendName' => 'diagnoseTime', + ], + ], + ], + 'JobDiagnosisSymptom' => [ + 'title' => '', + 'description' => 'The diagnostic item.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The diagnostic task name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'name', + ], + 'description' => [ + 'title' => '', + 'description' => 'The diagnostic result.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'description', + ], + 'recommendation' => [ + 'title' => '', + 'description' => 'The fixing suggestions.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'recommendation', + ], + ], + ], + 'JobDiagnosisSymptoms' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'autopilot' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'backendName' => 'autopilot', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'startup' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'backendName' => 'startup', + ], + 'runtime' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'backendName' => 'runtime', + ], + 'troubleshooting' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'backendName' => 'rutroubleshootingntime', + ], + 'state' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'backendName' => 'state', + ], + 'others' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/JobDiagnosisSymptom', + ], + 'backendName' => 'others', + ], + ], + ], + 'JobFailure' => [ + 'title' => '', + 'description' => 'The information about the deployment failure.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '', + 'description' => 'The details of the failure.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.', + 'backendName' => 'message', + ], + 'reason' => [ + 'title' => '', + 'description' => 'The reason for the failure.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'KubernetesDeploymentNotProgressing', + 'backendName' => 'reason', + ], + 'failedAt' => [ + 'title' => '', + 'description' => 'The time when the deployment fails.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660120062', + 'backendName' => 'failedAt', + ], + ], + ], + 'JobInfo' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****'."\n", + 'backendName' => 'id', + ], + 'properties' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'example' => '{"id:xxx","createTime:v"}', + 'backendName' => 'properties', + ], + ], + ], + 'JobMetric' => [ + 'title' => '', + 'description' => 'The metrics for the resources of the job that is running in a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'totalMemoryByte' => [ + 'title' => '', + 'description' => 'The memory size. Unit: bytes.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096', + 'backendName' => 'totalMemoryByte', + ], + 'totalCpu' => [ + 'title' => 'CPU', + 'description' => 'The number of CPU cores.'."\n", + 'visibility' => 'public', + 'type' => 'number', + 'format' => 'double', + 'example' => '2', + 'backendName' => 'totalCpu', + ], + ], + ], + 'JobStartParameters' => [ + 'title' => '', + 'description' => 'The parameters that are used to start a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '', + 'description' => 'The deployment ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + 'backendName' => 'deploymentId', + ], + 'restoreStrategy' => [ + 'title' => '', + 'description' => 'The configuration of the start offset of the deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'restoreStrategy', + '$ref' => '#/components/schemas/DeploymentRestoreStrategy', + ], + 'resourceQueueName' => [ + 'title' => '', + 'description' => 'The queue in which the deployment is running.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'default-queue', + 'backendName' => 'resourceQueueName', + ], + 'localVariables' => [ + 'title' => '', + 'description' => 'The variables.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The variables.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LocalVariable', + ], + 'backendName' => 'localVariables', + ], + ], + ], + 'JobStatus' => [ + 'title' => '', + 'description' => 'The status of the job that is generated in a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'currentJobStatus' => [ + 'title' => '', + 'description' => 'The status of the current job. Valid values:'."\n" + ."\n" + .'* STARTING'."\n" + .'* RUNNING'."\n" + .'* CANCELLING'."\n" + .'* FAILED'."\n" + .'* CANCELLED'."\n" + .'* FINISHED'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'RUNNING', + 'backendName' => 'currentJobStatus', + 'enum' => [ + 'STARTING', + 'RUNNING', + 'CANCELLING', + 'FAILED', + 'CANCELLED', + 'FINISHED', + ], + ], + 'failure' => [ + 'title' => '', + 'description' => 'The information about the job failure. This parameter is valid when the value of the currentJobStatus parameter is FAILED.'."\n", + 'visibility' => 'public', + 'backendName' => 'failure', + '$ref' => '#/components/schemas/JobFailure', + ], + 'running' => [ + 'title' => '', + 'description' => 'The details of the job. This parameter is valid when the value of the currentJobStatus parameter is RUNNING.'."\n", + 'visibility' => 'public', + 'backendName' => 'running', + '$ref' => '#/components/schemas/JobStatusRunning', + ], + ], + ], + 'JobStatusRunning' => [ + 'title' => '', + 'description' => 'The status of a job.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'observedFlinkJobRestarts' => [ + 'title' => '', + 'description' => 'The number of times the job is restarted.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + 'backendName' => 'observedFlinkJobRestarts', + ], + 'observedFlinkJobStatus' => [ + 'title' => '', + 'description' => 'The status of the Flink job.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'RUNNING', + 'backendName' => 'observedFlinkJobStatus', + ], + ], + ], + 'JobSummary' => [ + 'title' => '', + 'description' => 'The summary of the status of all jobs in a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'starting' => [ + 'title' => '', + 'description' => 'The number of jobs that are in the starting state.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'starting', + ], + 'running' => [ + 'title' => '', + 'description' => 'The number of jobs that are in the running state.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'backendName' => 'running', + ], + 'cancelling' => [ + 'title' => '', + 'description' => 'The number of jobs that are in the cancelling state.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'cancelling', + ], + 'cancelled' => [ + 'title' => '', + 'description' => 'The number of jobs that are in the cancelled state.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'backendName' => 'cancelled', + ], + 'finished' => [ + 'title' => '', + 'description' => 'The number of jobs that are in the finished state.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'backendName' => 'finished', + ], + 'failed' => [ + 'title' => '', + 'description' => 'The number of jobs that are in the failed state.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + 'backendName' => 'failed', + ], + ], + ], + 'LineageColumn' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the lineage line.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => 'The field ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '123ss3', + 'backendName' => 'id', + ], + 'columnName' => [ + 'title' => '', + 'description' => 'The name of the column.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'name', + 'backendName' => 'columnName', + ], + 'nullable' => [ + 'title' => '', + 'description' => 'Indicates whether the value is nullable.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'nullable', + ], + 'description' => [ + 'title' => '', + 'description' => 'The description.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'description', + ], + 'columnType' => [ + 'title' => '', + 'description' => 'The column type.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'string', + 'backendName' => 'columnType', + ], + 'columnNativeType' => [ + 'title' => '', + 'description' => 'The original type of the column.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'string', + 'backendName' => 'columnNativeType', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The creation time.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The modification time.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537978', + 'backendName' => 'modifiedAt', + ], + 'creator' => [ + 'title' => '', + 'description' => 'The user that creates the column.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'creator', + ], + 'modifier' => [ + 'title' => '', + 'description' => 'The ID of the account that is used to modify the column.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'modifier', + ], + ], + ], + 'LineageInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The details of the data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'title' => '', + 'description' => 'The nodes.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The node information.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Node', + ], + 'backendName' => 'nodes', + ], + 'edges' => [ + 'title' => '', + 'description' => 'The edge information.'."\n", + 'visibility' => 'Public', + 'backendName' => 'edges', + '$ref' => '#/components/schemas/Edge', + ], + 'jobInfos' => [ + 'title' => '', + 'description' => 'The deployments.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the deployment.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/JobInfo', + ], + 'backendName' => 'jobInfos', + ], + ], + ], + 'LineageTable' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the lineage table.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => 'The table ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '434508', + 'backendName' => 'id', + ], + 'tableName' => [ + 'title' => '', + 'description' => 'The name of the table.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'order-test', + 'backendName' => 'tableName', + ], + 'with' => [ + 'title' => '', + 'description' => 'The parameters of the table.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'with', + ], + 'properties' => [ + 'title' => '', + 'description' => 'The information about the table. The information includes the user who creates the table, the user who modifies the table, and the creation time and modification time of the table.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'properties', + ], + 'columns' => [ + 'title' => '', + 'description' => 'The information about columns.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The details about columns.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LineageColumn', + ], + 'backendName' => 'columns', + ], + ], + ], + 'LocalVariable' => [ + 'title' => 'A short description of struct', + 'description' => 'The variables.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The name of the variable.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'name', + ], + 'value' => [ + 'title' => '', + 'description' => 'The value of the variable.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'datagen', + 'backendName' => 'value', + ], + ], + ], + 'Lock' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the lock of the draft.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => 'The lock ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'stt-fu1658tbk6mnkk2****', + 'backendName' => 'id', + ], + 'workspace' => [ + 'title' => '', + 'description' => 'The workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'a14bd5d90a****', + 'backendName' => 'workspace', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'default-namespace', + 'backendName' => 'namespace', + ], + 'holderId' => [ + 'title' => '', + 'description' => 'The ID of the lock holder.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '18389966****', + 'backendName' => 'holderId', + ], + 'holderName' => [ + 'title' => '', + 'description' => 'The username of the lock holder.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'holderName', + ], + ], + ], + 'Log4jLogger' => [ + 'title' => '', + 'description' => 'The configuration information about the output log of a job.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'loggerName' => [ + 'title' => '', + 'description' => 'The name of the class of the output log.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'StdOutErrConsoleAppender', + 'backendName' => 'loggerName', + ], + 'loggerLevel' => [ + 'title' => '', + 'description' => 'The level of the output log.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'ERROR', + 'backendName' => 'loggerLevel', + 'enum' => [ + 'TRACE', + 'DEBUG', + 'INFO', + 'WARN', + 'ERROR', + ], + ], + ], + ], + 'Logging' => [ + 'title' => '', + 'description' => 'The information about log configurations for a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'loggingProfile' => [ + 'title' => '', + 'description' => 'The type of the system log template.'."\n" + ."\n" + .'* default: The default template is used.'."\n" + .'* oss: Logs are delivered to Object Storage Service (OSS).'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'oss', + 'backendName' => 'loggingProfile', + 'enum' => [ + 'default', + 'oss', + ], + ], + 'log4j2ConfigurationTemplate' => [ + 'title' => '', + 'description' => 'Custom log templates.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'log4j2ConfigurationTemplate', + ], + 'log4jLoggers' => [ + 'title' => '', + 'description' => 'The Log4j configuration.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The log output configuration information about a job.'."\n", + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/Log4jLogger', + ], + 'backendName' => 'log4jLoggers', + ], + 'logReservePolicy' => [ + 'title' => '', + 'description' => 'The log retention policy.'."\n", + 'visibility' => 'public', + 'backendName' => 'logReservePolicy', + '$ref' => '#/components/schemas/LogReservePolicy', + ], + ], + ], + 'LogReservePolicy' => [ + 'title' => '', + 'description' => 'The configurations related to log archiving for a job.', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'openHistory' => [ + 'title' => '', + 'description' => 'Specifies whether to enable the log archiving feature.', + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'openHistory', + ], + 'expirationDays' => [ + 'title' => '', + 'description' => 'The number of days for which logs are retained after you enable the'."\n" + .'log archiving feature.', + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + 'backendName' => 'expirationDays', + ], + ], + ], + 'Member' => [ + 'title' => '', + 'description' => 'The parameters related to a member.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'member' => [ + 'title' => '', + 'description' => 'The member ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'user: 181319557522****', + 'backendName' => 'member', + ], + 'role' => [ + 'title' => '', + 'description' => 'The role of the member.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* EDITOR'."\n" + .'* VIEWER'."\n" + .'* ADMIN'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'enumValueTitles' => [ + 'EDITOR' => 'EDITOR', + 'OWNER' => 'OWNER', + 'VIEWER' => 'VIEWER', + ], + 'example' => 'VIEWER', + 'backendName' => 'role', + ], + ], + ], + 'MetadataInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'The metadata information.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '', + 'description' => 'The metadata field.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'topic', + 'backendName' => 'key', + ], + 'virtual' => [ + 'title' => '', + 'description' => 'Specifies whether the metadata is read only.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'backendName' => 'virtual', + ], + ], + ], + 'Node' => [ + 'title' => 'A short description of struct', + 'description' => 'The nodes in data lineage.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => 'The ID of the node.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '97383', + 'backendName' => 'id', + ], + 'catalogName' => [ + 'title' => '', + 'description' => 'The name of the catalog.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'paimon', + 'backendName' => 'catalogName', + ], + 'databaseName' => [ + 'title' => '', + 'description' => 'The name of the database.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'paimon-ods', + 'backendName' => 'databaseName', + ], + 'isTemporary' => [ + 'title' => '', + 'description' => 'Specifies whether the table is a temporary table.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'isTemporary', + ], + 'connector' => [ + 'title' => '', + 'description' => 'The name of the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'paimon', + 'backendName' => 'connector', + ], + 'tables' => [ + 'title' => '', + 'description' => 'The information about the table.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the table.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/LineageTable', + ], + 'backendName' => 'tables', + ], + ], + ], + 'PrimaryKey' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'constraintName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'pk', + 'backendName' => 'constraintName', + ], + 'columns' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'id', + 'extendType' => 'true', + ], + 'backendName' => 'columns', + ], + ], + ], + 'Property' => [ + 'title' => 'A short description of struct', + 'description' => 'The configuration of the connector.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key', + 'description' => 'The name of the parameter key.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'username', + 'backendName' => 'key', + ], + 'defaultValue' => [ + 'title' => '', + 'description' => 'The default value of the parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'defaultValue', + ], + 'description' => [ + 'title' => '', + 'description' => 'The description of the parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'description', + ], + 'required' => [ + 'title' => '', + 'description' => 'Indicates whether the parameter is required.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'required', + ], + 'definesFormat' => [ + 'title' => '', + 'description' => 'Indicates whether the format is defined.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'flase', + 'backendName' => 'definesFormat', + ], + 'sensitive' => [ + 'title' => '', + 'description' => 'Indiactes whether the data is sensitive.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'sensitive', + ], + ], + ], + 'PythonArtifact' => [ + 'title' => '', + 'description' => 'The information required for a Python deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'pythonArtifactUri' => [ + 'title' => '', + 'description' => 'The full URL for the Python deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/test.py', + 'backendName' => 'pythonArtifactUri', + ], + 'mainArgs' => [ + 'title' => '', + 'description' => 'The startup parameter.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'start from main', + 'backendName' => 'mainArgs', + ], + 'entryModule' => [ + 'title' => '', + 'description' => 'The startup module for the Python deployment.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'test.py', + 'backendName' => 'entryModule', + ], + 'additionalDependencies' => [ + 'title' => '', + 'description' => 'The URL of the additional dependency file.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL of the dependency file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/addition.py', + 'extendType' => 'true', + ], + 'backendName' => 'additionalDependencies', + ], + 'additionalPythonLibraries' => [ + 'title' => '', + 'description' => 'The Python library file on which the deployment depends.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL of the Python library file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/additionlib.py', + 'extendType' => 'true', + ], + 'backendName' => 'additionalPythonLibraries', + ], + 'additionalPythonArchives' => [ + 'title' => '', + 'description' => 'The Python archive file on which the deployment depends.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL of the Python archive file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/additionArchives.zip', + 'extendType' => 'true', + ], + 'backendName' => 'additionalPythonArchives', + ], + ], + ], + 'Relation' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'TableA', + 'backendName' => 'source', + ], + 'destination' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'TableB', + 'backendName' => 'destination', + ], + 'jobId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****', + 'backendName' => 'jobId', + ], + ], + ], + 'RescaleJobParam' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'jobParallelism' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'backendName' => 'jobParallelism', + ], + ], + ], + 'ResourceSpec' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'cpu' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + 'backendName' => 'cpu', + ], + 'memory' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '4Gi', + 'backendName' => 'memory', + ], + ], + ], + 'Savepoint' => [ + 'title' => '', + 'description' => 'The information about the savepoint.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'savepointId' => [ + 'title' => '', + 'description' => 'The savepoint ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', + 'backendName' => 'savepointId', + ], + 'deploymentId' => [ + 'title' => '', + 'description' => 'The deployment ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '1d716b22-6aad-4be2-85c2-50cfc757****', + 'backendName' => 'deploymentId', + ], + 'jobId' => [ + 'title' => '', + 'description' => 'The job ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + 'backendName' => 'jobId', + ], + 'namespace' => [ + 'title' => '', + 'description' => 'The name of the namespace.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'namespacetest', + 'backendName' => 'namespace', + ], + 'savepointOrigin' => [ + 'title' => '', + 'description' => 'The method that is used to create a savepoint.'."\n" + ."\n" + .'* `USER_REQUEST`: The savepoint is manually created.'."\n" + .'* `STOP_WITH_SAVEPOINT`: The savepoint is created when you cancel the deployment.'."\n" + .'* `RETAINED_CHECKPOINT`: The savepoint is created based on the returned checkpoint.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'USER_REQUEST', + 'backendName' => 'savepointOrigin', + 'enum' => [ + 'USER_REQUEST', + 'STOP_WITH_SAVEPOINT', + 'RETAINED_CHECKPOINT', + 'AUTO_TRIGGERED', + ], + ], + 'nativeFormat' => [ + 'title' => '', + 'description' => 'Specifies whether the savepoint is in native format.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'TRUE', + 'backendName' => 'nativeFormat', + ], + 'description' => [ + 'title' => '', + 'description' => 'The description of the savepoint.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'description', + ], + 'stopWithDrainEnabled' => [ + 'title' => '', + 'description' => 'Specifies whether to use the stop-with-drain mode.'."\n", + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'TRUE', + 'backendName' => 'stopWithDrainEnabled', + ], + 'savepointLocation' => [ + 'title' => '', + 'description' => 'The storage URL of the savepoint.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285', + 'backendName' => 'savepointLocation', + ], + 'status' => [ + 'title' => '', + 'description' => 'The status of the savepoint.'."\n", + 'visibility' => 'public', + 'backendName' => 'status', + '$ref' => '#/components/schemas/SavepointStatus', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The time when the savepoint was created.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659066711', + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The time when the savepoint was last modified.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1659069473', + 'backendName' => 'modifiedAt', + ], + ], + ], + 'SavepointFailure' => [ + 'title' => '', + 'description' => 'The information about a savepoint failure in a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '', + 'description' => 'The failure information.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'create savepoint failed', + 'backendName' => 'message', + ], + 'reason' => [ + 'title' => '', + 'description' => 'The reason for the failure.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'IO Exception', + 'backendName' => 'reason', + ], + 'failedAt' => [ + 'title' => '', + 'description' => 'The time when the deployment fails.'."\n", + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655006835', + 'backendName' => 'failedAt', + ], + ], + ], + 'SavepointStatus' => [ + 'title' => '', + 'description' => 'The status of the savepoint that is created for a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'title' => '', + 'description' => 'The status of the savepoint that is created for the deployment. Valid values:'."\n" + ."\n" + .'* STARTED'."\n" + .'* COMPLETED'."\n" + .'* FAILED'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'COMPLETED', + 'backendName' => 'state', + 'enum' => [ + 'STARTED', + 'COMPLETED', + 'FAILED', + ], + ], + 'failure' => [ + 'title' => '', + 'description' => 'The details of the failure to create a savepoint for the deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'failure', + '$ref' => '#/components/schemas/SavepointFailure', + ], + ], + ], + 'Schema' => [ + 'title' => 'A short description of struct', + 'description' => 'The schema information about the table.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'title' => '', + 'description' => 'The information about columns.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the fields that are contained in the table.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/TableColumn', + ], + 'backendName' => 'columns', + ], + 'watermarkSpecs' => [ + 'title' => '', + 'description' => 'The watermark information.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The watermark information.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/WatermarkSpec', + ], + 'backendName' => 'watermarkSpecs', + ], + 'primaryKey' => [ + 'description' => 'The information about the primary key.'."\n", + 'visibility' => 'Public', + 'backendName' => 'primaryKey', + '$ref' => '#/components/schemas/PrimaryKey', + 'title' => '', + ], + ], + ], + 'SqlArtifact' => [ + 'title' => '', + 'description' => 'The information required for an SQL deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'sqlScript' => [ + 'title' => '', + 'description' => 'The script of the SQL deployment.'."\n", + 'visibility' => 'public', + '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;', + 'backendName' => 'sqlScript', + ], + 'additionalDependencies' => [ + 'title' => '', + 'description' => 'The additional dependency files. If you want to use dependencies such as UDFs, connectors, and formats that are not registered on Ververica Platform (VVP), you need to configure this parameter. You do not need to configure this parameter for dependencies that are registered on VVP.'."\n", + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL of the additional dependency file.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'https://oss/bucket/addition.jar', + 'extendType' => 'true', + ], + 'backendName' => 'additionalDependencies', + ], + ], + ], + 'SqlStatementExecuteResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The returned result of the SQL statement.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'executeSuccess' => [ + 'title' => '', + 'description' => 'Indicates whether the request was successful.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'executeSuccess', + ], + 'errorDetails' => [ + 'description' => 'The error details returned.'."\n", + 'visibility' => 'Public', + 'backendName' => 'errorDetails', + '$ref' => '#/components/schemas/ErrorDetails', + ], + 'statement' => [ + 'title' => '', + 'description' => 'The statement that was executed.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“show create table order”', + 'backendName' => 'statement', + ], + ], + ], + 'SqlStatementValidationResult' => [ + 'title' => '', + 'description' => 'The verification result of the SQL deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'title' => '', + 'description' => 'Indicates whether the request was successful.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'True', + 'backendName' => 'success', + ], + 'message' => [ + 'title' => '', + 'description' => 'The verification information.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'message', + ], + 'validationResult' => [ + 'title' => '', + 'description' => 'The verification result.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'VALIDATION_RESULT_INVALID', + 'backendName' => 'validationResult', + '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' => 'The error message of the verification result.'."\n", + 'visibility' => 'Public', + 'backendName' => 'errorDetails', + '$ref' => '#/components/schemas/ErrorDetails', + ], + ], + ], + 'SqlStatementWithContext' => [ + 'title' => '', + 'description' => 'The code of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'statement' => [ + 'title' => '', + 'description' => 'The code of the deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'CREATE TEMPORARY TABLE datagen_source ('."\n" + .' name VARCHAR,'."\n" + .' score BIGINT'."\n" + .') WITH ('."\n" + .' \'connector\' = \'datagen\''."\n" + .');'."\n" + .'CREATE TEMPORARY TABLE print_table ('."\n" + .' name VARCHAR,'."\n" + .' score BIGINT'."\n" + .') WITH ('."\n" + .' \'connector\'=\'print\','."\n" + .' \'logger\'=\'true\''."\n" + .');'."\n" + ."\n" + .'INSERT INTO print_table'."\n" + .'select * from datagen_source;', + 'backendName' => 'statement', + ], + 'flinkConfiguration' => [ + 'title' => '', + 'description' => 'The Realtime Compute for Apache Flink configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'flink_configuration', + ], + 'batchMode' => [ + 'title' => '', + 'description' => 'Specifies whether the deployment is a batch deployment.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + 'backendName' => 'batch_mode', + ], + 'versionName' => [ + 'title' => '', + 'description' => 'The engine version.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'vvr-8.0.6-flink-1.17', + 'backendName' => 'version_name', + ], + 'additionalDependencies' => [ + 'title' => '', + 'description' => 'The additional dependencies.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The URL of the additional dependency file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '"oss://xxx"', + 'extendType' => 'true', + ], + 'backendName' => 'additional_dependencies', + 'itemName' => 'dependency', + ], + ], + ], + 'StartJobRequestBody' => [ + 'title' => '', + 'description' => 'The information about the startup of a deployment.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '', + 'description' => 'The deployment ID.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => '5a19a71b-1c42-4f34-94fd-86cf6078****', + 'backendName' => 'deploymentId', + ], + 'resourceSettingSpec' => [ + 'title' => '', + 'description' => 'The resource configuration of the deployment.'."\n", + 'visibility' => 'public', + 'backendName' => 'resourceSettingSpec', + '$ref' => '#/components/schemas/BriefResourceSetting', + ], + 'restoreStrategy' => [ + 'title' => '', + 'description' => 'The start offset of the job.'."\n", + 'visibility' => 'public', + 'backendName' => 'restoreStrategy', + '$ref' => '#/components/schemas/DeploymentRestoreStrategy', + ], + ], + ], + 'StopJobRequestBody' => [ + 'title' => '', + 'description' => 'The request that is used to stop the job.', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'stopStrategy' => [ + 'title' => '', + 'description' => 'The strategy that is used to stop a job. Valid values:'."\n" + ."\n" + .'* `NONE`: Directly stop the job.'."\n" + .'* `STOP_WITH_SAVEPOINT`: Stop the job after a savepoint is generated.'."\n" + .'* `STOP_WITH_DRAIN`: Stop the job and drain the pipeline. Use this strategy only if you want to permanently terminate the job.', + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'NONE', + 'backendName' => 'stopStrategy', + 'enum' => [ + 'NONE', + 'STOP_WITH_SAVEPOINT', + 'STOP_WITH_DRAIN', + ], + ], + ], + ], + 'StreamingResourceSetting' => [ + 'title' => '', + 'description' => 'The resource parameters of the deployment that runs in streaming mode.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'resourceSettingMode' => [ + 'title' => '', + 'description' => 'The resource configuration mode used by a deployment that runs in streaming mode. Valid values:'."\n" + ."\n" + .'* EXPERT'."\n" + .'* BASIC'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'EXPERT', + 'backendName' => 'resourceSettingMode', + 'enum' => [ + 'BASIC', + 'EXPERT', + ], + ], + 'expertResourceSetting' => [ + 'title' => '', + 'description' => 'The resource parameters in expert mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'expertResourceSetting', + '$ref' => '#/components/schemas/ExpertResourceSetting', + ], + 'basicResourceSetting' => [ + 'title' => '', + 'description' => 'The resource parameters in basic mode.'."\n", + 'visibility' => 'public', + 'backendName' => 'basicResourceSetting', + '$ref' => '#/components/schemas/BasicResourceSetting', + ], + ], + ], + 'SubFolder' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'folderId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'a579aec9-1d5e-3382-9d65-9887ff6cfaff', + 'backendName' => 'folderId', + ], + 'parentId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '95c0787c-408f-4e1f-88ba-ef0a84a2c2ee', + 'backendName' => 'parentId', + ], + 'name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'test', + 'backendName' => 'name', + ], + ], + ], + 'Table' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the table.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The name of the table.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'order-test', + 'backendName' => 'name', + ], + 'schema' => [ + 'title' => '', + 'description' => 'The schema information about the table.'."\n", + 'visibility' => 'Public', + 'required' => false, + 'backendName' => 'schema', + '$ref' => '#/components/schemas/Schema', + ], + 'properties' => [ + 'title' => '', + 'description' => 'The parameter configurations of the table.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'backendName' => 'properties', + ], + 'comment' => [ + 'title' => '', + 'description' => 'The comment.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'comment', + ], + 'partitionKeys' => [ + 'title' => '', + 'description' => 'The partition key column.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The partition field.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ad=xxxxx', + 'extendType' => 'true', + ], + 'backendName' => 'partitionKeys', + ], + 'tableType' => [ + 'title' => ' TABLE;'."\n" + .' MATERIALIZED_TABLE;'."\n" + .' VIEW;', + 'description' => ' TABLE;'."\n" + .' MATERIALIZED_TABLE;'."\n" + .' VIEW;', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'backendName' => 'tableType', + ], + 'metadata' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'visibility' => 'Public', + 'type' => 'string', + ], + ], + ], + ], + 'TableColumn' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about columns.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '', + 'description' => 'The column name.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + 'backendName' => 'name', + ], + 'metadataInfo' => [ + 'title' => '', + 'description' => 'The metadata information.'."\n", + 'visibility' => 'Public', + 'backendName' => 'metadataInfo', + '$ref' => '#/components/schemas/MetadataInfo', + ], + 'expression' => [ + 'title' => '', + 'description' => 'The computed column.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'expression', + ], + 'type' => [ + 'title' => '', + 'description' => 'The data type of the column.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'string', + 'backendName' => 'type', + ], + 'nullable' => [ + 'title' => '', + 'description' => 'Specifies whether the column can have a null value.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'nullable', + ], + 'logicalType' => [ + 'visibility' => 'Public', + 'type' => 'string', + 'backendName' => 'logicalType', + ], + ], + ], + 'TableMeta' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'catalogName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'paimon', + 'backendName' => 'catalogName', + ], + 'databaseName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'paimon-ods', + 'backendName' => 'databaseName', + ], + 'tableName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'order-table', + 'backendName' => 'tableName', + ], + ], + ], + 'UdfArtifact' => [ + 'title' => 'A short description of struct', + 'description' => 'The data structure of the JAR file of a user-defined function (UDF).'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'namespace' => [ + 'title' => '', + 'description' => 'The namespace.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'default-namespace'."\n", + 'backendName' => 'namespace', + ], + 'creator' => [ + 'title' => '', + 'description' => 'The user that creates the JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'userA', + 'backendName' => 'creator', + ], + 'createdAt' => [ + 'title' => '', + 'description' => 'The time when the JAR file was created.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723532876', + 'backendName' => 'createdAt', + ], + 'modifiedAt' => [ + 'title' => '', + 'description' => 'The time when the JAR file was modified.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723537876', + 'backendName' => 'modifiedAt', + ], + 'name' => [ + 'title' => '', + 'description' => 'The name of the JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'udfCollection.jar'."\n", + 'backendName' => 'name', + ], + 'jarUrl' => [ + 'title' => 'udfArtifact url', + 'description' => 'The path in which the JAR file is stored.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://bucket/udfCollection.jar'."\n", + 'backendName' => 'jarUrl', + ], + 'dependencyJarUris' => [ + 'title' => '', + 'description' => 'The list of paths in which the additional dependencies of the JAR file are stored.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The paths in which the additional dependencies of the JAR file are stored.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'oss://bucket/addition/add.jar'."\n", + 'extendType' => 'true', + ], + 'backendName' => 'dependencyJarUris', + ], + 'artifactType' => [ + 'title' => '', + 'description' => 'The type of the JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ARTIFACT_TYPE_JAVA', + 'backendName' => 'artifactType', + 'enum' => [ + 'ARTIFACT_TYPE_JAVA', + 'ARTIFACT_TYPE_PYTHON', + 'ARTIFACT_TYPE_UNKNOWN', + ], + ], + 'udfClasses' => [ + 'title' => '', + 'description' => 'The list of the class name of the JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the UDF class.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/UdfClass', + ], + 'backendName' => 'udfClasses', + ], + ], + ], + 'UdfClass' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about the user-defined function (UDF) class.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'udfArtifactName' => [ + 'title' => '', + 'description' => 'The name of the UDF JAR file.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'udfCollection.jar', + 'backendName' => 'udfArtifactName', + ], + 'className' => [ + 'title' => '', + 'description' => 'The name of the class.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'myfunctionTest', + 'backendName' => 'className', + ], + 'classType' => [ + 'title' => '', + 'description' => 'The type of the class.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'UDF_TYPE_TABLE_AGGREGATE', + 'backendName' => 'classType', + 'enum' => [ + 'UDF_TYPE_INVALID', + 'UDF_TYPE_SCALAR', + 'UDF_TYPE_TABLE', + 'UDF_TYPE_AGGREGATE', + 'UDF_TYPE_TABLE_AGGREGATE', + 'UDF_TYPE_OTHER', + ], + ], + 'functionNames' => [ + 'title' => '', + 'description' => 'The list of UDF names.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the UDF.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'myfunction', + 'extendType' => 'true', + ], + 'backendName' => 'functionNames', + ], + ], + ], + 'UdfFunction' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'functionName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'myFunction', + 'backendName' => 'functionName', + ], + 'udfArtifactName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'udfCollection.jar', + 'backendName' => 'udfArtifactName', + ], + 'className' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'myFunctionTest', + 'backendName' => 'className', + ], + ], + ], + 'UpdateJobConfigParam' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'newFlinkConf' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'example' => '{"table.exec.parallelism：4"}', + 'backendName' => 'newFlinkConf', + ], + ], + ], + 'ValidateStatementResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The verification result of the SQL syntax.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'validationResult' => [ + 'title' => '', + 'description' => 'The verification result.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '"there have some errors""', + 'backendName' => 'validationResult', + ], + 'errorDetails' => [ + 'description' => 'The details of verification errors of the SQL syntax.'."\n", + 'visibility' => 'Public', + 'backendName' => 'errorDetails', + '$ref' => '#/components/schemas/ValidationErrorDetails', + ], + ], + ], + 'ValidationErrorDetails' => [ + 'title' => 'A short description of struct', + 'description' => 'The errors of the verification result of the SQL syntax.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'lineNumber' => [ + 'title' => '', + 'description' => 'The number the row at which the error starts.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '3', + 'backendName' => 'lineNumber', + ], + 'columnNumber' => [ + 'title' => '', + 'description' => 'The number of the column at which the error starts.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10', + 'backendName' => 'columnNumber', + ], + 'endLineNumber' => [ + 'title' => '', + 'description' => 'The number of the row at which the error ends.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '4', + 'backendName' => 'endLineNumber', + ], + 'endColumnNumber' => [ + 'title' => '', + 'description' => 'The number of the column at which the error ends.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '5', + 'backendName' => 'endColumnNumber', + ], + 'message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '“”', + 'backendName' => 'message', + ], + ], + ], + 'Variable' => [ + 'title' => 'A short description of struct', + 'description' => 'The information about variable configurations.'."\n", + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'kind' => [ + 'title' => '', + 'description' => 'The type of the variable. Valid value: Plain.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'Plain', + 'backendName' => 'kind', + 'enum' => [ + 'Plain', + ], + ], + 'name' => [ + 'title' => '', + 'description' => 'The name of the variable.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'variableName', + 'pattern' => '^[a-zA-Z0-9_-]{1,64}$', + 'backendName' => 'name', + ], + 'value' => [ + 'title' => '', + 'description' => 'The value of the variable.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'required' => true, + 'example' => 'variableValue', + 'backendName' => 'value', + ], + 'description' => [ + 'title' => '', + 'description' => 'The description of the variable.'."\n", + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'This is a variable description', + 'backendName' => 'description', + ], + ], + ], + 'WatermarkSpec' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'column' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'time', + 'backendName' => 'column', + ], + 'watermarkExpression' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'INTERVAL \'5\' SECOND', + 'backendName' => 'watermarkExpression', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateFolder' => [ + 'summary' => 'Creates a folder.', + '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' => 'The name of the workspace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The structure of data in the folder.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The HTTP status code. If this parameter was not empty and the value of this parameter was not 200, the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The structure of data in the folder.'."\n", + '$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' => 'CreateFolder', + ], + 'UpdateFolder' => [ + 'summary' => 'Updates a folder.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'f89a0c1ca8****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'folderId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The folder ID. You can call the GetFolder operation to obtain the folder ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '13803', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The data structure of the folder.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Folder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The HTTP status code. If this parameter was not empty and the value of this parameter was not 200, the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The information returned after the folder is updated.'."\n", + '$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', + ], + 'DeleteFolder' => [ + 'summary' => 'Deletes an empty folder. If files or folders exist in a folder, the folder cannot be deleted.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'c96306e2b****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'folderId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The folder ID. You can call the GetFloder operation to obtain the folder ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '13803', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'If the value of success was true, the created deployment was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The HTTP status code. If this parameter was not empty and the value of this parameter was not 200, the request failed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteFolder', + ], + 'GetFolder' => [ + 'summary' => 'Obtains the details of a folder.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '89097', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'If the value of success was true, the created deployment was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The data structure of the folder.'."\n", + '$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' => 'GetFolder', + ], + 'ValidateDeploymentDraftAsync' => [ + 'summary' => 'validate DeploymentDraft async', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ticketId' => [ + 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'description' => '', + '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' => 'ValidateDeploymentDraftAsync', + ], + 'GetValidateDeploymentDraftResult' => [ + 'summary' => 'Get validate DeploymentDraft result', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetValidateDeploymentDraftResult', + ], + 'CreateDeploymentDraft' => [ + 'summary' => 'Creates an SQL draft.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'CreateDeploymentDraft', + 'translator' => 'machine', + ], + 'UpdateDeploymentDraft' => [ + 'summary' => 'Updates an SQL draft.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'DeleteDeploymentDraft' => [ + 'summary' => 'Deletes an SQL draft. If the draft is deployed as a deployment and the deployment is published or the deployment status is RUNNING, the deployment for the draft cannot be deleted.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + '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}","type":"json"}]', + 'title' => 'DeleteDeploymentDraft', + ], + 'GetDeploymentDraft' => [ + 'summary' => 'Obtains the details of an SQL draft.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetDeploymentDraft', + ], + 'ListDeploymentDrafts' => [ + 'summary' => 'Queries a list of SQL drafts.', + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => '', + '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' => 'ListDeploymentDrafts', + ], + 'GetDeploymentDraftLock' => [ + 'summary' => 'Obtains the lock that is used to edit a draft. This can prevent operations performed on the page and API operations from affecting each other.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetDeploymentDraftLock', + ], + 'DeployDeploymentDraftAsync' => [ + 'summary' => 'Deploys an SQL draft.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ticketId' => [ + 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'description' => '', + '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' => 'DeployDeploymentDraftAsync', + ], + 'GetDeployDeploymentDraftResult' => [ + 'summary' => 'Obtains the deployment result based on the ID of the asynchronous ticket.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetDeployDeploymentDraftResult', + ], + 'ValidateSqlStatement' => [ + 'summary' => 'Verifies the code of an SQL deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => 'Deployment内容。', + 'description' => 'The content of the code that you want to verify.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/SqlStatementWithContext', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-****-1D30-8A4F-882ED4DD5E02', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error code was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error message was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The returned data, which represents the details of SQL validation results.'."\n", + '$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' => 'ValidateSqlStatement', + ], + 'CreateUdfArtifact' => [ + 'summary' => 'Parses all user-defined function (UDF) methods in your JAR or Python file and creates an artifact configuration for a 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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The resource file of the UDF.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/UdfArtifact', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The result of creating an artifact configuration for the UDF.'."\n", + '$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' => 'CreateUdfArtifact', + ], + 'UpdateUdfArtifact' => [ + 'summary' => 'Updates the JAR file of the user-defined function (UDF) that you create.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the JAR file of the UDF.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-udf', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The details of the JAR file of the UDF.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/UdfArtifact', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The result of updating the JAR file of the UDF.'."\n", + '$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' => 'UpdateUdfArtifact', + ], + 'GetUdfArtifacts' => [ + 'summary' => 'Obtains the details of the JAR or Python file that corresponds to the user-defined function (UDF) that you upload and create.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8c34d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the JAR or Python file that corresponds to the UDF.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-udf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, the details of the JAR or Python file that corresponds to the UDF were returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of JAR or Python file.'."\n", + '$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' => 'GetUdfArtifacts', + ], + 'DeleteUdfArtifact' => [ + 'summary' => 'Deletes resources of a user-defined function (UDF) from a namespace. Before you delete the resources of a UDF, you must delete the UDF.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'DeleteUdfArtifact', + ], + 'DeleteUdfFunction' => [ + 'summary' => 'Deletes an existing user-defined function (UDF) from a Realtime Compute for Apache Flink workspace.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the UDF that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'category', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource that corresponds to the UDF that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-udf', + ], + ], + [ + 'name' => 'className', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the class that corresponds to the UDF.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Category', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteUdfFunction', + ], + 'RegisterUdfFunction' => [ + 'summary' => 'Registers specific or all of the user-defined functions (UDFs) that are parsed from the JAR files. The registered functions can be used in SQL statements.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'functionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the UDF. In most cases, the name of the UDF is the same as the class name. You can specify a name for the UDF.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'orderRank', + ], + ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the JAR or Python file that corresponds to the UDF.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-udf', + ], + ], + [ + 'name' => 'className', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the class that corresponds to the UDF.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'orderRank', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The information about the UDF.'."\n", + '$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' => 'RegisterUdfFunction', + ], + 'ListCustomConnectors' => [ + 'summary' => 'Obtains a list of existing custom connectors.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, the list of custom connectors in the namespace was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the custom connector.'."\n", + '$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' => 'ListCustomConnectors', + ], + 'RegisterCustomConnector' => [ + 'summary' => 'Registers a custom connector in a namespace. The registered custom connector can be used in SQL statements.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jarUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL in which the JAR package of the custom connector is stored. The platform must be able to access this address.', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://flink/connector/mysql123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, a list of deployments in which custom connectors were deleted was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the custom connector.'."\n", + '$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', + ], + 'DeleteCustomConnector' => [ + 'summary' => 'Deletes a registered custom connector from a workspace.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test-flink-bigdata-default', + ], + ], + [ + 'name' => 'connectorName', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the custom connector.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'mysql-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, a list of deployments in which custom connectors were deleted was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about tables that are created by using a custom connector.'."\n", + '$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' => 'DeleteCustomConnector', + ], + 'GetDatabases' => [ + 'summary' => 'Obtains the information about a database in a specified catalog or lists all databases in a specified catalog.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon', + ], + ], + [ + 'name' => 'databaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'paimon-ods', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, the list of databases that meet the specified condition was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the database.'."\n", + '$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' => 'GetDatabases', + ], + 'GetTables' => [ + 'summary' => 'Obtains the details of a specific table in a database of a specific catalog or the information about all tables in a 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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon', + ], + ], + [ + 'name' => 'databaseName', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'paimon-ods', + ], + ], + [ + 'name' => 'tableName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'item', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'ECE641B2-AB0B-4174-9C3B-885881558637', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, the list and details of tables that meet the condition were returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the table.'."\n", + '$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' => 'GetTables', + ], + 'GetCatalogs' => [ + 'summary' => 'Obtains details of the specified catalog or all catalogs.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'paimon', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => 'If the value of success was true, the list of catalogs that meet the specified condition was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the catalog.'."\n", + '$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' => 'GetCatalogs', + ], + 'ExecuteSqlStatement' => [ + 'summary' => 'Executes SQL statements to query the metadata. Only DDL and DML statements are supported. DQL statements are not supported.', + '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' => '', + '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' => 'The SQL statement to query the metadata.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SqlStatementWithContext', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The result of executing the SQL statement to query the metadata.'."\n", + '$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' => 'ExecuteSqlStatement', + ], + 'CreateSavepoint' => [ + 'summary' => 'Creates a savepoint.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '触发savepoint参数。', + 'description' => 'The parameters that are used to create a savepoint.'."\n", + 'type' => 'object', + 'properties' => [ + 'deploymentId' => [ + 'title' => '作业ID。', + 'description' => 'The deployment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + 'description' => [ + 'title' => 'savepoint描述信息。', + 'description' => 'The description of the savepoint.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'nativeFormat' => [ + 'title' => '是否使用nativeFormat模式。', + 'description' => 'Specifies whether to use the native format mode. Valid values:'."\n" + ."\n" + .'* true: The native format mode is used.'."\n" + .'* false: The native format mode is not used.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回触发成功的savepoint信息；当success为false，该值为空。', + 'description' => '* If the value of success was true, the savepoint that was created was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'CreateSavepoint', + ], + 'GetSavepoint' => [ + 'summary' => 'Queries details of a savepoint and checkpoint.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'savepointId', + 'in' => 'path', + 'schema' => [ + 'title' => 'Savepoint ID。', + 'description' => 'The savepoint ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => 'Savepoint信息。', + 'description' => '* If the value of success was true, the savepoint information was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'GetSavepoint', + ], + 'DeleteSavepoint' => [ + 'summary' => 'Deletes a savepoint.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'savepointId', + 'in' => 'path', + 'schema' => [ + 'title' => '需要删除的savepoint ID。', + 'description' => 'The ID of the savepoint that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '907a8f0e-4f6c-412b-8a5e-7d4a065b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteSavepoint', + ], + 'ListSavepoints' => [ + 'summary' => 'Obtains a list of savepoints or checkpoints.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => '作业ID。', + 'description' => 'The deployment ID. This parameter is optional.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The job ID. This parameter is optional.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '99a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回满足查询条件的savepoint列表；当success为false，该值为空。', + 'description' => '* If the value of success was true, a list of savepoints was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'savepoint数据。', + 'description' => 'The information about the savepoint.'."\n", + '$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' => 'ListSavepoints', + ], + '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' => '', + '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' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'true', + ], + ], + [ + 'name' => 'ignoreResourceSetting', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetDeploymentsByName', + ], + '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' => '', + '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' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'ignoreResourceSetting', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetDeploymentsByLabel', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.100', + ], + ], + [ + 'name' => 'srcPort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '54321', + ], + ], + [ + 'name' => 'dstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10.100.2.200', + ], + ], + [ + 'name' => 'dstPort', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '9092', + ], + ], + [ + 'name' => 'ignoreJobSummary', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetDeploymentsByIp', + ], + 'CreateDeployment' => [ + 'summary' => 'Creates a deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => 'Deployment内容。', + 'description' => 'The content of the deployment.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '响应数据。', + 'description' => '* If the value of success was true, the deployment that you created was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'CreateDeployment', + ], + 'UpdateDeployment' => [ + 'summary' => 'Updates information about a deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => 'The deployment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '需要更新的作业内容。', + 'description' => 'The information about the deployment that you want to update.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Deployment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回更新后的作业内容；当success为false，该值为空。', + 'description' => '* If the value of success was true, the information about the deployment after the update was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'UpdateDeployment', + ], + 'GetDeployment' => [ + 'summary' => 'Obtains the details of a deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => 'The deployment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回根据ID查询的作业；当success为false，该值为空。', + 'description' => '* If the value of success was true, the details of the deployment were returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'GetDeployment', + ], + 'ListDeployments' => [ + 'summary' => 'Obtains information about all deployments.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => 'The name of the deployment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vvp_ds_0522', + ], + ], + [ + 'name' => 'executionMode', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment执行模式。', + 'description' => 'The execution mode of the deployment.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* BATCH'."\n" + .'* STREAMING'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'STREAMING', + 'enum' => [ + 'BATCH', + 'STREAMING', + ], + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest status of the deployment.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CANCELLED'."\n" + .'* FAILED'."\n" + .'* RUNNING'."\n" + .'* TRANSITIONING'."\n" + .'* FINISHED'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CANCELLED' => 'CANCELLED', + 'FAILED' => 'FAILED', + 'RUNNING' => 'RUNNING', + 'TRANSITIONING' => 'TRANSITIONING', + 'FINISHED' => 'FINISHED', + ], + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'creator', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who creates the deployment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '183899668*******', + ], + ], + [ + 'name' => 'modifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who modifies the deployment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '183899668*******', + ], + ], + [ + 'name' => 'labelKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'labelValueArray', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag value. Separate multiple values with semicolon (;).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1,value2', + ], + ], + [ + 'name' => 'sortName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'gmt_create', + 'gmt_modified', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '* If the value of success was true, the list of all deployments was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '作业数据。', + 'description' => 'The data of the deployment.'."\n", + '$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' => 'ListDeployments', + ], + 'DeleteDeployment' => [ + 'summary' => 'Deletes a deployment based on the deployment 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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => '作业ID。', + 'description' => 'The deployment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5737ef81-d2f1-49cf-8752-30910809****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteDeployment', + ], + 'GetEvents' => [ + 'summary' => 'Queries events.', + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => '', + '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' => 'GetEvents', + ], + 'GetJob' => [ + 'summary' => 'Obtains the details of a job.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回查询的实例；当success为false，该值为空。', + 'description' => '* If the value of success was true, the details of the job was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'GetJob', + ], + 'ListJobs' => [ + 'summary' => 'Queries the information about all jobs in a deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => '作业ID。', + 'description' => 'The deployment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + [ + 'name' => 'sortName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collation.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* gmt_create'."\n" + .'* job_id'."\n" + .'* status'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gmt_create', + 'enum' => [ + 'gmt_create', + 'job_id', + 'status', + ], + ], + ], + [ + 'name' => 'sortOrder', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'enum' => [ + 'asc', + 'desc', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回所有满足条件的实例信息；当success为false，该值为空。', + 'description' => '* If the value of success was true, all jobs that meet the condition were returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '实例数据。', + 'description' => 'The job data.'."\n", + '$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' => 'ListJobs', + ], + 'StartJobWithParams' => [ + 'summary' => 'Starts a job.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****'."\n", + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace'."\n", + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '作业实例启动参数。', + 'description' => 'The parameter that is used to start the job.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/JobStartParameters', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据结构。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'."\n", + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error code was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error message was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The details of the job of the deployment returned.'."\n", + '$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' => 'StartJobWithParams', + ], + 'StopJob' => [ + 'summary' => 'Stops a job.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '启动实例参数。', + 'description' => 'The parameter that is used to stop the job.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/StopJobRequestBody', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '启动生成的实例数据。', + 'description' => '* If the value of success was true, the job that you stopped was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'StopJob', + ], + 'DeleteJob' => [ + 'summary' => 'Deletes the information about a job that is not in the running state in a deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间ID。', + 'description' => 'The namespace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteJob', + ], + 'HotUpdateJob' => [ + 'summary' => 'Dynamically updates parameters or resources of a deployment that is running.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'If the value of success was true, the dynamic update result was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The dynamic update result.'."\n", + '$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' => 'HotUpdateJob', + ], + 'GetHotUpdateJobResult' => [ + 'summary' => 'Obtains the dynamic update result of a deployment when you dynamically update the deployment.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123hashd****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetHotUpdateJobResult', + ], + 'GetLatestJobStartLog' => [ + 'summary' => 'Obtains the latest startup logs of a job.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The deployment ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error code was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error message was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'If the value of success was false, the latest logs of the deployment were returned. If the value of success was true, a null value was returned.'."\n", + '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' => 'GetLatestJobStartLog', + ], + 'GetJobDiagnosis' => [ + 'summary' => 'Queries information about abnormal diagnostic items based on the intelligent deployment diagnostics feature.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'GetJobDiagnosis', + ], + 'StartJob' => [ + 'summary' => 'Creates and starts a job.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The parameter that is used to start the job.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/StartJobRequestBody', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '* If the value of success was true, the job that you created was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'StartJob', + ], + 'CreateScheduledPlan' => [ + 'summary' => 'Creates a scheduled tuning plan.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'CreateScheduledPlan', + ], + 'UpdateScheduledPlan' => [ + 'summary' => 'Update a scheduled tuning plan.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'UpdateScheduledPlan', + ], + 'DeleteScheduledPlan' => [ + 'summary' => 'Deletes a scheduled tuning plan.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'ListScheduledPlan' => [ + 'summary' => 'Obtains a list of scheduled tuning plans.', + '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' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'deployment名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => '', + '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' => 'ListScheduledPlan', + ], + 'ApplyScheduledPlan' => [ + 'summary' => 'Executes a scheduled plan.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'ApplyScheduledPlan', + ], + 'StopApplyScheduledPlan' => [ + 'summary' => 'Stops the scheduled plan of an application.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'GetAppliedScheduledPlan' => [ + 'summary' => 'Queries the scheduled plan of an application.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5737ef81-d2f1-49cf-8752-30910809****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'ListScheduledPlanExecutedHistory' => [ + 'summary' => 'Queries the execution history of a scheduled plan.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '', + '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' => 'ListScheduledPlanExecutedHistory', + ], + 'CreateSessionCluster' => [ + 'summary' => 'Create a session cluster', + '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' => '', + '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/SessionCluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '', + '$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' => 'CreateSessionCluster', + ], + 'UpdateSessionCluster' => [ + 'summary' => 'Updates a session cluster.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '', + 'required' => false, + '$ref' => '#/components/schemas/SessionCluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '', + '$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' => 'UpdateSessionCluster', + ], + 'DeleteSessionCluster' => [ + 'summary' => 'Deletes a session cluster.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '', + '$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' => 'DeleteSessionCluster', + ], + 'GetSessionCluster' => [ + 'summary' => 'Queries the information about a session cluster.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '', + '$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' => 'GetSessionCluster', + ], + 'ListSessionClusters' => [ + 'summary' => 'Queries a list of session clusters.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '$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' => 'ListSessionClusters', + ], + 'StartSessionCluster' => [ + 'summary' => 'Starts a session cluster.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'StartSessionCluster', + ], + 'StopSessionCluster' => [ + 'summary' => 'Stops a session cluster.', + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test-session', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + '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}","type":"json"}]', + 'title' => 'StopSessionCluster', + ], + 'CreateDeploymentTarget' => [ + 'summary' => 'Creates a deployment target.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'CreateDeploymentTarget', + ], + 'UpdateDeploymentTarget' => [ + 'summary' => 'Updates a cluster on which the deployment is deployed.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'DeleteDeploymentTarget' => [ + 'summary' => 'Deletes a deployment target.', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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', + ], + 'ListDeploymentTargets' => [ + 'summary' => 'Obtains a list of clusters in which deployments can be deployed. The cluster can be a session cluster or a per-job cluster.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值1000。', + 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'pageIndex' => [ + 'title' => '页参数，页码索引，表示所请求页码。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回所有满足条件的幕布目标信息；当success为false，该值为空。', + 'description' => '* If the value of success was true, a list of clusters in which the deployment is deployed was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '部署目标信息。', + 'description' => 'The information about the cluster in which the deployment is deployed'."\n", + '$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' => 'ListDeploymentTargets', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'UpdateDeploymentTargetV2', + ], + 'CreateDeploymentTargetV2' => [ + 'summary' => '创建部署目标V2', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '', + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '', + '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' => 'CreateDeploymentTargetV2', + ], + 'CreateMember' => [ + 'summary' => 'Adds a user to a namespace as a member and grants permissions to the user.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ca84d539167d4d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'u-gs3rgla9-default', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '成员内容。', + 'description' => 'The mappings between the ID and permissions of the member.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Member', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F989CA70-2925-5A94-92B7-20F5762B71C8', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的成员；当success为false，该值为空。', + 'description' => '* If the value of success was false, a null value was returned.'."\n" + .'* If the value of success was true, the authorization information was returned.'."\n", + '$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' => 'CreateMember', + ], + 'UpdateMember' => [ + 'summary' => 'Updates the permissions of one or more members in a specific namespace.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '成员信息。', + 'description' => 'The permission information about the member.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/Member', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的成员；当success为false，该值为空。', + 'description' => 'If the value of success was true, the member that was created was returned. If the value of success was false, a null value was returned.'."\n", + '$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' => 'UpdateMember', + ], + 'DeleteMember' => [ + 'summary' => 'Revokes the permissions from a member.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8c34d', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'member', + 'in' => 'path', + 'schema' => [ + 'title' => '成员名称。', + 'description' => 'The member ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user:223769', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteMember', + ], + 'GetMember' => [ + 'summary' => 'Queries the permissions of a member.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'member', + 'in' => 'path', + 'schema' => [ + 'title' => '成员名称。', + 'description' => 'The display name of the member.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user:223769', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回成员信息；当success为false，该值为空。', + 'description' => '* If the value of success was false, a null value was returned.'."\n" + .'* If the value of success was true, the authorization information was returned.'."\n", + '$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' => 'GetMember', + ], + 'ListMembers' => [ + 'summary' => 'Queries the mappings between the ID and permissions of a member in a specific namespace.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'data' => [ + 'title' => '当success为true，返回所有满足条件的成员信息；当success为false，该值为空。', + 'description' => '* If the value of success was false, a null value was returned.'."\n" + .'* If the value of success was true, the authorization information was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '成员数据。', + 'description' => 'The information about the member.'."\n", + '$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' => 'ListMembers', + ], + 'UpdateVariable' => [ + 'summary' => 'Updates the information about a variable in a namespace.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the workspace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => 'The name of the variable.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vvp_ds_0522', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '创建变量的数据内容。', + 'description' => 'The information about the variable after the update.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Variable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error code was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => 'If the value of success was false, an error message was returned. If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的变量；当success为false，该值为空。', + 'description' => 'The variable structure after the update.'."\n", + '$ref' => '#/components/schemas/Variable', + ], + 'accessDeniedDetail' => [ + 'description' => 'The details of the access denial. This parameter is returned in scenarios where the account is not authorized to perform operations.'."\n", + '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' => 'UpdateVariable', + ], + 'CreateVariable' => [ + 'summary' => 'Creates a variable.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '创建变量的数据内容。', + 'description' => 'The parameter that is used to create the variable.'."\n", + 'required' => true, + '$ref' => '#/components/schemas/Variable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回创建的变量；当success为false，该值为空。', + 'description' => '* If the value of success was true, the variable that you created was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'CreateVariable', + ], + 'DeleteVariable' => [ + 'summary' => 'Deletes a variable.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'title' => '变量名称。', + 'description' => 'The name of the variable that you want to delete.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'variableName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + ], + ], + ], + ], + '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' => 'DeleteVariable', + ], + 'ListVariables' => [ + 'summary' => 'Obtains a list of variables.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bda1c4a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，所请求页码的元素数量，最大值为100，默认值为10。', + 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', + 'description' => 'The page number. Minimum value: 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'pageSize' => [ + 'title' => '分页参数，所请求页码的元素数量。', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'pageIndex' => [ + 'title' => '分页参数，页码索引，表示所请求页码。', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'totalSize' => [ + 'title' => '满足查询条件的所有元素的数量。', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'data' => [ + 'title' => '当success为true，返回满足查询条件的所有变量；当success为false，该值为空。', + 'description' => '* If the value of success was true, a list of variables was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '变量数据。', + 'description' => 'The value of the variable.'."\n", + '$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' => 'ListVariables', + ], + 'ListEngineVersionMetadata' => [ + 'summary' => 'Obtains a list of engine versions that are supported by Realtime Compute for Apache Flink.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回系统支持的引擎版本总体信息；当success为false，该值为空。', + 'description' => '* If the value of success was true, the engine versions that are supported by Realtime Compute for Apache Flink were returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'ListEngineVersionMetadata', + ], + 'GenerateResourcePlanWithFlinkConfAsync' => [ + 'summary' => 'Submits a ticket that applies for asynchronous generation of the fine-grained resources. This operation returns the ID of the ticket for you to query the asynchronous generation result.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => [ + 'title' => 'deploymentId信息，deployment唯一标识。', + 'description' => 'The deployment ID, which is the unique identifier of the deployment.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The Flink configuration that is used to generate a resource plan.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/FlinkConf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => '* If the value of success was true, the asynchronous generation result was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ticketId' => [ + 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', + 'description' => 'The ID of the ticket for you to query the asynchronous generation result.'."\n", + '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' => 'GenerateResourcePlanWithFlinkConfAsync', + ], + 'GetGenerateResourcePlanResult' => [ + 'summary' => 'Obtains the asynchronous generation result of fine-grained resources based on the ID of the ticket that applies for an asynchronous generation.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'ticketId', + 'in' => 'path', + 'schema' => [ + 'title' => '异步工单ID，可以通过提交异步操作获取。', + 'description' => 'The ID of the asynchronous ticket. You can submit an application for an asynchronous operation to obtain this ticket ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '异步操作结果。', + 'description' => '* If the value of success was true, the asynchronous generation result was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '$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' => 'GetGenerateResourcePlanResult', + ], + 'FlinkApiProxy' => [ + 'summary' => 'Provides a proxy for Realtime Compute for Apache Flink requests.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'a14bd5d90a****', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '项目空间名称。', + 'description' => 'The name of the namespace.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'default-namespace', + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型，支持以下类型：'."\n" + .'-jobs', + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'* jobs'."\n" + .'* sessionclusters'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'jobs', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源ID。', + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '5a27a3aa-c5b9-4dc1-8c86-be57d2d6****', + ], + ], + [ + 'name' => 'flinkApiPath', + 'in' => 'query', + 'schema' => [ + 'title' => 'flink-ui路径。', + 'description' => 'The path of the Flink UI.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/jobs/4df35f8e54554b23bf7dcd38a151****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应数据。', + 'description' => 'The return value of the Flink request.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'httpCode' => [ + 'description' => 'The value was fixed to 200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'title' => '当success为true，返回代理请求结果；当success为false，该值为空。', + 'description' => '* If the value of success was true, the result of the proxy request was returned.'."\n" + .'* If the value of success was false, a null value was returned.'."\n", + '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' => 'FlinkApiProxy', + ], + 'GetLineageInfo' => [ + 'summary' => 'Obtains the lineage information of a deployment.', + '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' => 'The workspace ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '710d6a64d8****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => 'The parameters about the lineage information.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/GetLineageInfoParams', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', + 'description' => 'If the value of success was true, the lineage information of a deployment in a namespace was returned. If the value of success was false, a null value was returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****', + ], + 'success' => [ + 'title' => '表示业务请求是否成功。', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpCode' => [ + 'title' => '业务状态码，统一为200；使用success表示业务请求是否成功。', + 'description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'errorCode' => [ + 'title' => '当success为false时，该值不为空，表示业务错误码；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error code was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'errorMessage' => [ + 'title' => '当success为false时，该值不为空，表示业务错误信息；当success为true时，该值为空。', + 'description' => '* If the value of success was false, an error message was returned.'."\n" + .'* If the value of success was true, a null value was returned.'."\n", + 'type' => 'string', + 'example' => '""', + ], + 'data' => [ + 'description' => 'The lineage information.'."\n", + '$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' => 'GetLineageInfo', + ], + ], + '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', + ], + ], +]; |