From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/ververica/2020-05-01/api-docs.php | 2812 +--- data/en_us/ververica/2022-07-18/api-docs.php | 18684 ++++++++++--------------- 2 files changed, 7789 insertions(+), 13707 deletions(-) (limited to 'data/en_us/ververica') diff --git a/data/en_us/ververica/2020-05-01/api-docs.php b/data/en_us/ververica/2020-05-01/api-docs.php index ba9bc88..2b4561b 100644 --- a/data/en_us/ververica/2020-05-01/api-docs.php +++ b/data/en_us/ververica/2020-05-01/api-docs.php @@ -1,74 +1,15 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'ververica', - 'version' => '2020-05-01', - ], + 'info' => ['style' => 'ROA', 'product' => 'ververica', 'version' => '2020-05-01'], 'directories' => [ [ 'id' => 0, - 'title' => '其它', + 'title' => 'Others', 'type' => 'directory', 'children' => [ - 'CreateDeployment', - 'CreateSavepoint', - 'DeleteDeployment', - 'DeleteArtifact', - 'ExecuteSqlScript', - 'GetArtifactMetadata', - 'GetDeployment', - 'GetDeploymentDefaults', - 'GetGlobalDeploymentDefaults', - 'ListArtifacts', - 'ListDeploymentTargets', - 'ListDeployments', - 'ListNamespaces', - 'ListJobs', - 'ListSavepoints', - 'UpdateDeployment', - 'UpdateDeploymentDesiredState', - 'ValidateSqlScript', - 'DatabaseExists', - 'FunctionExists', - 'GetCatalog', - 'GetDatabase', - 'GetDefaultDatabase', - 'GetFunction', - 'GetTable', - 'ListCatalogs', - 'ListDatabases', - 'ListFunctions', - 'TableExists', - 'ListTables', - 'CreateUdfArtifact', - 'DeleteUdfArtifact', - 'ExecuteSqlscriptsStatements', - 'GetUdfArtifact', - 'ListFlinkVersions', - 'ListSessionClusters', - 'UpdateUdfArtifact', - 'UpdateConnector', - 'DeleteConnector', - 'DeleteFormat', - 'GenerateResourcePlan', - 'UpdateMember', - 'CreateConnector', - 'UpdateFormat', - 'ParseConnector', - 'GetResourcePlan', - 'ListFormats', - 'ListConnectors', - 'DeleteMember', - 'ParseFormat', - 'CreateFormat', - 'CreateMember', - 'SetDeploymentResourceMode', - 'ForcefullyCreateLock', - 'ReplaceDeployment', - 'DeleteSecretValue', - 'ListSecretValues', - 'CreateSecretValue', + 'CreateDeployment', 'CreateSavepoint', 'DeleteDeployment', 'DeleteArtifact', 'ExecuteSqlScript', 'GetArtifactMetadata', 'GetDeployment', 'GetDeploymentDefaults', 'GetGlobalDeploymentDefaults', 'ListArtifacts', 'ListDeploymentTargets', 'ListDeployments', 'ListNamespaces', 'ListJobs', 'ListSavepoints', 'UpdateDeployment', 'UpdateDeploymentDesiredState', 'ValidateSqlScript', 'DatabaseExists', 'FunctionExists', + 'GetCatalog', 'GetDatabase', 'GetDefaultDatabase', 'GetFunction', 'GetTable', 'ListCatalogs', 'ListDatabases', 'ListFunctions', 'TableExists', 'ListTables', 'CreateUdfArtifact', 'DeleteUdfArtifact', 'ExecuteSqlscriptsStatements', 'GetUdfArtifact', 'ListFlinkVersions', 'ListSessionClusters', 'UpdateUdfArtifact', 'UpdateConnector', 'DeleteConnector', 'DeleteFormat', + 'GenerateResourcePlan', 'UpdateMember', 'CreateConnector', 'UpdateFormat', 'ParseConnector', 'GetResourcePlan', 'ListFormats', 'ListConnectors', 'DeleteMember', 'ParseFormat', 'CreateFormat', 'CreateMember', 'SetDeploymentResourceMode', 'ForcefullyCreateLock', 'ReplaceDeployment', 'DeleteSecretValue', 'ListSecretValues', 'CreateSecretValue', ], ], ], @@ -78,13 +19,8 @@ 'apis' => [ 'CreateDeployment' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -95,37 +31,23 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '86092', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -133,15 +55,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -150,13 +66,8 @@ ], 'CreateSavepoint' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/savepoints', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -167,46 +78,28 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '86093', - 'abilityTreeNodes' => [ - 'FEATUREscUX40QK', - ], + 'abilityTreeNodes' => ['FEATUREscUX40QK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'header', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -214,15 +107,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -231,13 +118,8 @@ ], 'DeleteDeployment' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -248,37 +130,23 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '86097', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -286,12 +154,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -300,13 +164,8 @@ ], 'DeleteArtifact' => [ 'path' => '/pop/workspaces/{workspace}/artifacts/v1/namespaces/{namespace}/artifacts:delete', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -317,37 +176,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86096', - 'abilityTreeNodes' => [ - 'FEATUREscFF0JJK', - ], + 'abilityTreeNodes' => ['FEATUREscFF0JJK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'filename', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -355,12 +200,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -369,13 +210,8 @@ ], 'ExecuteSqlScript' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/sqlscripts:execute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -386,37 +222,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86099', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -424,15 +246,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -441,13 +257,8 @@ ], 'GetArtifactMetadata' => [ 'path' => '/pop/workspaces/{workspace}/artifacts/v1/namespaces/{namespace}/artifacts:getMetadata', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -458,37 +269,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86102', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'filename', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -496,15 +293,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -513,13 +304,8 @@ ], 'GetDeployment' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -530,37 +316,23 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '86106', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -568,15 +340,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -585,13 +351,8 @@ ], 'GetDeploymentDefaults' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployment-defaults', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -602,28 +363,18 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86107', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -631,15 +382,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -648,13 +393,8 @@ ], 'GetGlobalDeploymentDefaults' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/global-deployment-defaults', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -665,32 +405,18 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86109', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'header', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'openapi-test-default', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'openapi-test-default'], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '710d6a64d8c34d', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '710d6a64d8c34d'], ], ], 'responses' => [ @@ -698,19 +424,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ECE641B2-AB0B-4174-9C3B-885881558637', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['description' => '', 'type' => 'string', 'example' => 'ECE641B2-AB0B-4174-9C3B-885881558637'], + 'data' => ['description' => '', 'type' => 'string', 'example' => '123'], ], ], ], @@ -723,13 +439,8 @@ ], 'ListArtifacts' => [ 'path' => '/pop/workspaces/{workspace}/artifacts/v1/namespaces/{namespace}/artifacts:list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -740,28 +451,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86112', - 'abilityTreeNodes' => [ - 'FEATUREscFF0JJK', - ], + 'abilityTreeNodes' => ['FEATUREscFF0JJK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -769,15 +470,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -786,13 +481,8 @@ ], 'ListDeploymentTargets' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployment-targets', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -803,28 +493,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86116', - 'abilityTreeNodes' => [ - 'FEATUREscYYH6D4', - ], + 'abilityTreeNodes' => ['FEATUREscYYH6D4'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -832,15 +512,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -849,13 +523,8 @@ ], 'ListDeployments' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -866,116 +535,73 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86115', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'sortName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'sortOrder', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'creator', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'modifier', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'priority', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'deploymentId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'state', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'batchMode', @@ -986,10 +612,7 @@ 'docRequired' => false, 'isFileTransferUrl' => false, 'default' => 'false', - 'enum' => [ - 'true', - 'false', - ], + 'enum' => ['true', 'false'], ], ], ], @@ -998,15 +621,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1015,13 +632,8 @@ ], 'ListNamespaces' => [ 'path' => '/pop/namespaces/v1/namespaces', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1032,9 +644,7 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86120', - 'abilityTreeNodes' => [ - 'FEATUREscR3E3VD', - ], + 'abilityTreeNodes' => ['FEATUREscR3E3VD'], ], 'parameters' => [], 'responses' => [ @@ -1042,19 +652,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['description' => '', 'type' => 'string', 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9'], + 'data' => ['description' => '', 'type' => 'string', 'example' => ''], ], ], ], @@ -1067,13 +667,8 @@ ], 'ListJobs' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/jobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1084,37 +679,23 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86119', - 'abilityTreeNodes' => [ - 'FEATUREscB9XR98', - ], + 'abilityTreeNodes' => ['FEATUREscB9XR98'], ], 'parameters' => [ [ 'name' => 'deploymentId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1122,15 +703,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1139,13 +714,8 @@ ], 'ListSavepoints' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/savepoints', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1156,45 +726,28 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86121', - 'abilityTreeNodes' => [ - 'FEATUREscUX40QK', - ], + 'abilityTreeNodes' => ['FEATUREscUX40QK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'jobId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1202,15 +755,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1219,13 +766,8 @@ ], 'UpdateDeployment' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}/patch', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1236,46 +778,28 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '86125', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1283,16 +807,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'integer', 'format' => 'int32'], ], ], ], @@ -1301,13 +818,8 @@ ], 'UpdateDeploymentDesiredState' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}/state', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1318,46 +830,28 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86126', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1365,15 +859,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -1382,13 +870,8 @@ ], 'ValidateSqlScript' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/sqlscripts:validate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1399,37 +882,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86128', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1437,15 +906,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -1454,13 +917,8 @@ ], 'DatabaseExists' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:databaseExists', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1471,46 +929,28 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86095', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1518,15 +958,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1534,12 +968,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1547,13 +977,8 @@ ], 'FunctionExists' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:functionExists', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1564,55 +989,33 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86101', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'function', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1620,15 +1023,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1636,12 +1033,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1649,13 +1042,8 @@ ], 'GetCatalog' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:getCatalog', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1666,37 +1054,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86103', - 'abilityTreeNodes' => [ - 'FEATUREscA3ZDC5', - ], + 'abilityTreeNodes' => ['FEATUREscA3ZDC5'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1704,15 +1078,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1720,12 +1088,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1733,13 +1097,8 @@ ], 'GetDatabase' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:getDatabase', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1750,46 +1109,28 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86104', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1797,15 +1138,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1813,12 +1148,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1826,13 +1157,8 @@ ], 'GetDefaultDatabase' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:getDefaultDatabase', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1843,37 +1169,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86105', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1881,15 +1193,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1897,12 +1203,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1910,13 +1212,8 @@ ], 'GetFunction' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:getFunction', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1927,55 +1224,33 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '86108', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'function', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -1983,15 +1258,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -1999,12 +1268,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2012,13 +1277,8 @@ ], 'GetTable' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:getTable', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2029,55 +1289,33 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '86110', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'table', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2085,15 +1323,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2101,12 +1333,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2114,13 +1342,8 @@ ], 'ListCatalogs' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2131,28 +1354,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86113', - 'abilityTreeNodes' => [ - 'FEATUREscA3ZDC5', - ], + 'abilityTreeNodes' => ['FEATUREscA3ZDC5'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2160,15 +1373,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2176,12 +1383,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2189,13 +1392,8 @@ ], 'ListDatabases' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:listDatabases', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2206,37 +1404,23 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86114', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2244,15 +1428,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2260,12 +1438,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2273,13 +1447,8 @@ ], 'ListFunctions' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:listFunctions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2290,46 +1459,28 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86118', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2337,15 +1488,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2353,12 +1498,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2366,13 +1507,8 @@ ], 'TableExists' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:tableExists', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2383,55 +1519,33 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86124', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'table', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2439,15 +1553,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2455,12 +1563,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2468,13 +1572,8 @@ ], 'ListTables' => [ 'path' => '/pop/workspaces/{workspace}/catalog/v1beta2/namespaces/{namespace}/catalogs/{cat}:listTables', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2485,46 +1584,28 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86123', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'cat', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'database', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2532,12 +1613,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2545,13 +1622,8 @@ ], 'CreateUdfArtifact' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/udfartifacts', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2562,36 +1634,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86094', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2599,15 +1658,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2615,13 +1668,8 @@ ], 'DeleteUdfArtifact' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/udfartifacts/{udfArtifactName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2632,37 +1680,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86098', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'udfArtifactName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2670,15 +1704,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2686,13 +1714,8 @@ ], 'ExecuteSqlscriptsStatements' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/sqlscripts:execute-multi', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2703,36 +1726,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86100', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -2740,15 +1750,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2756,13 +1760,8 @@ ], 'GetUdfArtifact' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/udfartifacts/{udfArtifactName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2773,46 +1772,28 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '86111', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'requireFunctionNames', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'boolean', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'udfArtifactName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2820,15 +1801,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2836,13 +1811,8 @@ ], 'ListFlinkVersions' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/flink-version-meta.json', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2852,19 +1822,13 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '86117', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2872,15 +1836,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2888,13 +1846,8 @@ ], 'ListSessionClusters' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/sessionclusters', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2905,28 +1858,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '86122', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -2934,15 +1877,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -2950,13 +1887,8 @@ ], 'UpdateUdfArtifact' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/udfartifacts/{udfArtifactName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2967,45 +1899,28 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '86127', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'udfArtifactName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3013,15 +1928,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3029,13 +1938,8 @@ ], 'UpdateConnector' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/connectors/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3046,45 +1950,28 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '101179', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3092,15 +1979,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3108,13 +1989,8 @@ ], 'DeleteConnector' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/connectors/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3125,37 +2001,23 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '101133', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3163,12 +2025,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3176,13 +2034,8 @@ ], 'DeleteFormat' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/formats/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3193,37 +2046,23 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '101137', - 'abilityTreeNodes' => [ - 'FEATUREscKE9BYZ', - ], + 'abilityTreeNodes' => ['FEATUREscKE9BYZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3231,9 +2070,7 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'type' => 'string', - ], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3241,13 +2078,8 @@ ], 'GenerateResourcePlan' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}/resource_plan:generate', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3258,37 +2090,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '101145', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3296,15 +2114,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3312,13 +2124,8 @@ ], 'UpdateMember' => [ 'path' => '/pop/workspaces/{workspace}/members/v1/namespaces/{namespace}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3329,36 +2136,23 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '101181', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3366,15 +2160,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -3382,13 +2170,8 @@ ], 'CreateConnector' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/connectors', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3399,36 +2182,23 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '101117', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -3436,15 +2206,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3452,13 +2216,8 @@ ], 'UpdateFormat' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/formats/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3469,45 +2228,28 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '101180', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3515,15 +2257,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3531,13 +2267,8 @@ ], 'ParseConnector' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/connectors:analyze-jars', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3548,36 +2279,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '101170', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3585,15 +2303,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3601,13 +2313,8 @@ ], 'GetResourcePlan' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}/resource_plan', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3618,37 +2325,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '101165', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3656,15 +2349,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3672,13 +2359,8 @@ ], 'ListFormats' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/formats', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3689,28 +2371,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '101169', - 'abilityTreeNodes' => [ - 'FEATUREscKE9BYZ', - ], + 'abilityTreeNodes' => ['FEATUREscKE9BYZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3718,15 +2390,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3734,13 +2400,8 @@ ], 'ListConnectors' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/connectors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3751,28 +2412,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '101167', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3780,15 +2431,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3796,13 +2441,8 @@ ], 'DeleteMember' => [ 'path' => '/pop/workspaces/{workspace}/members/v1/namespaces/{namespace}/members/{member}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3813,37 +2453,23 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '101138', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'member', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3851,12 +2477,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3864,13 +2486,8 @@ ], 'ParseFormat' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/formats:analyze-jars', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3881,36 +2498,23 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '101172', - 'abilityTreeNodes' => [ - 'FEATUREscKE9BYZ', - ], + 'abilityTreeNodes' => ['FEATUREscKE9BYZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -3918,15 +2522,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -3934,13 +2532,8 @@ ], 'CreateFormat' => [ 'path' => '/pop/workspaces/{workspace}/sql/v1beta1/namespaces/{namespace}/formats', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3951,36 +2544,23 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '101122', - 'abilityTreeNodes' => [ - 'FEATUREscKE9BYZ', - ], + 'abilityTreeNodes' => ['FEATUREscKE9BYZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -3988,15 +2568,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -4004,56 +2578,36 @@ ], 'CreateMember' => [ 'path' => '/pop/workspaces/{workspace}/members/v1/namespaces/{namespace}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '101123', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -4061,15 +2615,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -4077,13 +2625,8 @@ ], 'SetDeploymentResourceMode' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}/set-resource', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4094,45 +2637,28 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '101176', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -4140,15 +2666,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -4156,13 +2676,8 @@ ], 'ForcefullyCreateLock' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/locks', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4173,42 +2688,28 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '136124', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'resourceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -4216,15 +2717,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -4232,13 +2727,8 @@ ], 'ReplaceDeployment' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/deployments/{deploymentId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4249,46 +2739,28 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '138326', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -4296,16 +2768,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'integer', 'format' => 'int32'], ], ], ], @@ -4313,13 +2778,8 @@ ], 'DeleteSecretValue' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/secret-values/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4330,35 +2790,23 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '141541', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'abilityTreeNodes' => ['FEATUREscGTCR1G'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -4366,12 +2814,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -4379,13 +2823,8 @@ ], 'ListSecretValues' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/secret-values', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4396,28 +2835,18 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '141542', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'abilityTreeNodes' => ['FEATUREscGTCR1G'], ], 'parameters' => [ [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], ], 'responses' => [ @@ -4425,15 +2854,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'requestId' => [ - 'type' => 'string', - ], - 'data' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'requestId' => ['type' => 'string'], + 'data' => ['type' => 'string'], ], ], ], @@ -4441,13 +2864,8 @@ ], 'CreateSecretValue' => [ 'path' => '/pop/workspaces/{workspace}/api/v1/namespaces/{namespace}/secret-values', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4458,37 +2876,23 @@ 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '141533', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'abilityTreeNodes' => ['FEATUREscGTCR1G'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'paramsJson', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true], ], ], 'responses' => [ @@ -4496,15 +2900,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'success' => [ - 'type' => 'boolean', - ], - 'data' => [ - 'type' => 'string', - ], - 'requestId' => [ - 'type' => 'string', - ], + 'success' => ['type' => 'boolean'], + 'data' => ['type' => 'string'], + 'requestId' => ['type' => 'string'], ], ], ], @@ -4512,73 +2910,23 @@ ], ], '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', - ], + ['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' => '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'], + ['regionId' => 'ap-southeast-3', 'endpoint' => 'ververica.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'endpoint' => 'ververica.ap-southeast-5.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' => 'us-west-1', 'endpoint' => 'ververica.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'endpoint' => 'ververica.us-east-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'ververica.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'endpoint' => 'ververica.cn-qingdao.aliyuncs.com'], ], ]; diff --git a/data/en_us/ververica/2022-07-18/api-docs.php b/data/en_us/ververica/2022-07-18/api-docs.php index b8a6ecc..aa166be 100644 --- a/data/en_us/ververica/2022-07-18/api-docs.php +++ b/data/en_us/ververica/2022-07-18/api-docs.php @@ -1,1274 +1,608 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'ververica', - 'version' => '2022-07-18', - ], + 'info' => ['style' => 'ROA', 'product' => 'ververica', 'version' => '2022-07-18'], 'directories' => [ [ - 'id' => 364574, - 'title' => null, + 'children' => ['ValidateDeploymentDraftAsync', 'GetValidateDeploymentDraftResult', 'CreateDeploymentDraft', 'UpdateDeploymentDraft', 'DeleteDeploymentDraft', 'GetDeploymentDraft', 'ListDeploymentDrafts', 'GetDeploymentDraftLock', 'DeployDeploymentDraftAsync', 'GetDeployDeploymentDraftResult', 'ValidateSqlStatement'], 'type' => 'directory', - 'children' => [ - 'CreateFolder', - 'UpdateFolder', - 'DeleteFolder', - 'GetFolder', - ], + 'title' => 'Job drafts', ], [ - 'id' => 364579, - 'title' => null, + 'children' => ['CreateUdfArtifact', 'UpdateUdfArtifact', 'GetUdfArtifacts', 'DeleteUdfArtifact', 'DeleteUdfFunction', 'RegisterUdfFunction'], 'type' => 'directory', - 'children' => [ - 'ValidateDeploymentDraftAsync', - 'GetValidateDeploymentDraftResult', - 'CreateDeploymentDraft', - 'UpdateDeploymentDraft', - 'DeleteDeploymentDraft', - 'GetDeploymentDraft', - 'ListDeploymentDrafts', - 'GetDeploymentDraftLock', - 'DeployDeploymentDraftAsync', - 'GetDeployDeploymentDraftResult', - 'ValidateSqlStatement', - ], + 'title' => 'Custom functions', ], [ - 'id' => 364591, - 'title' => null, + 'children' => ['ListCustomConnectors', 'RegisterCustomConnector', 'DeleteCustomConnector'], 'type' => 'directory', - 'children' => [ - 'CreateUdfArtifact', - 'UpdateUdfArtifact', - 'GetUdfArtifacts', - 'DeleteUdfArtifact', - 'DeleteUdfFunction', - 'RegisterUdfFunction', - ], + 'title' => 'Custom connectors', ], [ - 'id' => 364598, - 'title' => null, + 'children' => ['GetDatabases', 'GetTables', 'GetCatalogs', 'ExecuteSqlStatement'], 'type' => 'directory', - 'children' => [ - 'ListCustomConnectors', - 'RegisterCustomConnector', - 'DeleteCustomConnector', - ], + 'title' => 'Metadata', ], [ - 'id' => 364602, - 'title' => null, + 'children' => ['CreateSavepoint', 'GetSavepoint', 'DeleteSavepoint', 'ListSavepoints'], 'type' => 'directory', - 'children' => [ - 'GetDatabases', - 'GetTables', - 'GetCatalogs', - 'ExecuteSqlStatement', - ], + 'title' => 'Snapshots', ], [ - 'id' => 364607, - 'title' => null, + 'children' => ['GetDeploymentsByName', 'GetDeploymentsByLabel', 'GetDeploymentsByIp', 'UpdateDeployment', 'DeleteDeployment', 'GetEvents'], 'type' => 'directory', - 'children' => [ - 'CreateSavepoint', - 'GetSavepoint', - 'DeleteSavepoint', - 'ListSavepoints', - ], + 'title' => 'Deployed jobs', ], [ - 'id' => 364612, - 'title' => null, + 'children' => ['GetJob', 'StartJobWithParams', 'StopJob', 'HotUpdateJob', 'GetHotUpdateJobResult', 'GetLatestJobStartLog', 'GetJobDiagnosis', 'StartJob'], 'type' => 'directory', - 'children' => [ - 'GetDeploymentsByName', - 'GetDeploymentsByLabel', - 'GetDeploymentsByIp', - 'CreateDeployment', - 'UpdateDeployment', - 'GetDeployment', - 'ListDeployments', - 'DeleteDeployment', - 'GetEvents', - ], + 'title' => 'Job instances', ], [ - 'id' => 364622, - 'title' => null, + 'children' => ['CreateScheduledPlan', 'UpdateScheduledPlan', 'DeleteScheduledPlan', 'ListScheduledPlan', 'ApplyScheduledPlan', 'StopApplyScheduledPlan', 'GetAppliedScheduledPlan', 'ListScheduledPlanExecutedHistory'], 'type' => 'directory', - 'children' => [ - 'GetJob', - 'ListJobs', - 'StartJobWithParams', - 'StopJob', - 'DeleteJob', - 'HotUpdateJob', - 'GetHotUpdateJobResult', - 'GetLatestJobStartLog', - 'GetJobDiagnosis', - 'StartJob', - ], + 'title' => 'Scheduled plans', ], [ - 'id' => 364633, - 'title' => null, + 'children' => ['UpdateSessionCluster'], 'type' => 'directory', - 'children' => [ - 'CreateScheduledPlan', - 'UpdateScheduledPlan', - 'DeleteScheduledPlan', - 'ListScheduledPlan', - 'ApplyScheduledPlan', - 'StopApplyScheduledPlan', - 'GetAppliedScheduledPlan', - 'ListScheduledPlanExecutedHistory', - ], + 'title' => 'Session clusters', ], [ - 'id' => 364642, - 'title' => null, + 'children' => ['CreateDeploymentTargetV2', 'UpdateDeploymentTargetV2', 'CreateDeploymentTarget', 'UpdateDeploymentTarget', 'DeleteDeploymentTarget', 'ListDeploymentTargets'], 'type' => 'directory', - 'children' => [ - 'CreateSessionCluster', - 'UpdateSessionCluster', - 'DeleteSessionCluster', - 'GetSessionCluster', - 'ListSessionClusters', - 'StartSessionCluster', - 'StopSessionCluster', - ], + 'title' => 'Job deployment targets', ], [ - 'id' => 364650, - 'title' => null, + 'children' => ['CreateMember', 'UpdateMember', 'DeleteMember', 'GetMember'], 'type' => 'directory', - 'children' => [ - 'CreateDeploymentTarget', - 'UpdateDeploymentTarget', - 'DeleteDeploymentTarget', - 'ListDeploymentTargets', - ], + 'title' => 'Member management', ], - 'UpdateDeploymentTargetV2', - 'CreateDeploymentTargetV2', [ - 'id' => 364657, - 'title' => null, + 'children' => ['ListVariables'], 'type' => 'directory', - 'children' => [ - 'CreateMember', - 'UpdateMember', - 'DeleteMember', - 'GetMember', - 'ListMembers', - ], + 'title' => 'Variables', ], [ - 'id' => 364663, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'UpdateVariable', - 'CreateVariable', - 'DeleteVariable', - 'ListVariables', + 'ListEngineVersionMetadata', 'GenerateResourcePlanWithFlinkConfAsync', 'GetGenerateResourcePlanResult', 'FlinkApiProxy', 'GetLineageInfo', 'CreateDeployment', 'CreateFolder', 'CreateSessionCluster', 'CreateVariable', 'DeleteFolder', 'DeleteJob', 'DeleteSessionCluster', 'DeleteVariable', 'GetDeployment', 'GetFolder', 'GetSessionCluster', 'ListDeployments', 'ListJobs', 'ListMembers', 'ListSessionClusters', + 'StartSessionCluster', 'StartSqlExecution', 'StopSessionCluster', 'UpdateFolder', 'UpdateVariable', ], - ], - [ - 'id' => 364668, - 'title' => null, 'type' => 'directory', - 'children' => [ - 'ListEngineVersionMetadata', - 'GenerateResourcePlanWithFlinkConfAsync', - 'GetGenerateResourcePlanResult', - 'FlinkApiProxy', - 'GetLineageInfo', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ + 'AiModel' => [ + 'type' => 'object', + 'properties' => [ + 'outputSchema' => ['$ref' => '#/components/schemas/Schema'], + 'inputSchema' => ['$ref' => '#/components/schemas/Schema'], + 'name' => ['type' => 'string', 'required' => true], + 'comment' => ['type' => 'string'], + 'options' => [ + 'type' => 'object', + 'required' => true, + 'additionalProperties' => ['type' => 'string', 'required' => true], + ], + ], + ], 'Artifact' => [ 'title' => '', - 'description' => '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', + 'description' => 'An artifact contains the user-provided information required to launch a deployed job. You cannot create a deployed job without an artifact. For an SQL job, it includes the SQL text and dependencies such as udfs and connectors. For a JAR job, it includes JAR files and dependency files. For a Python job, it includes py files and zip files.', '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', - ], + 'sqlArtifact' => ['title' => '', 'description' => 'Required for an SQL job.', '$ref' => '#/components/schemas/SqlArtifact', 'example' => ''], + 'jarArtifact' => ['title' => '', 'description' => 'Required for a JAR job.', '$ref' => '#/components/schemas/JarArtifact', 'example' => ''], + 'pythonArtifact' => ['title' => '', 'description' => 'Required for a Python job.', '$ref' => '#/components/schemas/PythonArtifact', 'example' => ''], + 'cdcYamlArtifact' => ['title' => '', 'description' => 'Required for a data ingestion job.', 'example' => '', '$ref' => '#/components/schemas/CdcYamlArtifact'], 'kind' => [ 'title' => '', - 'description' => 'The type of the deployment. This parameter is required and cannot be modified after the deployment is created.'."\n" + 'description' => 'Specifies the kind of job. This field is required and cannot be changed after creation.'."\n" + ."\n" + .'- SQLSCRIPT: An SQL job.'."\n" ."\n" - .'* SQLSCRIPT'."\n" - .'* JAR'."\n" - .'* PYTHON'."\n", - 'visibility' => 'public', + .'- JAR: A JAR job.'."\n" + ."\n" + .'- PYTHON: A Python job.'."\n" + ."\n" + .'- CDCYAML: A CDC data ingestion job.', 'type' => 'string', 'example' => 'SQLSCRIPT', - 'backendName' => 'kind', - 'enum' => [ - 'SQLSCRIPT', - 'JAR', - 'PYTHON', - ], + 'enum' => ['SQLSCRIPT', 'JAR', 'PYTHON', 'CDCYAML'], + 'required' => false, ], ], + 'example' => '', ], 'AsyncDraftDeployResult' => [ - 'title' => 'A short description of struct', - 'description' => 'The deployment result based on the ID of the asynchronous ticket.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The deployment result based on the ID of the asynchronous ticket.', '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', - ], + 'ticketStatus' => ['title' => '', 'description' => 'The state of the execution.', 'type' => 'string', 'example' => 'FINISHED'], + 'artifactValidationDetail' => ['description' => 'The verification result of the SQL syntax.', '$ref' => '#/components/schemas/ValidateStatementResult', 'title' => '', 'example' => ''], + 'deploymentId' => ['title' => '', 'description' => 'The deployment ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'message' => ['title' => '', 'description' => 'The information about the deployment result.', 'type' => 'string', 'example' => '"Validation error: SQL validate failed"'], + ], + 'example' => '', + ], + 'AsyncDraftValidateResult' => [ + 'type' => 'object', + 'properties' => [ + 'ticketStatus' => ['type' => 'string', 'backendName' => 'ticketStatus', 'description' => '', 'title' => '', 'example' => ''], + 'success' => ['type' => 'boolean', 'backendName' => 'success', 'description' => '', 'title' => '', 'example' => ''], + 'message' => ['type' => 'string', 'backendName' => 'message', 'description' => '', 'title' => '', 'example' => ''], + 'draftValidationDetail' => ['$ref' => '#/components/schemas/DraftValidationDetail', 'backendName' => 'draftValidationDetail', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'AsyncResourcePlanOperationResult' => [ 'title' => '', - 'description' => 'The resource configuration plan of a deployment that works in expert mode.'."\n", - 'visibility' => 'public', + 'description' => 'The resource configuration plan of a deployment that works in expert mode.', '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', + .'- EXECUTING'."\n" + ."\n" + .'- FINISHED'."\n" + ."\n" + .'- FAILED', + 'enumValueTitles' => ['EXECUTING' => 'EXECUTING', 'FAILED' => 'FAILED', 'FINISHED' => 'FINISHED'], 'type' => 'string', - 'enumValueTitles' => [ - 'EXECUTING' => 'EXECUTING', - 'FAILED' => 'FAILED', - 'FINISHED' => 'FINISHED', - ], 'example' => 'FINISHED', + 'enum' => ['INIT', 'EXECUTING', 'FINISHED', 'FAILED'], + 'visibility' => 'Public', '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', ], + '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.', '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]}}', 'visibility' => 'Public', '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.', 'type' => 'string', 'example' => '"create resource plan failed"', 'visibility' => 'Public', 'backendName' => 'message'], ], + 'example' => '', + 'visibility' => 'Public', ], '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', - ], + 'parallelism' => ['title' => '', 'description' => 'The parallelism for a deployment.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'visibility' => 'Public', 'backendName' => 'parallelism'], + 'jobmanagerResourceSettingSpec' => ['title' => '', 'description' => 'The resource configuration of the JobManager.'."\n", '$ref' => '#/components/schemas/BasicResourceSettingSpec', 'visibility' => 'Public', 'backendName' => 'jobmanagerResourceSettingSpec', 'example' => ''], + 'taskmanagerResourceSettingSpec' => ['title' => '', 'description' => 'The resource configuration of a TaskManager.'."\n", '$ref' => '#/components/schemas/BasicResourceSettingSpec', 'visibility' => 'Public', 'backendName' => 'taskmanagerResourceSettingSpec', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], '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', + '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.', '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', - ], + 'cpu' => ['title' => '', 'description' => 'The number of CPU cores.', 'type' => 'number', 'format' => 'double', 'example' => '2.0', 'visibility' => 'Public', 'backendName' => 'cpu'], + 'memory' => ['title' => '', 'description' => 'The capacity of the memory. Unit: GiB.', 'type' => 'string', 'example' => '4 GiB', 'visibility' => 'Public', 'backendName' => 'memory'], ], + 'example' => '', + 'visibility' => 'Public', ], 'BatchResourceSetting' => [ 'title' => '', - 'description' => 'The resource parameters for a deployment in batch mode.'."\n", - 'visibility' => 'public', + 'description' => 'The resource parameters for a deployment in batch mode.', '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', - ], + 'maxSlot' => ['title' => '', 'description' => 'The maximum number of slots.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'maxSlot'], + 'basicResourceSetting' => ['title' => '', 'description' => 'The resource parameters in basic mode.', '$ref' => '#/components/schemas/BasicResourceSetting', 'example' => '', 'visibility' => 'Public', 'backendName' => 'basicResourceSetting'], ], + 'example' => '', + 'visibility' => 'Public', ], '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', + 'title' => '', + 'description' => 'The description of the per-job cluster on which a deployment is run. This data structure is used in the Deployment data structure.', 'type' => 'object', 'properties' => [ 'mode' => [ - 'title' => 'mode', - 'description' => 'The deployment mode.'."\n", - 'visibility' => 'public', + 'title' => '', + 'description' => 'The deployment mode.', + 'enumValueTitles' => ['SESSION' => 'SESSION', 'PER_JOB' => 'PER_JOB'], 'type' => 'string', 'example' => 'PER_JOB', + 'enum' => ['PER_JOB'], + 'visibility' => 'Public', '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', ], + 'name' => ['title' => '', 'description' => 'The name of the queue used for the deployment.', 'type' => 'string', 'example' => 'default-queue ', 'visibility' => 'Public', 'backendName' => 'name'], ], + 'example' => '', + 'visibility' => 'Public', ], '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', - ], + 'flinkConf' => ['title' => '', 'description' => 'The Realtime Compute for Apache Flink configuration.'."\n", 'type' => 'object', 'example' => '“execution.checkpointing.interval: 180s”', 'visibility' => 'Public', '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", '$ref' => '#/components/schemas/BatchResourceSetting', 'visibility' => 'Public', 'backendName' => 'batchResourceSetting', 'example' => ''], + 'streamingResourceSetting' => ['title' => '', 'description' => 'The resource configuration for the deployment in streaming mode. This parameter is required for a deployment in streaming mode.'."\n", '$ref' => '#/components/schemas/StreamingResourceSetting', 'visibility' => 'Public', 'backendName' => 'streamingResourceSetting', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'Catalog' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The catalog structure.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', + 'name' => ['title' => '', 'description' => 'The catalog name.', 'type' => 'string', 'example' => 'paimon-test', 'required' => true, 'visibility' => 'Public', 'backendName' => 'name'], + 'properties' => ['title' => '', 'description' => 'The catalog configuration parameters.', 'type' => 'object', 'example' => '', 'required' => true, 'visibility' => 'Public', 'backendName' => 'properties'], + 'extensionConf' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'paimon-test', - 'backendName' => 'name', + 'title' => '', + 'example' => '', ], - 'properties' => [ + ], + 'example' => '', + 'visibility' => 'Public', + ], + 'CdcYamlArtifact' => [ + 'type' => 'object', + 'properties' => [ + 'cdcYaml' => ['title' => '', 'description' => 'Code for the data ingestion job.', 'type' => 'string', 'example' => ''], + 'additionalDependencies' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'backendName' => 'properties', + 'type' => 'array', + 'items' => ['description' => 'The path to a dependency file.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'Full URL paths to the additional dependencies.', + 'example' => '', ], ], + 'description' => 'Defines the artifact for a Change Data Capture (CDC) task, which includes the YAML configuration and a list of additional dependencies.', + 'title' => '', + 'example' => '', + ], + 'Cell' => [ + 'type' => 'object', + 'properties' => [ + 'value' => ['type' => 'string'], + ], ], 'Connector' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'name' => ['description' => 'The name of the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => 'mysql-test'], + 'type' => ['description' => 'The type of the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => 'mysql-test'], + 'source' => ['description' => 'Indicates whether the connector can be used as the source.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'sink' => ['description' => 'Indicates whether the connector can be used as the sink.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'lookup' => ['description' => 'Indicates whether the connector can be used as a lookup table.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], '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', + 'items' => ['description' => 'The parameters of the connector.'."\n", '$ref' => '#/components/schemas/Property', 'title' => '', 'example' => ''], + 'example' => '', ], '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', + 'items' => ['description' => 'The supported formats.'."\n", 'type' => 'string', 'example' => 'Json', 'title' => ''], + 'example' => '', ], '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', + 'items' => ['description' => 'The additional dependency file.'."\n", 'type' => 'string', 'example' => 'oss://bucket/add.jar', 'title' => ''], + 'example' => '', ], + 'creator' => ['description' => 'The ID of the user who creates the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => '183899668*******'], + 'creatorName' => ['description' => 'The nickname of the user who creates the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => 'userA'], + 'modifier' => ['description' => 'The ID of the user who modifies the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => '183899668*******'], + 'modifierName' => ['description' => 'The nickname of the user who modifies the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => 'userA'], ], + 'example' => '', ], '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', + 'title' => '', + 'description' => 'The returned result of creating the JAR file of the user-defined function (UDF).', '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', - ], + 'createSuccess' => ['title' => '', 'description' => 'Indicates whether the JAR file was created.', 'type' => 'boolean', 'example' => 'true'], + 'message' => ['title' => '', 'description' => 'The message used to create the JAR file.', 'type' => 'string', 'example' => '“”'], + 'udfArtifact' => ['title' => '', 'description' => 'The JAR file that you created.', '$ref' => '#/components/schemas/UdfArtifact', 'example' => ''], 'collidingClasses' => [ 'title' => '', - 'description' => 'All classes in conflict.'."\n", - 'visibility' => 'Public', + 'description' => 'All classes in conflict.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the class in conflict.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/UdfClass', - ], - 'backendName' => 'collidingClasses', + 'items' => ['description' => 'The name of the class in conflict.', '$ref' => '#/components/schemas/UdfClass', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'Database' => [ - 'title' => 'A short description of struct', - 'description' => 'The structure of the database.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The structure of the database.', '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', - ], + 'name' => ['title' => '', 'description' => 'The name of the database.', 'type' => 'string', 'example' => 'database-test'], + 'properties' => ['title' => '', 'description' => 'The parameters of the database.', 'type' => 'object', 'example' => '“”'], + 'comment' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'example' => '测试数据库。'], ], + 'example' => '', ], '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', + 'title' => '', + 'description' => 'The returned result of deleting the JAR file of the user-defined function (UDF).', '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', - ], + 'deleteSuccess' => ['title' => '', 'description' => 'Indicates whether the JAR file was deleted.', 'type' => 'boolean', 'example' => 'true'], + 'message' => ['title' => '', 'description' => 'The message used to delete the JAR file.', 'type' => 'string', 'example' => '“”'], 'referencedClasses' => [ 'title' => '', - 'description' => 'All associated classes.'."\n", - 'visibility' => 'Public', + 'description' => 'All associated classes.', 'type' => 'array', - 'items' => [ - 'description' => 'The class name of the UDF.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/UdfClass', - ], - 'backendName' => 'referencedClasses', + 'items' => ['description' => 'The class name of the UDF.', '$ref' => '#/components/schemas/UdfClass', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'Deployment' => [ 'title' => '', - 'description' => 'The parameters of a deployment.'."\n", - 'visibility' => 'public', + 'description' => 'This data structure describes a complete deployed job.', 'type' => 'object', 'properties' => [ - 'deploymentId' => [ + 'deploymentId' => ['title' => '', 'description' => 'Deployed job ID.', 'type' => 'string', 'example' => '00000000-0000-0000-0000-0000012312****', 'visibility' => 'Public', 'backendName' => 'deploymentId'], + 'namespace' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'default-namespace', 'visibility' => 'Public', 'backendName' => 'namespace'], + 'name' => ['title' => '', 'description' => 'Deployed job name.', 'type' => 'string', 'example' => 'deploymentName', 'visibility' => 'Public', 'backendName' => 'name'], + 'engineVersion' => ['title' => '', 'description' => 'Engine version.', 'type' => 'string', 'example' => 'vvr-6.0.0-flink-1.15', 'visibility' => 'Public', 'backendName' => 'engineVersion'], + 'description' => ['title' => '', 'description' => 'Description.', 'type' => 'string', 'example' => 'this is a deployment description', 'visibility' => 'Public', 'backendName' => 'description'], + 'creator' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => '27846363877456****', 'visibility' => 'Public', 'backendName' => 'creator'], + 'creatorName' => ['title' => '', 'description' => 'Name of the creator.', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com', 'visibility' => 'Public', 'backendName' => 'creatorName'], + 'modifier' => ['title' => '', 'description' => 'Modifier.', 'type' => 'string', 'example' => '27846363877456****', 'visibility' => 'Public', 'backendName' => 'modifier'], + 'modifierName' => ['title' => '', 'description' => 'Name of the modifier.', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com', 'visibility' => 'Public', 'backendName' => 'modifierName'], + 'deploymentHasChanged' => ['title' => '', 'description' => 'Indicates whether the deployed job has been modified after it was started.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'deploymentHasChanged'], + 'artifact' => ['title' => '', 'description' => 'The data structure required to start the deployed job.', '$ref' => '#/components/schemas/Artifact', 'example' => '', 'visibility' => 'Public', 'backendName' => 'artifact'], + 'flinkConf' => ['title' => '', 'description' => 'Flink configuration.', 'type' => 'object', 'example' => '{"taskmanager.numberOfTaskSlots":"1"}', 'visibility' => 'Public', 'backendName' => 'flinkConf'], + 'logging' => ['title' => '', 'description' => 'Log configuration.', '$ref' => '#/components/schemas/Logging', 'example' => '', 'visibility' => 'Public', 'backendName' => 'logging'], + 'jobSummary' => ['title' => '', 'description' => 'A summary of information about the job instances under the deployed job.', '$ref' => '#/components/schemas/JobSummary', 'example' => '', 'visibility' => 'Public', 'backendName' => 'jobSummary'], + 'deploymentTarget' => ['title' => '', 'description' => 'Deployment target.', '$ref' => '#/components/schemas/BriefDeploymentTarget', 'example' => '', 'visibility' => 'Public', 'backendName' => 'deploymentTarget'], + 'executionMode' => [ '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', + 'description' => 'Execution mode.'."\n" + ."\n" + .'- STREAMING: stream mode.'."\n" + ."\n" + .'- BATCH: batch mode.', '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", + 'enum' => ['STREAMING', 'BATCH'], 'visibility' => 'Public', - 'backendName' => 'batchResourceSetting', - '$ref' => '#/components/schemas/BatchResourceSetting', + 'backendName' => 'executionMode', ], + 'streamingResourceSetting' => ['title' => '', 'description' => 'Resource settings for a stream job.', '$ref' => '#/components/schemas/StreamingResourceSetting', 'example' => '', 'visibility' => 'Public', 'backendName' => 'streamingResourceSetting'], + 'batchResourceSetting' => ['title' => '', 'description' => 'Resource settings for a batch job.', '$ref' => '#/components/schemas/BatchResourceSetting', 'example' => '', 'visibility' => 'Public', 'backendName' => 'batchResourceSetting'], + 'labels' => ['title' => '', 'description' => 'Job labels.', 'type' => 'object', 'example' => '', 'visibility' => 'Public', 'backendName' => 'labels'], 'localVariables' => [ 'title' => '', - 'description' => 'The variables of the deployment.'."\n", - 'visibility' => 'Public', + 'description' => 'Job variables.', '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", + 'items' => ['$ref' => '#/components/schemas/LocalVariable', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1714058843', - 'backendName' => 'modifiedAt', + 'backendName' => 'localVariables', ], + 'workspace' => ['title' => '', 'description' => 'Workspace.', 'type' => 'string', 'example' => 'edcef******b4f', 'visibility' => 'Public', 'backendName' => 'workspace'], + 'createdAt' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '1714058507'."\n", 'visibility' => 'Public', 'backendName' => 'createdAt'], + 'modifiedAt' => ['title' => '', 'description' => 'Modification time.', 'type' => 'string', 'example' => '1714058843', 'visibility' => 'Public', 'backendName' => 'modifiedAt'], + 'referencedDeploymentDraftId' => ['title' => '', 'description' => 'Associated job draft ID.', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000000003', 'visibility' => 'Public', 'backendName' => 'referencedDeploymentDraftId'], ], + 'example' => '', + 'visibility' => 'Public', ], 'DeploymentDraft' => [ - 'title' => 'A short description of struct', - 'description' => 'The draft.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'A deployment draft.', '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', - ], + 'deploymentDraftId' => ['title' => '', 'description' => 'The deployment draft ID.', 'type' => 'string', 'example' => '00000000-0000-0000-0000-00000012****'], + 'name' => ['title' => '', 'description' => 'The deployment draft name.', 'type' => 'string', 'example' => 'test-draft'], + 'parentId' => ['title' => '', 'description' => 'The parent ID.', 'type' => 'string', 'example' => '00000000-0000-0000-0000-00000013****'], + 'referencedDeploymentId' => ['title' => '', 'description' => 'The referenced deployment ID.', 'type' => 'string', 'example' => '00000000-0000-0000-0000-0000012312****'], 'executionMode' => [ 'title' => '', - 'description' => 'The execution mode.'."\n", - 'visibility' => 'Public', + 'description' => 'The execution mode.', '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', + 'enum' => ['STREAMING', 'BATCH'], ], + 'artifact' => ['description' => 'The artifact. Supported types include SQLSCRIPT and CDCYAML.', '$ref' => '#/components/schemas/Artifact', 'title' => '', 'example' => ''], + 'engineVersion' => ['title' => '', 'description' => 'The engine version.', 'type' => 'string', 'example' => 'vvr-6.0.7-flink-1.15'], 'localVariables' => [ 'title' => '', - 'description' => 'The variables.'."\n", - 'visibility' => 'Public', + 'description' => 'The local variables.', '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', + 'items' => ['description' => 'A local variable.', '$ref' => '#/components/schemas/LocalVariable', 'title' => '', 'example' => ''], + 'example' => '', ], + 'labels' => ['title' => '', 'description' => 'Key-value pairs to apply as labels.', 'type' => 'object', 'example' => ''], + 'lock' => ['title' => '', 'description' => 'The deployment draft lock.', '$ref' => '#/components/schemas/Lock', 'example' => ''], + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'edcef******b4f'], + 'namespace' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'example' => 'default-namespace'], + 'creator' => ['title' => '', 'description' => 'Output only. The ID of the creator.', 'type' => 'string', 'example' => '27846363877456****'], + 'creatorName' => ['title' => '', 'description' => 'Output only. The name of the creator.', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifier' => ['title' => '', 'description' => 'Output only. The ID of the modifier.', 'type' => 'string', 'example' => '27846363877456****'], + 'modifierName' => ['title' => '', 'description' => 'Output only. The name of the modifier.', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'createdAt' => ['title' => '', 'description' => 'Output only. The creation time, represented as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723537978'], + 'modifiedAt' => ['title' => '', 'description' => 'Output only. The modification time, represented as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723537978'], ], + 'example' => '', ], 'DeploymentRestoreStrategy' => [ 'title' => '', - 'description' => 'The startup strategy for a deployment.'."\n", - 'visibility' => 'public', + 'description' => 'The startup strategy for a deployment.', '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', + .'- NONE: The deployment is started without states.'."\n" + ."\n" + .'- LATEST\\_SAVEPOINT: The deployment is started from the latest savepoint.'."\n" + ."\n" + .'- FROM\\_SAVEPOINT: The deployment is started from the specified savepoint.'."\n" + ."\n" + .'- LATEST\\_STATE: The deployment is started from the latest state of the deployment.', 'type' => 'string', 'example' => 'LATEST_STATE', + 'enum' => ['NONE', 'LATEST_SAVEPOINT', 'FROM_SAVEPOINT', 'LATEST_STATE'], + 'visibility' => 'Public', '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', ], + '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.', 'type' => 'boolean', 'example' => 'TRUE', 'visibility' => 'Public', '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.', 'type' => 'integer', 'format' => 'int64', 'example' => '1660293803155', 'visibility' => 'Public', '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.', 'type' => 'string', 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', 'visibility' => 'Public', 'backendName' => 'savepointId'], ], + 'example' => '', + 'visibility' => 'Public', ], 'DeploymentTarget' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The information about the perjob deployment target configured in the cluster.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'deployment target', - 'backendName' => 'name', - ], - 'namespace' => [ + 'name' => ['title' => '', 'description' => 'The name of the perjob deployment target.', 'type' => 'string', 'example' => 'deployment target', 'visibility' => 'Public', 'backendName' => 'name'], + 'namespace' => ['title' => '', 'description' => 'The namespace name.', 'type' => 'string', 'example' => 'namespace', 'visibility' => 'Public', 'backendName' => 'namespace'], + 'quota' => ['title' => '', 'description' => 'The resource quota.', 'example' => '', '$ref' => '#/components/schemas/ResourceQuota', 'visibility' => 'Public', 'backendName' => 'quota'], + ], + 'example' => '', + 'visibility' => 'Public', + ], + 'DqlResult' => [ + 'type' => 'object', + 'properties' => [ + 'statementIndex' => ['description' => 'The statement index.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'submitPreviewResult' => ['description' => 'The submit preview results.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SubmitPreviewResult'], + 'tableResults' => [ + 'type' => 'array', + 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/TableResult'], + 'description' => 'The table results.', 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'namespace', - 'backendName' => 'namespace', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'DraftDeployParams' => [ - 'title' => 'A short description of struct', - 'description' => 'The parameters that are used to deploy a draft.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The parameters that are used to deploy a draft.', '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', - ], + 'skipValidate' => ['title' => '', 'description' => 'Specifies whether to skip the syntax check.', 'type' => 'boolean', 'example' => 'false'], + 'deploymentTarget' => ['title' => '', 'description' => 'The cluster on which the deployment is deployed.', '$ref' => '#/components/schemas/BriefDeploymentTarget', 'example' => ''], + 'deploymentDraftId' => ['title' => '', 'description' => 'The draft ID.', 'type' => 'string', 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51****'], ], + 'example' => '', ], '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' => [ + 'success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'title' => '部署结果', 'example' => 'true'], + 'message' => ['description' => 'The deployment information.'."\n", 'type' => 'string', 'title' => '部署信息', 'example' => '""'], + 'deploymentId' => ['description' => 'The deployment ID.'."\n", 'type' => 'string', 'title' => '已部署作业ID', 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], + 'artifactValidationDetail' => ['description' => 'The verification result of the SQL syntax.'."\n", '$ref' => '#/components/schemas/ValidateStatementResult', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'DraftMetaInfoErrorDetail' => [ + 'type' => 'object', + 'properties' => [ + 'message' => ['type' => 'string', 'backendName' => 'message', 'description' => '', 'title' => '', 'example' => ''], + 'reason' => ['type' => 'string', 'backendName' => 'reason', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DraftValidateParams' => [ + 'type' => 'object', + 'properties' => [ + 'deploymentDraftId' => ['type' => 'string', 'backendName' => 'deploymentDraftId', 'description' => '', 'title' => '', 'example' => ''], + 'deploymentTargetName' => ['type' => 'string', 'backendName' => 'deploymentTargetName', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'DraftValidationDetail' => [ + 'type' => 'object', + 'properties' => [ + 'draftMetaInfoErrorDetails' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/DraftMetaInfoErrorDetail', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', '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', + 'example' => '', ], + 'sqlValidationResult' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'sqlErrorDetail' => ['$ref' => '#/components/schemas/ValidationErrorDetails', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'Edge' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', + 'items' => ['description' => 'The information about the associated table.'."\n", '$ref' => '#/components/schemas/Relation', 'title' => '', 'example' => ''], + 'example' => '', ], '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', + 'items' => ['description' => 'The information about the associated fields.'."\n", '$ref' => '#/components/schemas/Relation', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', + ], + 'EditableNamespace' => [ + 'title' => '有编辑权限的项目空间对象', + 'type' => 'object', + 'properties' => [ + 'Role' => ['title' => '用户角色', 'type' => 'string'], + 'WorkspaceId' => ['title' => '工作空间ID', 'type' => 'string'], + 'Namespace' => ['title' => '项目空间名字', 'type' => 'string'], + ], ], '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', - ], + 'engineVersion' => ['title' => '', 'description' => 'The engine version.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vvr-6.0.0-flink-1.15', 'visibility' => 'Public', 'backendName' => 'engineVersion'], 'status' => [ 'title' => '', 'description' => 'The status of the engine version.'."\n" @@ -1277,1056 +611,453 @@ .'* BETA'."\n" .'* DEPRECATED'."\n" .'* EXPIRED'."\n", - 'visibility' => 'public', 'type' => 'string', 'required' => true, 'example' => 'STABLE', + 'enum' => ['STABLE', 'BETA', 'DEPRECATED', 'EXPIRED'], + 'visibility' => 'Public', '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', ], + 'features' => ['title' => '', 'description' => 'The features supported by the engine version.'."\n", '$ref' => '#/components/schemas/EngineVersionSupportedFeatures', 'visibility' => 'Public', 'backendName' => 'features', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'defaultEngineVersion' => ['title' => '', 'description' => 'The default engine version that is used for a deployment.'."\n", 'type' => 'string', 'example' => 'vvr-6.0.1-flink-1.15', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The basic information about the engine version.'."\n", '$ref' => '#/components/schemas/EngineVersionMetadata', 'visibility' => 'Public', 'extendType' => 'true', 'title' => '', 'example' => ''], + 'visibility' => 'Public', 'backendName' => 'engineVersionMetadata', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'useForSqlDeployments' => ['title' => '', 'description' => 'Specifies whether the engine version can be used to submit an SQL deployment.'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'useForSqlDeployments'], + 'supportNativeSavepoint' => ['title' => '', 'description' => 'Specifies whether the engine version can be used to create a native savepoint.'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'supportNativeSavepoint'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'lineNumber' => ['description' => 'The number the row at which the error starts.'."\n", 'type' => 'string', 'title' => '', 'example' => '3'], + 'columnNumber' => ['description' => 'The number of the column at which the error starts.'."\n", 'type' => 'string', 'title' => '', 'example' => '2'], + 'endLineNumber' => ['description' => 'The number of the row at which the error ends.'."\n", 'type' => 'string', 'title' => '', 'example' => '5'], + 'endColumnNumber' => ['description' => 'The number of the column at which the error ends.'."\n", 'type' => 'string', 'title' => '', 'example' => '11'], + 'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'title' => '', 'example' => '""'], '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', + 'items' => ['description' => 'The information about the invalid configurations of Realtime Compute for Apache Flink.'."\n", 'type' => 'string', 'example' => '{"k:v"}', 'title' => ''], + 'example' => '', ], ], + 'example' => '', + ], + 'Event' => [ + 'title' => '运行事件', + 'description' => 'event', + 'type' => 'object', + 'properties' => [ + 'eventId' => ['title' => '运行事件ID', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000000001'], + 'namespace' => ['title' => '项目空间', 'type' => 'string', 'example' => 'default-namespace'], + 'workspace' => ['title' => '工作空间', 'type' => 'string', 'example' => 'edcef******b4f'], + 'eventName' => ['title' => '运行事件名称', 'type' => 'string', 'example' => 'STATE_TRANSITION_IS_COMPLETED'], + 'deploymentId' => ['title' => '作业ID', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000680003'], + 'jobId' => ['title' => '作业实例ID', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000005043'], + 'message' => ['title' => '运行事件信息', 'type' => 'string'], + 'createdAt' => ['type' => 'string'], + ], ], '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', - ], + 'jobmanagerResourceSettingSpec' => ['title' => '', 'description' => 'The basic resource configuration of the JobManager.'."\n", '$ref' => '#/components/schemas/BasicResourceSettingSpec', 'visibility' => 'Public', 'backendName' => 'jobmanagerResourceSettingSpec', 'example' => ''], + 'resourcePlan' => ['title' => '', 'description' => 'The resource configuration plan of the deployment in expert mode.'."\n", '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]}}', 'visibility' => 'Public', 'backendName' => 'resourcePlan'], ], + 'visibility' => 'Public', + 'example' => '', ], - 'FlinkConf' => [ - 'title' => 'Flink conf', - 'description' => 'The Realtime Compute for Apache Flink configurations.'."\n", - 'visibility' => 'public', + 'FetchResult' => [ 'type' => 'object', - 'example' => '{"taskmanager.numberOfTaskSlots":"1","table.exec.state.ttl":"128000s"}'."\n", - 'parseType' => 'struct', + 'properties' => [ + 'resultType' => ['type' => 'string'], + 'resultMessage' => ['type' => 'string'], + 'tableResults' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/TableResult'], + ], + ], ], + 'FlinkConf' => ['title' => '', 'description' => 'The Realtime Compute for Apache Flink configurations.'."\n", 'type' => 'object', 'example' => '{"taskmanager.numberOfTaskSlots":"1","table.exec.state.ttl":"128000s"}'."\n", 'visibility' => 'Public', 'parseType' => 'struct'], 'Folder' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'folderId' => ['description' => 'The ID of the folder.'."\n", 'type' => 'string', 'title' => '', 'example' => '00000000-0000-0000-0000-0000012312****'], + 'parentId' => ['description' => 'The ID of the parent folder.'."\n", 'type' => 'string', 'title' => '', 'example' => '00000000-0000-0000-0000-0000012390****'], + 'name' => ['description' => 'The name of the folder.'."\n", 'type' => 'string', 'title' => '', 'example' => 'test'], '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', + 'items' => ['description' => 'The information about the subfolder.'."\n", '$ref' => '#/components/schemas/SubFolder', 'title' => '', 'example' => ''], + 'example' => '', ], + 'workspace' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'title' => '', 'example' => 'edcef******b4f'], + 'namespace' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'title' => '', 'example' => 'default-namespace'], + 'createdAt' => ['description' => 'The time when the folder was created.'."\n", 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1723537978'], + 'modifiedAt' => ['description' => 'The time when the folder was modified.'."\n", 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1723537978'], + ], + 'example' => '', + ], + 'Function' => [ + 'type' => 'object', + 'properties' => [ + 'gmtModified' => ['type' => 'integer', 'format' => 'int64', 'required' => false], + 'functionLanguage' => ['title' => 'FUNCTION_LANGUAGE_INVALID: FUNCTION_LANGUAGE_INVALID = 0;, FUNCTION_LANGUAGE_JAVA: FUNCTION_LANGUAGE_JAVA = 1;, FUNCTION_LANGUAGE_SCALA: FUNCTION_LANGUAGE_SCALA = 2;, FUNCTION_LANGUAGE_PYTHON: '."\n" + .'FUNCTION_LANGUAGE_PYTHON = 3;', 'type' => 'string', 'required' => true], + 'name' => ['type' => 'string', 'required' => true], + 'description' => ['type' => 'string'], + 'className' => ['title' => '', 'type' => 'string', 'required' => true], + 'functionType' => ['title' => 'FUNCTION_TYPE_INVALID: FUNCTION_TYPE_INVALID = 0;, FUNCTION_TYPE_FLINK: FUNCTION_TYPE_FLINK = 1;, FUNCTION_TYPE_UNKNOWN_EXTERNAL: FUNCTION_TYPE_UNKNOWN_EXTERNAL = 2;', 'type' => 'string', 'required' => true], ], ], 'GetLineageInfoParams' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'id' => ['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", 'type' => 'string', 'title' => '', 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****'], + 'depth' => ['description' => 'The depth of the data lineage.'."\n", 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1'], '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', + 'example' => 'JOB', + 'enum' => ['TABLE', 'JOB'], ], + 'isColumnLevel' => ['description' => 'The lineage type. The value true indicates a field-level lineage. The value false indicates a table-level lineage.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], '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', + 'example' => 'Both', + 'enum' => ['UPSTREAM', 'DOWNSTREAM', 'BOTH'], ], + 'isTemporary' => ['description' => 'Indicates whether the table was a temporary table.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'workspace' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'title' => '', 'example' => 'a14bd5d90a****'."\n"], + 'namespace' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'title' => '', 'example' => 'default-namespace'], + ], + 'example' => '', + ], + 'GetPreSignedUrlForObjectResult' => [ + 'type' => 'object', + 'properties' => [ + 'preSignedUrl' => ['title' => '签名URL', 'type' => 'string'], + 'jarUrl' => ['title' => 'jar存放路径', 'type' => 'string'], ], ], 'HotUpdateJobFailureInfo' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The hot update status of the job.', 'type' => 'object', 'properties' => [ - 'reason' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“”', - 'backendName' => 'reason', - ], - 'message' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“”', - 'backendName' => 'message', - ], + 'reason' => ['title' => '', 'description' => 'The error cause.', 'type' => 'string', 'example' => '“”', 'visibility' => 'Public', 'backendName' => 'reason'], + 'message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '“”', 'visibility' => 'Public', 'backendName' => 'message'], 'failureSeverity' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The error level.', 'type' => 'string', 'example' => 'LOW', + 'enum' => ['CRITICAL', 'LOW'], + 'visibility' => 'Public', 'backendName' => 'failureSeverity', - 'enum' => [ - 'CRITICAL', - 'LOW', - ], ], ], + 'example' => '', + 'visibility' => 'Public', ], 'HotUpdateJobParams' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'rescaleJobParam' => ['description' => '', '$ref' => '#/components/schemas/RescaleJobParam', 'visibility' => 'Public', 'backendName' => 'rescaleJobParam', 'title' => '', 'example' => ''], + 'updateJobConfigParam' => ['description' => '', '$ref' => '#/components/schemas/UpdateJobConfigParam', 'visibility' => 'Public', 'backendName' => 'updateJobConfigParam', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'HotUpdateJobResult' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'jobHotUpdateId' => ['title' => '', 'description' => '', 'type' => 'string', 'example' => '123hashd****', 'visibility' => 'Public', 'backendName' => 'jobHotUpdateId'], + 'jobId' => ['title' => '', 'description' => '', 'type' => 'string', 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', 'visibility' => 'Public', 'backendName' => 'jobId'], + 'targetResourceSetting' => ['title' => '', 'description' => '', '$ref' => '#/components/schemas/BriefResourceSetting', 'visibility' => 'Public', 'backendName' => 'targetResourceSetting', 'example' => ''], + 'hotUpdateParams' => ['title' => '', 'description' => '', '$ref' => '#/components/schemas/HotUpdateJobParams', 'visibility' => 'Public', 'backendName' => 'hotUpdateParams', 'example' => ''], + 'status' => ['title' => '', 'description' => '', '$ref' => '#/components/schemas/HotUpdateJobStatus', 'visibility' => 'Public', 'backendName' => 'status', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'HotUpdateJobStatus' => [ - 'title' => 'A short description of struct', - 'description' => 'The dynamic update status of the deployment.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The dynamic update status of the deployment.', 'type' => 'object', 'properties' => [ 'status' => [ 'title' => '', - 'description' => 'The status of the dynamic update.'."\n", - 'visibility' => 'Public', + 'description' => 'The status of the dynamic update.', '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', + 'enum' => ['INIT', 'HOT_UPDATING', 'FAILED', 'HOT_UPDATED'], ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'failure' => ['title' => '', 'description' => 'The error message of the dynamical update.', '$ref' => '#/components/schemas/HotUpdateJobFailureInfo', 'example' => ''], ], + 'example' => '', ], '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', - ], + 'jarUri' => ['title' => '', 'description' => 'The full URL for the JAR deployment.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/test.jar', 'visibility' => 'Public', 'backendName' => 'jarUri'], + 'entryClass' => ['title' => '', 'description' => 'The entry class. You must enter the full name of the class.'."\n", 'type' => 'string', 'example' => 'org.apapche.flink.test', 'visibility' => 'Public', 'backendName' => 'entryClass'], + 'mainArgs' => ['title' => '', 'description' => 'The parameters required by the entry class.'."\n", 'type' => 'string', 'example' => 'start from main', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The full URL of the additional dependency file.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/addition.jar', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'additionalDependencies', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Job' => [ 'title' => '', - 'description' => 'The details of jobs generated in a deployment.'."\n", - 'visibility' => 'public', + 'description' => 'This data structure represents the details of a job instance generated by a deployment.', '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', - ], + 'jobId' => ['title' => '', 'description' => 'Job instance ID.', 'type' => 'string', 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', 'visibility' => 'Public', 'backendName' => 'jobId'], + 'deploymentId' => ['title' => '', 'description' => 'Deployment ID.', 'type' => 'string', 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', 'visibility' => 'Public', 'backendName' => 'deploymentId'], + 'deploymentName' => ['title' => '', 'description' => 'Deployment name.', 'type' => 'string', 'example' => 'flinktest', 'visibility' => 'Public', 'backendName' => 'deploymentName'], + 'namespace' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'namespacetest', 'visibility' => 'Public', 'backendName' => 'namespace'], 'executionMode' => [ 'title' => '', - 'description' => 'The execution mode of the job. Valid values:'."\n" + 'description' => 'Job instance execution mode.'."\n" ."\n" - .'* STREAM'."\n" - .'* BATCH'."\n", - 'visibility' => 'public', + .'- STREAM: Stream mode.'."\n" + ."\n" + .'- BATCH: Batch mode.', 'type' => 'string', 'example' => 'BATCH', + 'enum' => ['STREAMING', 'BATCH'], + 'visibility' => 'Public', 'backendName' => 'executionMode', - 'enum' => [ - 'STREAMING', - 'BATCH', - ], ], - 'creator' => [ + 'creator' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => '27846363877456****', 'visibility' => 'Public', 'backendName' => 'creator'], + 'creatorName' => ['title' => '', 'description' => 'Creator name.', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com', 'visibility' => 'Public', 'backendName' => 'creatorName'], + 'modifier' => ['title' => '', 'description' => 'Modifier.', 'type' => 'string', 'example' => '27846363877456****', 'visibility' => 'Public', 'backendName' => 'modifier'], + 'modifierName' => ['title' => '', 'description' => 'Modifier name.', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com', 'visibility' => 'Public', 'backendName' => 'modifierName'], + 'startTime' => ['title' => '', 'description' => 'Job instance start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1660190835', 'visibility' => 'Public', 'backendName' => 'startTime'], + 'endTime' => ['title' => '', 'description' => 'Job instance end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1660277235', 'visibility' => 'Public', 'backendName' => 'endTime'], + 'engineVersion' => ['title' => '', 'description' => 'Job engine version.', 'type' => 'string', 'example' => 'vvr-4.0.14-flink-1.13', 'visibility' => 'Public', 'backendName' => 'engineVersion'], + 'flinkConf' => ['title' => '', 'description' => 'Full parameter settings for the job instance.', 'type' => 'object', 'example' => '{execution.checkpointing.unaligned: false}', 'visibility' => 'Public', 'backendName' => 'flinkConf'], + 'status' => ['title' => '', 'description' => 'Job instance status.', '$ref' => '#/components/schemas/JobStatus', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'], + 'metric' => ['title' => '', 'description' => 'Job instance resource information.', '$ref' => '#/components/schemas/JobMetric', 'example' => '', 'visibility' => 'Public', 'backendName' => 'metric'], + 'sessionClusterName' => ['title' => '', 'description' => 'If the job instance runs on a Session cluster, this shows the Session cluster name; otherwise, it is null.', 'type' => 'string', 'example' => 'null', 'visibility' => 'Public', 'backendName' => 'sessionClusterName'], + 'artifact' => ['title' => '', 'description' => 'Job instance content template.', '$ref' => '#/components/schemas/Artifact', 'example' => '', 'visibility' => 'Public', 'backendName' => 'artifact'], + 'logging' => ['title' => '', 'description' => 'Job instance log configuration.', '$ref' => '#/components/schemas/Logging', 'example' => '', 'visibility' => 'Public', 'backendName' => 'logging'], + 'batchResourceSetting' => ['title' => '', 'description' => 'Batch mode resource settings.', '$ref' => '#/components/schemas/BatchResourceSetting', 'example' => '', 'visibility' => 'Public', 'backendName' => 'batchResourceSetting'], + 'streamingResourceSetting' => ['title' => '', 'description' => 'Stream mode resource settings.', '$ref' => '#/components/schemas/StreamingResourceSetting', 'example' => '', 'visibility' => 'Public', 'backendName' => 'streamingResourceSetting'], + 'restoreStrategy' => ['title' => '', 'description' => 'Job instance startup policy.', '$ref' => '#/components/schemas/DeploymentRestoreStrategy', 'example' => '', 'visibility' => 'Public', 'backendName' => 'restoreStrategy'], + 'userFlinkConf' => ['title' => '', 'description' => 'User job parameter settings.', '$ref' => '#/components/schemas/FlinkConf', 'example' => '', 'visibility' => 'Public', 'backendName' => 'userFlinkConf'], + 'localVariables' => [ 'title' => '', - 'description' => 'The ID of the account that is used to create the job.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '27846363877456****', - 'backendName' => 'creator', + 'description' => 'Job variables.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/LocalVariable', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', + 'backendName' => 'localVariables', ], - 'creatorName' => [ + 'workspace' => ['title' => '', 'description' => 'Workspace.', 'type' => 'string', 'example' => 'edcef******b4f', 'visibility' => 'Public', 'backendName' => 'workspace'], + 'createdAt' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '1714058507', 'visibility' => 'Public', 'backendName' => 'createdAt'], + 'modifiedAt' => ['title' => '', 'description' => 'Modification time.', 'type' => 'string', 'example' => '1714058800', 'visibility' => 'Public', 'backendName' => 'modifiedAt'], + ], + 'example' => '', + 'visibility' => 'Public', + ], + 'JobDiagnosis' => [ + 'title' => '', + 'description' => 'The job diagnostic result.', + 'type' => 'object', + 'properties' => [ + 'diagnoseId' => ['title' => '', 'description' => 'The diagnostic ID.', 'type' => 'string', 'example' => 'ba30cd99-37a5-4a20-8cd9-ed4b*****'], + 'diagnoseTime' => ['title' => '', 'description' => 'The diagnostic time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1740389560871'], + 'workspace' => ['title' => '', 'description' => 'The workspace.', 'type' => 'string', 'example' => 'a14bd5d90a****'], + 'namespace' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'example' => 'default-namespace-*****'], + 'riskLevel' => [ 'title' => '', - 'description' => 'The name of the account that is used to create the job.'."\n", - 'visibility' => 'public', + 'description' => 'The risk level.', + 'enumValueTitles' => ['RISK_LEVEL_HIGH' => 'RISK_LEVEL_HIGH', 'RISK_LEVEL_MID' => 'RISK_LEVEL_MID', 'RISK_LEVEL_LOW' => 'RISK_LEVEL_LOW'], 'type' => 'string', - 'example' => '****@streamcompute.onaliyun.com', - 'backendName' => 'creatorName', + 'example' => 'RISK_LEVEL_LOW', ], - 'modifier' => [ + 'symptoms' => ['title' => '', 'description' => 'The diagnostic details.', '$ref' => '#/components/schemas/JobDiagnosisSymptoms', 'example' => ''], + 'healthScore' => ['title' => '', 'type' => 'integer', 'description' => '', 'example' => '', 'format' => 'int32'], + ], + 'example' => '', + ], + 'JobDiagnosisSymptom' => [ + 'title' => '', + 'description' => 'The diagnostic item.', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '', 'description' => 'The diagnostic task name.', 'type' => 'string', 'example' => '启动速度分析'], + 'description' => ['title' => '', 'description' => 'The diagnostic result.', 'type' => 'string', 'example' => 'JM资源配置过低导致作业启动慢'], + 'recommendation' => ['title' => '', 'description' => 'The fixing suggestions.', 'type' => 'string', 'example' => '将 JOBManager 内存从 1Gi 改为 4Gi'], + ], + 'example' => '', + ], + 'JobDiagnosisSymptoms' => [ + 'title' => '', + 'description' => 'All diagnosis items for the job.', + 'type' => 'object', + 'properties' => [ + 'autopilot' => ['title' => '', 'description' => 'Job resource diagnosis.', '$ref' => '#/components/schemas/JobDiagnosisSymptom', 'example' => ''], + 'startup' => [ 'title' => '', - 'description' => 'The ID of the account that is used to modify the job.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '27846363877456****', - 'backendName' => 'modifier', + 'description' => 'Startup procedure diagnosis.', + 'type' => 'array', + 'items' => ['description' => 'Diagnosis item details.', '$ref' => '#/components/schemas/JobDiagnosisSymptom', 'title' => '', 'example' => ''], + 'example' => '', ], - 'modifierName' => [ + 'runtime' => [ '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', + 'description' => 'Run diagnosis.', + 'type' => 'array', + 'items' => ['description' => 'Diagnosis item details.', '$ref' => '#/components/schemas/JobDiagnosisSymptom', 'title' => '', 'example' => ''], + 'example' => '', ], - 'startTime' => [ + 'state' => [ 'title' => '', - 'description' => 'The start time of the job.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660190835', - 'backendName' => 'startTime', + 'description' => 'Job status diagnosis.', + 'type' => 'array', + 'items' => ['description' => 'Diagnosis item details.', '$ref' => '#/components/schemas/JobDiagnosisSymptom', 'title' => '', 'example' => ''], + 'example' => '', ], - 'endTime' => [ + 'troubleshooting' => [ 'title' => '', - 'description' => 'The end time of the job.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1660277235', - 'backendName' => 'endTime', + 'description' => 'Underlying abnormal diagnosis.', + 'type' => 'array', + 'items' => ['description' => 'Diagnosis item details.', '$ref' => '#/components/schemas/JobDiagnosisSymptom', 'title' => '', 'example' => ''], + 'example' => '', ], - 'engineVersion' => [ + 'others' => [ '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', + 'description' => 'Other namespace diagnosis.', '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', + 'items' => ['description' => 'Diagnosis item details.', '$ref' => '#/components/schemas/JobDiagnosisSymptom', 'title' => '', 'example' => ''], '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', ], ], + 'example' => '', ], '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', - ], + 'message' => ['title' => '', 'description' => 'The details of the failure.'."\n", 'type' => 'string', 'example' => 'Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.', 'visibility' => 'Public', 'backendName' => 'message'], + 'reason' => ['title' => '', 'description' => 'The reason for the failure.'."\n", 'type' => 'string', 'example' => 'KubernetesDeploymentNotProgressing', 'visibility' => 'Public', 'backendName' => 'reason'], + 'failedAt' => ['title' => '', 'description' => 'The time when the deployment fails.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1660120062', 'visibility' => 'Public', 'backendName' => 'failedAt'], ], + 'visibility' => 'Public', + 'example' => '', ], 'JobInfo' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The job information.', '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', - ], + 'id' => ['title' => '', 'description' => 'The job instance ID.', 'type' => 'string', 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****'."\n", 'visibility' => 'Public', 'backendName' => 'id'], + 'properties' => ['title' => '', 'description' => 'The job details.', 'type' => 'object', 'example' => '{"id:xxx","createTime:v"}', 'visibility' => 'Public', 'backendName' => 'properties'], ], + 'example' => '', + 'visibility' => 'Public', ], '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', - ], + 'totalMemoryByte' => ['title' => '', 'description' => 'The memory size. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'visibility' => 'Public', 'backendName' => 'totalMemoryByte'], + 'totalCpu' => ['title' => '', 'description' => 'The number of CPU cores.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'totalCpu'], ], + 'visibility' => 'Public', + 'example' => '', ], 'JobStartParameters' => [ 'title' => '', - 'description' => 'The parameters that are used to start a deployment.'."\n", - 'visibility' => 'public', + 'description' => 'Job start parameters', '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', - ], + 'deploymentId' => ['title' => '', 'description' => 'Job ID', 'type' => 'string', 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', 'visibility' => 'Public', 'backendName' => 'deploymentId'], + 'restoreStrategy' => ['title' => '', 'description' => 'Job start offset settings', '$ref' => '#/components/schemas/DeploymentRestoreStrategy', 'example' => '', 'visibility' => 'Public', 'backendName' => 'restoreStrategy'], + 'resourceQueueName' => ['title' => '', 'description' => 'Resource queue for job execution', 'type' => 'string', 'example' => 'default-queue', 'visibility' => 'Public', 'backendName' => 'resourceQueueName'], 'localVariables' => [ 'title' => '', - 'description' => 'The variables.'."\n", - 'visibility' => 'Public', + 'description' => 'Job variables', 'type' => 'array', - 'items' => [ - 'description' => 'The variables.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/LocalVariable', - ], + 'items' => ['description' => 'Job variables', '$ref' => '#/components/schemas/LocalVariable', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'localVariables', ], + 'jobId' => ['title' => '', 'description' => 'Job instance ID', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'jobId'], ], + 'example' => '', + 'visibility' => 'Public', ], 'JobStatus' => [ 'title' => '', 'description' => 'The status of the job that is generated in a deployment.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'currentJobStatus' => [ @@ -2339,499 +1070,201 @@ .'* FAILED'."\n" .'* CANCELLED'."\n" .'* FINISHED'."\n", - 'visibility' => 'public', 'type' => 'string', 'example' => 'RUNNING', + 'enum' => ['STARTING', 'RUNNING', 'CANCELLING', 'FAILED', 'CANCELLED', 'FINISHED'], + 'visibility' => 'Public', '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', ], + 'failure' => ['title' => '', 'description' => 'The information about the job failure. This parameter is valid when the value of the currentJobStatus parameter is FAILED.'."\n", '$ref' => '#/components/schemas/JobFailure', 'visibility' => 'Public', 'backendName' => 'failure', 'example' => ''], + 'running' => ['title' => '', 'description' => 'The details of the job. This parameter is valid when the value of the currentJobStatus parameter is RUNNING.'."\n", '$ref' => '#/components/schemas/JobStatusRunning', 'visibility' => 'Public', 'backendName' => 'running', 'example' => ''], + 'healthScore' => ['type' => 'integer', 'format' => 'int32', 'visibility' => 'Public', 'backendName' => 'healthScore', 'description' => '', 'title' => '', 'example' => ''], + 'riskLevel' => ['type' => 'string', 'visibility' => 'Public', 'backendName' => 'riskLevel', 'description' => '', 'title' => '', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'observedFlinkJobRestarts' => ['title' => '', 'description' => 'The number of times the job is restarted.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'visibility' => 'Public', 'backendName' => 'observedFlinkJobRestarts'], + 'observedFlinkJobStatus' => ['title' => '', 'description' => 'The status of the Flink job.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'visibility' => 'Public', 'backendName' => 'observedFlinkJobStatus'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'starting' => ['title' => '', 'description' => 'The number of jobs that are in the starting state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'starting'], + 'running' => ['title' => '', 'description' => 'The number of jobs that are in the running state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'visibility' => 'Public', 'backendName' => 'running'], + 'cancelling' => ['title' => '', 'description' => 'The number of jobs that are in the cancelling state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'cancelling'], + 'cancelled' => ['title' => '', 'description' => 'The number of jobs that are in the cancelled state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'visibility' => 'Public', 'backendName' => 'cancelled'], + 'finished' => ['title' => '', 'description' => 'The number of jobs that are in the finished state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'visibility' => 'Public', 'backendName' => 'finished'], + 'failed' => ['title' => '', 'description' => 'The number of jobs that are in the failed state.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'visibility' => 'Public', 'backendName' => 'failed'], ], + 'visibility' => 'Public', + 'example' => '', ], 'LineageColumn' => [ - 'title' => 'A short description of struct', - 'description' => 'The information about the lineage line.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The information about the lineage line.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '', - 'description' => 'The field ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '123ss3', - 'backendName' => 'id', - ], - 'columnName' => [ + 'id' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => '123ss3'], + 'columnName' => ['title' => '', 'description' => 'The name of the column.', 'type' => 'string', 'example' => 'name'], + 'nullable' => ['title' => '', 'description' => 'Indicates whether the value is nullable.', 'type' => 'boolean', 'example' => 'false'], + 'description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => '订单用户名称'], + 'columnType' => ['title' => '', 'description' => 'The column type.', 'type' => 'string', 'example' => 'string'], + 'columnNativeType' => ['title' => '', 'description' => 'The original type of the column.', 'type' => 'string', 'example' => 'string'], + 'createdAt' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723537978'], + 'modifiedAt' => ['title' => '', 'description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723537978'], + 'creator' => ['title' => '', 'description' => 'The user that creates the column.', 'type' => 'string', 'example' => 'userA'], + 'modifier' => ['title' => '', 'description' => 'The ID of the account that is used to modify the column.', 'type' => 'string', 'example' => 'userA'], + ], + 'example' => '', + ], + 'LineageInfo' => [ + 'title' => '', + 'description' => 'The details of the data lineage.'."\n", + 'type' => 'object', + 'properties' => [ + 'nodes' => [ 'title' => '', - 'description' => 'The name of the column.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'name', - 'backendName' => 'columnName', + 'description' => 'The nodes.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The node information.'."\n", '$ref' => '#/components/schemas/Node', 'title' => '', 'example' => ''], + 'example' => '', ], - 'nullable' => [ + 'edges' => ['description' => 'The edge information.'."\n", 'title' => '', '$ref' => '#/components/schemas/Edge', 'example' => ''], + 'jobInfos' => [ 'title' => '', - 'description' => 'Indicates whether the value is nullable.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'nullable', + 'description' => 'The deployments.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The information about the deployment.'."\n", '$ref' => '#/components/schemas/JobInfo', 'title' => '', 'example' => ''], + 'example' => '', ], - 'description' => [ + ], + 'example' => '', + ], + 'LineageTable' => [ + 'title' => '', + 'description' => 'The information about the lineage table.'."\n", + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The table ID.'."\n", 'type' => 'string', 'title' => '', 'example' => '434508'], + 'tableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'title' => '', 'example' => 'order-test'], + 'with' => ['description' => 'The parameters of the table.'."\n", 'type' => 'object', 'title' => '', 'example' => ''], + 'properties' => ['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", 'type' => 'object', 'title' => '', 'example' => ''], + 'columns' => [ 'title' => '', - 'description' => 'The description.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'description' => 'The information about columns.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The details about columns.'."\n", '$ref' => '#/components/schemas/LineageColumn', 'title' => '', 'example' => ''], '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', ], ], + 'example' => '', ], 'LocalVariable' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'name' => ['title' => '', 'description' => 'The name of the variable.'."\n", 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'name'], + 'value' => ['title' => '', 'description' => 'The value of the variable.'."\n", 'type' => 'string', 'example' => 'datagen', 'visibility' => 'Public', 'backendName' => 'value'], ], + 'visibility' => 'Public', + 'example' => '', ], 'Lock' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'id' => ['description' => 'The lock ID.'."\n", 'type' => 'string', 'title' => '', 'example' => 'stt-fu1658tbk6mnkk2****'], + 'workspace' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'title' => '', 'example' => 'a14bd5d90a****'], + 'namespace' => ['description' => 'The name of the namespace.'."\n", 'type' => 'string', 'title' => '', 'example' => 'default-namespace'], + 'holderId' => ['description' => 'The ID of the lock holder.'."\n", 'type' => 'string', 'title' => '', 'example' => '18389966****'], + 'holderName' => ['description' => 'The username of the lock holder.'."\n", 'type' => 'string', 'title' => '', 'example' => 'userA'], ], + 'example' => '', ], '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', - ], + 'loggerName' => ['title' => '', 'description' => 'The name of the class of the output log.'."\n", 'type' => 'string', 'example' => 'StdOutErrConsoleAppender', 'visibility' => 'Public', 'backendName' => 'loggerName'], 'loggerLevel' => [ 'title' => '', 'description' => 'The level of the output log.'."\n", - 'visibility' => 'public', 'type' => 'string', 'example' => 'ERROR', + 'enum' => ['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR'], + 'visibility' => 'Public', 'backendName' => 'loggerLevel', - 'enum' => [ - 'TRACE', - 'DEBUG', - 'INFO', - 'WARN', - 'ERROR', - ], ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Logging' => [ 'title' => '', - 'description' => 'The information about log configurations for a deployment.'."\n", - 'visibility' => 'public', + 'description' => 'The information about log configurations for a deployment.', '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', + .'- default: The default template is used.'."\n" + ."\n" + .'- oss: Logs are delivered to Object Storage Service (OSS).', + 'enumValueTitles' => ['default' => 'default'], 'type' => 'string', - 'example' => 'oss', + 'example' => 'default', + 'enum' => ['default', 'oss'], + 'visibility' => 'Public', 'backendName' => 'loggingProfile', - 'enum' => [ - 'default', - 'oss', - ], - ], - 'log4j2ConfigurationTemplate' => [ - 'title' => '', - 'description' => 'Custom log templates.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'log4j2ConfigurationTemplate', ], + 'log4j2ConfigurationTemplate' => ['title' => '', 'description' => 'Custom log templates.', 'type' => 'string', 'example' => 'xml格式文本', 'visibility' => 'Public', 'backendName' => 'log4j2ConfigurationTemplate'], 'log4jLoggers' => [ 'title' => '', - 'description' => 'The Log4j configuration.'."\n", - 'visibility' => 'public', + 'description' => 'The Log4j configuration.', 'type' => 'array', - 'items' => [ - 'description' => 'The log output configuration information about a job.'."\n", - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Log4jLogger', - ], + 'items' => ['description' => 'The log output configuration information about a job.', '$ref' => '#/components/schemas/Log4jLogger', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', + 'visibility' => 'Public', 'backendName' => 'log4jLoggers', ], - 'logReservePolicy' => [ - 'title' => '', - 'description' => 'The log retention policy.'."\n", - 'visibility' => 'public', - 'backendName' => 'logReservePolicy', - '$ref' => '#/components/schemas/LogReservePolicy', - ], + 'logReservePolicy' => ['title' => '', 'description' => 'The log retention policy.', '$ref' => '#/components/schemas/LogReservePolicy', 'example' => '', 'visibility' => 'Public', 'backendName' => 'logReservePolicy'], ], + 'example' => '', + 'visibility' => 'Public', ], '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', - ], + 'openHistory' => ['title' => '', 'description' => 'Specifies whether to enable the log archiving feature.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'openHistory'], + 'expirationDays' => ['title' => '', 'description' => 'The number of days for which logs are retained after you enable the'."\n" + .'log archiving feature.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'visibility' => 'Public', 'backendName' => 'expirationDays'], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'member' => ['title' => '', 'description' => 'The member ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user: 181319557522****', 'visibility' => 'Public', 'backendName' => 'member'], 'role' => [ 'title' => '', 'description' => 'The role of the member.'."\n" @@ -2841,488 +1274,276 @@ .'* EDITOR'."\n" .'* VIEWER'."\n" .'* ADMIN'."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'EDITOR' => 'EDITOR', - 'OWNER' => 'OWNER', - 'VIEWER' => 'VIEWER', - ], + 'enumValueTitles' => ['EDITOR' => 'EDITOR', 'OWNER' => 'OWNER', 'VIEWER' => 'VIEWER'], 'example' => 'VIEWER', + 'visibility' => 'Public', 'backendName' => 'role', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'MetadataInfo' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'key' => ['description' => 'The metadata field.'."\n", 'type' => 'string', 'title' => '', 'example' => 'topic'], + 'virtual' => ['description' => 'Specifies whether the metadata is read only.'."\n", 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'Node' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'id' => ['description' => 'The ID of the node.'."\n", 'type' => 'string', 'title' => '', 'example' => '97383'], + 'catalogName' => ['description' => 'The name of the catalog.'."\n", 'type' => 'string', 'title' => '', 'example' => 'paimon'], + 'databaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'title' => '', 'example' => 'paimon-ods'], + 'isTemporary' => ['description' => 'Specifies whether the table is a temporary table.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'connector' => ['description' => 'The name of the connector.'."\n", 'type' => 'string', 'title' => '', 'example' => 'paimon'], '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', + 'items' => ['description' => 'The details of the table.'."\n", '$ref' => '#/components/schemas/LineageTable', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], - 'PrimaryKey' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'NodeExecutionContextDTO' => [ 'type' => 'object', 'properties' => [ - 'constraintName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'pk', - 'backendName' => 'constraintName', + 'context' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string'], ], - 'columns' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', + ], + ], + 'NodeExecutionStatusDTO' => [ + 'type' => 'object', + 'properties' => [ + 'executionId' => ['type' => 'string'], + 'workspace' => ['type' => 'string'], + 'resourceId' => ['type' => 'string'], + 'namespace' => ['type' => 'string'], + 'type' => ['type' => 'string'], + 'status' => ['type' => 'string'], + ], + ], + 'PeriodicSchedulingPolicy' => [ + 'title' => '定时计划策略', + 'description' => '定时计划策略', + 'type' => 'object', + 'properties' => [ + 'onlyOnceTriggerTime' => ['title' => '单次触发时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1723195800000'], + 'onlyOnceTriggerTimeIsExpired' => ['title' => '单次触发是否过期', 'type' => 'boolean', 'example' => 'true'], + 'periodicTriggerTime' => ['title' => '周期触发时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1723199340000'], + 'periodicSchedulingLevel' => ['title' => '触发周期', 'type' => 'string', 'example' => 'DAY'], + 'periodicSchedulingValues' => [ + 'title' => '周期触发值', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'id', - 'extendType' => 'true', - ], - 'backendName' => 'columns', + 'items' => ['type' => 'integer', 'format' => 'int32'], ], + 'isFinished' => ['title' => '单次触发是否完成', 'type' => 'boolean'], + 'resourceSetting' => ['title' => '作业资源设置', '$ref' => '#/components/schemas/BriefResourceSetting'], ], ], - 'Property' => [ - 'title' => 'A short description of struct', - 'description' => 'The configuration of the connector.'."\n", - 'visibility' => 'Public', + 'PrimaryKey' => [ + 'title' => '', + 'description' => 'The primary key of the table.', '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' => [ + 'constraintName' => ['title' => '', 'description' => 'The constraint name.', 'type' => 'string', 'example' => 'pk', 'required' => true, 'visibility' => 'Public', 'backendName' => 'constraintName'], + 'columns' => [ 'title' => '', - 'description' => 'The description of the parameter.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'description' => 'The primary key column group.', + 'type' => 'array', + 'items' => ['description' => 'The column name.', 'type' => 'string', 'example' => 'id', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], '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", + 'required' => true, 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'sensitive', + 'backendName' => 'columns', ], + 'constraintType' => ['title' => '', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], + 'enforced' => ['type' => 'boolean', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', + 'required' => false, + 'visibility' => 'Public', + ], + 'Property' => [ + 'title' => '', + 'description' => 'The configuration of the connector.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'The name of the parameter key.', 'type' => 'string', 'example' => 'username'], + 'defaultValue' => ['title' => '', 'description' => 'The default value of the parameter.', 'type' => 'string', 'example' => 'userA'], + 'description' => ['title' => '', 'description' => 'The description of the parameter.', 'type' => 'string', 'example' => '用户名'], + 'required' => ['title' => '', 'description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true'], + 'definesFormat' => ['title' => '', 'description' => 'Indicates whether the format is defined.', 'type' => 'boolean', 'example' => 'flase'], + 'sensitive' => ['title' => '', 'description' => 'Indiactes whether the data is sensitive.', 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '', ], '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', - ], + 'pythonArtifactUri' => ['title' => '', 'description' => 'The full URL for the Python deployment.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/test.py', 'visibility' => 'Public', 'backendName' => 'pythonArtifactUri'], + 'mainArgs' => ['title' => '', 'description' => 'The startup parameter.'."\n", 'type' => 'string', 'example' => 'start from main', 'visibility' => 'Public', 'backendName' => 'mainArgs'], + 'entryModule' => ['title' => '', 'description' => 'The startup module for the Python deployment.'."\n", 'type' => 'string', 'example' => 'test.py', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The URL of the dependency file.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/addition.py', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'additionalDependencies', + 'example' => '', ], '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', - ], + 'items' => ['description' => 'The URL of the Python library file.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/additionlib.py', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'additionalPythonLibraries', + 'example' => '', ], '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', - ], + 'items' => ['description' => 'The URL of the Python archive file.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/additionArchives.zip', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'additionalPythonArchives', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], 'Relation' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The lineage information.', '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', - ], + 'source' => ['title' => '', 'description' => 'The source table information.', 'type' => 'string', 'example' => 'TableA', 'visibility' => 'Public', 'backendName' => 'source'], + 'destination' => ['title' => '', 'description' => 'The destination table information.', 'type' => 'string', 'example' => 'TableB', 'visibility' => 'Public', 'backendName' => 'destination'], + 'jobId' => ['title' => '', 'description' => 'The job instance ID.', 'type' => 'string', 'example' => '664cc64d-5dea-4ad3-9ee4-8432a874****', 'visibility' => 'Public', 'backendName' => 'jobId'], ], + 'example' => '', + 'visibility' => 'Public', ], 'RescaleJobParam' => [ - 'title' => 'A short description of struct', - 'description' => '', + 'title' => '', + 'description' => 'The parameters for dynamically updating job resource configurations.', + 'type' => 'object', + 'properties' => [ + 'jobParallelism' => ['title' => '', 'description' => 'The parallelism.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'jobParallelism'], + ], + 'example' => '', 'visibility' => 'Public', + ], + 'Resource' => [ 'type' => 'object', 'properties' => [ - 'jobParallelism' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'jobParallelism', - ], + 'fixedResource' => ['title' => '固定资源。', 'required' => true, '$ref' => '#/components/schemas/ResourceSpec'], + 'elasticResource' => ['$ref' => '#/components/schemas/ResourceSpec'], + ], + 'required' => true, + ], + 'ResourceQuota' => [ + 'title' => '资源配额', + 'description' => '资源配额', + 'type' => 'object', + 'properties' => [ + 'limit' => ['title' => '已分配资源', '$ref' => '#/components/schemas/ResourceSpec'], + 'used' => ['title' => '已使用资源', '$ref' => '#/components/schemas/ResourceSpec'], + 'request' => ['title' => '保障资源', '$ref' => '#/components/schemas/ResourceSpec'], ], ], 'ResourceSpec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The resource specification.', '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', + 'cpu' => ['title' => '', 'description' => 'The CPU size.', 'type' => 'number', 'format' => 'double', 'example' => '1.0'], + 'memory' => ['title' => '', 'description' => 'The memory size.', 'type' => 'string', 'example' => '4Gi'], + ], + 'example' => '', + ], + 'Row' => [ + 'type' => 'object', + 'properties' => [ + 'cells' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/Cell'], ], ], ], + 'RowUpdate' => [ + 'type' => 'object', + 'properties' => [ + 'rowKind' => ['type' => 'string'], + 'row' => ['$ref' => '#/components/schemas/Row'], + ], + ], 'Savepoint' => [ 'title' => '', - 'description' => 'The information about the savepoint.'."\n", - 'visibility' => 'public', + 'description' => 'The information about the savepoint.', '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', - ], + 'savepointId' => ['title' => '', 'description' => 'The savepoint ID.', 'type' => 'string', 'example' => '354dde66-a3ae-463e-967a-0b4107fd****', 'visibility' => 'Public', 'backendName' => 'savepointId'], + 'deploymentId' => ['title' => '', 'description' => 'The deployment ID.', 'type' => 'string', 'example' => '1d716b22-6aad-4be2-85c2-50cfc757****', 'visibility' => 'Public', 'backendName' => 'deploymentId'], + 'jobId' => ['title' => '', 'description' => 'The job ID.', 'type' => 'string', 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', 'visibility' => 'Public', 'backendName' => 'jobId'], + 'namespace' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'namespacetest', 'visibility' => 'Public', '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', + .'- `USER_REQUEST`: The savepoint is manually created.'."\n" + ."\n" + .'- `STOP_WITH_SAVEPOINT`: The savepoint is created when you cancel the deployment.'."\n" + ."\n" + .'- `RETAINED_CHECKPOINT`: The savepoint is created based on the returned checkpoint.', 'type' => 'string', 'example' => 'USER_REQUEST', + 'enum' => ['USER_REQUEST', 'STOP_WITH_SAVEPOINT', 'RETAINED_CHECKPOINT', 'AUTO_TRIGGERED'], + 'visibility' => 'Public', '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', ], + 'nativeFormat' => ['title' => '', 'description' => 'Specifies whether the savepoint is in native format.', 'type' => 'boolean', 'example' => 'TRUE', 'visibility' => 'Public', 'backendName' => 'nativeFormat'], + 'description' => ['title' => '', 'description' => 'The description of the savepoint.', 'type' => 'string', 'example' => '作业快照1', 'visibility' => 'Public', 'backendName' => 'description'], + 'stopWithDrainEnabled' => ['title' => '', 'description' => 'Specifies whether to use the stop-with-drain mode.', 'type' => 'boolean', 'example' => 'TRUE', 'visibility' => 'Public', 'backendName' => 'stopWithDrainEnabled'], + 'savepointLocation' => ['title' => '', 'description' => 'The storage URL of the savepoint.', 'type' => 'string', 'example' => 'https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf60782c81/checkpoints/sp-3285', 'visibility' => 'Public', 'backendName' => 'savepointLocation'], + 'status' => ['title' => '', 'description' => 'The status of the savepoint.', '$ref' => '#/components/schemas/SavepointStatus', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'], + 'createdAt' => ['title' => '', 'description' => 'The time when the savepoint was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1659066711', 'visibility' => 'Public', 'backendName' => 'createdAt'], + 'modifiedAt' => ['title' => '', 'description' => 'The time when the savepoint was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1659069473', 'visibility' => 'Public', 'backendName' => 'modifiedAt'], ], + 'example' => '', + 'visibility' => 'Public', ], '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', - ], + 'message' => ['title' => '', 'description' => 'The failure information.'."\n", 'type' => 'string', 'example' => 'create savepoint failed', 'visibility' => 'Public', 'backendName' => 'message'], + 'reason' => ['title' => '', 'description' => 'The reason for the failure.'."\n", 'type' => 'string', 'example' => 'IO Exception', 'visibility' => 'Public', 'backendName' => 'reason'], + 'failedAt' => ['title' => '', 'description' => 'The time when the deployment fails.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1655006835', 'visibility' => 'Public', 'backendName' => 'failedAt'], ], + 'visibility' => 'Public', + 'example' => '', ], 'SavepointStatus' => [ 'title' => '', 'description' => 'The status of the savepoint that is created for a deployment.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'state' => [ @@ -3332,307 +1553,384 @@ .'* STARTED'."\n" .'* COMPLETED'."\n" .'* FAILED'."\n", - 'visibility' => 'public', 'type' => 'string', 'example' => 'COMPLETED', + 'enum' => ['STARTED', 'COMPLETED', 'FAILED'], + 'visibility' => 'Public', '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', + 'failure' => ['title' => '', 'description' => 'The details of the failure to create a savepoint for the deployment.'."\n", '$ref' => '#/components/schemas/SavepointFailure', 'visibility' => 'Public', 'backendName' => 'failure', 'example' => ''], + ], + 'visibility' => 'Public', + 'example' => '', + ], + 'ScheduledPlan' => [ + 'title' => '定时计划', + 'description' => '定时计划策略', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间ID', 'type' => 'string', 'example' => 'edcef******b4f'], + 'namespace' => ['title' => '项目空间ID', 'type' => 'string', 'example' => 'default-namespace'], + 'createdAt' => ['title' => '创建时间', 'type' => 'string', 'example' => '1723197248'], + 'creator' => ['title' => '创建者', 'type' => 'string', 'example' => '27846363877456****'], + 'creatorName' => ['title' => '创建者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifier' => ['title' => '修改者', 'type' => 'string', 'example' => '27846363877456****'], + 'modifierName' => ['title' => '修改者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifiedAt' => ['title' => '修改时间', 'type' => 'string', 'example' => '1723197248'], + 'scheduledPlanId' => ['title' => '定时计划ID', 'type' => 'string', 'example' => 'f3b4ec1e-85dc-4b1d-9726-1d7f4c37****'], + 'name' => ['title' => '定时计划名称', 'type' => 'string', 'example' => 'test-scheduled-plan'], + 'deploymentId' => ['title' => '作业实例ID', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000000001'], + 'updatedByUser' => ['title' => '是否由用户更新', 'type' => 'boolean', 'example' => 'true'], + 'origin' => ['title' => '定时计划来源', 'type' => 'string', 'example' => 'USER_DEFINED'], + 'periodicSchedulingPolicies' => [ + 'title' => '周期执行策略', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/PeriodicSchedulingPolicy'], ], + 'status' => ['title' => '定时计划状态', 'type' => 'string', 'example' => 'FINISHED'], + ], + ], + 'ScheduledPlanAppliedInfo' => [ + 'title' => '定时计划应用信息', + 'description' => '定时计划执行信息', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间ID', 'type' => 'string', 'example' => 'edcef******b4f'], + 'namespace' => ['title' => '项目空间ID', 'type' => 'string', 'example' => 'default-namespace'], + 'modifier' => ['title' => '修改者', 'type' => 'string', 'example' => '27846363877456****'], + 'modifierName' => ['title' => '修改者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifiedAt' => ['title' => '修改时间', 'type' => 'string', 'example' => '1723197248'], + 'scheduledPlanId' => ['title' => '定时计划ID', 'type' => 'string', 'example' => 'f3b4ec1e-85dc-4b1d-9726-1d7f4c37****'], + 'scheduledPlanName' => ['title' => '定时计划名称', 'type' => 'string', 'example' => 'test-scheduled-plan'], + 'deploymentId' => ['title' => '作业ID', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000000001'], + 'expectedState' => ['title' => '期望状态', 'type' => 'string', 'example' => 'RUNNING'], + 'statusState' => ['title' => '实际状态', 'type' => 'string', 'example' => 'WAITING'], + ], + ], + 'ScheduledPlanExecutedInfo' => [ + 'title' => '作业资源变更信息', + 'description' => '作业执行信息', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间ID', 'type' => 'string', 'example' => 'edcef******b4f'], + 'namespace' => ['title' => '项目空间ID', 'type' => 'string', 'example' => 'default-namespace'], + 'createdAt' => ['title' => '创建时间', 'type' => 'string', 'example' => '1723197248'], + 'creator' => ['title' => '创建者', 'type' => 'string', 'example' => '27846363877456****'], + 'creatorName' => ['title' => '创建者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifier' => ['title' => '修改者', 'type' => 'string', 'example' => '27846363877456****'], + 'modifierName' => ['title' => '修改者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifiedAt' => ['title' => '修改时间', 'type' => 'string', 'example' => '1723197248'], + 'jobResourceUpgradingId' => ['title' => '执行ID', 'type' => 'string', 'example' => '0e6d3bab-2277-4ed1-b573-9de6413d****'], + 'name' => ['title' => '执行名称', 'type' => 'string', 'example' => 'test-scheduled-plan'], + 'origin' => ['title' => '执行来源', 'type' => 'string', 'example' => 'SCHEDULED_PLAN'], + 'deploymentId' => ['title' => '作业ID', 'type' => 'string', 'example' => '00000000-0000-0000-0000-000000000001'], + 'originJobId' => ['title' => '作业实例ID', 'type' => 'string', 'example' => 'f8a2d5d9-9fc5-4273-bfcc-2a3cd354****'], + 'status' => ['title' => '作业资源变更状态', '$ref' => '#/components/schemas/ScheduledPlanExecutedStatus'], + ], + ], + 'ScheduledPlanExecutedStatus' => [ + 'title' => '定时计划执行状态', + 'description' => '定时计划执行状态', + 'type' => 'object', + 'properties' => [ + 'statusState' => ['title' => '当前状态', 'type' => 'string', 'example' => 'UPGRADED'], + 'restartType' => ['title' => '重启类型', 'type' => 'string', 'example' => 'HOT_UPDATE'], ], ], 'Schema' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', + 'items' => ['description' => 'The information about the fields that are contained in the table.'."\n", '$ref' => '#/components/schemas/TableColumn', 'title' => '', 'example' => ''], + 'example' => '', ], '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', + 'items' => ['description' => 'The watermark information.'."\n", '$ref' => '#/components/schemas/WatermarkSpec', 'title' => '', 'example' => ''], + 'example' => '', ], 'primaryKey' => [ 'description' => 'The information about the primary key.'."\n", - 'visibility' => 'Public', - 'backendName' => 'primaryKey', - '$ref' => '#/components/schemas/PrimaryKey', 'title' => '', + 'type' => 'array', + 'items' => ['description' => '', '$ref' => '#/components/schemas/PrimaryKey', 'title' => '', 'example' => ''], + 'example' => '', + '$ref' => '#/components/schemas/PrimaryKey', + ], + ], + 'example' => '', + ], + 'SessionCluster' => [ + 'title' => 'A short description of struct', + 'description' => 'SessionCluster', + 'type' => 'object', + 'properties' => [ + 'workspace' => ['title' => '工作空间', 'type' => 'string', 'example' => 'edcef******b4f'], + 'namespace' => ['title' => '项目空间', 'type' => 'string', 'example' => 'default-namespace'], + 'creator' => ['title' => '创建者', 'type' => 'string', 'example' => '27846363877456****'], + 'creatorName' => ['title' => '创建者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'modifier' => ['title' => '修改者', 'type' => 'string', 'example' => '27846363877456****'], + 'modifierName' => ['title' => '修改者名称', 'type' => 'string', 'example' => '****@streamcompute.onaliyun.com'], + 'createdAt' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64'], + 'modifiedAt' => ['title' => '修改时间', 'type' => 'integer', 'format' => 'int64'], + 'sessionClusterId' => ['title' => 'session集群ID', 'type' => 'string', 'example' => '1f68a52c-1760-43c6-97fb-afe0674b****'], + 'name' => ['title' => 'session集群名称', 'type' => 'string', 'example' => 'test-sessionCluster'], + 'deploymentTargetName' => ['title' => '部署目标', 'type' => 'string', 'example' => 'default-queue'], + 'engineVersion' => ['title' => '引擎版本', 'type' => 'string', 'example' => 'vvr-6.0.7-flink-1.15'], + 'labels' => ['title' => '作业标签', 'type' => 'object'], + 'basicResourceSetting' => ['title' => '资源设置', '$ref' => '#/components/schemas/BasicResourceSetting'], + 'flinkConf' => ['title' => 'Flink配置', 'type' => 'object', 'example' => '{"taskmanager.numberOfTaskSlots":"1"}'], + 'logging' => ['title' => '日志配置', '$ref' => '#/components/schemas/Logging'], + 'status' => ['title' => 'session集群状态信息', '$ref' => '#/components/schemas/SessionClusterStatus'], + ], + ], + 'SessionClusterFailureInfo' => [ + 'title' => 'session集群失败信息', + 'description' => 'session集群失败信息', + 'type' => 'object', + 'properties' => [ + 'message' => ['title' => '失败信息', 'type' => 'string'], + 'reason' => ['title' => '失败原因', 'type' => 'string'], + 'failedAt' => ['title' => '失败时间', 'type' => 'integer', 'format' => 'int64'], + ], + ], + 'SessionClusterRunningInfo' => [ + 'title' => 'session集群运行信息', + 'description' => 'session集群运行信息', + 'type' => 'object', + 'properties' => [ + 'startedAt' => ['title' => '启动时间', 'type' => 'integer', 'format' => 'int64'], + 'lastUpdateTime' => ['title' => '更新时间', 'type' => 'integer', 'format' => 'int64'], + 'referenceDeploymentIds' => [ + 'title' => '运行在session集群上的部署作业id', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + ], + ], + 'SessionClusterStatus' => [ + 'title' => 'session集群状态信息', + 'description' => 'session集群状态信息', + 'type' => 'object', + 'properties' => [ + 'currentSessionClusterStatus' => [ + 'title' => 'session集群当前状态', + 'type' => 'string', + 'enum' => ['STOPPED', 'STARTING', 'RUNNING', 'UPDATING', 'STOPPING', 'FAILED'], ], + 'failure' => ['title' => 'session集群失败信息', '$ref' => '#/components/schemas/SessionClusterFailureInfo'], + 'running' => ['title' => 'session集群运行信息', '$ref' => '#/components/schemas/SessionClusterRunningInfo'], ], ], 'SqlArtifact' => [ 'title' => '', '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', - ], + 'sqlScript' => ['title' => '', 'description' => 'The script of the SQL deployment.'."\n", '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;', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The URL of the additional dependency file.'."\n", 'type' => 'string', 'example' => 'https://oss/bucket/addition.jar', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'additionalDependencies', + 'example' => '', ], ], - ], - 'SqlStatementExecuteResult' => [ - 'title' => 'A short description of struct', - 'description' => 'The returned result of the SQL statement.'."\n", 'visibility' => 'Public', + 'example' => '', + ], + 'SqlExecution' => [ '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' => [ + 'namespace' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'example' => 'default-namespace'], + 'workspace' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'edcef******b4f'], + 'sqlExecutionId' => ['description' => 'The SQL execution ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the SQL execution.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description of the SQL execution.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sessionClusterName' => ['description' => 'The name of the session cluster.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sqlFileId' => ['description' => 'The SQL file ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sqlScript' => ['description' => 'The SQL script content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'batchMode' => ['description' => 'Specifies whether to enable batch mode.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'state' => ['description' => 'The state of the SQL execution.', 'type' => 'string', 'title' => '', 'example' => ''], + 'message' => ['description' => 'The message returned for the SQL execution.', 'type' => 'string', 'title' => '', 'example' => ''], + 'statements' => [ + 'type' => 'array', + 'items' => ['description' => 'The SQL statement.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SqlStatement'], + 'description' => '', 'title' => '', - 'description' => 'The statement that was executed.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '“show create table order”', - 'backendName' => 'statement', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SqlExecutionFetchResult' => [ + 'type' => 'object', + 'properties' => [ + 'sqlExecution' => ['description' => 'The information about the SQL execution.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/SqlExecution'], + 'dqlResult' => ['description' => 'The result of the data query language (DQL) statement.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/DqlResult'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SqlFile' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the SQL file.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sqlFileId' => ['description' => 'The SQL file ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'parentId' => ['description' => 'The ID of the parent SQL file.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description of the SQL file.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sessionClusterName' => ['description' => 'The name of the session cluster.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sqlScript' => ['description' => 'The SQL script content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'batchMode' => ['description' => 'The batch mode.', 'type' => 'string', 'title' => '', 'example' => ''], + 'workspace' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'namespace' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SqlStatement' => [ + 'type' => 'object', + 'properties' => [ + 'index' => ['description' => 'The index of the SQL statement.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'], + 'sqlScript' => ['description' => 'The SQL script content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'type' => ['description' => 'The type of the SQL statement.', 'type' => 'string', 'title' => '', 'example' => ''], + 'statusState' => ['description' => 'The status of the SQL statement.', 'type' => 'string', 'title' => '', 'example' => ''], + 'message' => ['description' => 'The message returned for the SQL statement.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SqlStatementExecuteResult' => [ + 'title' => '', + 'description' => 'The returned result of the SQL statement.', + 'type' => 'object', + 'properties' => [ + 'executeSuccess' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'errorDetails' => ['description' => 'The error details returned.', '$ref' => '#/components/schemas/ErrorDetails', 'title' => '', 'example' => ''], + 'statement' => ['title' => '', 'description' => 'The statement that was executed.', 'type' => 'string', 'example' => '“show create table order”'], + ], + 'example' => '', ], 'SqlStatementValidationResult' => [ 'title' => '', - 'description' => 'The verification result of the SQL deployment.'."\n", - 'visibility' => 'Public', + 'description' => 'The verification result of the SQL deployment.', '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', - ], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'message' => ['title' => '', 'description' => 'The verification information.', 'type' => 'string', 'example' => '“”'], 'validationResult' => [ 'title' => '', - 'description' => 'The verification result.'."\n", - 'visibility' => 'Public', + 'description' => 'The verification result.', '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', + '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.', '$ref' => '#/components/schemas/ErrorDetails', 'example' => ''], ], + 'example' => '', ], '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', - ], + 'statement' => ['title' => '', 'description' => 'The code of the deployment.'."\n", 'type' => 'string', 'required' => true, 'example' => 'CREATE TEMPORARY TABLE datagen_source ('."\n" + .' name VARCHAR,'."\n" + .' score BIGINT'."\n" + .') WITH ('."\n" + .' \'connector\' = \'datagen\''."\n" + .');', 'visibility' => 'Public', 'backendName' => 'statement'], + 'flinkConfiguration' => ['title' => '', 'description' => 'The Realtime Compute for Apache Flink configuration.'."\n", 'type' => 'object', 'visibility' => 'Public', 'backendName' => 'flink_configuration', 'example' => ''], + 'batchMode' => ['title' => '', 'description' => 'Specifies whether the deployment is a batch deployment.'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'batch_mode'], + 'versionName' => ['title' => '', 'description' => 'The engine version.'."\n", 'type' => 'string', 'example' => 'vvr-8.0.6-flink-1.17', 'visibility' => 'Public', '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', - ], + 'items' => ['description' => 'The URL of the additional dependency file.'."\n", 'type' => 'string', 'example' => '"oss://xxx"', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], + 'visibility' => 'Public', 'backendName' => 'additional_dependencies', 'itemName' => 'dependency', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], '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', - ], + 'deploymentId' => ['title' => '', 'description' => 'The deployment ID.'."\n", 'type' => 'string', 'example' => '5a19a71b-1c42-4f34-94fd-86cf6078****', 'visibility' => 'Public', 'backendName' => 'deploymentId'], + 'resourceSettingSpec' => ['title' => '', 'description' => 'The resource configuration of the deployment.'."\n", '$ref' => '#/components/schemas/BriefResourceSetting', 'visibility' => 'Public', 'backendName' => 'resourceSettingSpec', 'example' => ''], + 'restoreStrategy' => ['title' => '', 'description' => 'The start offset of the job.'."\n", '$ref' => '#/components/schemas/DeploymentRestoreStrategy', 'visibility' => 'Public', 'backendName' => 'restoreStrategy', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], - 'StopJobRequestBody' => [ - 'title' => '', - 'description' => 'The request that is used to stop the job.', - 'visibility' => 'public', + 'StartSqlExecutionBody' => [ 'type' => 'object', 'properties' => [ - 'stopStrategy' => [ + 'sqlFileId' => ['description' => 'The SQL file ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'sqlScript' => ['description' => 'The SQL script content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description of the SQL execution.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StartSqlExecutionResult' => [ + 'type' => 'object', + 'properties' => [ + 'newlyCreated' => ['description' => 'Indicates whether the SQL execution is newly created.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'sqlExecutionId' => ['description' => 'The SQL execution ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'success' => ['description' => 'Indicates whether the SQL execution is successful.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'StopJobRequestBody' => [ + 'title' => '', + 'description' => 'The request that is used to stop the job.', + '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', + 'enum' => ['NONE', 'STOP_WITH_SAVEPOINT', 'STOP_WITH_DRAIN'], + 'visibility' => 'Public', 'backendName' => 'stopStrategy', - 'enum' => [ - 'NONE', - 'STOP_WITH_SAVEPOINT', - 'STOP_WITH_DRAIN', - ], ], ], + 'visibility' => 'Public', + 'example' => '', ], 'StreamingResourceSetting' => [ 'title' => '', 'description' => 'The resource parameters of the deployment that runs in streaming mode.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'resourceSettingMode' => [ @@ -3641,11619 +1939,9055 @@ ."\n" .'* EXPERT'."\n" .'* BASIC'."\n", - 'visibility' => 'public', 'type' => 'string', 'example' => 'EXPERT', + 'enum' => ['BASIC', 'EXPERT'], + 'visibility' => 'Public', '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', ], + 'expertResourceSetting' => ['title' => '', 'description' => 'The resource parameters in expert mode.'."\n", '$ref' => '#/components/schemas/ExpertResourceSetting', 'visibility' => 'Public', 'backendName' => 'expertResourceSetting', 'example' => ''], + 'basicResourceSetting' => ['title' => '', 'description' => 'The resource parameters in basic mode.'."\n", '$ref' => '#/components/schemas/BasicResourceSetting', 'visibility' => 'Public', 'backendName' => 'basicResourceSetting', 'example' => ''], ], + 'visibility' => 'Public', + 'example' => '', ], 'SubFolder' => [ - 'title' => 'A short description of struct', - 'description' => '', + 'title' => '', + 'description' => 'The job draft subfolder information.', + 'type' => 'object', + 'properties' => [ + 'folderId' => ['title' => '', 'description' => 'The folder ID.', 'type' => 'string', 'example' => 'a579aec9-1d5e-3382-9d65-9887ff6cfaff', 'visibility' => 'Public', 'backendName' => 'folderId'], + 'parentId' => ['title' => '', 'description' => 'The parent folder ID.', 'type' => 'string', 'example' => '95c0787c-408f-4e1f-88ba-ef0a84a2c2ee', 'visibility' => 'Public', 'backendName' => 'parentId'], + 'name' => ['title' => '', 'description' => 'The folder name.', 'type' => 'string', 'example' => 'test', 'visibility' => 'Public', 'backendName' => 'name'], + ], + 'example' => '', 'visibility' => 'Public', + ], + 'SubmitPreviewResult' => [ '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', + 'queryId' => ['title' => '查询id', 'type' => 'string'], + 'sessionId' => ['title' => 'session id', 'type' => 'string'], + 'tableSchemas' => [ + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/TableSchema'], ], ], ], 'Table' => [ - 'title' => 'A short description of struct', - 'description' => 'The information about the table.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The information about the table.', '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', - ], + 'name' => ['title' => '', 'description' => 'The name of the table.', 'type' => 'string', 'example' => 'order-test', 'required' => true], + 'schema' => ['title' => '', 'description' => 'The schema information about the table.', '$ref' => '#/components/schemas/Schema', 'example' => '', 'required' => false], + 'properties' => ['title' => '', 'description' => 'The parameter configurations of the table.', 'type' => 'object', 'example' => ''], + 'comment' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'example' => '测试订单表'], 'partitionKeys' => [ 'title' => '', - 'description' => 'The partition key column.'."\n", - 'visibility' => 'Public', + 'description' => 'The partition key column.', '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', + 'items' => ['description' => 'The partition field.', 'type' => 'string', 'example' => 'ad=xxxxx', 'title' => ''], + 'example' => '', ], + 'tableType' => ['title' => '', 'type' => 'string', 'required' => true, 'description' => '', 'example' => ''], 'metadata' => [ - 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'visibility' => 'Public', - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], 'TableColumn' => [ - 'title' => 'A short description of struct', - 'description' => 'The information about columns.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The information about columns.', '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', - ], + 'name' => ['title' => '', 'description' => 'The column name.', 'type' => 'string', 'example' => 'name', 'required' => true], + 'metadataInfo' => ['title' => '', 'description' => 'The metadata information.', '$ref' => '#/components/schemas/MetadataInfo', 'example' => ''], + 'expression' => ['title' => '', 'description' => 'The computed column.', 'type' => 'string', 'example' => '“”'], + 'type' => ['title' => '', 'description' => 'The data type of the column.', 'type' => 'string', 'example' => 'string'], + 'nullable' => ['title' => '', 'description' => 'Specifies whether the column can have a null value.', 'type' => 'boolean', 'example' => 'true'], + 'logicalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'TableMeta' => [ - 'title' => 'A short description of struct', - 'description' => '', + 'title' => '', + 'description' => 'The table metadata.', + 'type' => 'object', + 'properties' => [ + 'catalogName' => ['title' => '', 'description' => 'The catalog name.', 'type' => 'string', 'example' => 'paimon', 'visibility' => 'Public', 'backendName' => 'catalogName'], + 'databaseName' => ['title' => '', 'description' => 'The database name.', 'type' => 'string', 'example' => 'paimon-ods', 'visibility' => 'Public', 'backendName' => 'databaseName'], + 'tableName' => ['title' => '', 'description' => 'The table name.', 'type' => 'string', 'example' => 'order-table', 'visibility' => 'Public', 'backendName' => 'tableName'], + ], + 'example' => '', 'visibility' => 'Public', + ], + 'TableResult' => [ 'type' => 'object', 'properties' => [ - 'catalogName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'paimon', - 'backendName' => 'catalogName', - ], - 'databaseName' => [ - 'title' => '', + 'tableName' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => ''], + 'collectSinkOperatorId' => ['description' => 'The ID of the collect sink operator.', 'type' => 'string', 'title' => '', 'example' => ''], + 'rowUpdates' => [ + 'type' => 'array', + 'items' => ['description' => 'The row update.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/RowUpdate'], 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'paimon-ods', - 'backendName' => 'databaseName', - ], - 'tableName' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'order-table', - 'backendName' => 'tableName', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'TableSchema' => [ + 'type' => 'object', + 'properties' => [ + 'tableName' => ['description' => 'The name of the table.', 'type' => 'string', 'title' => '', 'example' => ''], + 'schema' => ['description' => 'The schema of the table.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Schema'], + 'collectSinkOperatorId' => ['description' => 'The ID of the collect sink operator.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'UdfArtifact' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'title' => '', 'example' => 'default-namespace'."\n"], + 'creator' => ['description' => 'The user that creates the JAR file.'."\n", 'type' => 'string', 'title' => '', 'example' => 'userA'], + 'createdAt' => ['description' => 'The time when the JAR file was created.'."\n", 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1723532876'], + 'modifiedAt' => ['description' => 'The time when the JAR file was modified.'."\n", 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1723537876'], + 'name' => ['description' => 'The name of the JAR file.'."\n", 'type' => 'string', 'title' => '', 'example' => 'udfCollection.jar'."\n"], + 'jarUrl' => ['title' => '', 'description' => 'The path in which the JAR file is stored.'."\n", 'type' => 'string', 'example' => 'oss://bucket/udfCollection.jar'."\n"], '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', + 'items' => ['description' => 'The paths in which the additional dependencies of the JAR file are stored.'."\n", 'type' => 'string', 'example' => 'oss://bucket/addition/add.jar'."\n", 'title' => ''], + 'example' => '', ], 'artifactType' => [ - 'title' => '', 'description' => 'The type of the JAR file.'."\n", - 'visibility' => 'Public', 'type' => 'string', + 'title' => '', 'example' => 'ARTIFACT_TYPE_JAVA', - 'backendName' => 'artifactType', - 'enum' => [ - 'ARTIFACT_TYPE_JAVA', - 'ARTIFACT_TYPE_PYTHON', - 'ARTIFACT_TYPE_UNKNOWN', - ], + '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', + 'items' => ['description' => 'The name of the UDF class.'."\n", '$ref' => '#/components/schemas/UdfClass', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'UdfClass' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'udfArtifactName' => ['description' => 'The name of the UDF JAR file.'."\n", 'type' => 'string', 'title' => '', 'example' => 'udfCollection.jar'], + 'className' => ['description' => 'The name of the class.'."\n", 'type' => 'string', 'title' => '', 'example' => 'myfunctionTest'], 'classType' => [ - 'title' => '', 'description' => 'The type of the class.'."\n", - 'visibility' => 'Public', 'type' => 'string', + 'title' => '', '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', - ], + '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', + 'items' => ['description' => 'The name of the UDF.'."\n", 'type' => 'string', 'example' => 'myfunction', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], 'UdfFunction' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The UDF function.', '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', - ], + 'functionName' => ['title' => '', 'description' => 'The function name.', 'type' => 'string', 'example' => 'myFunction', 'visibility' => 'Public', 'backendName' => 'functionName'], + 'udfArtifactName' => ['title' => '', 'description' => 'The UDF artifact name.', 'type' => 'string', 'example' => 'udfCollection.jar', 'visibility' => 'Public', 'backendName' => 'udfArtifactName'], + 'className' => ['title' => '', 'description' => 'The class name.', 'type' => 'string', 'example' => 'myFunctionTest', 'visibility' => 'Public', 'backendName' => 'className'], ], + 'example' => '', + 'visibility' => 'Public', ], 'UpdateJobConfigParam' => [ - 'title' => 'A short description of struct', - 'description' => '', + 'title' => '', + 'description' => 'The parameters for dynamically updating job runtime configurations.', + 'type' => 'object', + 'properties' => [ + 'newFlinkConf' => ['title' => '', 'description' => 'The job parameter configuration.', 'type' => 'object', 'example' => '{"table.exec.parallelism：4"}', 'visibility' => 'Public', 'backendName' => 'newFlinkConf'], + ], + 'example' => '', 'visibility' => 'Public', + ], + 'UpdateUdfArtifactResult' => [ + 'title' => 'A short description of struct', + 'description' => '更新UdfArtifact返回数据', 'type' => 'object', 'properties' => [ - 'newFlinkConf' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{"table.exec.parallelism：4"}', - 'backendName' => 'newFlinkConf', + 'updateSuccess' => ['title' => '更新是否成功', 'type' => 'boolean'], + 'udfArtifact' => ['title' => '更新的udfArtifact', '$ref' => '#/components/schemas/UdfArtifact'], + 'message' => ['title' => '更新信息', 'type' => 'string'], + 'collidingClasses' => [ + 'title' => '存在冲突的class', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UdfClass'], + ], + 'missingClasses' => [ + 'title' => '存在缺失的calss', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/UdfClass'], ], ], ], 'ValidateStatementResult' => [ - 'title' => 'A short description of struct', + 'title' => '', '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', - ], + 'validationResult' => ['description' => 'The verification result.'."\n", 'type' => 'string', 'title' => '', 'example' => '"there have some errors""'], + 'errorDetails' => ['description' => 'The details of verification errors of the SQL syntax.'."\n", '$ref' => '#/components/schemas/ValidationErrorDetails', 'title' => '', 'example' => ''], ], + 'example' => '', ], 'ValidationErrorDetails' => [ - 'title' => 'A short description of struct', - 'description' => 'The errors of the verification result of the SQL syntax.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The errors of the verification result of the SQL syntax.', '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' => [ + 'lineNumber' => ['title' => '', 'description' => 'The number the row at which the error starts.', 'type' => 'string', 'example' => '3'], + 'columnNumber' => ['title' => '', 'description' => 'The number of the column at which the error starts.', 'type' => 'string', 'example' => '10'], + 'endLineNumber' => ['title' => '', 'description' => 'The number of the row at which the error ends.', 'type' => 'string', 'example' => '4'], + 'endColumnNumber' => ['title' => '', 'description' => 'The number of the column at which the error ends.', 'type' => 'string', 'example' => '5'], + 'message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '“”'], + ], + 'example' => '', + ], + 'Variable' => [ + 'title' => '', + 'description' => 'This data structure defines a variable\'s configuration.', + 'type' => 'object', + 'properties' => [ + 'kind' => [ 'title' => '', - 'description' => 'The number of the row at which the error ends.'."\n", - 'visibility' => 'Public', + 'description' => 'The type of the variable. `Clear` indicates plaintext and `Encrypted` indicates ciphertext.', + 'enumValueTitles' => ['Plain' => 'Plain', 'Encrypted' => 'Encrypted', 'Clear' => 'Clear'], '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', + 'required' => true, + 'example' => 'Encrypted', + 'enum' => ['Plain'], ], + 'name' => ['title' => '', 'description' => 'The name of the variable.', 'type' => 'string', 'required' => true, 'example' => 'mysqlPassword', 'pattern' => '^[a-zA-Z0-9_-]{1,64}$'], + 'value' => ['title' => '', 'description' => 'The value of the variable.', 'type' => 'string', 'required' => true, 'example' => 'myPassword'], + 'description' => ['title' => '', 'description' => 'The description of the variable.', 'type' => 'string', 'example' => 'test'], ], + 'example' => '', ], 'WatermarkSpec' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The watermark information.', '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', - ], + 'column' => ['title' => '', 'description' => 'The column of the event time attribute.', 'type' => 'string', 'example' => 'time', 'visibility' => 'Public', 'backendName' => 'column'], + 'watermarkExpression' => ['title' => '', 'description' => 'The watermark expression.', 'type' => 'string', 'example' => 'INTERVAL \'5\' SECOND', 'visibility' => 'Public', 'backendName' => 'watermarkExpression'], + 'watermarkType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', + 'visibility' => 'Public', ], ], ], 'apis' => [ - 'CreateFolder' => [ - 'summary' => 'Creates a folder.', - 'path' => '/api/v2/namespaces/{namespace}/folder', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ApplyScheduledPlan' => [ + 'summary' => 'This operation applies a scheduled plan.', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}:apply', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '223021', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '235224', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', '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', - ], + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the scheduled plan.', 'type' => 'string', 'required' => true, 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is returned. Use the \\`success\\` parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the applied scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Application Scheduled Plan', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyScheduledPlan'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ApplyScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'CreateDeployment' => [ + 'summary' => 'Creates a deployment.', + 'path' => '/api/v2/namespaces/{namespace}/deployments', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '223054', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '146090', + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'f89a0c1ca8****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The data structure of the folder.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Folder', - ], + 'schema' => ['description' => 'The content of the deployment.', 'required' => true, '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the deployment that you created was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'title' => 'CreateDeployment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeployment'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateDeploymentDraft' => [ + 'summary' => 'Creates a draft for an SQL or data ingestion job.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '223067', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '223181', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c96306e2b****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', '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', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The data structure of the job draft.', 'required' => true, '$ref' => '#/components/schemas/DeploymentDraft', 'title' => '', 'example' => ''], ], ], '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", + 'description' => 'The response.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value other than 200 indicates that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If \\`success\\` is \\`false\\`, an error code is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If \\`success\\` is \\`false\\`, an error message is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the job draft.', '$ref' => '#/components/schemas/DeploymentDraft', 'title' => '', 'example' => ''], ], + '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', + '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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\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\\": \\"stt-fu1658tbk6mnkk2****\\",\\n \\"workspace\\": \\"a14bd5d90a****\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"holderId\\": \\"18389966****\\",\\n \\"holderName\\": \\"userA\\"\\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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n}","type":"json"}]', + 'title' => 'CreateDeploymentDraft', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeploymentDraft'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateDeploymentTarget' => [ + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '223029', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '235197', + 'abilityTreeNodes' => ['FEATUREscRC0N9T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bda1c4a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'folderId', + 'name' => 'deploymentTargetName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '89097', - ], + 'schema' => ['description' => 'The name of the deployment target.', 'type' => 'string', 'required' => true, 'example' => 'test-dt', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The data structure that represents the resources for the deployment target.', '$ref' => '#/components/schemas/ResourceSpec', 'required' => false, 'title' => '', 'example' => ''], ], ], '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", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The business status code. A value of 200 is always returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is returned only when the request fails. If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is returned only when the request fails. If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure that represents the created deployment target.', '$ref' => '#/components/schemas/DeploymentTarget', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Deployment Target', + 'summary' => 'Creates a deployment target.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeploymentTarget'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeploymentTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'CreateDeploymentTargetV2' => [ + 'summary' => 'Creates a deployment target.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/support-elastic', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeCode' => '235197', + 'abilityTreeNodes' => ['FEATUREscRC0N9T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentTargetName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the deployment target.', 'type' => 'string', 'required' => true, 'example' => 'test-dt', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/DraftValidateParams', - ], + 'schema' => ['description' => 'The resources for the deployment target.', '$ref' => '#/components/schemas/Resource', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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****', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'If success is false, this parameter is not empty and indicates the error code. If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'If success is false, this parameter is not empty and indicates the error message. If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The details of the deployment target.', '$ref' => '#/components/schemas/DeploymentTarget', '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 } } ] }', 'title' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Deployment Target (V2)', + 'description' => 'The previous API for creating deployment targets supported only fixed or elastic resources. This new API supports fixed resources, elastic resources, and mixed mode.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeploymentTargetV2', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'CreateFolder' => [ + 'summary' => 'Creates a folder.', + 'path' => '/api/v2/namespaces/{namespace}/folder', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '223021', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bda1c4a****', 'title' => ''], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace', 'title' => ''], ], [ - 'name' => 'ticketId', - 'in' => 'path', - 'schema' => [ - 'title' => '异步工单ID，可以通过提交异步操作获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The structure of data in the folder.', '$ref' => '#/components/schemas/Folder', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. If this parameter was not empty and the value of this parameter was not 200, the request failed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The structure of data in the folder.', '$ref' => '#/components/schemas/Folder', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateFolder', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFolder'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '223181', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177220', + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ca84d539167d4d'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'u-gs3rgla9-default'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => true, - '$ref' => '#/components/schemas/DeploymentDraft', - ], + 'schema' => ['description' => 'The mappings between the ID and permissions of the member.', '$ref' => '#/components/schemas/Member', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F989CA70-2925-5A94-92B7-20F5762B71C8'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was false, a null value was returned.'."\n" + ."\n" + .'- If the value of success was true, the authorization information was returned.', '$ref' => '#/components/schemas/Member', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateMember', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMember'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'CreateSavepoint' => [ + 'summary' => 'Creates a savepoint.', + 'path' => '/api/v2/namespaces/{namespace}/savepoints', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '223182', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '146960', + 'abilityTreeNodes' => ['FEATUREscUX40QK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'required' => true, - '$ref' => '#/components/schemas/DeploymentDraft', + 'title' => '', + 'description' => 'The parameters that are used to create a savepoint.', + 'type' => 'object', + 'properties' => [ + 'deploymentId' => ['description' => 'The deployment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], + 'description' => ['description' => 'The description of the savepoint.', 'type' => 'string', 'example' => 'Job snapshot description', 'title' => '', 'required' => false], + 'nativeFormat' => ['description' => 'Specifies whether to use the native format mode. Valid values:'."\n" + ."\n" + .'- true: The native format mode is used.'."\n" + ."\n" + .'- false: The native format mode is not used.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + 'required' => false, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the savepoint that was created was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/Savepoint', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'responseDemo' => '[{"errorExample":"","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\\": \\"作业快照1\\",\\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\\": \\"create savepoint failed\\",\\n \\"reason\\": \\"IO Exception\\",\\n \\"failedAt\\": 1655006835\\n }\\n },\\n \\"createdAt\\": 1659066711,\\n \\"modifiedAt\\": 1659069473\\n }\\n}","type":"json"}]', + 'title' => 'CreateSavepoint', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSavepoint'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateSavepoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'CreateScheduledPlan' => [ + 'summary' => 'Creates a scheduled plan.', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '223183', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '235220', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentDraftId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'This data structure represents the scheduled plan to be created.', '$ref' => '#/components/schemas/ScheduledPlan', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the business request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'httpCode' => ['title' => '', 'description' => 'The business status code. This is always 200. Use the success parameter to determine if the business request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'If success is false, this parameter is not empty and indicates the business error code. If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'If success is false, this parameter is not empty and indicates the business error message. If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'This data structure represents the created scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlan', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a scheduled plan', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateScheduledPlan'], + ], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', ], - 'GetDeploymentDraft' => [ - 'summary' => 'Obtains the details of an SQL draft.', - 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateSessionCluster' => [ + 'summary' => 'Creates a session cluster.', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '223184', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentDraftId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The data structure of the session cluster to create.', '$ref' => '#/components/schemas/SessionCluster', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the created session cluster.', '$ref' => '#/components/schemas/SessionCluster', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a session cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSessionCluster'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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"}]', + ], + 'CreateUdfArtifact' => [ + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '223185', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '230166', + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'u-gs3rgla9-default'], ], [ - 'name' => 'pageIndex', - 'in' => 'query', - 'schema' => [ - 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The resource file of the UDF.', 'required' => true, '$ref' => '#/components/schemas/UdfArtifact', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The result of creating an artifact configuration for the UDF.', '$ref' => '#/components/schemas/CreateUdfArtifactResult', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateUdfArtifact', + 'summary' => 'Parses all user-defined function (UDF) methods in your JAR or Python file and creates an artifact configuration for a UDF.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUdfArtifact'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateUdfArtifact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"default-namespace\\\\n\\",\\n \\"creator\\": \\"userA\\",\\n \\"createdAt\\": 1723532876,\\n \\"modifiedAt\\": 1723537876,\\n \\"name\\": \\"udfCollection.jar\\\\n\\",\\n \\"jarUrl\\": \\"oss://bucket/udfCollection.jar\\\\n\\",\\n \\"dependencyJarUris\\": [\\n \\"oss://bucket/addition/add.jar\\\\n\\"\\n ],\\n \\"artifactType\\": \\"ARTIFACT_TYPE_JAVA\\",\\n \\"udfClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ]\\n },\\n \\"collidingClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'CreateVariable' => [ + 'summary' => 'Creates a variable.', + 'path' => '/api/v2/namespaces/{namespace}/variables', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '223187', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '147069', + 'abilityTreeNodes' => ['FEATUREscGTCR1G'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bda1c4a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentDraftId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The parameter that is used to create the variable.', 'required' => true, '$ref' => '#/components/schemas/Variable', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the variable that you created was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/Variable', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'title' => 'CreateVariable', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVariable'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateVariable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"kind\\": \\"Encrypted\\",\\n \\"name\\": \\"mysqlPassword\\",\\n \\"value\\": \\"myPassword\\",\\n \\"description\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '223188', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeCode' => '230270', + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-flink-bigdata-default'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => true, - '$ref' => '#/components/schemas/DraftDeployParams', - ], + 'name' => 'connectorName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the custom connector.', 'type' => 'string', 'required' => true, 'example' => 'mysql-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ticketId' => [ - 'title' => '异步工单ID，可以使用该ID查询异步操作结果。 ', - 'description' => '', - 'type' => 'string', - 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****', - ], - ], + 'title' => '', + '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.', + 'type' => 'array', + 'items' => ['description' => 'The information about tables that are created by using a custom connector.', '$ref' => '#/components/schemas/TableMeta', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteCustomConnector', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomConnector'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:DeleteCustomConnector', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"paimon\\",\\n \\"databaseName\\": \\"paimon-ods\\",\\n \\"tableName\\": \\"order-table\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '223190', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '146802', + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '710d6a64d8****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'ticketId', + 'name' => 'deploymentId', 'in' => 'path', - 'schema' => [ - 'title' => '异步工单ID，可以通过提交异步操作获取。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', - ], + 'schema' => ['description' => 'The deployment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '5737ef81-d2f1-49cf-8752-30910809****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + '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 \\"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', + 'title' => 'DeleteDeployment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeployment'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteDeploymentDraft' => [ + 'summary' => 'Deletes a draft of an SQL or data ingestion job. The draft cannot be deleted if it has any published or running deployment.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '206207', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '223183', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', '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', - ], + 'name' => 'deploymentDraftId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the draft. Obtain this ID by calling the ListDeploymentDrafts operation.', 'type' => 'string', 'required' => true, 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'description' => 'If the operation is successful, the created job is returned.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value other than 200 indicates that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If \\`success\\` is \\`false\\`, an error code is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If \\`success\\` is \\`false\\`, an error message is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'example' => '""'], ], + 'example' => '', ], ], ], - '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', + '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' => 'Delete Job Draft', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeploymentDraft'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '230166', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '235201', + 'abilityTreeNodes' => ['FEATUREscR3E3VD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The resource file of the UDF.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/UdfArtifact', - ], + 'name' => 'deploymentTargetName', + 'in' => 'path', + 'schema' => ['description' => 'The deployment target name.', 'type' => 'string', 'required' => true, 'example' => 'test-dt', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The status code. The value is always 200. Use the success parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is returned when success is false. If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is returned when success is false. If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'This data structure represents the deleted deployment target.', '$ref' => '#/components/schemas/DeploymentTarget', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Deployment Target', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeploymentTarget'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteDeploymentTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '230195', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '223067', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'c96306e2b****', 'title' => ''], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace', 'title' => ''], ], [ - 'name' => 'udfArtifactName', + 'name' => 'folderId', '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', - ], + 'schema' => ['description' => 'The folder ID. You can call the GetFloder operation to obtain the folder ID.', 'type' => 'string', 'required' => true, 'example' => '13803', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + '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.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. If this parameter was not empty and the value of this parameter was not 200, the request failed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteFolder', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFolder'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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' => 'get', - 'abilityTreeCode' => '230252', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '146926', + 'abilityTreeNodes' => ['FEATUREscB9XR98'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '710d6a64d8c34d', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The namespace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + '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 {\\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', + 'title' => 'DeleteJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeleteMember' => [ + 'path' => '/gateway/v2/namespaces/{namespace}/members/{member}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '230197', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177280', + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '710d6a64d8c34d'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'udfArtifactName', + 'name' => 'member', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'check', - ], + 'schema' => ['description' => 'The member ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user:223769'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteMember', + 'summary' => 'Revokes the permissions from a member.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMember'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '230205', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + '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****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'u-gs3rgla9-default', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'functionName', + 'name' => 'savepointId', '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', - ], + 'schema' => ['description' => 'The ID of the savepoint that you want to delete.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '907a8f0e-4f6c-412b-8a5e-7d4a065b****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'DeleteSavepoint', + 'extraInfo' => '补充。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSavepoint'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteSavepoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], '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', + 'translator' => 'manual', ], - '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', - ], + 'DeleteScheduledPlan' => [ + 'summary' => 'Deletes a scheduled plan.', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '230203', - 'abilityTreeNodes' => [ - 'FEATUREscOYA64T', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '235222', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'className', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the class that corresponds to the UDF.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'orderRank', - ], + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the scheduled plan.', 'type' => 'string', 'required' => true, 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The business status code. This is always 200. Use the \\`success\\` parameter to check if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the deleted scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlan', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a scheduled plan', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteScheduledPlan'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '230268', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '237098', + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], + ], + [ + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the session cluster.', 'type' => 'string', 'required' => true, 'example' => 'test-session', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is returned. The \\`success\\` parameter indicates whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'This parameter is not empty and indicates the error code if \\`success\\` is \\`false\\`. This parameter is empty if \\`success\\` is \\`true\\`.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'This parameter is not empty and indicates the error message if \\`success\\` is \\`false\\`. This parameter is empty if \\`success\\` is \\`true\\`.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the deleted session cluster.', '$ref' => '#/components/schemas/SessionCluster', 'title' => '', 'example' => ''], ], + '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 {\\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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Session Cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSessionCluster'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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"}]', + ], + 'DeleteUdfArtifact' => [ + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/{udfArtifactName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '230266', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '230197', + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the project.', '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', - ], + 'name' => 'udfArtifactName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the user-defined function file.', 'type' => 'string', 'required' => true, 'example' => 'check', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', + 'title' => '', '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', - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is returned. Use the success parameter to check if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If success is false, an error code is returned.'."\n" + ."\n" + .'- If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If success is false, an error message is returned.'."\n" + ."\n" + .'- If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The result of deleting the user-defined function file.', '$ref' => '#/components/schemas/DeleteUdfArtifactResult', 'title' => '', 'example' => ''], ], + '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 {\\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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete User-Defined Function Resource', + 'summary' => 'Deletes a user-defined function (UDF) resource. You must delete all UDFs registered with the resource before you can delete the resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUdfArtifact'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteUdfArtifact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '230270', - 'abilityTreeNodes' => [ - 'FEATUREsc2PXREJ', - ], + 'abilityTreeCode' => '230205', + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-flink-bigdata-default', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'u-gs3rgla9-default'], ], [ - 'name' => 'connectorName', + 'name' => 'functionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the custom connector.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysql-test', - ], + 'schema' => ['description' => 'The name of the UDF that you want to delete.', 'type' => 'string', 'required' => true, 'example' => 'category', 'title' => ''], ], - ], + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource that corresponds to the UDF that you want to delete.', 'type' => 'string', 'required' => true, 'example' => 'test-udf', 'title' => ''], + ], + [ + 'name' => 'className', + 'in' => 'query', + 'schema' => ['description' => 'The name of the class that corresponds to the UDF.', 'type' => 'string', 'required' => true, 'example' => 'Category', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + '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 {\\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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteUdfFunction', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUdfFunction'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:DeleteUdfFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '230263', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '147071', + 'abilityTreeNodes' => ['FEATUREscGTCR1G'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'catalogName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'paimon', - ], - ], - [ - 'name' => 'databaseName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'paimon-ods', - ], + 'schema' => ['description' => 'The name of the variable that you want to delete.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'variableName'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], ], + '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 {\\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', + 'title' => 'DeleteVariable', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVariable'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteVariable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'DeployDeploymentDraftAsync' => [ + 'summary' => 'Deploys a draft of an SQL job.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/async-deploy', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '230264', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '223188', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'tableName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'item', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The job draft and deployment information.', 'required' => true, '$ref' => '#/components/schemas/DraftDeployParams', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The status code of the business operation. A value other than 200 indicates that the operation failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If success is false, an error code is returned.'."\n" + ."\n" + .'- If success is true, an empty value is returned.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If success is false, an error message is returned.'."\n" + ."\n" + .'- If success is true, an empty value is returned.', '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', + 'description' => 'The result of the asynchronous operation. This parameter is returned when the request is successful.', + 'type' => 'object', + 'properties' => [ + 'ticketId' => ['title' => '', 'description' => 'The ID of the asynchronous ticket. Use this ID to query the result of the asynchronous operation.', 'type' => 'string', 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Deploy a job draft', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployDeploymentDraftAsync'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:DeployDeploymentDraftAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'ExecuteSqlStatement' => [ + 'path' => '/api/v2/namespaces/{namespace}/sql-statement/execute', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '230262', - 'abilityTreeNodes' => [ - 'FEATUREsc53OKIK', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '230265', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '710d6a64d8c34d'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The namespace name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'catalogName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'paimon', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The SQL statements for metadata.', '$ref' => '#/components/schemas/SqlStatementWithContext', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response data.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code. The value is always 200. Use the \\`success\\` parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If \\`success\\` is \\`false\\`, an error code is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If \\`success\\` is \\`false\\`, an error message is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The result of the SQL statement execution for metadata.', '$ref' => '#/components/schemas/SqlStatementExecuteResult', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ExecuteSqlStatement', + 'summary' => 'Executes Data Definition Language (DDL) and Data Manipulation Language (DML) statements on metadata. Data Query Language (DQL) is not supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSqlStatement'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ExecuteSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"3\\",\\n \\"columnNumber\\": \\"2\\",\\n \\"endLineNumber\\": \\"5\\",\\n \\"endColumnNumber\\": \\"11\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"invalidflinkConf\\": [\\n \\"{\\\\\\"k:v\\\\\\"}\\"\\n ]\\n },\\n \\"statement\\": \\"“show create table order”\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'FlinkApiProxy' => [ + 'path' => '/flink-ui/v2/proxy', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '230265', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'abilityTreeCode' => '146918', + 'abilityTreeNodes' => ['FEATUREscO1AVSF'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '710d6a64d8c34d', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', - 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The SQL statement to query the metadata.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/SqlStatementWithContext', - ], + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'- jobs'."\n" + ."\n" + .'- sessionclusters', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'jobs'], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '5a27a3aa-c5b9-4dc1-8c86-be57d2d6****'], + ], + [ + 'name' => 'flinkApiPath', + 'in' => 'query', + 'schema' => ['description' => 'The path of the Flink UI.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '/jobs/:4df35f8e54554b23bf7dcd38a151****/config'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The return value of the Flink request.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the result of the proxy request was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', 'type' => 'string', 'title' => '', '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 } } ] }', ], ], ], - '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', + 'title' => 'FlinkApiProxy', + 'summary' => 'Provides a proxy for Realtime Compute for Apache Flink requests.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlinkApiProxy'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:FlinkApiProxy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'manual', + ], + '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' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '146960', - 'abilityTreeNodes' => [ - 'FEATUREscUX40QK', - ], + '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****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => ['description' => 'The deployment ID, which is the unique identifier of the deployment.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****'], ], [ '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, - ], + 'schema' => ['description' => 'The Flink configuration that is used to generate a resource plan.', '$ref' => '#/components/schemas/FlinkConf', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', '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', + 'description' => '- If the value of success was true, the asynchronous generation result was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', + 'type' => 'object', + 'properties' => [ + 'ticketId' => ['description' => 'The ID of the ticket for you to query the asynchronous generation result.', 'type' => 'string', 'title' => '', 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 1d716b22-6aad-4be2-85c2-50cfc757****\\n 5af678c0-7db0-4650-94c2-d2604f0a****\\n namespacetest\\n USER_REQUEST\\n true\\n true\\n https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285\\n \\n COMPLETED\\n \\n 1659066711\\n 1659069473\\n \\n","errorExample":""}]', - 'title' => 'CreateSavepoint', - ], - 'GetSavepoint' => [ - 'summary' => 'Queries details of a savepoint and checkpoint.', - 'path' => '/api/v2/namespaces/{namespace}/savepoints/{savepointId}', - 'methods' => [ - 'get', + 'title' => 'GenerateResourcePlanWithFlinkConfAsync', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateResourcePlanWithFlinkConfAsync'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GenerateResourcePlanWithFlinkConfAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'GetAppliedScheduledPlan' => [ + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans:getExecutedScheduledPlan', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '146997', - 'abilityTreeNodes' => [ - 'FEATUREscUX40QK', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '235226', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The namespace name.', '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****', - ], + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the deployed job.', 'type' => 'string', 'required' => true, 'example' => '5737ef81-d2f1-49cf-8752-30910809****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is returned if the request fails. If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is returned if the request fails. If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The scheduled plan for the application.', '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\n \\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 1d716b22-6aad-4be2-85c2-50cfc757****\\n 5af678c0-7db0-4650-94c2-d2604f0a****\\n namespacetest\\n USER_REQUEST\\n true\\n true\\n https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285\\n \\n COMPLETED\\n \\n 1659066711\\n 1659069473\\n \\n","errorExample":""}]', - 'title' => 'GetSavepoint', - ], - 'DeleteSavepoint' => [ - 'summary' => 'Deletes a savepoint.', - 'path' => '/api/v2/namespaces/{namespace}/savepoints/{savepointId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the scheduled plan of an application', + 'summary' => 'Retrieves the execution plan for an application.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppliedScheduledPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetAppliedScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'GetCatalogs' => [ + 'summary' => 'Retrieves the details of a specified catalog or all catalogs.', + 'path' => '/api/v2/namespaces/{namespace}/catalogs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '147041', - 'abilityTreeNodes' => [ - 'FEATUREscUX40QK', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '230262', + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', '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****', - ], + 'name' => 'catalogName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the catalog. If this parameter is left empty, all catalogs are listed.', 'type' => 'string', 'required' => false, 'example' => 'paimon', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response data.', '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' => '""', + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'True'], + 'httpCode' => ['description' => 'The business status code. This is always 200. Use the \\`success\\` parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If \\`success\\` is \\`false\\`, an error code is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If \\`success\\` is \\`false\\`, an error message is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => [ + 'title' => '', + 'description' => 'If \\`success\\` is \\`true\\`, a list of catalogs that meet the criteria is returned. If \\`success\\` is \\`false\\`, this parameter is empty.', + 'type' => 'array', + 'items' => ['description' => 'The details of the catalog.', '$ref' => '#/components/schemas/Catalog', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n","errorExample":""}]', - 'title' => 'DeleteSavepoint', - ], - 'ListSavepoints' => [ - 'summary' => 'Obtains a list of savepoints or checkpoints.', - 'path' => '/api/v2/namespaces/{namespace}/savepoints', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCatalogs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCatalogs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"paimon-test\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"extensionConf\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetDatabases' => [ + 'path' => '/api/v2/namespaces/{namespace}/catalogs/{catalogName}/databases', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '147013', - 'abilityTreeNodes' => [ - 'FEATUREscUX40QK', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '230263', + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', '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****', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', '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' => 'catalogName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the catalog.', 'type' => 'string', 'required' => true, 'example' => 'paimon', 'title' => ''], ], [ - 'name' => 'pageIndex', + 'name' => 'databaseName', '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', - ], + 'schema' => ['description' => 'The name of the database. If you do not specify this parameter, information about all databases in the catalog is returned.', 'type' => 'string', 'required' => false, 'example' => 'paimon-ods', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned.', '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', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. A value of 200 is always returned. To determine whether the request was successful, check the value of the \\`success\\` parameter.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If \\`success\\` is \\`false\\`, an error code is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If \\`success\\` is \\`false\\`, an error message is returned.'."\n" + ."\n" + .'- If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], '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", + 'title' => '', + 'description' => 'The list of databases. This parameter is returned only if the request is successful. If the request fails, this parameter is empty.', 'type' => 'array', - 'items' => [ - 'title' => 'savepoint数据。', - 'description' => 'The information about the savepoint.'."\n", - '$ref' => '#/components/schemas/Savepoint', - ], + 'items' => ['description' => 'The details of a database.', '$ref' => '#/components/schemas/Database', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n 100\\n 1\\n 500\\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 1d716b22-6aad-4be2-85c2-50cfc757****\\n 5af678c0-7db0-4650-94c2-d2604f0a****\\n namespacetest\\n USER_REQUEST\\n true\\n true\\n https://oss/bucket/flink/flink-jobs/namespaces/vvp-team/deployments/5a19a71b-1c42-4f34-94fd-86cf6078****/checkpoints/sp-3285\\n \\n COMPLETED\\n \\n 1659066711\\n 1659069473\\n \\n","errorExample":""}]', - 'title' => 'ListSavepoints', - ], - 'GetDeploymentsByName' => [ - 'summary' => '通过名称获取已部署作业', - 'path' => '/api/v2/namespaces/{namespace}/deployments/name/{deploymentName}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDatabases', + 'summary' => 'Retrieves information about one or more databases in a specified catalog.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabases'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"database-test\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"comment\\": \\"测试数据库。\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetDeployDeploymentDraftResult' => [ + 'summary' => 'Checks the deployment result of a job draft.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/tickets/{ticketId}/async-deploy', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '223190', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => '710d6a64d8****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentName', + 'name' => 'ticketId', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The ID of the asynchronous ticket. Obtain this ID by submitting an asynchronous operation.', 'type' => 'string', 'required' => true, 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '作业ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + 'description' => 'The response data.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value other than 200 indicates that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- The error code. This parameter is returned when the request fails.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- The error message. This parameter is returned when the request fails.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The deployment result of the job draft.', '$ref' => '#/components/schemas/AsyncDraftDeployResult', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Job Draft Deployment Result', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeployDeploymentDraftResult'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ignoreJobSummary', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'true', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetDeployDeploymentDraftResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + '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\\": \\"3\\",\\n \\"columnNumber\\": \\"10\\",\\n \\"endLineNumber\\": \\"4\\",\\n \\"endColumnNumber\\": \\"5\\",\\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"}]', + 'translator' => 'manual', + ], + 'GetDeployment' => [ + 'summary' => 'Obtains the details of a deployment.', + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ignoreResourceSetting', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146286', + 'abilityTreeNodes' => ['FEATUREscDX72HD'], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => ['description' => 'The deployment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the details of the deployment were returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], ], + '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 {\\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', + 'title' => 'GetDeployment', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeployment'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetDeploymentDraft' => [ + 'summary' => 'Retrieves the details of an SQL or data ingestion job draft.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeCode' => '223184', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'labelKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'key', - ], + 'name' => 'deploymentDraftId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the job draft. Call the ListDeploymentDrafts operation to obtain this ID.', 'type' => 'string', 'required' => true, 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", 'title' => ''], ], - [ - 'name' => 'labelValue', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'value', + 'description' => 'The response.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value other than 200 indicates that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- The error code returned if the request fails.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- The error message returned if the request fails.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The details of the job draft.', '$ref' => '#/components/schemas/DeploymentDraft', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain job draft details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeploymentDraft'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ignoreJobSummary', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'true', ], ], + ], + '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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\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\\": \\"stt-fu1658tbk6mnkk2****\\",\\n \\"workspace\\": \\"a14bd5d90a****\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"holderId\\": \\"18389966****\\",\\n \\"holderName\\": \\"userA\\"\\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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetDeploymentDraftLock' => [ + 'summary' => 'Before using an API to edit, validate, or deploy a job draft, you must acquire an edit lock to prevent conflicts between user interface (UI) and API operations. Acquiring this lock requires either the "Develop SQL/YAML Job (Create, Edit)" or "Unlock SQL/YAML Job Draft" permission.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/getLock', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ignoreResourceSetting', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '223187', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'header', + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentDraftId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the job draft. You can get this ID by calling the ListDeploymentDrafts operation.', 'type' => 'string', 'required' => true, 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response.', + 'title' => '', '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', - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value other than 200 indicates that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- An error code is returned if the request fails.'."\n" + ."\n" + .'- This parameter is empty if the request succeeds.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- An error message is returned if the request fails.'."\n" + ."\n" + .'- This parameter is empty if the request succeeds.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The details of the edit lock.', '$ref' => '#/components/schemas/Lock', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Edit Lock for Job Draft', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeploymentDraftLock'], + ], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentDraftLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"id\\": \\"stt-fu1658tbk6mnkk2****\\",\\n \\"workspace\\": \\"a14bd5d90a****\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"holderId\\": \\"18389966****\\",\\n \\"holderName\\": \\"userA\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], 'GetDeploymentsByIp' => [ - 'summary' => '通过Ip获取已部署作业', + 'summary' => 'Gets a list of deployed jobs and their information on a node by a specified IP address.', 'path' => '/api/v2/namespaces/{namespace}/deployments/getDeployments/byIp', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ 'name' => 'srcIp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.100', - ], + 'schema' => ['description' => 'The source IP address. This parameter is used to match the input source address of a job.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.100', 'title' => ''], ], [ 'name' => 'srcPort', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '54321', - ], + 'schema' => ['description' => 'The source port. Use this parameter with srcIp for an exact match of the connection.', 'type' => 'string', 'required' => false, 'example' => '54321', 'title' => ''], ], [ 'name' => 'dstIp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10.100.2.200', - ], + 'schema' => ['description' => 'The destination IP address. This parameter is used to match the destination sink address of a job.', 'type' => 'string', 'required' => false, 'example' => '10.100.2.200', 'title' => ''], ], [ 'name' => 'dstPort', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '9092', - ], + 'schema' => ['description' => 'The destination port. Use this parameter with dstIp.', 'type' => 'string', 'required' => false, 'example' => '9092', 'title' => ''], ], [ 'name' => 'ignoreJobSummary', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Specifies whether to exclude the job summary from the response. If you exclude the summary, only deployment information is returned. This improves performance.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'false', + 'title' => '', ], ], [ 'name' => 'ignoreResourceSetting', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Specifies whether to exclude resource configuration information. This reduces the size of the returned data.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'false', + 'title' => '', ], ], ], '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. A value of 200 indicates that the request was successful. Use the success parameter to determine whether the business request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => 'The error code. This parameter is returned only when success is false. If success is true, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message. This parameter is returned only when success is false. If success is true, this parameter is empty.', 'type' => 'string', 'title' => '', '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', - ], + 'items' => ['description' => 'This data structure describes a complete deployed job.', '$ref' => '#/components/schemas/Deployment', 'example' => '"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint"', 'title' => ''], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + '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 {\\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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetDeploymentsByIp', - ], - 'CreateDeployment' => [ - 'summary' => 'Creates a deployment.', - 'path' => '/api/v2/namespaces/{namespace}/deployments', - 'methods' => [ - 'post', + 'description' => 'Use this operation to query for associated Flink deployments based on the source or destination IP address and port of a network connection.', + 'requestParamsDescription' => '- You must specify at least one of srcIp or dstIp.'."\n" + ."\n" + .'- The port parameter is optional and can help narrow the search for a specific job. For a more precise search, use a combination of srcIp and srcPort.'."\n" + ."\n" + .'- Combined queries are supported. For example, if you specify only dstIp=10.100.2.200, all jobs that write to this IP address are returned. If you specify both srcIp and dstIp, the data link jobs between the two points are returned.'."\n" + ."\n" + .'- In a production environment, you can set ignoreJobSummary to true or ignoreResourceSetting to true to reduce response latency.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentsByIp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetDeploymentsByLabel' => [ + 'summary' => 'Queries a list of deployed jobs and their information by a specified label.', + 'path' => '/api/v2/namespaces/{namespace}/deployments/getDeployments/byLabel', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '146090', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], + ], + [ + 'name' => 'labelKey', + 'in' => 'query', + 'schema' => ['description' => 'The label key used for filtering.', 'type' => 'string', 'required' => true, 'example' => 'key', 'title' => ''], + ], + [ + 'name' => 'labelValue', + 'in' => 'query', + 'schema' => ['description' => 'The label value. You can specify multiple values separated by commas (,) to create an OR condition.', 'type' => 'string', 'required' => true, 'example' => 'value', 'title' => ''], + ], + [ + 'name' => 'ignoreJobSummary', + 'in' => 'query', 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', + 'description' => 'Specifies whether to exclude job summary information, such as jobName and status, from the response. If set to true, the response includes only the JobId. This improves performance.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'ignoreResourceSetting', + 'in' => 'query', 'schema' => [ - 'title' => 'Deployment内容。', - 'description' => 'The content of the deployment.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Deployment', + 'description' => 'Specifies whether to exclude resource configuration information, such as parallelism and the number of CUs, from the response. This reduces the size of the returned data.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', ], ], ], '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. A value of 200 is returned for a successful request. To determine whether an API call is successful, check the \\`success\\` parameter.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => 'The error code. This parameter is returned only if the request fails.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message. This parameter is returned only if the request fails.', 'type' => 'string', 'title' => '', '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', + 'type' => 'array', + 'items' => ['description' => 'The data structure of a complete deployment.', '$ref' => '#/components/schemas/Deployment', 'example' => '"[main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint [] - --------------------------------------------------------------------------------\\n2024-05-22 11:46:39,871 [main] INFO org.apache.flink.runtime.entrypoint.ClusterEntrypoint"', 'title' => ''], + 'description' => 'The details of the deployed jobs.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 00000000-0000-0000-0000-00000000****\\n default-namespace\\n deploymentName\\n vvr-6.0.0-flink-1.15\\n this is a deployment description\\n true\\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n JAR\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n \\n \\n PER_JOB\\n vvp-workload\\n \\n STREAMING\\n \\n","errorExample":""}]', - 'title' => 'CreateDeployment', - ], - 'UpdateDeployment' => [ - 'summary' => 'Updates information about a deployment.', - 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDeploymentsByLabel', + 'description' => 'Queries a list of deployed jobs and their details by a specified job label. The query performs an exact match on the `labelKey` and `labelValue`.', + 'requestParamsDescription' => '1. labelKey and labelValue form a key-value pair to filter deployments by the specified label.'."\n" + ."\n" + .'2. To reduce system load when processing large data volumes, you can enable ignoreJobSummary or ignoreResourceSetting.'."\n" + ."\n" + .'3. Currently, queries support only a single label key-value pair. Logical combinations of multiple labels (AND/OR) are not supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentsByLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetDeploymentsByName' => [ + 'summary' => 'Retrieves deployed job instances by name from a specified workspace and namespace.', + 'path' => '/api/v2/namespaces/{namespace}/deployments/name/{deploymentName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '146804', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentId', + 'name' => 'deploymentName', 'in' => 'path', - 'schema' => [ - 'title' => '作业ID。', - 'description' => 'The deployment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', - ], + 'schema' => ['description' => 'The name of the deployed job.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'ignoreJobSummary', + 'in' => 'query', 'schema' => [ - 'title' => '需要更新的作业内容。', - 'description' => 'The information about the deployment that you want to update.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Deployment', + 'description' => 'Specifies whether to exclude job summary information, such as jobName and status, from the response. Set this to true to return only the JobId and improve performance.', + 'enumValueTitles' => [], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', ], ], + [ + 'name' => 'ignoreResourceSetting', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to exclude resource configuration information, such as parallelism and the number of CUs, to reduce the response size.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. A value of 200 is returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => 'The error code. This is returned only when the request fails.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message. This is returned only when the request fails.', 'type' => 'string', 'title' => '', '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', + 'type' => 'array', + 'items' => ['description' => 'The details of the job instance.', '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 00000000-0000-0000-0000-00000000****\\n default-namespace\\n deploymentName\\n vvr-6.0.0-flink-1.15\\n this is a deployment description\\n true\\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n JAR\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n \\n \\n PER_JOB\\n vvp-workload\\n \\n STREAMING\\n \\n","errorExample":""}]', - 'title' => 'UpdateDeployment', - ], - 'GetDeployment' => [ - 'summary' => 'Obtains the details of a deployment.', - 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDeploymentsByName', + 'responseParamsDescription' => 'The deploymentName is a user-defined logical identifier and is not guaranteed to be unique. This operation returns a list of all deployments that match the specified name. The results are sorted by creation time in descending order. This lets you easily view the latest deployment or compare it with historical versions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentsByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetEvents' => [ + 'summary' => 'Retrieves runtime events.', + 'path' => '/api/v2/namespaces/{namespace}/events', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '146286', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235188', + 'abilityTreeNodes' => ['FEATUREscW7NIYA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number to retrieve. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1'], ], [ 'name' => 'deploymentId', - 'in' => 'path', - 'schema' => [ - 'title' => '作业ID。', - 'description' => 'The deployment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', - ], + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the deployed job. If you specify this parameter, the operation returns events only for this job.', 'type' => 'string', 'required' => false, 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], + ], + [ + 'name' => 'deploymentName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the business request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The business status code. This field always returns `200`. To confirm the request\'s success, check the `success` parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The business error code. Returned only when the request fails (that is, `success` is `false`).', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The business error message. Returned only when the request fails (that is, `success` is `false`).', 'type' => 'string', 'example' => '""'], + 'pageIndex' => ['title' => '', 'description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['title' => '', 'description' => 'The number of entries on this page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'totalSize' => ['title' => '', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], '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', + 'description' => 'A list of runtime events matching the filter criteria. Returned only when the request is successful (`success` is `true`).', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A runtime event for a deployed job.', '$ref' => '#/components/schemas/Event', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 00000000-0000-0000-0000-00000000****\\n default-namespace\\n deploymentName\\n vvr-6.0.0-flink-1.15\\n this is a deployment description\\n true\\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n SQLSCRIPT\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n \\n \\n PER_JOB\\n vvp-workload\\n \\n STREAMING\\n \\n","errorExample":""}]', - 'title' => 'GetDeployment', - ], - 'ListDeployments' => [ - 'summary' => 'Obtains information about all deployments.', - 'path' => '/api/v2/namespaces/{namespace}/deployments', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve management events', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEvents'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + '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 \\"namespace\\": \\"default-namespace\\",\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"eventName\\": \\"STATE_TRANSITION_IS_COMPLETED\\",\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-000000680003\\",\\n \\"jobId\\": \\"00000000-0000-0000-0000-000000005043\\",\\n \\"message\\": \\"\\",\\n \\"createdAt\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetFolder' => [ + 'path' => '/api/v2/namespaces/{namespace}/folder', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '146799', - 'abilityTreeNodes' => [ - 'FEATUREscB9XR98', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '223029', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bda1c4a****', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'Namespace name.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace', 'title' => ''], ], [ - 'name' => 'pageIndex', + 'name' => 'folderId', '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', - ], + 'schema' => ['description' => 'Folder ID. If empty, the root folder is returned.', 'type' => 'string', 'required' => false, 'example' => '89097', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'rootType', 'in' => 'query', 'schema' => [ - 'title' => 'deployment名称。', - 'description' => 'The name of the deployment.'."\n", + 'description' => 'The type of the root folder.', 'type' => 'string', - 'required' => false, - 'example' => 'vvp_ds_0522', + 'example' => 'DEVELOPMENT', + 'enum' => ['DEVELOPMENT', 'SQL_FILE'], + 'title' => '', ], ], - [ - 'name' => 'executionMode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ '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', + 'description' => 'If success is true, the created job is returned. If success is false, this value is empty.', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'Indicates task success or failure. If the parameter is not empty and not 200, it means failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If success is false, the business error code is returned.'."\n" + ."\n" + .'- If success is true, an empty value is returned.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If success is false, the business error message is returned.'."\n" + ."\n" + .'- If success is true, an empty value is returned.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'Folder data structure.', '$ref' => '#/components/schemas/Folder', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Folder Information', + 'summary' => 'Retrieves specific folder information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFolder'], + ], + ], + 'ramActions' => [ [ - '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', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'RUNNING', ], ], + ], + '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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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' => [ [ - '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*******', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '147081', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], + ], + 'parameters' => [ [ - 'name' => 'labelKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], + 'name' => 'workspace', + 'in' => 'header', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ - 'name' => 'labelValueArray', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag value. Separate multiple values with semicolon (;).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1,value2', - ], + 'name' => 'namespace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'sortName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'gmt_create', - 'gmt_modified', - ], - ], + 'name' => 'ticketId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the asynchronous ticket. You can submit an application for an asynchronous operation to obtain this ticket ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the asynchronous generation result was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/AsyncResourcePlanOperationResult', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n 10\\n 1\\n 1\\n \\n 00000000-0000-0000-0000-00000000****\\n default-namespace\\n deploymentName\\n vvr-6.0.0-flink-1.15\\n this is a deployment description\\n true\\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n JAR\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n \\n \\n PER_JOB\\n vvp-workload\\n \\n STREAMING\\n \\n","errorExample":""}]', - 'title' => 'ListDeployments', - ], - 'DeleteDeployment' => [ - 'summary' => 'Deletes a deployment based on the deployment ID.', - 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', - 'methods' => [ - 'delete', + 'title' => 'GetGenerateResourcePlanResult', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGenerateResourcePlanResult'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetGenerateResourcePlanResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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 \\"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\\": \\"\\\\\\"create resource plan failed\\\\\\"\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetHotUpdateJobResult' => [ + 'summary' => 'Retrieves the result of a hot update for a job.', + 'path' => '/api/v2/namespaces/{namespace}/jobs/hot-updates/{jobHotUpdateId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '146802', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '229982', + 'abilityTreeNodes' => ['FEATUREscU5EGD9'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentId', + 'name' => 'jobHotUpdateId', 'in' => 'path', - 'schema' => [ - 'title' => '作业ID。', - 'description' => 'The deployment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5737ef81-d2f1-49cf-8752-30910809****', - ], + 'schema' => ['description' => 'The dynamic update ID. This ID is returned after you call the HotUpdateJob operation.', 'type' => 'string', 'required' => true, 'example' => '123hashd****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'If the success parameter is true, the result is returned. If the success parameter is false, this parameter is empty.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. The success parameter indicates whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If the success parameter is false, an error code is returned.'."\n" + ."\n" + .'- If the success parameter is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If the success parameter is false, an error message is returned.'."\n" + ."\n" + .'- If the success parameter is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The result of the dynamic update.', '$ref' => '#/components/schemas/HotUpdateJobResult', 'title' => '', 'example' => ''], ], + '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n","errorExample":""}]', - 'title' => 'DeleteDeployment', - ], - 'GetEvents' => [ - 'summary' => 'Queries events.', - 'path' => '/api/v2/namespaces/{namespace}/events', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the Result of a Dynamic Job Update', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotUpdateJobResult'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetHotUpdateJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobHotUpdateId\\": \\"123hashd****\\",\\n \\"jobId\\": \\"5af678c0-7db0-4650-94c2-d2604f0a****\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n },\\n \\"hotUpdateParams\\": {\\n \\"rescaleJobParam\\": {\\n \\"jobParallelism\\": 10\\n },\\n \\"updateJobConfigParam\\": {\\n \\"newFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"status\\": \\"HOT_UPDATED\\",\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"failure\\": {\\n \\"reason\\": \\"“”\\",\\n \\"message\\": \\"“”\\",\\n \\"failureSeverity\\": \\"LOW\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetJob' => [ + 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235188', - 'abilityTreeNodes' => [ - 'FEATUREscW7NIYA', - ], + 'abilityTreeCode' => '146921', + 'abilityTreeNodes' => ['FEATUREscU5EGD9'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentId', - 'in' => 'query', - 'schema' => [ - 'title' => 'deployment名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', - ], + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['description' => 'The job instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'A fixed value of 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- An error code if `success` is `false`.'."\n" + ."\n" + .'- An empty string if `success` is `true`.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- An error message if `success` is `false`.'."\n" + ."\n" + .'- An empty string if `success` is `true`.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- The job instance information if `success` is `true`.'."\n" + ."\n" + .'- An empty object if `success` is `false`.', '$ref' => '#/components/schemas/Job', 'title' => '', 'example' => ''], + 'accessDeniedDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'title' => 'GetJob', + 'summary' => 'Retrieves detailed information about a job instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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 \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"failure\\": {\\n \\"message\\": \\"Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.\\",\\n \\"reason\\": \\"KubernetesDeploymentNotProgressing\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"healthScore\\": 0,\\n \\"riskLevel\\": \\"\\"\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"null\\",\\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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\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 \\"taskmanager.numberOfTaskSlots\\": \\"1\\",\\n \\"table.exec.state.ttl\\": \\"128000s\\"\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"1714058507\\",\\n \\"modifiedAt\\": \\"1714058800\\"\\n },\\n \\"accessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetJobDiagnosis' => [ + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}/jobs/{jobId}/job-diagnoses/lite', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '146921', - 'abilityTreeNodes' => [ - 'FEATUREscU5EGD9', - ], + 'abilityTreeCode' => '249132', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the deployed job.', 'type' => 'string', 'required' => true, 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', 'title' => ''], ], [ 'name' => 'jobId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', - ], + 'schema' => ['description' => 'The job instance ID.', 'type' => 'string', 'required' => true, 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code, which is always 200. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is not empty when success is false, indicating a business error code. This parameter is empty when success is true.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is not empty when success is false, indicating a business error message. This parameter is empty when success is true.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The diagnostics result.', '$ref' => '#/components/schemas/JobDiagnosis', 'example' => 'As shown in the response example.', 'title' => ''], + 'accessDeniedDetail' => ['description' => 'The details of the abnormal diagnostic items.', 'type' => 'string', 'example' => '“”', 'title' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n flinktest\\n namespacetest\\n BATCH\\n 1660190835\\n 1660277235\\n vvr-4.0.14-flink-1.13\\n \\n RUNNING\\n \\n 4\\n RUNNING\\n \\n \\n \\n 4096\\n 2\\n \\n preview\\n \\n \\n 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;\\n \\n SQLSCRIPT\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 10\\n \\n 4\\n \\n 2\\n 4Gi\\n \\n \\n 2\\n 4Gi\\n \\n \\n \\n \\n LATEST_STATE\\n true\\n 1660293803155\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n \\n \\n","errorExample":""}]', - 'title' => 'GetJob', - ], - 'ListJobs' => [ - 'summary' => 'Queries the information about all jobs in a deployment.', - 'path' => '/api/v2/namespaces/{namespace}/jobs', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve job diagnostics details', + 'summary' => 'Performs intelligent diagnostics on a job and retrieves information about abnormal diagnostic items.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobDiagnosis'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetJobDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"diagnoseId\\": \\"ba30cd99-37a5-4a20-8cd9-ed4b*****\\",\\n \\"diagnoseTime\\": 1740389560871,\\n \\"workspace\\": \\"a14bd5d90a****\\",\\n \\"namespace\\": \\"default-namespace-*****\\",\\n \\"riskLevel\\": \\"RISK_LEVEL_LOW\\",\\n \\"symptoms\\": {\\n \\"autopilot\\": {\\n \\"name\\": \\"启动速度分析\\",\\n \\"description\\": \\"JM资源配置过低导致作业启动慢\\",\\n \\"recommendation\\": \\"将 JOBManager 内存从 1Gi 改为 4Gi\\"\\n },\\n \\"startup\\": [\\n {\\n \\"name\\": \\"启动速度分析\\",\\n \\"description\\": \\"JM资源配置过低导致作业启动慢\\",\\n \\"recommendation\\": \\"将 JOBManager 内存从 1Gi 改为 4Gi\\"\\n }\\n ],\\n \\"runtime\\": [\\n {\\n \\"name\\": \\"启动速度分析\\",\\n \\"description\\": \\"JM资源配置过低导致作业启动慢\\",\\n \\"recommendation\\": \\"将 JOBManager 内存从 1Gi 改为 4Gi\\"\\n }\\n ],\\n \\"state\\": [],\\n \\"troubleshooting\\": [],\\n \\"others\\": []\\n },\\n \\"healthScore\\": 0\\n },\\n \\"accessDeniedDetail\\": \\"“”\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + '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', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '146903', - 'abilityTreeNodes' => [ - 'FEATUREscDX72HD', - 'FEATUREscU5EGD9', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '206199', + 'abilityTreeNodes' => ['FEATUREscIA7S9T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace', 'title' => ''], ], [ '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', - ], - ], + 'in' => 'path', + 'schema' => ['description' => 'The deployment ID.', 'type' => 'string', 'required' => true, 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['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.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['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.', 'type' => 'string', 'title' => '', '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.', '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"', 'title' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n \\"\\"\\n \\"\\"\\n 200\\n 1\\n 10\\n 1\\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n flinktest\\n namespacetest\\n BATCH\\n 1660190835\\n 1660277235\\n vvr-4.0.14-flink-1.13\\n \\n RUNNING\\n \\n 4\\n RUNNING\\n \\n \\n \\n 4096\\n 2\\n \\n preview\\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n JAR\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 10\\n \\n 4\\n \\n 2\\n 4Gi\\n \\n \\n 2\\n 4Gi\\n \\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListJobs', - ], - 'StartJobWithParams' => [ - 'summary' => 'Starts a job.', - 'path' => '/api/v2/namespaces/{namespace}/jobs:start', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetLatestJobStartLog', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLatestJobStartLog'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetLatestJobStartLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'GetLineageInfo' => [ + 'path' => '/meta/v2/lineage', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '196584', - 'abilityTreeNodes' => [ - 'FEATUREscFIKID5', - ], + 'abilityTreeCode' => '230001', + 'abilityTreeNodes' => ['FEATUREscDYS18E'], ], '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", - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '710d6a64d8****'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'title' => '作业实例启动参数。', - 'description' => 'The parameter that is used to start the job.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/JobStartParameters', - ], + 'schema' => ['description' => 'The parameters about the lineage information.', '$ref' => '#/components/schemas/GetLineageInfoParams', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据结构。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + '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.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The lineage information.', '$ref' => '#/components/schemas/LineageInfo', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetLineageInfo', + 'summary' => 'Obtains the lineage information of a deployment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLineageInfo'], + ], ], - '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', + 'ramActions' => [], + '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\\": \\"97383\\",\\n \\"catalogName\\": \\"paimon\\",\\n \\"databaseName\\": \\"paimon-ods\\",\\n \\"isTemporary\\": false,\\n \\"connector\\": \\"paimon\\",\\n \\"tables\\": [\\n {\\n \\"id\\": \\"434508\\",\\n \\"tableName\\": \\"order-test\\",\\n \\"with\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"columns\\": [\\n {\\n \\"id\\": \\"123ss3\\",\\n \\"columnName\\": \\"name\\",\\n \\"nullable\\": false,\\n \\"description\\": \\"订单用户名称\\",\\n \\"columnType\\": \\"string\\",\\n \\"columnNativeType\\": \\"string\\",\\n \\"createdAt\\": 1723537978,\\n \\"modifiedAt\\": 1723537978,\\n \\"creator\\": \\"userA\\",\\n \\"modifier\\": \\"userA\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"edges\\": {\\n \\"tableLineage\\": [\\n {\\n \\"source\\": \\"TableA\\",\\n \\"destination\\": \\"TableB\\",\\n \\"jobId\\": \\"664cc64d-5dea-4ad3-9ee4-8432a874****\\"\\n }\\n ],\\n \\"columnLineage\\": [\\n {\\n \\"source\\": \\"TableA\\",\\n \\"destination\\": \\"TableB\\",\\n \\"jobId\\": \\"664cc64d-5dea-4ad3-9ee4-8432a874****\\"\\n }\\n ]\\n },\\n \\"jobInfos\\": [\\n {\\n \\"id\\": \\"664cc64d-5dea-4ad3-9ee4-8432a874****\\\\n\\",\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'StopJob' => [ - 'summary' => 'Stops a job.', - 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}:stop', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMember' => [ + 'path' => '/gateway/v2/namespaces/{namespace}/members/{member}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '146949', - 'abilityTreeNodes' => [ - 'FEATUREscFIKID5', - ], + 'abilityTreeCode' => '177281', + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'jobId', + 'name' => 'member', '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', - ], + 'schema' => ['description' => 'The display name of the member.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user:223769'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was false, a null value was returned.'."\n" + ."\n" + .'- If the value of success was true, the authorization information was returned.', '$ref' => '#/components/schemas/Member', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n flinktest\\n namespacetest\\n BATCH\\n 1660190835\\n 1660277235\\n vvr-4.0.14-flink-1.13\\n \\n RUNNING\\n \\n 4\\n RUNNING\\n \\n \\n \\n 4096\\n 2\\n \\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n JAR\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 10\\n \\n 4\\n \\n 2\\n 4Gi\\n \\n \\n 2\\n 4Gi\\n \\n \\n \\n \\n LATEST_STATE\\n true\\n 1660293803155\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n \\n \\n","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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMember', + 'summary' => 'Queries the permissions of a member.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMember'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'GetSavepoint' => [ + 'path' => '/api/v2/namespaces/{namespace}/savepoints/{savepointId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '146926', - 'abilityTreeNodes' => [ - 'FEATUREscB9XR98', - ], + '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****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间ID。', - 'description' => 'The namespace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'jobId', + 'name' => 'savepointId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID。', - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', - ], + 'schema' => ['title' => '', 'description' => 'The savepoint ID.', 'type' => 'string', 'required' => true, 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the savepoint information was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/Savepoint', 'title' => '', 'example' => ''], ], + '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n","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', + 'title' => 'GetSavepoint', + 'summary' => 'Queries details of a savepoint and checkpoint.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSavepoint'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetSavepoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"作业快照1\\",\\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\\": \\"create savepoint failed\\",\\n \\"reason\\": \\"IO Exception\\",\\n \\"failedAt\\": 1655006835\\n }\\n },\\n \\"createdAt\\": 1659066711,\\n \\"modifiedAt\\": 1659069473\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetSessionCluster' => [ + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '229978', - 'abilityTreeNodes' => [ - 'FEATUREscU5EGD9', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '237093', + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'jobId', + 'name' => 'sessionClusterName', 'in' => 'path', - 'schema' => [ - 'description' => 'The job ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', - ], + 'schema' => ['description' => 'The session cluster name.', 'type' => 'string', 'required' => true, 'example' => 'test-session', 'title' => ''], ], ], '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", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. This parameter is always 200. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is returned when \\`success\\` is \\`false\\`. If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is returned when \\`success\\` is \\`false\\`. If \\`success\\` is \\`true\\`, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'This data structure represents the retrieved session cluster.', '$ref' => '#/components/schemas/SessionCluster', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve a session cluster', + 'summary' => 'Retrieves a session cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSessionCluster'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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"}]', + ], + 'GetTables' => [ + 'summary' => 'Retrieves the details of a specific table or all tables in a database within a specified catalog.', + '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' => 'none', - 'abilityTreeCode' => '229982', - 'abilityTreeNodes' => [ - 'FEATUREscU5EGD9', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '230264', + 'abilityTreeNodes' => ['FEATUREsc53OKIK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'u-gs3rgla9-default'], ], [ - 'name' => 'jobHotUpdateId', + 'name' => 'catalogName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123hashd****', - ], + 'schema' => ['description' => 'The name of the catalog.', 'type' => 'string', 'required' => true, 'example' => 'paimon', 'title' => ''], + ], + [ + 'name' => 'databaseName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => true, 'example' => 'paimon-ods', 'title' => ''], + ], + [ + 'name' => 'tableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table. If this parameter is left empty, information about all tables is returned.', 'type' => 'string', 'required' => false, 'example' => 'item', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '当success为true，返回创建的作业；当success为false，该值为空。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ECE641B2-AB0B-4174-9C3B-885881558637'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The business status code. This is always 200. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If success is false, an error code is returned.'."\n" + ."\n" + .'- If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If success is false, an error message is returned.'."\n" + ."\n" + .'- If success is true, this parameter is empty.', 'type' => 'string', 'example' => '""'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/HotUpdateJobResult', + 'description' => 'If success is true, a list of tables that meet the criteria and their details are returned. If success is false, this parameter is empty.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The table information.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain Table Information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTables'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"order-test\\",\\n \\"schema\\": {\\n \\"columns\\": [\\n {\\n \\"name\\": \\"name\\",\\n \\"metadataInfo\\": {\\n \\"key\\": \\"topic\\",\\n \\"virtual\\": false\\n },\\n \\"expression\\": \\"“”\\",\\n \\"type\\": \\"string\\",\\n \\"nullable\\": true,\\n \\"logicalType\\": \\"\\"\\n }\\n ],\\n \\"watermarkSpecs\\": [\\n {\\n \\"column\\": \\"time\\",\\n \\"watermarkExpression\\": \\"INTERVAL \'5\' SECOND\\",\\n \\"watermarkType\\": \\"\\"\\n }\\n ],\\n \\"primaryKey\\": [\\n {\\n \\"constraintName\\": \\"pk\\",\\n \\"columns\\": [\\n \\"id\\"\\n ],\\n \\"constraintType\\": \\"\\",\\n \\"enforced\\": false\\n }\\n ]\\n },\\n \\"properties\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"comment\\": \\"测试订单表\\",\\n \\"partitionKeys\\": [\\n \\"ad=xxxxx\\"\\n ],\\n \\"tableType\\": \\"\\",\\n \\"metadata\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '206199', - 'abilityTreeNodes' => [ - 'FEATUREscIA7S9T', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '230252', + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '710d6a64d8c34d'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The deployment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', - ], + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the JAR or Python file that corresponds to the UDF.', 'type' => 'string', 'required' => false, 'example' => 'test-udf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', '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"', + 'title' => '', + '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.', + 'type' => 'array', + 'items' => ['description' => 'The details of JAR or Python file.', '$ref' => '#/components/schemas/UdfArtifact', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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\\": \\"\\\\\\"[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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetUdfArtifacts', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUdfArtifacts'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetUdfArtifacts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"default-namespace\\\\n\\",\\n \\"creator\\": \\"userA\\",\\n \\"createdAt\\": 1723532876,\\n \\"modifiedAt\\": 1723537876,\\n \\"name\\": \\"udfCollection.jar\\\\n\\",\\n \\"jarUrl\\": \\"oss://bucket/udfCollection.jar\\\\n\\",\\n \\"dependencyJarUris\\": [\\n \\"oss://bucket/addition/add.jar\\\\n\\"\\n ],\\n \\"artifactType\\": \\"ARTIFACT_TYPE_JAVA\\",\\n \\"udfClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetValidateDeploymentDraftResult' => [ + 'summary' => 'Queries the depth validation result of a job draft by ticket ID.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/tickets/{ticketId}/async-validate', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '249132', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bda1c4a****'], ], [ '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****', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'jobId', + 'name' => 'ticketId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5af678c0-7db0-4650-94c2-d2604f0a****', - ], + 'schema' => ['description' => 'The ID of the asynchronous ticket. You can obtain this ID by submitting an asynchronous operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****'], ], ], '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' => '“”', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the business request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The business status code. This is always 200. The success parameter indicates whether the business request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => 'If success is false, this parameter is not empty and indicates the business error code. If success is true, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'If success is false, this parameter is not empty and indicates the business error message. If success is true, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The result object of the in-depth check for the job draft.', '$ref' => '#/components/schemas/AsyncDraftValidateResult', 'title' => '', 'example' => ''], ], + 'title' => '', + 'description' => 'The response data.', + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetValidateDeploymentDraftResult', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetValidateDeploymentDraftResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": false,\\n \\"message\\": \\"\\",\\n \\"draftValidationDetail\\": {\\n \\"draftMetaInfoErrorDetails\\": [\\n {\\n \\"message\\": \\"\\",\\n \\"reason\\": \\"\\"\\n }\\n ],\\n \\"sqlValidationResult\\": \\"\\",\\n \\"sqlErrorDetail\\": {\\n \\"lineNumber\\": \\"3\\",\\n \\"columnNumber\\": \\"10\\",\\n \\"endLineNumber\\": \\"4\\",\\n \\"endColumnNumber\\": \\"5\\",\\n \\"message\\": \\"“”\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '146938', - 'abilityTreeNodes' => [ - 'FEATUREscFIKID5', - ], + 'abilityTreeCode' => '229978', + 'abilityTreeNodes' => ['FEATUREscU5EGD9'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'name' => 'jobId', + 'in' => 'path', + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + '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.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The dynamic update result.', '$ref' => '#/components/schemas/HotUpdateJobResult', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ververica::2022-07-18::StartJobWithParams', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'HotUpdateJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HotUpdateJob'], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n 354dde66-a3ae-463e-967a-0b4107fd****\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n flinktest\\n namespacetest\\n BATCH\\n 1660190835\\n 1660277235\\n vvr-4.0.14-flink-1.13\\n \\n RUNNING\\n \\n 4\\n RUNNING\\n \\n \\n \\n 4096\\n 2\\n \\n \\n \\n https://oss//bucket//test.jar\\n org.apapche.flink.test\\n \\n JAR\\n \\n \\n oss\\n xml格式文本\\n \\n StdOutErrConsoleAppender\\n ERROR\\n \\n \\n true\\n 7\\n \\n \\n \\n 10\\n \\n 4\\n \\n 2\\n 4Gi\\n \\n \\n 2\\n 4Gi\\n \\n \\n \\n \\n LATEST_STATE\\n true\\n 1660293803155\\n 354dde66-a3ae-463e-967a-0b4107fd****\\n \\n \\n","errorExample":""}]', - 'title' => 'StartJob', - ], - 'CreateScheduledPlan' => [ - 'summary' => 'Creates a scheduled tuning plan.', - 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:HotUpdateJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"jobHotUpdateId\\": \\"123hashd****\\",\\n \\"jobId\\": \\"5af678c0-7db0-4650-94c2-d2604f0a****\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n },\\n \\"hotUpdateParams\\": {\\n \\"rescaleJobParam\\": {\\n \\"jobParallelism\\": 10\\n },\\n \\"updateJobConfigParam\\": {\\n \\"newFlinkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"status\\": \\"HOT_UPDATED\\",\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"failure\\": {\\n \\"reason\\": \\"“”\\",\\n \\"message\\": \\"“”\\",\\n \\"failureSeverity\\": \\"LOW\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '235220', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '230268', + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlan', + 'title' => '', + '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.', + 'type' => 'array', + 'items' => ['description' => 'The details of the custom connector.', '$ref' => '#/components/schemas/Connector', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListCustomConnectors', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomConnectors'], + ], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ListCustomConnectors', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"mysql-test\\",\\n \\"type\\": \\"mysql-test\\",\\n \\"source\\": false,\\n \\"sink\\": true,\\n \\"lookup\\": true,\\n \\"properties\\": [\\n {\\n \\"key\\": \\"username\\",\\n \\"defaultValue\\": \\"userA\\",\\n \\"description\\": \\"用户名\\",\\n \\"required\\": true,\\n \\"definesFormat\\": true,\\n \\"sensitive\\": false\\n }\\n ],\\n \\"supportedFormats\\": [\\n \\"Json\\"\\n ],\\n \\"dependencies\\": [\\n \\"oss://bucket/add.jar\\"\\n ],\\n \\"creator\\": \\"183899668*******\\",\\n \\"creatorName\\": \\"userA\\",\\n \\"modifier\\": \\"183899668*******\\",\\n \\"modifierName\\": \\"userA\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListDeploymentDrafts' => [ + 'summary' => 'Retrieves a list of SQL or data ingestion job drafts.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '235221', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '223185', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'scheduledPlanId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. The default value is 10. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ScheduledPlan', - ], + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. If this parameter is not empty and its value is not 200, the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If the request fails, the error code is returned.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If the request fails, the error message is returned.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'pageIndex' => ['title' => '', 'description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['title' => '', 'description' => 'The number of entries on the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'totalSize' => ['title' => '', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '69'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlan', + 'description' => 'A list of job drafts that match the query. This parameter is returned if the request is successful. If the request fails, this parameter is empty.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The details of the job draft.', '$ref' => '#/components/schemas/DeploymentDraft', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + '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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\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\\": \\"stt-fu1658tbk6mnkk2****\\",\\n \\"workspace\\": \\"a14bd5d90a****\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"holderId\\": \\"18389966****\\",\\n \\"holderName\\": \\"userA\\"\\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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'View job draft list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeploymentDrafts'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListDeploymentDrafts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '235222', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '146855', + 'abilityTreeNodes' => ['FEATUREscYYH6D4'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'scheduledPlanId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'example' => '10'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'pageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'totalSize' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlan', + 'title' => '', + 'description' => '- If the value of success was true, a list of clusters in which the deployment is deployed was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', + 'type' => 'array', + 'items' => ['description' => 'The information about the cluster in which the deployment is deployed', '$ref' => '#/components/schemas/DeploymentTarget', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'title' => 'ListDeploymentTargets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeploymentTargets'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListDeploymentTargets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'ListDeployments' => [ + 'summary' => 'Retrieve information about all deployed jobs.', + 'path' => '/api/v2/namespaces/{namespace}/deployments', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '235223', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'abilityTreeCode' => '146799', + 'abilityTreeNodes' => ['FEATUREscB9XR98'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The namespace name.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ 'name' => 'pageSize', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Pagination parameter. Number of elements on the requested page. Maximum value is 100, minimum value is 1, and default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Pagination parameter. Page index indicating the requested page number. Minimum value is 1. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Deployment name.', 'type' => 'string', 'required' => false, 'example' => 'vvp_ds_0522'], + ], + [ + 'name' => 'executionMode', + 'in' => 'query', 'schema' => [ - 'title' => '分页参数，所请求页码的元素数量，默认值为10，最大值100。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'Deployment execution mode.', + 'type' => 'string', + 'enum' => ['BATCH', 'STREAMING'], 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'example' => 'STREAMING', ], ], [ - 'name' => 'pageIndex', + 'name' => 'status', 'in' => 'query', 'schema' => [ - 'title' => '分页参数，页码索引，表示所请求页码，默认值为1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The status of the latest job for the deployment.', + 'enumValueTitles' => ['CANCELLED' => 'CANCELLED', 'FAILED' => 'FAILED', 'RUNNING' => 'RUNNING', 'TRANSITIONING' => 'TRANSITIONING', 'FINISHED' => 'FINISHED'], + 'type' => 'string', 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'example' => 'RUNNING', + 'title' => '', ], ], [ - 'name' => 'deploymentId', + 'name' => 'creator', + 'in' => 'query', + 'schema' => ['description' => 'Creator UID.', 'type' => 'string', 'required' => false, 'example' => '183899668*******', 'title' => ''], + ], + [ + 'name' => 'modifier', + 'in' => 'query', + 'schema' => ['description' => 'Modifier UID.', 'type' => 'string', 'required' => false, 'example' => '183899668*******', 'title' => ''], + ], + [ + 'name' => 'labelKey', + 'in' => 'query', + 'schema' => ['description' => 'Label name.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + ], + [ + 'name' => 'labelValueArray', + 'in' => 'query', + 'schema' => ['description' => 'Tag values. Multiple values are separated by semicolons.', 'type' => 'string', 'required' => false, 'example' => 'value1,value2', 'title' => ''], + ], + [ + 'name' => 'sortName', 'in' => 'query', 'schema' => [ - 'title' => 'deployment名称。', - 'description' => '', + 'description' => 'Sorting method. Supports returning data in descending order by creation time or updated time.', 'type' => 'string', + 'enum' => ['gmt_create', 'gmt_modified'], 'required' => false, - 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****', + 'example' => 'gmt_create', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'Response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the business request succeeded.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'Static field with a fixed value of 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- When success is false, returns a business error code;'."\n" + ."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- When success is false, returns a business error message;'."\n" + ."\n" + .'- When success is true, returns an empty value.', 'type' => 'string', 'example' => '""'], + 'pageIndex' => ['title' => '', 'description' => 'Pagination parameter: page index, indicating the requested page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['title' => '', 'description' => 'Pagination parameter: the number of elements on the requested page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'totalSize' => ['title' => '', 'description' => 'The total number of elements that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'data' => [ - 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', - 'description' => '', + 'description' => '- When success is true, returns a list of jobs that meet the query conditions;'."\n" + ."\n" + .'- When success is false, returns an empty value.', + 'title' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlan', - ], + 'items' => ['title' => '', 'description' => 'Job data.', '$ref' => '#/components/schemas/Deployment', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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', + 'title' => 'Retrieve the list of deployed jobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeployments'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListDeployments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + '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\\": 1,\\n \\"data\\": [\\n {\\n \\"deploymentId\\": \\"00000000-0000-0000-0000-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n ]\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'translator' => 'manual', + ], + 'ListEngineVersionMetadata' => [ + 'path' => '/api/v2/engine-version-meta.json', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '235224', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '146861', + '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' => 'scheduledPlanId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the engine versions that are supported by Realtime Compute for Apache Flink were returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/EngineVersionMetadataIndex', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'title' => 'ListEngineVersionMetadata', + 'summary' => 'Obtains a list of engine versions that are supported by Realtime Compute for Apache Flink.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEngineVersionMetadata'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListEngineVersionMetadata', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListJobs' => [ + 'summary' => 'Retrieves information about all job instances for a specified deployment.', + 'path' => '/api/v2/namespaces/{namespace}/jobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '235225', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146903', + 'abilityTreeNodes' => ['FEATUREscDX72HD', 'FEATUREscU5EGD9'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100. Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the deployment.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], + ], + [ + 'name' => 'sortName', + 'in' => 'query', 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', + 'description' => 'The field to sort the results by.', 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', + 'enum' => ['gmt_create', 'job_id', 'status'], + 'required' => false, + 'example' => 'gmt_create', + 'title' => '', ], ], [ - 'name' => 'scheduledPlanId', - 'in' => 'path', + 'name' => 'sortOrder', + 'in' => 'query', 'schema' => [ - 'description' => '', 'type' => 'string', - 'required' => true, - 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', + 'enum' => ['asc', 'desc'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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' => '""', - ], + 'requestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'A fixed value of 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- The error code for a failed request (when `success` is `false`).'."\n" + ."\n" + .'- An empty string if the request is successful (when `success` is `true`).', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- The error message for a failed request (when `success` is `false`).'."\n" + ."\n" + .'- An empty string if the request is successful (when `success` is `true`).', 'type' => 'string', 'title' => '', 'example' => '""'], + 'pageIndex' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'totalSize' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', + 'title' => '', + 'description' => '- An array of job instances for a successful request (when `success` is `true`).'."\n" + ."\n" + .'- An empty array for a failed request (when `success` is `false`).', + 'type' => 'array', + 'items' => ['description' => 'The details of a job instance.', '$ref' => '#/components/schemas/Job', 'title' => '', 'example' => ''], + 'example' => '', ], + 'accessDeniedDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'title' => 'ListJobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": 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 \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"failure\\": {\\n \\"message\\": \\"Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.\\",\\n \\"reason\\": \\"KubernetesDeploymentNotProgressing\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"healthScore\\": 0,\\n \\"riskLevel\\": \\"\\"\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"null\\",\\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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\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 \\"taskmanager.numberOfTaskSlots\\": \\"1\\",\\n \\"table.exec.state.ttl\\": \\"128000s\\"\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"1714058507\\",\\n \\"modifiedAt\\": \\"1714058800\\"\\n }\\n ],\\n \\"accessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '235226', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177185', + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentId', + 'name' => 'pageIndex', 'in' => 'query', - 'schema' => [ - 'title' => 'deployment名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5737ef81-d2f1-49cf-8752-30910809****', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'pageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'totalSize' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '50'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', + 'title' => '', + 'description' => '- If the value of success was false, a null value was returned.'."\n" + ."\n" + .'- If the value of success was true, the authorization information was returned.', + 'type' => 'array', + 'items' => ['description' => 'The information about the member.', '$ref' => '#/components/schemas/Member', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMembers', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMembers'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'ListSavepoints' => [ + 'path' => '/api/v2/namespaces/{namespace}/savepoints', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235227', - 'abilityTreeNodes' => [ - 'FEATUREsc6GKYF1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '147013', + 'abilityTreeNodes' => ['FEATUREscUX40QK'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ 'name' => 'deploymentId', 'in' => 'query', - 'schema' => [ - 'title' => 'deployment名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****', - ], + 'schema' => ['description' => 'The deployment ID. This parameter is optional.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****'], ], [ - 'name' => 'origin', + 'name' => 'jobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SCHEDULED_PLAN', - 'default' => 'SCHEDULED_PLAN', - 'enum' => [ - 'SCHEDULED_PLAN', - ], - ], + 'schema' => ['description' => 'The job ID. This parameter is optional.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '99a8fc49-e090-430a-85d8-3ee8c79c****'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'pageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'totalSize' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'data' => [ - 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', - 'description' => '', + 'title' => '', + 'description' => '- If the value of success was true, a list of savepoints was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/ScheduledPlanExecutedInfo', - ], + 'items' => ['description' => 'The information about the savepoint.', '$ref' => '#/components/schemas/Savepoint', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'title' => 'ListSavepoints', + 'summary' => 'Obtains a list of savepoints or checkpoints.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSavepoints'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListSavepoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"作业快照1\\",\\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\\": \\"create savepoint failed\\",\\n \\"reason\\": \\"IO Exception\\",\\n \\"failedAt\\": 1655006835\\n }\\n },\\n \\"createdAt\\": 1659066711,\\n \\"modifiedAt\\": 1659069473\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListScheduledPlan' => [ + 'summary' => 'Lists scheduled plans.', + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', + 'abilityTreeCode' => '235223', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/SessionCluster', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. The default value is 10. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1'], + ], + [ + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the job.', 'type' => 'string', 'required' => false, 'example' => '737d0921-c5ac-47fc-9ba9-07a1e0b4****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. The value is always 200. Use the \\`success\\` parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'pageIndex' => ['title' => '', 'description' => 'A paging parameter that specifies the page index to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['title' => '', 'description' => 'The number of entries on the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'totalSize' => ['title' => '', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/SessionCluster', + 'description' => 'The list of scheduled plans that meet the filter criteria. This parameter is returned only if the request is successful. If the request fails, this parameter is empty.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlan', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve the list of scheduled plans', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduledPlan'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListScheduledPlanExecutedHistory' => [ + 'summary' => 'Retrieves 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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '237096', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235227', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '710d6a64d8c34d', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bda1c4a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'sessionClusterName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-session', - ], + 'name' => 'deploymentId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the deployed job.', 'type' => 'string', 'required' => true, 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'origin', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The execution source.', + 'type' => 'string', 'required' => false, - '$ref' => '#/components/schemas/SessionCluster', + 'default' => 'SCHEDULED_PLAN', + 'enum' => ['SCHEDULED_PLAN'], + 'example' => 'SCHEDULED_PLAN', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. The value is always 200. Use the \\`success\\` parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => '""'], + 'pageIndex' => ['title' => '', 'description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['title' => '', 'description' => 'The number of entries on the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'totalSize' => ['title' => '', 'description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/SessionCluster', + 'description' => 'The list of jobs that meet the filter criteria. This parameter is returned only when the request is successful.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The execution information of the scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlanExecutedInfo', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve Scheduled Job Execution History', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduledPlanExecutedHistory'], + ], ], - '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', + 'ramActions' => [], + 'translator' => 'manual', + '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"}]', ], - 'DeleteSessionCluster' => [ - 'summary' => 'Deletes a session cluster.', - 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListSessionClusters' => [ + 'summary' => 'This operation lists session clusters.', + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '237098', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '237091', + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The data returned in the response.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the \\`success\\` parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/SessionCluster', + 'description' => 'The list of session clusters. This parameter is empty if the request fails.', + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'The details of a session cluster.', '$ref' => '#/components/schemas/SessionCluster', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve Session Cluster List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSessionClusters'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListSessionClusters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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"}]', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '237093', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '147070', + 'abilityTreeNodes' => ['FEATUREscGTCR1G'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bda1c4a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'sessionClusterName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-session', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'pageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'pageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'totalSize' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'data' => [ - 'description' => '', - '$ref' => '#/components/schemas/SessionCluster', + 'title' => '', + 'description' => '- If the value of success was true, a list of variables was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', + 'type' => 'array', + 'items' => ['description' => 'The value of the variable.', '$ref' => '#/components/schemas/Variable', 'title' => '', 'example' => ''], + 'example' => '', ], ], + '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 \\"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', + 'title' => 'ListVariables', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVariables'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListVariables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"Encrypted\\",\\n \\"name\\": \\"mysqlPassword\\",\\n \\"value\\": \\"myPassword\\",\\n \\"description\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '237091', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '230266', + 'abilityTreeNodes' => ['FEATUREsc2PXREJ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], 'data' => [ - 'title' => '当success为true，返回满足条件的作业列表；当success为false，该值为空。', - 'description' => '', + 'title' => '', + '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.', 'type' => 'array', - 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/SessionCluster', - ], + 'items' => ['description' => 'The information about the custom connector.', '$ref' => '#/components/schemas/Connector', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RegisterCustomConnector', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterCustomConnector'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:RegisterCustomConnector', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"mysql-test\\",\\n \\"type\\": \\"mysql-test\\",\\n \\"source\\": false,\\n \\"sink\\": true,\\n \\"lookup\\": true,\\n \\"properties\\": [\\n {\\n \\"key\\": \\"username\\",\\n \\"defaultValue\\": \\"userA\\",\\n \\"description\\": \\"用户名\\",\\n \\"required\\": true,\\n \\"definesFormat\\": true,\\n \\"sensitive\\": false\\n }\\n ],\\n \\"supportedFormats\\": [\\n \\"Json\\"\\n ],\\n \\"dependencies\\": [\\n \\"oss://bucket/add.jar\\"\\n ],\\n \\"creator\\": \\"183899668*******\\",\\n \\"creatorName\\": \\"userA\\",\\n \\"modifier\\": \\"183899668*******\\",\\n \\"modifierName\\": \\"userA\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'RegisterUdfFunction' => [ + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/function:registerUdfFunction', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '237099', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'abilityTreeCode' => '230203', + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'sessionClusterName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-session', - ], + '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.', 'type' => 'string', 'required' => true, 'example' => 'orderRank', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => '响应数据。', - 'description' => '', - 'type' => 'object', + [ + 'name' => 'udfArtifactName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the JAR or Python file that corresponds to the UDF.', 'type' => 'string', 'required' => true, 'example' => 'test-udf', 'title' => ''], + ], + [ + 'name' => 'className', + 'in' => 'query', + 'schema' => ['description' => 'The name of the class that corresponds to the UDF.', 'type' => 'string', 'required' => true, 'example' => 'orderRank', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The information about the UDF.', '$ref' => '#/components/schemas/UdfFunction', 'title' => '', 'example' => ''], ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '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.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterUdfFunction'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:RegisterUdfFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"functionName\\": \\"myFunction\\",\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myFunctionTest\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'StartJob' => [ + 'path' => '/api/v2/namespaces/{namespace}/jobs', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'deprecated' => false, + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '237100', - 'abilityTreeNodes' => [ - 'FEATUREscBWKRDZ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '146938', + 'abilityTreeNodes' => ['FEATUREscFIKID5'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bd5d90a****', 'title' => ''], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'Project name.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace', 'title' => ''], ], [ - 'name' => 'sessionClusterName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-session', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'Launch instance parameters.\\`LaunchInstance\\` is the API operation for creating one or more ECS instances.\\`LaunchInstance\\` is the API for creating one or more ECS instances.\\`LaunchInstance\\` is the API for creating one or more ECS instances.| Parameter | Type | Required | Example | Description |'."\n" + .'\\| --- | --- | --- | --- | --- |'."\n" + .'\\| \\`RegionId\\` | String | Yes | \\`cn-hangzhou\\` | The ID of the region where the instance resides. Call the \\[DescribeRegions]\\(\\~\\~25609\\~\\~) operation to view the latest list of Alibaba Cloud regions. |'."\n" + .'\\| \\`InstanceType\\` | String | Yes | \\`ecs.g5.large\\` | The instance type. For more information, see \\[Instance families]\\(\\~\\~25378\\~\\~) or call the \\[DescribeInstanceTypes]\\(\\~\\~25620\\~\\~) operation to query the latest instance type list. |'."\n" + .'\\| \\`ImageId\\` | String | Yes | \\`centos\\_7\\_04\\_64\\_20G\\_alibase\\_201701015.vhd\\` | The ID of the image to use for creating the instance. Call the \\[DescribeImages]\\(\\~\\~25619\\~\\~) operation to query available image resources. |'."\n" + .'\\| \\`SecurityGroupId\\` | String | Yes | \\`sg-bp15ed6xe1yxeycg7\\*\\*\\*\\` | The ID of the security group for the new instance. Instances within the same security group can communicate with each other over the internal network. |'."\n" + .'\\| \\`InstanceName\\` | String | No | \\`testInstanceName\\` | The display name of the instance. The name must be 2 to 128 characters long and start with a letter or a Chinese character. It can contain digits, underscores (\\`\\_\\`), hyphens (\\`-\\`), and periods (\\`.\\`). |'."\n" + .'\\| \\`Description\\` | String | No | \\`testDescription\\` | The description of the instance. The description must be 2 to 256 characters long. |'."\n" + .'\\| \\`InternetMaxBandwidthOut\\` | Integer | No | 100 | The maximum outbound public bandwidth, in Mbit/s. Valid values:If the billing method is pay-by-bandwidth (\\`PayByBandwidth\\`): 0 to 100. The default value is 0.If the billing method is pay-by-traffic (\\`PayByTraffic\\`): 0 to 100. The default value is 0. |'."\n" + .'\\| \\`HostName\\` | String | No | \\`testHostName\\` | The hostname of the instance.Periods (\\`.\\`) and hyphens (\\`-\\`) cannot be used at the beginning or end of the hostname. They also cannot be used consecutively.For Windows instances: The hostname must be 2 to 15 characters long. It can contain letters, digits, and hyphens (\\`-\\`). It cannot contain periods (\\`.\\`) or consist entirely of digits.For other instance types (such as Linux): The hostname must be 2 to 64 characters long. It can contain periods (\\`.\\`) and hyphens (\\`-\\`). Use periods to separate the hostname into segments. Each segment can contain letters, digits, and hyphens (\\`-\\`). |'."\n" + .'\\| \\`Password\\` | String | No | \\`Ecs\\@123\\` | The login password for the instance. The password must be 8 to 30 characters long and contain characters from at least three of the following categories: uppercase letters, lowercase letters, digits, and special characters. Allowed special characters are:\\`( ) \\` \\~ ! @ # $ % ^ & \\* - \\_ + = | { } \\[ ] : ; \' < > , . ? /\\`For Windows instances, the password cannot start with a forward slash (\\`/\\`). |'."\n" + .'\\| \\`ZoneId\\` | String | No | \\`cn-hangzhou-b\\` | The ID of the zone for the instance. For more information, see the \\[DescribeZones]\\(\\~\\~25610\\~\\~) operation. |'."\n" + .'\\| \\`IoOptimized\\` | String | No | \\`optimized\\` | Specifies whether the instance is I/O optimized. Only I/O optimized instances can use SSD cloud disks.\\`none\\`: Not I/O optimized.\\`optimized\\`: I/O optimized.For more information, see \\[I/O optimization]\\(\\~\\~57943\\~\\~). |'."\n" + .'\\| \\`SystemDisk.Category\\` | String | No | \\`cloud\\_ssd\\` | The category of the system disk. Valid values:\\`cloud\\_efficiency\\`: Ultra Disk.\\`cloud\\_ssd\\`: Standard SSD.\\`cloud\\_essd\\`: Enhanced SSD (ESSD).\\`cloud\\`: Basic Disk.The default value is \\`cloud\\_efficiency\\` for I/O optimized instances and \\`cloud\\` for non-I/O optimized instances. |'."\n" + .'\\| \\`SystemDisk.Size\\` | Integer | No | 40 | The size of the system disk, in GiB. Valid values: 20 to 500.The value must be greater than or equal to \\`max(20, ImageSize)\\`. |'."\n" + .'\\| \\`SystemDisk.DiskName\\` | String | No | \\`testSystemDiskName\\` | The name of the system disk. |'."\n" + .'\\| \\`SystemDisk.Description\\` | String | No | \\`testSystemDiskDescription\\` | The description of the system disk. |'."\n" + .'\\| \\`DataDisk.n.Size\\` | Integer | No | 2000 | The size of data disk \\`n\\`, in GiB. The value of \\`n\\` ranges from 1 to 16. The value range of this parameter depends on the disk category:\\`cloud\\_efficiency\\`: 20 to 32,768\\`cloud\\_ssd\\`: 20 to 32,768\\`cloud\\_essd\\`: 20 to 32,768\\`cloud\\`: 5 to 2,000The value must be greater than or equal to \\`max(20, ImageSize)\\`. |'."\n" + .'\\| \\`DataDisk.n.Category\\` | String | No | \\`cloud\\_ssd\\` | The category of data disk \\`n\\`. The value of \\`n\\` ranges from 1 to 16. Valid values:\\`cloud\\_efficiency\\`: Ultra Disk.\\`cloud\\_ssd\\`: Standard SSD.\\`cloud\\_essd\\`: Enhanced SSD (ESSD).\\`cloud\\`: Basic Disk.For I/O optimized instances, the default value is \\`cloud\\_efficiency\\`. |'."\n" + .'\\| \\`DataDisk.n.SnapshotId\\` | String | No | \\`s-bp17441ohwka0yuh\\*\\*\\*\\*\\` | The ID of the snapshot to use for creating data disk \\`n\\`. The value of \\`n\\` ranges from 1 to 16. |'."\n" + .'\\| \\`DataDisk.n.DiskName\\` | String | No | \\`testDataDiskName\\` | The name of data disk \\`n\\`. The value of \\`n\\` ranges from 1 to 16. |'."\n" + .'\\| \\`DataDisk.n.Description\\` | String | No | \\`testDataDiskDescription\\` | The description of data disk \\`n\\`. The value of \\`n\\` ranges from 1 to 16. |'."\n" + .'\\| \\`DataDisk.n.DeleteWithInstance\\` | Boolean | No | \\`true\\` | Specifies whether to release data disk \\`n\\` when the instance is released. The value of \\`n\\` ranges from 1 to 16. |', 'required' => true, '$ref' => '#/components/schemas/StartJobRequestBody', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'Response data', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the service request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'Fixed value: 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If success is false, the call returns a business error code.If success is true, the call returns business data. The following table describes the data format.If success is true, the call returns business data. The following table describes the data format.'."\n" + ."\n" + .'- When success is true, an empty value is returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If success is false, a business error message is returned.'."\n" + ."\n" + .'- When \\`success\\` is true, an empty value is returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- When \\`success\\` is \\`true\\`, the created instance information is returned.'."\n" + ."\n" + .'- Returns an empty value if \\`success\\` is false.', '$ref' => '#/components/schemas/Job', 'title' => '', 'example' => ''], + 'accessDeniedDetail' => ['description' => 'The detailed information about the access denial.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['ververica::2022-07-18::StartJobWithParams'], ], - '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', + 'title' => 'StartJob', + 'summary' => 'Create and start a job instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StartJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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 \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"failure\\": {\\n \\"message\\": \\"Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.\\",\\n \\"reason\\": \\"KubernetesDeploymentNotProgressing\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"healthScore\\": 0,\\n \\"riskLevel\\": \\"\\"\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"null\\",\\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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\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 \\"taskmanager.numberOfTaskSlots\\": \\"1\\",\\n \\"table.exec.state.ttl\\": \\"128000s\\"\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"1714058507\\",\\n \\"modifiedAt\\": \\"1714058800\\"\\n },\\n \\"accessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'StartJobWithParams' => [ + 'path' => '/api/v2/namespaces/{namespace}/jobs:start', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '235197', - 'abilityTreeNodes' => [ - 'FEATUREscRC0N9T', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196584', + 'abilityTreeNodes' => ['FEATUREscFIKID5'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'."\n"], ], [ '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'."\n"], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ResourceSpec', - ], + 'schema' => ['description' => 'Parameters to start the job instance.', '$ref' => '#/components/schemas/JobStartParameters', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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', - ], + 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'."\n"], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'."\n"], + 'httpCode' => ['description' => 'The HTTP status code. This value is always 200. Use the `success` field to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => 'The error code. This field is populated only when `success` is `false` and is empty otherwise.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message. This field is populated only when `success` is `false` and is empty otherwise.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'Details of the job instance created from the deployment.', '$ref' => '#/components/schemas/Job', 'title' => '', 'example' => ''], + 'accessDeniedDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartJobWithParams', + 'summary' => 'Starts a job instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartJobWithParams'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StartJobWithParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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 \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"failure\\": {\\n \\"message\\": \\"Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.\\",\\n \\"reason\\": \\"KubernetesDeploymentNotProgressing\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"healthScore\\": 0,\\n \\"riskLevel\\": \\"\\"\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"null\\",\\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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\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 \\"taskmanager.numberOfTaskSlots\\": \\"1\\",\\n \\"table.exec.state.ttl\\": \\"128000s\\"\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"1714058507\\",\\n \\"modifiedAt\\": \\"1714058800\\"\\n },\\n \\"accessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'StartSessionCluster' => [ + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}:start', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '235200', - 'abilityTreeNodes' => [ - 'FEATUREscR3E3VD', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '237099', + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'a14bda1c4a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentTargetName', + 'name' => 'sessionClusterName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-dt', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ResourceSpec', - ], + 'schema' => ['description' => 'The name of the session cluster.', 'type' => 'string', 'required' => true, 'example' => 'test-session', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-ABCF-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is empty if the request is successful. If the request fails, this parameter is not empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is empty if the request is successful. If the request fails, this parameter is not empty.', 'type' => 'string', 'example' => '""'], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Start Session Cluster', + 'summary' => 'Starts a session cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSessionCluster'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StartSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'StartSqlExecution' => [ + 'summary' => 'Executes an SQL query script task.', + 'path' => '/api/v2/namespaces/{namespace}/sql-execution', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '235201', - 'abilityTreeNodes' => [ - 'FEATUREscR3E3VD', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREscXPYFHF'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'a14bda1c4a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'default-namespace', 'title' => ''], ], [ - 'name' => 'deploymentTargetName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-dt', - ], + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['description' => 'The request body, which contains the SQL content to execute and description information.', '$ref' => '#/components/schemas/StartSqlExecutionBody', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the business request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'httpCode' => ['title' => '', 'description' => 'The business status code, which is always 200. Use success to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The business error code. This parameter is not empty when success is false. This parameter is empty when success is true.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The business error message. This parameter is not empty when success is false. This parameter is empty when success is true.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The complete information of the SQL script returned upon success. This parameter is valid when success is true.', '$ref' => '#/components/schemas/StartSqlExecutionResult', 'example' => '如返回示例所示', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Execute an SQL query script', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"newlyCreated\\": false,\\n \\"sqlExecutionId\\": \\"\\",\\n \\"success\\": false\\n }\\n}","type":"json"}]', ], - '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', - ], + 'StopApplyScheduledPlan' => [ + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}:stop', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '146855', - 'abilityTreeNodes' => [ - 'FEATUREscYYH6D4', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '235225', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', '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' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the scheduled plan.', 'type' => 'string', 'required' => true, 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the \\`success\\` parameter to check if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code. This parameter is not empty if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message. This parameter is not empty if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The application information for the scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlanAppliedInfo', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n 10\\n 1\\n 1\\n \\n deployment target\\n namespace\\n \\n","errorExample":""}]', - 'title' => 'ListDeploymentTargets', - ], - 'UpdateDeploymentTargetV2' => [ - 'summary' => '更新部署目标', - 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/support-elastic/{deploymentTargetName}', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop a scheduled plan for an application', + 'summary' => 'Stops the application of a scheduled plan.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopApplyScheduledPlan'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StopApplyScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'StopJob' => [ + 'summary' => 'Stops a job instance.', + 'path' => '/api/v2/namespaces/{namespace}/jobs/{jobId}:stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235200', - 'abilityTreeNodes' => [ - 'FEATUREscRC0N9T', - ], + 'abilityTreeCode' => '146949', + 'abilityTreeNodes' => ['FEATUREscFIKID5'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ - 'name' => 'deploymentTargetName', + 'name' => 'jobId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-dt', - ], + 'schema' => ['description' => 'The ID of the job instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '88a8fc49-e090-430a-85d8-3ee8c79c****'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Resource', - ], + 'schema' => ['description' => 'The parameters to stop the job instance.', 'required' => true, '$ref' => '#/components/schemas/StopJobRequestBody', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'title' => '', + 'description' => 'The response data.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value is fixed at 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- The error code that is returned if the request fails.'."\n" + ."\n" + .'- Empty if the request succeeds.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- The error message that is returned if the request fails.'."\n" + ."\n" + .'- Empty if the request succeeds.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- The details of the stopped job instance, returned if the request succeeds.'."\n" + ."\n" + .'- Empty if the request fails.', '$ref' => '#/components/schemas/Job', 'title' => '', 'example' => ''], + 'accessDeniedDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'title' => 'StopJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StopJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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 \\"currentJobStatus\\": \\"RUNNING\\",\\n \\"failure\\": {\\n \\"message\\": \\"Kubernetes deployment resource with name job-8b7db913-5b1f-4ac5-a332-8d50f342**** is not progressing.\\",\\n \\"reason\\": \\"KubernetesDeploymentNotProgressing\\",\\n \\"failedAt\\": 1660120062\\n },\\n \\"running\\": {\\n \\"observedFlinkJobRestarts\\": 4,\\n \\"observedFlinkJobStatus\\": \\"RUNNING\\"\\n },\\n \\"healthScore\\": 0,\\n \\"riskLevel\\": \\"\\"\\n },\\n \\"metric\\": {\\n \\"totalMemoryByte\\": 4096,\\n \\"totalCpu\\": 2\\n },\\n \\"sessionClusterName\\": \\"null\\",\\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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\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 \\"taskmanager.numberOfTaskSlots\\": \\"1\\",\\n \\"table.exec.state.ttl\\": \\"128000s\\"\\n },\\n \\"localVariables\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"value\\": \\"datagen\\"\\n }\\n ],\\n \\"workspace\\": \\"edcef******b4f\\",\\n \\"createdAt\\": \\"1714058507\\",\\n \\"modifiedAt\\": \\"1714058800\\"\\n },\\n \\"accessDeniedDetail\\": \\"\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'StopSessionCluster' => [ + 'path' => '/api/v2/namespaces/{namespace}/sessionclusters/{sessionClusterName}:stop', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235197', - 'abilityTreeNodes' => [ - 'FEATUREscRC0N9T', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '237100', + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/Resource', - ], + 'name' => 'sessionClusterName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the session cluster.', 'type' => 'string', 'required' => true, 'example' => 'test-session', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => '', + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop Session Cluster', + 'summary' => 'Stops a session cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSessionCluster'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StopSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateDeployment' => [ + 'path' => '/api/v2/namespaces/{namespace}/deployments/{deploymentId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '177220', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '146804', + 'abilityTreeNodes' => ['FEATUREscDX72HD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ca84d539167d4d', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'u-gs3rgla9-default', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentId', + 'in' => 'path', + 'schema' => ['description' => 'The deployment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '58718c99-3b29-4c5e-93bb-c9fc4ec6****'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'title' => '成员内容。', - 'description' => 'The mappings between the ID and permissions of the member.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Member', - ], + 'schema' => ['description' => 'The information about the deployment that you want to update.', 'required' => true, '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => '- If the value of success was true, the information about the deployment after the update was returned.'."\n" + ."\n" + .'- If the value of success was false, a null value was returned.', '$ref' => '#/components/schemas/Deployment', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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', + 'title' => 'UpdateDeployment', + 'summary' => 'Updates information about a deployment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDeployment'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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-0000012312****\\",\\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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\n \\"\\"\\n ]\\n },\\n \\"kind\\": \\"SQLSCRIPT\\"\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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\\": 2,\\n \\"cancelling\\": 0,\\n \\"cancelled\\": 5,\\n \\"finished\\": 4,\\n \\"failed\\": 6\\n },\\n \\"deploymentTarget\\": {\\n \\"mode\\": \\"PER_JOB\\",\\n \\"name\\": \\"default-queue\\\\t\\"\\n },\\n \\"executionMode\\": \\"STREAMING\\",\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4,\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\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\\": \\"1714058507\\\\n\\",\\n \\"modifiedAt\\": \\"1714058843\\",\\n \\"referencedDeploymentDraftId\\": \\"00000000-0000-0000-0000-000000000003\\"\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateDeploymentDraft' => [ + 'summary' => 'Updates the draft of an SQL or data ingestion job.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/{deploymentDraftId}', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '177223', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'abilityTreeCode' => '223182', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], + ], + [ + 'name' => 'deploymentDraftId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the job draft. You can get the ID by calling the ListDeploymentDrafts operation.', 'type' => 'string', 'required' => true, 'example' => 'c84d73be-40ad-4627-8bdd-fa1eba51b234', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'title' => '成员信息。', - 'description' => 'The permission information about the member.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/Member', - ], + 'schema' => ['description' => 'The information to update the job draft.', 'required' => true, '$ref' => '#/components/schemas/DeploymentDraft', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The updated job draft. This parameter is returned if \\`success\\` is \\`true\\`. If \\`success\\` is \\`false\\`, this parameter is empty.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value other than 200 indicates that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => '- If the request fails, an error code is returned.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => '- If the request fails, an error message is returned.'."\n" + ."\n" + .'- If the request is successful, this parameter is empty.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The resulting job draft.', '$ref' => '#/components/schemas/DeploymentDraft', 'title' => '', 'example' => ''], ], + '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 \\"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', + '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\\": \\"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;\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"jarArtifact\\": {\\n \\"jarUri\\": \\"https://oss/bucket/test.jar\\",\\n \\"entryClass\\": \\"org.apapche.flink.test\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.jar\\"\\n ]\\n },\\n \\"pythonArtifact\\": {\\n \\"pythonArtifactUri\\": \\"https://oss/bucket/test.py\\",\\n \\"mainArgs\\": \\"start from main\\",\\n \\"entryModule\\": \\"test.py\\",\\n \\"additionalDependencies\\": [\\n \\"https://oss/bucket/addition.py\\"\\n ],\\n \\"additionalPythonLibraries\\": [\\n \\"https://oss/bucket/additionlib.py\\"\\n ],\\n \\"additionalPythonArchives\\": [\\n \\"https://oss/bucket/additionArchives.zip\\"\\n ]\\n },\\n \\"cdcYamlArtifact\\": {\\n \\"cdcYaml\\": \\"\\",\\n \\"additionalDependencies\\": [\\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\\": \\"stt-fu1658tbk6mnkk2****\\",\\n \\"workspace\\": \\"a14bd5d90a****\\",\\n \\"namespace\\": \\"default-namespace\\",\\n \\"holderId\\": \\"18389966****\\",\\n \\"holderName\\": \\"userA\\"\\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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n}","type":"json"}]', + 'title' => 'Update a job draft', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDeploymentDraft'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateDeploymentTarget' => [ + 'summary' => 'Updates a deployment target.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/{deploymentTargetName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '177280', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '235200', + 'abilityTreeNodes' => ['FEATUREscR3E3VD'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '710d6a64d8c34d', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'member', + 'name' => 'deploymentTargetName', 'in' => 'path', - 'schema' => [ - 'title' => '成员名称。', - 'description' => 'The member ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user:223769', - ], + 'schema' => ['description' => 'The name of the deployment target.', 'type' => 'string', 'required' => true, 'example' => 'test-dt', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The resource specifications for the updated deployment target.', '$ref' => '#/components/schemas/ResourceSpec', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the \\`success\\` parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The updated deployment target.', '$ref' => '#/components/schemas/DeploymentTarget', 'title' => '', 'example' => ''], ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Deployment Target', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDeploymentTarget'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeploymentTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'UpdateDeploymentTargetV2' => [ + 'summary' => 'Updates a deployment target.', + 'path' => '/api/v2/namespaces/{namespace}/deployment-targets/support-elastic/{deploymentTargetName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '177281', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'abilityTreeCode' => '235200', + 'abilityTreeNodes' => ['FEATUREscRC0N9T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The namespace name.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'member', + 'name' => 'deploymentTargetName', 'in' => 'path', - 'schema' => [ - 'title' => '成员名称。', - 'description' => 'The display name of the member.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user:223769', - ], + 'schema' => ['description' => 'The name of the deployment target.', 'type' => 'string', 'required' => true, 'example' => 'test-dt', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The deployment target resource.', '$ref' => '#/components/schemas/Resource', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. A value of 200 is always returned. Use the success parameter to determine whether the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The details of the deployment target.', 'example' => 'As shown in the response example.', '$ref' => '#/components/schemas/DeploymentTarget', 'title' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Deployment Target (V2)', + 'description' => 'This new API operation updates deployment targets that use fixed resources, elastic resources, or mixed mode. The previous operation supported only fixed and elastic resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeploymentTargetV2', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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"}]', + ], + 'UpdateFolder' => [ + 'path' => '/api/v2/namespaces/{namespace}/folder/{folderId}', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '177185', - 'abilityTreeNodes' => [ - 'FEATUREscWQDSD2', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '223054', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'f89a0c1ca8****', 'title' => ''], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace', 'title' => ''], ], [ - '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' => 'folderId', + 'in' => 'path', + 'schema' => ['description' => 'The folder ID. You can call the GetFolder operation to obtain the folder ID.', 'type' => 'string', 'required' => true, 'example' => '13803', 'title' => ''], ], [ - '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', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The data structure of the folder.', 'required' => true, '$ref' => '#/components/schemas/Folder', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The HTTP status code. If this parameter was not empty and the value of this parameter was not 200, the request failed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The information returned after the folder is updated.', '$ref' => '#/components/schemas/Folder', 'title' => '', 'example' => ''], ], + '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 \\"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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateFolder', + 'summary' => 'Updates a folder.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFolder'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": 1723537978,\\n \\"modifiedAt\\": 1723537978\\n }\\n}","type":"json"}]', + 'translator' => 'manual', + ], + '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'abilityTreeCode' => '177223', + 'abilityTreeNodes' => ['FEATUREscWQDSD2'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'title' => '创建变量的数据内容。', - 'description' => 'The information about the variable after the update.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Variable', - ], + 'schema' => ['description' => 'The permission information about the member.', '$ref' => '#/components/schemas/Member', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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' => '“”', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['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.', '$ref' => '#/components/schemas/Member', 'title' => '', 'example' => ''], ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMember', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMember'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + 'UpdateScheduledPlan' => [ + 'path' => '/api/v2/namespaces/{namespace}/scheduled-plans/{scheduledPlanId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '147069', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '235221', + 'abilityTreeNodes' => ['FEATUREsc6GKYF1'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', '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', - ], + 'name' => 'scheduledPlanId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the scheduled plan.', 'type' => 'string', 'required' => true, 'example' => 'f420c2e7-6d3f-4683-81d0-3ea8585*****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The data structure of the scheduled plan to be updated.', '$ref' => '#/components/schemas/ScheduledPlan', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The business status code. This is always 200. Use the success parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The business error code. This parameter is not empty when the success parameter is false. This parameter is empty when the success parameter is true.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The business error message. This parameter is not empty when the success parameter is false. This parameter is empty when the success parameter is true.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the updated scheduled plan.', '$ref' => '#/components/schemas/ScheduledPlan', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-ABCD-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n Plain\\n variableName\\n variableValue\\n This is a variable description\\n \\n","errorExample":""}]', - 'title' => 'CreateVariable', - ], - 'DeleteVariable' => [ - 'summary' => 'Deletes a variable.', - 'path' => '/api/v2/namespaces/{namespace}/variables/{name}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a scheduled plan', + 'summary' => 'Updates a scheduled plan.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateScheduledPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n }\\n },\\n \\"streamingResourceSetting\\": {\\n \\"resourceSettingMode\\": \\"EXPERT\\",\\n \\"expertResourceSetting\\": {\\n \\"jobmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n },\\n \\"resourcePlan\\": \\"{\\\\\\\\\\\\\\"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 },\\n \\"basicResourceSetting\\": {\\n \\"parallelism\\": 4\\n }\\n }\\n }\\n }\\n ],\\n \\"status\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', + ], + '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', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '147071', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '237096', + 'abilityTreeNodes' => ['FEATUREscBWKRDZ'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', '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', - ], + 'schema' => ['title' => '', 'description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'default-namespace'], ], [ - 'name' => 'name', + 'name' => 'sessionClusterName', 'in' => 'path', - 'schema' => [ - 'title' => '变量名称。', - 'description' => 'The name of the variable that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'variableName', - ], + 'schema' => ['description' => 'The name of the session cluster.', 'type' => 'string', 'required' => true, 'example' => 'test-session', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The data structure of the session cluster to be updated.', '$ref' => '#/components/schemas/SessionCluster', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', + 'title' => '', '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' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9'], + 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'httpCode' => ['title' => '', 'description' => 'The HTTP status code. The value is always 200. Use the \\`success\\` parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'errorCode' => ['title' => '', 'description' => 'The error code returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'errorMessage' => ['title' => '', 'description' => 'The error message returned if the request fails. This parameter is empty if the request is successful.', 'type' => 'string', 'example' => '""'], + 'data' => ['description' => 'The data structure of the updated session cluster.', '$ref' => '#/components/schemas/SessionCluster', 'title' => '', 'example' => ''], ], + '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n","errorExample":""}]', - 'title' => 'DeleteVariable', - ], - 'ListVariables' => [ - 'summary' => 'Obtains a list of variables.', - 'path' => '/api/v2/namespaces/{namespace}/variables', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Session Cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSessionCluster'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"4 GiB\\"\\n },\\n \\"taskmanagerResourceSettingSpec\\": {\\n \\"cpu\\": 2,\\n \\"memory\\": \\"4 GiB\\"\\n }\\n },\\n \\"flinkConf\\": {\\n \\"taskmanager.numberOfTaskSlots\\": \\"1\\"\\n },\\n \\"logging\\": {\\n \\"loggingProfile\\": \\"default\\",\\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"}]', + ], + 'UpdateUdfArtifact' => [ + 'path' => '/api/v2/namespaces/{namespace}/udfartifacts/{udfArtifactName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '147070', - 'abilityTreeNodes' => [ - 'FEATUREscGTCR1G', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '230195', + 'abilityTreeNodes' => ['FEATUREscOYA64T'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bda1c4a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', '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' => 'udfArtifactName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the JAR file of the UDF.', 'type' => 'string', 'required' => true, 'example' => 'test-udf', 'title' => ''], ], [ - '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' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The details of the JAR file of the UDF.', 'required' => true, '$ref' => '#/components/schemas/UdfArtifact', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-ABCD-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => '- If the value of success was false, an error code was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => '- If the value of success was false, an error message was returned.'."\n" + ."\n" + .'- If the value of success was true, a null value was returned.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The result of updating the JAR file of the UDF.', '$ref' => '#/components/schemas/UpdateUdfArtifactResult', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-ABCF-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n 10\\n 1\\n 1\\n \\n Plain\\n variableName\\n variableValue\\n This is a variable description\\n \\n","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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateUdfArtifact', + 'summary' => 'Updates the JAR file of the user-defined function (UDF) that you create.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUdfArtifact'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateUdfArtifact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + '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\\": \\"default-namespace\\\\n\\",\\n \\"creator\\": \\"userA\\",\\n \\"createdAt\\": 1723532876,\\n \\"modifiedAt\\": 1723537876,\\n \\"name\\": \\"udfCollection.jar\\\\n\\",\\n \\"jarUrl\\": \\"oss://bucket/udfCollection.jar\\\\n\\",\\n \\"dependencyJarUris\\": [\\n \\"oss://bucket/addition/add.jar\\\\n\\"\\n ],\\n \\"artifactType\\": \\"ARTIFACT_TYPE_JAVA\\",\\n \\"udfClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ]\\n },\\n \\"message\\": \\"\\",\\n \\"collidingClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ],\\n \\"missingClasses\\": [\\n {\\n \\"udfArtifactName\\": \\"udfCollection.jar\\",\\n \\"className\\": \\"myfunctionTest\\",\\n \\"classType\\": \\"UDF_TYPE_TABLE_AGGREGATE\\",\\n \\"functionNames\\": [\\n \\"myfunction\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpdateVariable' => [ + 'path' => '/api/v2/namespaces/{namespace}/variables/{name}', + 'methods' => ['patch'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '146861', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + '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****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], + ], + [ + 'name' => 'namespace', + 'in' => 'path', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the variable.', 'type' => 'string', 'required' => true, 'example' => 'vvp_ds_0522', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The information about the variable after the update.', 'required' => true, '$ref' => '#/components/schemas/Variable', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['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.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['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.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The variable structure after the update.', '$ref' => '#/components/schemas/Variable', 'title' => '', 'example' => ''], + 'accessDeniedDetail' => ['description' => 'The details of the access denial. This parameter is returned in scenarios where the account is not authorized to perform operations.', 'type' => 'string', 'example' => '“”', 'title' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n vvr-6.0.1-flink-1.15\\n \\n vvr-6.0.0-flink-1.15\\n STABLE\\n \\n true\\n true\\n \\n \\n \\n","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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateVariable', + 'summary' => 'Updates the information about a variable in a namespace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateVariable'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateVariable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1EF03B0C-F44F-47AD-BB48-D002D0F7B8C9\\",\\n \\"success\\": true,\\n \\"httpCode\\": 200,\\n \\"errorCode\\": \\"\\\\\\"\\\\\\"\\",\\n \\"errorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"kind\\": \\"Encrypted\\",\\n \\"name\\": \\"mysqlPassword\\",\\n \\"value\\": \\"myPassword\\",\\n \\"description\\": \\"test\\"\\n },\\n \\"accessDeniedDetail\\": \\"“”\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ValidateDeploymentDraftAsync' => [ + 'path' => '/api/v2/namespaces/{namespace}/deployment-drafts/async-validate', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '151658', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREscWKZGIA'], ], 'parameters' => [ [ 'name' => 'workspace', 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', '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****', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-namespace'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The Flink configuration that is used to generate a resource plan.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/FlinkConf', - ], + 'style' => 'json', + 'schema' => ['description' => 'The parameter object for the job draft.', '$ref' => '#/components/schemas/DraftValidateParams', 'required' => false, 'title' => '', 'example' => ''], ], ], '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' => '""', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-AS7S-1D30-8A4F-882ED4DD****'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code. This is always 200. Use the success parameter to determine if the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['description' => 'The error code. This parameter is returned when the request fails. If the request is successful, this parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['description' => 'The error message. This parameter is returned when the request fails. If the request is successful, this parameter is empty.', 'type' => 'string', 'title' => '', '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****', - ], + 'ticketId' => ['description' => 'The ID of the asynchronous ticket. Use this ID to query the result of the asynchronous operation.', 'type' => 'string', 'title' => '', 'example' => 'b3dcdb25-bf36-457d-92ba-a36077e8****'], ], + 'description' => 'The response data.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n b3dcdb25-bf36-457d-92ba-a36077e8****\\n \\n","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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ValidateDeploymentDraftAsync', + 'summary' => 'Asynchronously performs an in-depth check of a Flink job draft to validate its syntax and resource configuration.', + 'description' => 'This API asynchronously validates a job draft. It conducts end-to-end compliance and compatibility checks on the draft\'s configuration before it is submitted for deployment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ValidateDeploymentDraftAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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"}]', + 'translator' => 'manual', + ], + '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', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '147081', - 'abilityTreeNodes' => [ - 'FEATUREscWKZGIA', - ], + '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****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a14bd5d90a****'], ], [ 'name' => 'namespace', 'in' => 'path', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', - ], + 'schema' => ['description' => 'The name of the namespace.', 'type' => 'string', 'required' => true, 'title' => '', '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****', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The content of the code that you want to verify.', 'required' => true, '$ref' => '#/components/schemas/SqlStatementWithContext', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据。', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', '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', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'CBC799F0-****-1D30-8A4F-882ED4DD5E02'], + 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'httpCode' => ['description' => 'The status code returned. The value was fixed to 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'errorCode' => ['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.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'errorMessage' => ['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.', 'type' => 'string', 'title' => '', 'example' => '""'], + 'data' => ['description' => 'The returned data, which represents the details of SQL validation results.', '$ref' => '#/components/schemas/SqlStatementValidationResult', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n true\\n 200\\n \\"\\"\\n \\"\\"\\n \\n FINISHED\\n {\\\\\\"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 \\"\\"\\n \\n","errorExample":""}]', - 'title' => 'GetGenerateResourcePlanResult', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ValidateSqlStatement', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateSqlStatement'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ValidateSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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\\": \\"VALIDATION_RESULT_INVALID\\",\\n \\"errorDetails\\": {\\n \\"lineNumber\\": \\"3\\",\\n \\"columnNumber\\": \\"2\\",\\n \\"endLineNumber\\": \\"5\\",\\n \\"endColumnNumber\\": \\"11\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"invalidflinkConf\\": [\\n \\"{\\\\\\"k:v\\\\\\"}\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'FlinkApiProxy' => [ - 'summary' => 'Provides a proxy for Realtime Compute for Apache Flink requests.', - 'path' => '/flink-ui/v2/proxy', - 'methods' => [ - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-qingdao.aliyuncs.com', 'endpoint' => 'ververica.cn-qingdao.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ververica.cn-shenzhen.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'ververica.cn-wulanchabu.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-beijing.aliyuncs.com', 'endpoint' => 'ververica.cn-beijing.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.ap-northeast-1.aliyuncs.com', 'endpoint' => 'ververica.ap-northeast-1.aliyuncs.com', 'vpc' => 'ververica-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-chengdu.aliyuncs.com', 'endpoint' => 'ververica.cn-chengdu.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-shanghai.aliyuncs.com', 'endpoint' => 'ververica.cn-shanghai.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-hongkong.aliyuncs.com', 'endpoint' => 'ververica.cn-hongkong.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ververica.ap-southeast-1.aliyuncs.com', 'vpc' => 'ververica-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.ap-southeast-3.aliyuncs.com', 'endpoint' => 'ververica.ap-southeast-3.aliyuncs.com', 'vpc' => 'ververica-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.ap-southeast-5.aliyuncs.com', 'endpoint' => 'ververica.ap-southeast-5.aliyuncs.com', 'vpc' => 'ververica-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'ververica.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ververica.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ververica.cn-hangzhou.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ververica.us-west-1.aliyuncs.com', 'endpoint' => 'ververica.us-west-1.aliyuncs.com', 'vpc' => 'ververica-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ververica.us-east-1.aliyuncs.com', 'endpoint' => 'ververica.us-east-1.aliyuncs.com', 'vpc' => 'ververica-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ververica.eu-central-1.aliyuncs.com', 'endpoint' => 'ververica.eu-central-1.aliyuncs.com', 'vpc' => 'ververica-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ververica.eu-west-1.aliyuncs.com', 'endpoint' => 'ververica.eu-west-1.aliyuncs.com', 'vpc' => 'ververica-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ververica.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'ververica.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'ververica-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSavepoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeploymentDraftLock'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVariable'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeployDeploymentDraftAsync'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeploymentDraft'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDeploymentTarget'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUdfArtifact'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomConnectors'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVariables'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDeploymentDraft'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEngineVersionMetadata'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFolder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartSessionCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeploymentTargets'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppliedScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopApplyScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSessionCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFolder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSessionCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeployments'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateVariable'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HotUpdateJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeployment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobDiagnosis'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSavepoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGenerateResourcePlanResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSavepoints'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeployDeploymentDraftResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateSqlStatement'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterCustomConnector'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeploymentDraft'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTables'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSessionClusters'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FlinkApiProxy'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartJobWithParams'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCatalogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotUpdateJobResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeployment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMember'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSavepoint'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteSqlStatement'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterUdfFunction'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduledPlanExecutedHistory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDeployment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeploymentTarget'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUdfFunction'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSessionCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeployment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateResourcePlanWithFlinkConfAsync'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMembers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLineageInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUdfArtifact'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUdfArtifact'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeploymentTarget'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLatestJobStartLog'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVariable'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduledPlan'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSessionCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDatabases'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeploymentDrafts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFolder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeploymentDraft'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSessionCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEvents'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomConnector'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUdfArtifacts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFolder'], + ], + ], + 'ram' => [ + 'productCode' => 'RealtimeCompute', + 'productName' => 'Realtime Compute for Apache Flink', + 'ramCodes' => ['stream', 'fluss'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetCatalogs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListEngineVersionMetadata', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListEngineVersionMetadata', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListMembers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListCustomConnectors', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ListCustomConnectors', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'StartJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StartJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetHotUpdateJobResult', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '146918', - 'abilityTreeNodes' => [ - 'FEATUREscO1AVSF', + 'ramAction' => [ + 'action' => 'stream:GetHotUpdateJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspace', - 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a14bd5d90a****', + [ + 'apiName' => 'ListSavepoints', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListSavepoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '项目空间名称。', - 'description' => 'The name of the namespace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'default-namespace', + ], + [ + 'apiName' => 'CreateDeploymentDraft', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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', + ], + [ + 'apiName' => 'CreateSavepoint', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateSavepoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'resourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源ID。', - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5a27a3aa-c5b9-4dc1-8c86-be57d2d6****', + ], + [ + 'apiName' => 'DeleteDeploymentTarget', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteDeploymentTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'flinkApiPath', - 'in' => 'query', - 'schema' => [ - 'title' => 'flink-ui路径。', - 'description' => 'The path of the Flink UI.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '/jobs/4df35f8e54554b23bf7dcd38a151****', + ], + [ + 'apiName' => 'GetEvents', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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 } } ] }', + [ + 'apiName' => 'GetDeployDeploymentDraftResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetDeployDeploymentDraftResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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":"\\n CBC799F0-AS7S-1D30-8A4F-882ED4DD****\\n 200\\n true\\n \\"\\"\\n \\"\\"\\n { \\"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":""}]', - 'title' => 'FlinkApiProxy', - ], - 'GetLineageInfo' => [ - 'summary' => 'Obtains the lineage information of a deployment.', - 'path' => '/meta/v2/lineage', - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateDeployment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateMember', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateFolder', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDeploymentDraft', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeleteJob', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'CreateScheduledPlan', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteUdfFunction', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '230001', - 'abilityTreeNodes' => [ - 'FEATUREscDYS18E', + 'ramAction' => [ + 'action' => 'stream:DeleteUdfFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspace', - 'in' => 'header', - 'schema' => [ - 'title' => '工作空间ID。', - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '710d6a64d8****', + [ + 'apiName' => 'DeleteMember', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The parameters about the lineage information.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/GetLineageInfoParams', + ], + [ + 'apiName' => 'ListVariables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListVariables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'ExecuteSqlStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ExecuteSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ValidateDeploymentDraftAsync', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ValidateDeploymentDraftAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSavepoint', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetSavepoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSessionCluster', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMember', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTables', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetGenerateResourcePlanResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetGenerateResourcePlanResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFolder', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVariable', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteVariable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDeployment', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDeploymentDrafts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListDeploymentDrafts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeploymentDraftLock', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentDraftLock', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeploymentDraft', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomConnector', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:DeleteCustomConnector', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDatabases', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDeploymentTarget', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeploymentTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDeployments', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListDeployments', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RegisterCustomConnector', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:RegisterCustomConnector', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartSessionCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StartSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FlinkApiProxy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:FlinkApiProxy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFolder', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeploymentsByLabel', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentsByLabel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateScheduledPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'HotUpdateJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:HotUpdateJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeploymentsByIp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentsByIp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDeploymentTarget', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeploymentTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMember', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSessionCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeployment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopSessionCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StopSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDeploymentDraft', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteDeploymentDraft', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteUdfArtifact', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteUdfArtifact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ValidateSqlStatement', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ValidateSqlStatement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateVariable', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateVariable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDeployment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeployment', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateSessionCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListScheduledPlan', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateUdfArtifact', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateUdfArtifact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartJobWithParams', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StartJobWithParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLatestJobStartLog', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetLatestJobStartLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAppliedScheduledPlan', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetAppliedScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ApplyScheduledPlan', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:ApplyScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDeploymentTargetV2', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateDeploymentTargetV2', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetJobDiagnosis', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetJobDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteScheduledPlan', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateUdfArtifact', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'stream:CreateUdfArtifact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSessionCluster', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteSessionCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDeploymentTargets', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListDeploymentTargets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSavepoint', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'stream:DeleteSavepoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetUdfArtifacts', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetUdfArtifacts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeployDeploymentDraftAsync', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:DeployDeploymentDraftAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StopJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetFolder', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetFolder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RegisterUdfFunction', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:RegisterUdfFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopApplyScheduledPlan', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:StopApplyScheduledPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDeploymentTargetV2', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateDeploymentTargetV2', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeploymentsByName', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'stream:GetDeploymentsByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateResourcePlanWithFlinkConfAsync', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GenerateResourcePlanWithFlinkConfAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateVariable', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'stream:UpdateVariable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSessionClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'stream:ListSessionClusters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetValidateDeploymentDraftResult', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'stream:GetValidateDeploymentDraftResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'RealtimeCompute', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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', ], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3