summaryrefslogtreecommitdiff
path: root/data/en_us/openanalytics-open/2018-06-19
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/openanalytics-open/2018-06-19
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/openanalytics-open/2018-06-19')
-rw-r--r--data/en_us/openanalytics-open/2018-06-19/api-docs.php2233
1 files changed, 788 insertions, 1445 deletions
diff --git a/data/en_us/openanalytics-open/2018-06-19/api-docs.php b/data/en_us/openanalytics-open/2018-06-19/api-docs.php
index a7ac1f3..2d609ea 100644
--- a/data/en_us/openanalytics-open/2018-06-19/api-docs.php
+++ b/data/en_us/openanalytics-open/2018-06-19/api-docs.php
@@ -1,95 +1,47 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'openanalytics-open',
- 'version' => '2018-06-19',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'openanalytics-open', 'version' => '2018-06-19'],
'directories' => [
[
- 'id' => 66483,
- 'title' => null,
+ 'children' => ['GetJobStatus', 'GetJobDetail', 'GetJobLog', 'ListSparkJob', 'SubmitSparkJob', 'KillSparkJob'],
'type' => 'directory',
- 'children' => [
- 'GetJobStatus',
- 'GetJobDetail',
- 'GetJobLog',
- 'ListSparkJob',
- 'SubmitSparkJob',
- 'KillSparkJob',
- ],
+ 'title' => 'Serverless Spark ',
],
[
- 'id' => 66490,
- 'title' => null,
+ 'children' => ['CreateInstance', 'ReleaseInstance', 'ValidateVirtualClusterName'],
'type' => 'directory',
- 'children' => [
- 'CreateInstance',
- 'ReleaseInstance',
- 'ValidateVirtualClusterName',
- ],
+ 'title' => 'Service Management ',
],
[
- 'id' => 362601,
- 'title' => null,
+ 'children' => ['SubmitSparkSQL', 'CancelSparkStatement', 'ExecuteSparkStatement', 'GetSparkSessionState', 'GetSparkStatement', 'ListSparkStatements', 'GetJobAttemptLog', 'ListSparkJobAttempt'],
'type' => 'directory',
- 'children' => [
- 'SubmitSparkSQL',
- 'CancelSparkStatement',
- 'ExecuteSparkStatement',
- 'GetSparkSessionState',
- 'GetSparkStatement',
- 'ListSparkStatements',
- 'GetJobAttemptLog',
- 'ListSparkJobAttempt',
- ],
+ 'title' => 'Other ',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetJobStatus' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CancelSparkStatement' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'StatementId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202011031935hangzhouf742a4330003667',
- ],
+ 'schema' => ['description' => 'The unique ID of the code block in the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2026****', 'title' => ''],
],
[
- 'name' => 'VcName',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MyCluster',
- ],
+ 'schema' => ['description' => 'The unique ID of the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202106071620hangzhou****', 'title' => ''],
],
],
'responses' => [
@@ -97,67 +49,66 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5C3F9ADD-2350-4C21-A3A1-A906F8DF8016',
- ],
+ 'Data' => ['description' => 'Indicates whether the code block is stopped. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Stopped.'."\n"
+ .'- **false**: Failed to stop.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '341ADFA1-4A68-4707-9CA7-FA86523A5F14', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"success\\",\\n \\"RequestId\\": \\"5C3F9ADD-2350-4C21-A3A1-A906F8DF8016\\"\\n}","errorExample":""},{"type":"xml","example":"<Status>success</Status>\\n<RequestId>5C3F9ADD-2350-4C21-A3A1-A906F8DF8016</RequestId>","errorExample":""}]',
- 'title' => 'GetJobStatus',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"341ADFA1-4A68-4707-9CA7-FA86523A5F14\\"\\n}","type":"json"}]',
+ 'title' => 'Stop the execution of a code block',
+ 'summary' => 'Stops the execution of a code block.',
'requestParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetJobDetail' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'This is an asynchronous operation. When `true` is returned, it indicates that the Spark job has received the stop command and starts attempting to stop the code block. Whether the code block is actually stopped depends on the runtime conditions. Call the `GetSparkStatement` operation to check whether the code block is stopped.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'CreateInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'RegionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202010271622hangzhouf742a4330000923',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
- 'name' => 'VcName',
+ 'name' => 'ChargeType',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MyCluster',
- ],
+ 'schema' => ['description' => 'Set to **POSTPAY**. Only pay-as-you-go instances can be created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'POSTPAY', 'title' => ''],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The instance type. Valid values:'."\n"
+ ."\n"
+ .'- **CU_SPARK**: cloud-native Spark engine.'."\n"
+ ."\n"
+ .'- **CU_PRESTO**: compatible with open-source Presto syntax.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CU_PRESTO', 'title' => ''],
+ ],
+ [
+ 'name' => 'Component',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The JSON serialization of the component module.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '"{\\"operable\\":\\"false\\",\\"max_cu\\":\\"8\\",\\"instance_name\\":\\"api-test-9\\",\\"min_cu\\":\\"0\\",\\"engine\\":\\"spark\\",\\"region\\":\\"cn-hangzhou\\",\\"app_name\\":\\"xx\\",\\"app_version_name\\":\\"xx\\"}"', 'title' => ''],
],
],
'responses' => [
@@ -165,148 +116,70 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '5F10AB6E-8984-4E32-B821-4E1512711B8C',
- ],
- 'JobDetail' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-27 16:23:16',
- ],
- 'ExecutorResourceSpec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-27 16:23:16',
- ],
- 'DriverResourceSpec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'CreateTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1603786996000',
- ],
- 'UpdateTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1603786996000',
- ],
- 'SparkUI' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx',
- ],
- 'LastJobAttemptId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '202105251618hzslot9906b0b40000005-0001',
- ],
- 'SubmitTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1603786996000',
- ],
- 'JobName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SparkPi',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'j202010271622hangzhouf742a4330000923',
- ],
- 'ExecutorInstances' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'VcName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MyCluster',
- ],
- 'SubmitTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-27 16:23:16',
- ],
- 'Detail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"args\\":[\\"100\\"],\\"name\\":\\"SparkPi\\",\\"className\\":\\"org.apache.spark.examples.SparkPi\\",\\"conf\\":{\\"spark.driver.resourceSpec\\":\\"medium\\",\\"spark.executor.instances\\":5,\\"spark.executor.resourceSpec\\":\\"medium\\"},\\"file\\":\\"local:///tmp/spark-examples.jar\\"}',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '312F48C7-AFA0-46AA-B8F6-1B16B8808045', 'title' => ''],
+ 'ErrorInfo' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'An internal error occurred', 'title' => ''],
+ 'Result' => ['description' => 'The result of the instance creation.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '600', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5F10AB6E-8984-4E32-B821-4E1512711B8C\\",\\n \\"JobDetail\\": {\\n \\"Status\\": \\"success\\",\\n \\"UpdateTime\\": \\"2020-10-27 16:23:16\\",\\n \\"ExecutorResourceSpec\\": \\"small\\",\\n \\"CreateTime\\": \\"2020-10-27 16:23:16\\",\\n \\"DriverResourceSpec\\": \\"small\\",\\n \\"CreateTimeValue\\": \\"1603786996000\\",\\n \\"UpdateTimeValue\\": \\"1603786996000\\",\\n \\"SparkUI\\": \\"https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx\\",\\n \\"LastJobAttemptId\\": \\"202105251618hzslot9906b0b40000005-0001\\",\\n \\"SubmitTimeValue\\": \\"1603786996000\\",\\n \\"JobName\\": \\"SparkPi\\",\\n \\"JobId\\": \\"j202010271622hangzhouf742a4330000923\\",\\n \\"ExecutorInstances\\": \\"1\\",\\n \\"VcName\\": \\"MyCluster\\",\\n \\"SubmitTime\\": \\"2020-10-27 16:23:16\\",\\n \\"Detail\\": \\"{\\\\\\\\\\\\\\"args\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"100\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SparkPi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"className\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"org.apache.spark.examples.SparkPi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"conf\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"spark.driver.resourceSpec\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"medium\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"spark.executor.instances\\\\\\\\\\\\\\":5,\\\\\\\\\\\\\\"spark.executor.resourceSpec\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"medium\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"file\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"local:///tmp/spark-examples.jar\\\\\\\\\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<JobDetail>\\n <Status>success</Status>\\n <VcName>MyCluser</VcName>\\n <ExecutorInstances>5</ExecutorInstances>\\n <LastJobAttemptId>j202010271622hangzhouf742a4330000923-0001</LastJobAttemptId>\\n <SparkUI>https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx</SparkUI>\\n <DriverResourceSpec>medium</DriverResourceSpec>\\n <CreateTime>2020-10-27 16:23:16</CreateTime>\\n <JobName>SparkPi</JobName>\\n <ExecutorResourceSpec>medium</ExecutorResourceSpec>\\n <SubmitTime>2020-10-27 16:22:52</SubmitTime>\\n <CreateTimeValue>1603786996000</CreateTimeValue>\\n <UpdateTimeValue>1603787047000</UpdateTimeValue>\\n <SubmitTimeValue>1603786972000</SubmitTimeValue>\\n <UpdateTime>2020-10-27 16:24:07</UpdateTime>\\n <JobId>j202010271622hangzhouf742a4330000923</JobId>\\n <Detail>{\\"args\\":[\\"100\\"],\\"name\\":\\"SparkPi\\",\\"className\\":\\"org.apache.spark.examples.SparkPi\\",\\"conf\\":{\\"spark.driver.resourceSpec\\":\\"medium\\",\\"spark.executor.instances\\":5,\\"spark.executor.resourceSpec\\":\\"medium\\"},\\"file\\":\\"local:///tmp/spark-examples.jar\\"}</Detail>\\n</JobDetail>\\n<RequestId>5F10AB6E-8984-4E32-B821-4E1512711B8C</RequestId>","errorExample":""}]',
- 'title' => 'GetJobDetail',
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'Openanalytics.Unauthorized.Exception', 'errorMessage' => 'You do not have permission to perform the operation.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'Openanalytics.NotFound.Exception', 'errorMessage' => 'The specified instance does not exist.', 'description' => ''],
+ ],
+ 600 => [
+ ['errorCode' => 'Openanalytics.Internal.Exception', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"312F48C7-AFA0-46AA-B8F6-1B16B8808045\\",\\n \\"ErrorInfo\\": \\"An internal error occurred\\",\\n \\"Result\\": \\"true\\",\\n \\"ErrorCode\\": \\"600\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Create an instance',
+ 'summary' => 'Creates an instance by calling CreateInstance.',
'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetJobLog' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ExecuteSparkStatement' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'operationType' => 'write',
+ 'systemTags' => [],
'parameters' => [
[
+ 'name' => 'Code',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'A code block. Use the Linux newline character \''."\n"
+ .'\' to indicate a new line.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'print(2+2)\\n', 'title' => ''],
+ ],
+ [
'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202010271622hangzhouf742a4330000923',
- ],
+ 'schema' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202106071620hangzhou****', 'title' => ''],
],
[
- 'name' => 'VcName',
+ 'name' => 'Kind',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MyCluster',
- ],
+ 'schema' => ['description' => 'The language used to execute the code. Valid values:'."\n"
+ .'- **scala**'."\n"
+ .'- **python**'."\n"
+ .'- **sql**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sql', 'title' => ''],
],
],
'responses' => [
@@ -314,36 +187,31 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'INFO SparkContext: Running Spark version 2.x',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EC031B4B-3E07-40D2-9BC5-xxxx',
- ],
+ 'Data' => ['description' => 'The unique ID of the code block in the Spark job after the code block is submitted.', 'type' => 'string', 'example' => '2', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0DC5B6F080E8-0DC5B6F080E8-0DC5B', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"INFO SparkContext: Running Spark version 2.x\\",\\n \\"RequestId\\": \\"EC031B4B-3E07-40D2-9BC5-xxxx\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3970ACB5-3E30-4A3A-B63A-xxxx</RequestId>\\n<Data>Running Spark version 2.x</Data>","errorExample":""}]',
- 'title' => 'GetJobLog',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"2\\",\\n \\"RequestId\\": \\"0DC5B6F080E8-0DC5B6F080E8-0DC5B\\"\\n}","type":"json"}]',
+ 'title' => 'Execute a spark code block job',
+ 'summary' => 'Submits a code block to a Spark job for execution.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListSparkJob' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetJobAttemptLog' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -351,55 +219,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'VcName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MySparkCluster',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The Spark job ID. You can view the job on the job management page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202105272322hangzhou5d64f1560000128', 'title' => ''],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
- ],
+ 'name' => 'VcName',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the virtual cluster that runs the Spark job. You can view the virtual cluster name on the virtual cluster management page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'release-test', 'title' => ''],
],
[
- 'name' => 'Condition',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{ "createTime":"2020-12-28 09:00:00", "jobName":"SparkPi" }',
- ],
+ 'name' => 'JobAttemptId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The Spark job attempt ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202105272322hangzhou5d64f1560000128-0001', 'title' => ''],
],
],
'responses' => [
@@ -407,164 +242,49 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'E18B0634-F003-486A-90B9-4AA6932DA3AA',
- ],
- 'DataResult' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4998',
- ],
- 'JobList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'UpdateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-27 17:51:05',
- ],
- 'ExecutorResourceSpec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-27 17:51:05',
- ],
- 'CreateTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1603792267000',
- ],
- 'DriverResourceSpec' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'small',
- ],
- 'UpdateTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1603792267000',
- ],
- 'SparkUI' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx',
- ],
- 'SubmitTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1603792267000',
- ],
- 'JobName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'SparkPi',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'j202010271750hangzhouf742a4330000950',
- ],
- 'VcName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MyCluster',
- ],
- 'ExecutorInstances' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'SubmitTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2020-10-27 17:51:05',
- ],
- 'Detail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"args":["100"],"name":...}',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Data' => ['description' => 'The returned log.', 'type' => 'string', 'example' => 'local:///opt/spark/jars/offline-sql.jar, main_file\\n+ exec /usr/bin/tini -s -- /jdk/jdk8/bin/java -cp \'/opt/tools/exec-wrapper.jar:.:::/opt/spark/jars/*\' com.aliyun.dla.spark.SparkJobWrapper /opt/spark/bin/spark-submit --conf spark.driver.host=172.16.6.205 --conf spark.ui.port=4040 --conf \'spark.driver.extraJavaOptions=-Dlog4j.configuration=file:///opt/spark/log-conf/log4j.properties -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp/dump.hprof -XX:OnOutOfMemoryError=\\"bash /opt/tools/oss-cp.sh /tmp/dump.hprof oss://dla-test-cn-hangzhou/spark-logs/release-test/j202105272322hangzhou5d64f1560000128-0001/driver/dump.hprof; bash /opt/tools/job-stop.sh\\" \'', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9CE8F271-F918-43B6-8F58-F9F1C2DCFDB8', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E18B0634-F003-486A-90B9-4AA6932DA3AA\\",\\n \\"DataResult\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"4998\\",\\n \\"JobList\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"UpdateTime\\": \\"2020-10-27 17:51:05\\",\\n \\"ExecutorResourceSpec\\": \\"small\\",\\n \\"CreateTime\\": \\"2020-10-27 17:51:05\\",\\n \\"CreateTimeValue\\": \\"1603792267000\\",\\n \\"DriverResourceSpec\\": \\"small\\",\\n \\"UpdateTimeValue\\": \\"1603792267000\\",\\n \\"SparkUI\\": \\"https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx\\",\\n \\"SubmitTimeValue\\": \\"1603792267000\\",\\n \\"JobName\\": \\"SparkPi\\",\\n \\"JobId\\": \\"j202010271750hangzhouf742a4330000950\\",\\n \\"VcName\\": \\"MyCluster\\",\\n \\"ExecutorInstances\\": \\"100\\",\\n \\"SubmitTime\\": \\"2020-10-27 17:51:05\\",\\n \\"Detail\\": \\"{\\\\\\"args\\\\\\":[\\\\\\"100\\\\\\"],\\\\\\"name\\\\\\":...}\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DataResult>\\n <TotalCount>4998</TotalCount>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <JobList>\\n <ExecutorInstances>2</ExecutorInstances>\\n <Status>success</Status>\\n <VcName>MyCluster</VcName>\\n <SparkUI>https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx</SparkUI>\\n <DriverResourceSpec>small</DriverResourceSpec>\\n <CreateTime>2020-10-27 17:51:07</CreateTime>\\n <JobName>localFile</JobName>\\n <ExecutorResourceSpec>small</ExecutorResourceSpec>\\n <SubmitTime>2020-10-27 17:50:43</SubmitTime>\\n <CreateTimeValue>1603792267000</CreateTimeValue>\\n <UpdateTimeValue>1603792302000</UpdateTimeValue>\\n <SubmitTimeValue>1603792243000</SubmitTimeValue>\\n <UpdateTime>2020-10-27 17:51:42</UpdateTime>\\n <Detail>{\\"args\\":[\\"100\\"],\\"name\\"f}</Detail>\\n <JobId>j202010271750hangzhouf742a4330000950</JobId>\\n </JobList>\\n <JobList>\\n <ExecutorInstances>2</ExecutorInstances>\\n <Status>error</Status>\\n <VcName>MyCluster</VcName>\\n <SparkUI>https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx</SparkUI>\\n <DriverResourceSpec>small</DriverResourceSpec>\\n <CreateTime>2020-10-27 17:51:05</CreateTime>\\n <JobName>localFile</JobName>\\n <ExecutorResourceSpec>small</ExecutorResourceSpec>\\n <SubmitTime>2020-10-27 17:50:39</SubmitTime>\\n <CreateTimeValue>1603792265000</CreateTimeValue>\\n <UpdateTimeValue>1603792300000</UpdateTimeValue>\\n <SubmitTimeValue>1603792239000</SubmitTimeValue>\\n <UpdateTime>2020-10-27 17:51:40</UpdateTime>\\n <Detail>{\\"args\\":[\\"100\\"],\\"name\\"f}</Detail>\\n <JobId>j202010271750hangzhouf742a4330000949</JobId>\\n </JobList>\\n</DataResult>\\n<RequestId>E18B0634-F003-486A-90B9-4AA6932DA3AA</RequestId>","errorExample":""}]',
- 'title' => 'ListSparkJob',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"local:///opt/spark/jars/offline-sql.jar, main_file\\\\\\\\n+ exec /usr/bin/tini -s -- /jdk/jdk8/bin/java -cp \'/opt/tools/exec-wrapper.jar:.:::/opt/spark/jars/*\' com.aliyun.dla.spark.SparkJobWrapper /opt/spark/bin/spark-submit --conf spark.driver.host=172.16.6.205 --conf spark.ui.port=4040 --conf \'spark.driver.extraJavaOptions=-Dlog4j.configuration=file:///opt/spark/log-conf/log4j.properties -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp/dump.hprof -XX:OnOutOfMemoryError=\\\\\\\\\\\\\\"bash /opt/tools/oss-cp.sh /tmp/dump.hprof oss://dla-test-cn-hangzhou/spark-logs/release-test/j202105272322hangzhou5d64f1560000128-0001/driver/dump.hprof; bash /opt/tools/job-stop.sh\\\\\\\\\\\\\\" \'\\",\\n \\"RequestId\\": \\"9CE8F271-F918-43B6-8F58-F9F1C2DCFDB8\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve job logs',
+ 'summary' => 'Retrieves the log of a specified JobAttempt.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SubmitSparkJob' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetJobDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'VcName',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MyCluster',
- ],
+ 'schema' => ['description' => 'The Spark job ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202010271622hangzhouf742a4330000923', 'title' => ''],
],
[
- 'name' => 'ConfigJson',
+ 'name' => 'VcName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{ "name": "SparkPi", "file": "local:///tmp/spark-examples.jar", "className": "org.apache.spark.examples.SparkPi", "args": [ "100" ], "conf": { "spark.driver.resourceSpec": "medium", "spark.executor.instances": 5, "spark.executor.resourceSpec": "medium" } }',
- ],
+ 'schema' => ['description' => 'The name of the virtual cluster that runs the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MyCluster', 'title' => ''],
],
],
'responses' => [
@@ -572,65 +292,96 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'j202011032013hangzhouf742a4330003679',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C039FD4D-2F3C-4556-AF09-864D3A6485B2',
+ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '5F10AB6E-8984-4E32-B821-4E1512711B8C', 'title' => ''],
+ 'JobDetail' => [
+ 'description' => 'The details of the Spark job.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status code of the Spark job.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the Spark job status was last updated. The time zone is the time zone of the region where the job runs.', 'type' => 'string', 'example' => '2020-10-27 16:23:16', 'title' => ''],
+ 'ExecutorResourceSpec' => ['description' => 'The compute resource specifications of the executor. Valid values:'."\n"
+ ."\n"
+ .'- **small**: 1 core, 4 GB'."\n"
+ ."\n"
+ .'- **medium**: 2 cores, 8 GB'."\n"
+ ."\n"
+ .'- **large**: 4 cores, 16 GB'."\n"
+ ."\n"
+ .'- **xlarge**: 8 cores, 32 GB.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the Spark job started to run. The time zone is the time zone of the region where the job runs.', 'type' => 'string', 'example' => '2020-10-27 16:23:16', 'title' => ''],
+ 'DriverResourceSpec' => ['description' => 'The compute resource specifications of the driver. Valid values:'."\n"
+ ."\n"
+ .'- **small**: 1 core, 4 GB'."\n"
+ ."\n"
+ .'- **medium**: 2 cores, 8 GB'."\n"
+ ."\n"
+ .'- **large**: 4 cores, 16 GB'."\n"
+ ."\n"
+ .'- **xlarge**: 8 cores, 32 GB.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'CreateTimeValue' => ['description' => 'The timestamp in milliseconds when the Spark job started to run.', 'type' => 'string', 'example' => '1603786996000', 'title' => ''],
+ 'UpdateTimeValue' => ['description' => 'The timestamp in milliseconds when the Spark job status was last updated.', 'type' => 'string', 'example' => '1603786996000', 'title' => ''],
+ 'SparkUI' => ['description' => 'The Spark UI of the Spark job. For more information, see [Configure Spark UI](~~163470~~).', 'type' => 'string', 'example' => 'https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx', 'title' => ''],
+ 'LastJobAttemptId' => ['description' => 'The ID of the most recent attempt to run the Spark job.', 'type' => 'string', 'example' => '202105251618hzslot9906b0b40000005-0001', 'title' => ''],
+ 'SubmitTimeValue' => ['description' => 'The timestamp in milliseconds when the Spark job was submitted.', 'type' => 'string', 'example' => '1603786996000', 'title' => ''],
+ 'JobName' => ['description' => 'The name of the Spark job.', 'type' => 'string', 'example' => 'SparkPi', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'example' => 'j202010271622hangzhouf742a4330000923', 'title' => ''],
+ 'ExecutorInstances' => ['description' => 'The number of executors for the Spark job.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'VcName' => ['description' => 'The name of the virtual cluster that runs the Spark job.', 'type' => 'string', 'example' => 'MyCluster', 'title' => ''],
+ 'SubmitTime' => ['description' => 'The time when the Spark job was submitted. The time zone is the time zone of the region where the job runs.', 'type' => 'string', 'example' => '2020-10-27 16:23:16', 'title' => ''],
+ 'Detail' => ['description' => 'The JSON string that defines the Spark job.', 'type' => 'string', 'example' => '{\\"args\\":[\\"100\\"],\\"name\\":\\"SparkPi\\",\\"className\\":\\"org.apache.spark.examples.SparkPi\\",\\"conf\\":{\\"spark.driver.resourceSpec\\":\\"medium\\",\\"spark.executor.instances\\":5,\\"spark.executor.resourceSpec\\":\\"medium\\"},\\"file\\":\\"local:///tmp/spark-examples.jar\\"}', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"j202011032013hangzhouf742a4330003679\\",\\n \\"RequestId\\": \\"C039FD4D-2F3C-4556-AF09-864D3A6485B2\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C039FD4D-2F3C-4556-AF09-864D3A6485B2</RequestId>\\n<JobId>j202011032013hangzhouf742a4330003679</JobId>","errorExample":""}]',
- 'title' => 'SubmitSparkJob',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5F10AB6E-8984-4E32-B821-4E1512711B8C\\",\\n \\"JobDetail\\": {\\n \\"Status\\": \\"success\\",\\n \\"UpdateTime\\": \\"2020-10-27 16:23:16\\",\\n \\"ExecutorResourceSpec\\": \\"small\\",\\n \\"CreateTime\\": \\"2020-10-27 16:23:16\\",\\n \\"DriverResourceSpec\\": \\"small\\",\\n \\"CreateTimeValue\\": \\"1603786996000\\",\\n \\"UpdateTimeValue\\": \\"1603786996000\\",\\n \\"SparkUI\\": \\"https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx\\",\\n \\"LastJobAttemptId\\": \\"202105251618hzslot9906b0b40000005-0001\\",\\n \\"SubmitTimeValue\\": \\"1603786996000\\",\\n \\"JobName\\": \\"SparkPi\\",\\n \\"JobId\\": \\"j202010271622hangzhouf742a4330000923\\",\\n \\"ExecutorInstances\\": \\"1\\",\\n \\"VcName\\": \\"MyCluster\\",\\n \\"SubmitTime\\": \\"2020-10-27 16:23:16\\",\\n \\"Detail\\": \\"{\\\\\\\\\\\\\\"args\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"100\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SparkPi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"className\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"org.apache.spark.examples.SparkPi\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"conf\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"spark.driver.resourceSpec\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"medium\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"spark.executor.instances\\\\\\\\\\\\\\":5,\\\\\\\\\\\\\\"spark.executor.resourceSpec\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"medium\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"file\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"local:///tmp/spark-examples.jar\\\\\\\\\\\\\\"}\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve the details of a spark job',
+ 'summary' => 'Calls GetJobDetail to retrieve the details of a Spark job.',
'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
+ 'responseParamsDescription' => '**Job status codes**'."\n"
+ .'| Status code | Description |'."\n"
+ .'|----------|--------------------------------------|'."\n"
+ .'| starting | The job is starting and has not been run. |'."\n"
+ .'| running | The job is running. |'."\n"
+ .'| error | The program in the job failed and threw an exception. |'."\n"
+ .'| dead | The job failed due to insufficient resources or other issues. |'."\n"
+ .'| killed | The job was canceled while running. |'."\n"
+ .'| success | The job ran successfully. |.',
'extraInfo' => ' ',
- ],
- 'KillSparkJob' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetJobLog' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'VcName',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MyCluster',
- ],
+ 'schema' => ['description' => 'The ID of the Spark job. You can log on to the [DLA console](https://datalakeanalytics.console.aliyun.com/) and obtain the job ID from the job list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202010271622hangzhouf742a4330000923', 'title' => ''],
],
[
- 'name' => 'JobId',
+ 'name' => 'VcName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202011031935hangzhouf742a4330003667',
- ],
+ 'schema' => ['description' => 'The name of the virtual cluster in which the job is executed.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MyCluster', 'title' => ''],
],
],
'responses' => [
@@ -638,90 +389,49 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'deleted',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '3970ACB5-3E30-4A3A-B63A-1790FCC261F4',
- ],
+ 'Data' => ['description' => 'The log content of the job.', 'type' => 'string', 'example' => 'INFO SparkContext: Running Spark version 2.x', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EC031B4B-3E07-40D2-9BC5-xxxx', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"deleted\\",\\n \\"RequestId\\": \\"3970ACB5-3E30-4A3A-B63A-1790FCC261F4\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3970ACB5-3E30-4A3A-B63A-1790FCC261F4</RequestId>\\n<Data>deleted</Data>","errorExample":""}]',
- 'title' => 'KillSparkJob',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"INFO SparkContext: Running Spark version 2.x\\",\\n \\"RequestId\\": \\"EC031B4B-3E07-40D2-9BC5-xxxx\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve spark job log',
+ 'summary' => 'Retrieves the log of a Spark job.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CreateInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetJobStatus' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
- ],
- [
- 'name' => 'ChargeType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'POSTPAY',
- ],
- ],
- [
- 'name' => 'InstanceType',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'CU_PRESTO',
- ],
+ 'schema' => ['description' => 'The ID of the Spark job. You can log on to the [DLA console](https://datalakeanalytics.console.aliyun.com/) and obtain the job ID from the job list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202011031935hangzhouf742a4330003667', 'title' => ''],
],
[
- 'name' => 'Component',
+ 'name' => 'VcName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '"{\\"operable\\":\\"false\\",\\"max_cu\\":\\"8\\",\\"instance_name\\":\\"api-test-9\\",\\"min_cu\\":\\"0\\",\\"engine\\":\\"spark\\",\\"region\\":\\"cn-hangzhou\\",\\"app_name\\":\\"xx\\",\\"app_version_name\\":\\"xx\\"}"',
- ],
+ 'schema' => ['description' => 'The name of the virtual cluster that runs the job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MyCluster', 'title' => ''],
],
],
'responses' => [
@@ -729,100 +439,51 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '312F48C7-AFA0-46AA-B8F6-1B16B8808045',
- ],
- 'ErrorInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'An internal error occurred',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '600',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Status' => ['description' => 'The status code of the job execution.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5C3F9ADD-2350-4C21-A3A1-A906F8DF8016', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'Openanalytics.Unauthorized.Exception',
- 'errorMessage' => 'You do not have permission to perform the operation.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'Openanalytics.NotFound.Exception',
- 'errorMessage' => 'The specified instance does not exist.',
- ],
- ],
- 600 => [
- [
- 'errorCode' => 'Openanalytics.Internal.Exception',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"312F48C7-AFA0-46AA-B8F6-1B16B8808045\\",\\n \\"ErrorInfo\\": \\"An internal error occurred\\",\\n \\"Result\\": \\"true\\",\\n \\"ErrorCode\\": \\"600\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>312F48C7-AFA0-46AA-B8F6-1B16B8808045</RequestId>\\n<ErrorInfo>An internal error occurred</ErrorInfo>\\n<ErrorCode>600</ErrorCode>\\n<Success>true</Success>\\n<Result>true</Result>","errorExample":""}]',
- 'title' => 'CreateInstance',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"success\\",\\n \\"RequestId\\": \\"5C3F9ADD-2350-4C21-A3A1-A906F8DF8016\\"\\n}","type":"json"}]',
+ 'title' => 'Retrieve the execution status of a spark job',
+ 'summary' => 'Retrieves the execution status of a Spark job.',
'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
+ 'responseParamsDescription' => '**Job status codes**'."\n"
+ .'| Status code | Description |'."\n"
+ .'|-------------|----------------------------------------------------------|'."\n"
+ .'| starting | The job is starting and has not been executed yet. |'."\n"
+ .'| running | The job is being executed. |'."\n"
+ .'| error | The program in the job failed and threw an exception. |'."\n"
+ .'| dead | The job failed due to resource issues or other problems. |'."\n"
+ .'| killed | The running job was canceled. |'."\n"
+ .'| success | The job was executed successfully. |.',
'extraInfo' => ' ',
- ],
- 'ReleaseInstance' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetSparkSessionState' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
- 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'RegionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
- ],
- [
- 'name' => 'InstanceId',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dla-3qntmdtbqklsbsmceu****',
- ],
+ 'schema' => ['description' => 'The ID of the Spark job. You can log on to the [DLA console](https://datalakeanalytics.console.aliyun.com/) and obtain the job ID from the job list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202104171040zjkb4cc449d0000000', 'title' => ''],
],
],
'responses' => [
@@ -830,92 +491,46 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '312F48C7-AFA0-46AA-B8F6-1B16B8808045',
- ],
- 'ErrorInfo' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'An internal error occurred',
- ],
- 'Result' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '600',
- ],
- 'Success' => [
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'State' => ['description' => 'The internal status of the Spark job, such as running, success, starting, killing, or failed.', 'type' => 'string', 'example' => 'killed', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '9AD49396-8F80-5511-9268-A6360B205136', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 401 => [
- [
- 'errorCode' => 'Openanalytics.Unauthorized.Exception',
- 'errorMessage' => 'You do not have permission to perform the operation.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'Openanalytics.NotFound.Exception',
- 'errorMessage' => 'The specified instance does not exist.',
- ],
- ],
- 600 => [
- [
- 'errorCode' => 'Openanalytics.Internal.Exception',
- 'errorMessage' => 'An internal error occurred.',
- ],
- ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"State\\": \\"killed\\",\\n \\"RequestId\\": \\"9AD49396-8F80-5511-9268-A6360B205136\\"\\n}","type":"json"}]',
+ 'title' => 'Get interactive spark job status',
+ 'summary' => 'Retrieves the status of an interactive Spark job.',
+ 'description' => 'Retrieves the status of the current session.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"312F48C7-AFA0-46AA-B8F6-1B16B8808045\\",\\n \\"ErrorInfo\\": \\"An internal error occurred\\",\\n \\"Result\\": \\"true\\",\\n \\"ErrorCode\\": \\"600\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<requestId>312F48C7-AFA0-46AA-B8F6-1B16B8808045</requestId>\\n<result>true</result>\\n<success>true</success>","errorExample":""}]',
- 'title' => 'ReleaseInstance',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'ramActions' => [],
],
- 'ValidateVirtualClusterName' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetSparkStatement' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [],
'parameters' => [
[
- 'name' => 'VcName',
+ 'name' => 'StatementId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abc123',
- ],
+ 'schema' => ['description' => 'The unique ID of the code block in the Spark job.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The unique ID of the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202106071620hangzhou00000000001', 'title' => ''],
],
],
'responses' => [
@@ -923,54 +538,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C039FD4D-2F3C-4556-AF09-864D3A6485B2',
- ],
+ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'C5DB60E0-6EB3-493C-8956-DA0D3A2EE656', 'title' => ''],
'Data' => [
- 'description' => '',
+ 'description' => 'The execution status of the code block.',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'Legal' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Process' => ['description' => 'The current execution progress of the code block. The value is a floating-point number. `1` indicates 100% completion, and `0.5` indicates 50% completion.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''],
+ 'CompletedTime' => ['description' => 'The UNIX timestamp in milliseconds when the code execution ended.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623033200754', 'title' => ''],
+ 'State' => ['description' => 'The execution status of the code block. Valid values:'."\n"
+ ."\n"
+ .'- waiting: waiting for execution.'."\n"
+ .'- running: currently executing.'."\n"
+ .'- available: execution completed.'."\n"
+ .'- error: execution failed.'."\n"
+ .'- cancelling: attempting to stop.'."\n"
+ .'- cancelled: execution stopped.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'StartedTime' => ['description' => 'The UNIX timestamp in milliseconds when the code execution started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623033200750', 'title' => ''],
+ 'Code' => ['description' => 'The submitted code block.', 'type' => 'string', 'example' => 'print(2+2)', 'title' => ''],
+ 'Output' => ['description' => 'The execution result of the code block. The result is a JSON-formatted string with the following structure:'."\n"
+ ."\n"
+ .'- status: the execution status.'."\n"
+ .'- execution_count: the line number of the code block that is currently being executed.'."\n"
+ .'- data: the code execution result.', 'type' => 'string', 'example' => '"{\\"status\\":\\"ok\\",\\"execution_count\\":1,\\"data\\":{\\"text/plain\\":\\"4\\"}}"', 'title' => ''],
+ 'Id' => ['description' => 'The unique increment ID of the code block in the Spark job.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [
- 404 => [
- [
- 'errorCode' => 'EmptyResult',
- 'errorMessage' => 'The result is empty.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C039FD4D-2F3C-4556-AF09-864D3A6485B2\\",\\n \\"Data\\": {\\n \\"Message\\": \\"null\\",\\n \\"Legal\\": \\"true\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C039FD4D-2F3C-4556-AF09-864D3A6485B2</RequestId>\\n<Data>\\n <Message>null</Message>\\n <Legal>true</Legal>\\n</Data>","errorExample":""}]',
- 'title' => 'ValidateVirtualClusterName',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5DB60E0-6EB3-493C-8956-DA0D3A2EE656\\",\\n \\"Data\\": {\\n \\"Process\\": 0.5,\\n \\"CompletedTime\\": 1623033200754,\\n \\"State\\": \\"running\\",\\n \\"StartedTime\\": 1623033200750,\\n \\"Code\\": \\"print(2+2)\\",\\n \\"Output\\": \\"\\\\\\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ok\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"execution_count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"text/plain\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\"}}\\\\\\"\\",\\n \\"Id\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'Get the execution status of a code block',
+ 'summary' => 'Retrieves the execution status of a specified code block.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SubmitSparkSQL' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'KillSparkJob' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -983,24 +600,12 @@
[
'name' => 'VcName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'MySparkCluster',
- ],
+ 'schema' => ['description' => 'The name of the virtual cluster that runs the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MyCluster', 'title' => ''],
],
[
- 'name' => 'Sql',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'set spark.driver.resourceSpec=medium;set spark.executor.instances=5; set spark.executor.resourceSpec=medium; set spark.app.name=sparksqltest; show databases;',
- ],
+ 'schema' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202011031935hangzhouf742a4330003667', 'title' => ''],
],
],
'responses' => [
@@ -1008,64 +613,60 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'j202104261729hangzhou224ee5230000930',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'B570310A-8A49-461B-B81D-AE0B58D63DA4',
- ],
+ 'Data' => ['description' => 'The execution result. A value of `deleted` indicates that the operation is successful.', 'type' => 'string', 'example' => 'deleted', 'title' => ''],
+ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '3970ACB5-3E30-4A3A-B63A-1790FCC261F4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"j202104261729hangzhou224ee5230000930\\",\\n \\"RequestId\\": \\"B570310A-8A49-461B-B81D-AE0B58D63DA4\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>B570310A-8A49-461B-B81D-AE0B58D63DA4</RequestId>\\n<JobId>j202104261729hangzhou224ee5230000930</JobId>","errorExample":""}]',
- 'title' => 'SubmitSparkSQL',
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"deleted\\",\\n \\"RequestId\\": \\"3970ACB5-3E30-4A3A-B63A-1790FCC261F4\\"\\n}","type":"json"}]',
+ 'title' => 'Forcefully stop a running spark job',
+ 'summary' => 'Calls KillSparkJob to forcefully stop a running Spark job.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'CancelSparkStatement' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListSparkJob' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'systemTags' => [],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'StatementId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2026****',
- ],
+ 'name' => 'VcName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the virtual cluster that runs Spark jobs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySparkCluster', 'title' => ''],
],
[
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202106071620hangzhou****',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Pages start from page 1. This parameter is used to traverse all data.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of jobs to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'Condition',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The filter condition for retrieving historical job details of the Spark virtual cluster. If you leave this parameter empty, no filter condition is applied.', 'type' => 'object', 'required' => false, 'example' => '{ "createTime":"2020-12-28 09:00:00", "jobName":"SparkPi" }', 'title' => ''],
],
],
'responses' => [
@@ -1073,74 +674,124 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '341ADFA1-4A68-4707-9CA7-FA86523A5F14',
+ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'E18B0634-F003-486A-90B9-4AA6932DA3AA', 'title' => ''],
+ 'DataResult' => [
+ 'description' => 'The list of historical job results of the virtual cluster.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of jobs returned per page.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of historical jobs that can be queried.', 'type' => 'string', 'example' => '4998', 'title' => ''],
+ 'JobList' => [
+ 'description' => 'The array of historical job details.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status code of the job.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the job status was last updated. The time zone is the time zone of the region where the cluster resides.', 'type' => 'string', 'example' => '2020-10-27 17:51:05', 'title' => ''],
+ 'ExecutorResourceSpec' => ['description' => 'The resource specifications of the executor requested by the job.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the Spark job was created. The time zone is the time zone of the region where the cluster resides.', 'type' => 'string', 'example' => '2020-10-27 17:51:05', 'title' => ''],
+ 'CreateTimeValue' => ['description' => 'The timestamp in milliseconds when the Spark job was created.', 'type' => 'string', 'example' => '1603792267000', 'title' => ''],
+ 'DriverResourceSpec' => ['description' => 'The instance specifications of the driver requested by the job.', 'type' => 'string', 'example' => 'small', 'title' => ''],
+ 'UpdateTimeValue' => ['description' => 'The timestamp in milliseconds when the job status was last updated.', 'type' => 'string', 'example' => '1603792267000', 'title' => ''],
+ 'SparkUI' => ['description' => 'The Spark UI of the job. For more information, refer to [Spark UI](~~163470~~) in References.', 'type' => 'string', 'example' => 'https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx', 'title' => ''],
+ 'SubmitTimeValue' => ['description' => 'The timestamp in milliseconds when the job was submitted.', 'type' => 'string', 'example' => '1603792267000', 'title' => ''],
+ 'JobName' => ['description' => 'The name of the Spark job.', 'type' => 'string', 'example' => 'SparkPi', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'example' => 'j202010271750hangzhouf742a4330000950', 'title' => ''],
+ 'VcName' => ['description' => 'The name of the virtual cluster that runs the job.', 'type' => 'string', 'example' => 'MyCluster', 'title' => ''],
+ 'ExecutorInstances' => ['description' => 'The number of executors requested by the job.', 'type' => 'string', 'example' => '100', 'title' => ''],
+ 'SubmitTime' => ['description' => 'The time when the job was submitted. The time zone is the time zone of the region where the cluster resides.', 'type' => 'string', 'example' => '2020-10-27 17:51:05', 'title' => ''],
+ 'Detail' => ['description' => 'The JSON-formatted string that describes the job.', 'type' => 'string', 'example' => '{"args":["100"],"name":...}', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"341ADFA1-4A68-4707-9CA7-FA86523A5F14\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>341ADFA1-4A68-4707-9CA7-FA86523A5F14</RequestId>\\n<Data>true</Data>","errorExample":""}]',
- 'title' => 'CancelSparkStatement',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- ],
- 'ExecuteSparkStatement' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E18B0634-F003-486A-90B9-4AA6932DA3AA\\",\\n \\"DataResult\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"4998\\",\\n \\"JobList\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"UpdateTime\\": \\"2020-10-27 17:51:05\\",\\n \\"ExecutorResourceSpec\\": \\"small\\",\\n \\"CreateTime\\": \\"2020-10-27 17:51:05\\",\\n \\"CreateTimeValue\\": \\"1603792267000\\",\\n \\"DriverResourceSpec\\": \\"small\\",\\n \\"UpdateTimeValue\\": \\"1603792267000\\",\\n \\"SparkUI\\": \\"https://dlaui-cn-hangzhou.aliyuncs.com/?token=xxx\\",\\n \\"SubmitTimeValue\\": \\"1603792267000\\",\\n \\"JobName\\": \\"SparkPi\\",\\n \\"JobId\\": \\"j202010271750hangzhouf742a4330000950\\",\\n \\"VcName\\": \\"MyCluster\\",\\n \\"ExecutorInstances\\": \\"100\\",\\n \\"SubmitTime\\": \\"2020-10-27 17:51:05\\",\\n \\"Detail\\": \\"{\\\\\\"args\\\\\\":[\\\\\\"100\\\\\\"],\\\\\\"name\\\\\\":...}\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve historical job information of a DLA spark virtual cluster',
+ 'summary' => 'Retrieves historical job details of a Data Lake Analytics (DLA) Spark virtual cluster by page.',
+ 'requestParamsDescription' => ' Condition is a JSON-formatted string. The following parameters are supported:'."\n"
+ .'- status: the status of the Spark job. Valid values:'."\n"
+ .' - starting: The job is being submitted.'."\n"
+ .' - running: The job is running.'."\n"
+ .' - success: The job succeeded.'."\n"
+ .' - error: The job failed.'."\n"
+ .' - killed: The job was canceled.'."\n"
+ .' - unknown: The job status is unknown.'."\n"
+ .' - dead: The job failed to start.'."\n"
+ .'- createTime: filters jobs submitted after the specified time. The format is yyyy-mm-dd HH:mm:ss. When you specify this parameter, you must also specify timeZone.'."\n"
+ .'- timeZone: the time zone of the createTime string, such as Asia/Shanghai.'."\n"
+ .'- jobId: the ID of the Spark job.'."\n"
+ .'- jobName: the name of the Spark job. Partial matching is supported.',
+ 'responseParamsDescription' => '**Job status codes**'."\n"
+ .'| Status code | Description |'."\n"
+ .'|-------------|---------------------------------------------|'."\n"
+ .'| starting | The job is starting and has not been executed. |'."\n"
+ .'| running | The job is running. |'."\n"
+ .'| error | The program in the job failed and threw an exception. |'."\n"
+ .'| dead | The job failed due to resource issues. |'."\n"
+ .'| killed | The job was canceled during execution. |'."\n"
+ .'| success | The job was executed successfully. |.',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListSparkJobAttempt' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'Code',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'print(2+2)\\n',
- ],
+ 'name' => 'VcName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the virtual cluster in which the Spark job runs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'release-test', 'title' => ''],
],
[
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202106071620hangzhou****',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number to query. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
- 'name' => 'Kind',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'sql',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of jobs to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'Condition',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The filter conditions for JobAttempt in JSON format.', 'type' => 'object', 'required' => false, 'example' => '{"status":"success", "createTime":"2021-05-27 11:00:00", "timeZone":"Asia/Shanghai"}', 'title' => ''],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The Spark job ID. You can view the job ID on the job management page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202105272322hangzhou5d64f1560000128', 'title' => ''],
],
],
'responses' => [
@@ -1148,54 +799,85 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '0DC5B6F080E8-0DC5B6F080E8-0DC5B',
+ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '4A839055-70C7-423D-A6F2-E714EA4502DB', 'title' => ''],
+ 'DataResult' => [
+ 'description' => 'The returned result.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'string', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of JobAttempts.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'JobAttemptList' => [
+ 'description' => 'The list of JobAttempts.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => 'The status of the JobAttempt.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'DurationTime' => ['description' => 'The duration of the JobAttempt.', 'type' => 'string', 'example' => '00:01:12', 'title' => ''],
+ 'TerminatedTime' => ['description' => 'The termination time.', 'type' => 'string', 'example' => '2021-05-27 23:23:20', 'title' => ''],
+ 'DurationTimeValue' => ['description' => 'The duration timestamp.', 'type' => 'string', 'example' => '72000', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time of the JobAttempt.', 'type' => 'string', 'example' => '2021-05-27 23:22:08', 'title' => ''],
+ 'CreateTimeValue' => ['description' => 'The creation timestamp of the JobAttempt.', 'type' => 'string', 'example' => '1622128928000', 'title' => ''],
+ 'SparkUI' => ['description' => 'The SparkUI address.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'JobAttemptId' => ['description' => 'The job attempt ID.', 'type' => 'string', 'example' => 'j202105272322hangzhou5d64f1560000128-0001', 'title' => ''],
+ 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'j202105272322hangzhou5d64f1560000128', 'title' => ''],
+ 'TerminatedTimeValue' => ['description' => 'The termination timestamp.', 'type' => 'string', 'example' => '1622129000000', 'title' => ''],
+ 'VcName' => ['description' => 'The virtual cluster name.', 'type' => 'string', 'example' => 'release-test', 'title' => ''],
+ 'Detail' => ['description' => 'The job configuration.', 'type' => 'string', 'example' => '{"xxx":"xxx"}', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"2\\",\\n \\"RequestId\\": \\"0DC5B6F080E8-0DC5B6F080E8-0DC5B\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0DC5B6F080E8-0DC5B6F080E8-0DC5B</RequestId>\\n<Data>2</Data>","errorExample":""}]',
- 'title' => 'ExecuteSparkStatement',
- 'requestParamsDescription' => ' ',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A839055-70C7-423D-A6F2-E714EA4502DB\\",\\n \\"DataResult\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"JobAttemptList\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"DurationTime\\": \\"00:01:12\\",\\n \\"TerminatedTime\\": \\"2021-05-27 23:23:20\\",\\n \\"DurationTimeValue\\": \\"72000\\",\\n \\"CreateTime\\": \\"2021-05-27 23:22:08\\",\\n \\"CreateTimeValue\\": \\"1622128928000\\",\\n \\"SparkUI\\": \\"xxx\\",\\n \\"JobAttemptId\\": \\"j202105272322hangzhou5d64f1560000128-0001\\",\\n \\"JobName\\": \\"xxx\\",\\n \\"JobId\\": \\"j202105272322hangzhou5d64f1560000128\\",\\n \\"TerminatedTimeValue\\": \\"1622129000000\\",\\n \\"VcName\\": \\"release-test\\",\\n \\"Detail\\": \\"{\\\\\\"xxx\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Retrieve spark job attempt list',
+ 'summary' => 'Retrieves all JobAttempt information for a specified job.',
+ 'requestParamsDescription' => ' Condition currently supports the following two parameters:'."\n"
+ ."\n"
+ .'- status: starting, running, unknown, success, dead, killed'."\n"
+ .'- createTime: In the format of yyyy-mm-dd HH:mm:ss. Filters jobs submitted after the specified time. When this parameter is specified, timeZone must also be specified.'."\n"
+ .'- timeZone: For example, Asia/Shanghai.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetSparkSessionState' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListSparkStatements' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202104171040zjkb4cc449d0000000',
- ],
+ 'schema' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'j202106071620hangzhou00000000001', 'title' => ''],
],
],
'responses' => [
@@ -1203,63 +885,80 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'killed',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9AD49396-8F80-5511-9268-A6360B205136',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C2AB7692-B9EF-4A50-BCFF-0DC5B6F080E8', 'title' => ''],
+ 'Statements' => [
+ 'description' => 'The list of code block execution results.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Progress' => ['description' => 'The current execution progress. This is a floating-point number that represents the execution percentage. A value of 1 indicates 100% completion.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''],
+ 'CompletedTime' => ['description' => 'The timestamp in milliseconds when the execution is completed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623033200754', 'title' => ''],
+ 'State' => ['description' => 'The execution status of the code block. Valid values:'."\n"
+ ."\n"
+ .'- waiting: Waiting for execution.'."\n"
+ .'- running: Being executed.'."\n"
+ .'- available: Execution completed.'."\n"
+ .'- error: Execution failed.'."\n"
+ .'- cancelling: Attempting to stop.'."\n"
+ .'- cancelled: Execution stopped.', 'type' => 'string', 'example' => 'running', 'title' => ''],
+ 'StartedTime' => ['description' => 'The timestamp in milliseconds when the code block starts to be executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1623033200750', 'title' => ''],
+ 'Code' => ['description' => 'The code block submitted for execution.', 'type' => 'string', 'example' => 'print(2 + 2)', 'title' => ''],
+ 'Output' => ['description' => 'The execution result of the code block. The execution result is a JSON-formatted string with the following structure:'."\n"
+ ."\n"
+ .'- status: The execution status.'."\n"
+ .'- execution_count: The line number of the code block that is currently being executed.'."\n"
+ .'- data: The code execution result.', 'type' => 'string', 'example' => '{\\"status\\":\\"ok\\",\\"execution_count\\":1,\\"data\\":{\\"text/plain\\":\\"4\\"}}', 'title' => ''],
+ 'Id' => ['description' => 'The unique ID of the code block.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"State\\": \\"killed\\",\\n \\"RequestId\\": \\"9AD49396-8F80-5511-9268-A6360B205136\\"\\n}","type":"json"}]',
- ],
- 'GetSparkStatement' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2AB7692-B9EF-4A50-BCFF-0DC5B6F080E8\\",\\n \\"Statements\\": [\\n {\\n \\"Progress\\": 1,\\n \\"CompletedTime\\": 1623033200754,\\n \\"State\\": \\"running\\",\\n \\"StartedTime\\": 1623033200750,\\n \\"Code\\": \\"print(2 + 2)\\",\\n \\"Output\\": \\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ok\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"execution_count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"text/plain\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\"}}\\",\\n \\"Id\\": 2\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'List spark code blocks',
+ 'summary' => 'Retrieves the execution status of all code blocks in a Spark session.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ReleaseInstance' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'StatementId',
+ 'name' => 'RegionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '0',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
- 'name' => 'JobId',
+ 'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202106071620hangzhou00000000001',
- ],
+ 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dla-3qntmdtbqklsbsmceu****', 'title' => ''],
],
],
'responses' => [
@@ -1267,76 +966,44 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C5DB60E0-6EB3-493C-8956-DA0D3A2EE656',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Process' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.5',
- ],
- 'CompletedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1623033200754',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'StartedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1623033200750',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'print(2+2)',
- ],
- 'Output' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '"{\\"status\\":\\"ok\\",\\"execution_count\\":1,\\"data\\":{\\"text/plain\\":\\"4\\"}}"',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '312F48C7-AFA0-46AA-B8F6-1B16B8808045', 'title' => ''],
+ 'ErrorInfo' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'An internal error occurred', 'title' => ''],
+ 'Result' => ['description' => 'The result of releasing the instance.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '600', 'title' => ''],
+ 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C5DB60E0-6EB3-493C-8956-DA0D3A2EE656\\",\\n \\"Data\\": {\\n \\"Process\\": 0.5,\\n \\"CompletedTime\\": 1623033200754,\\n \\"State\\": \\"running\\",\\n \\"StartedTime\\": 1623033200750,\\n \\"Code\\": \\"print(2+2)\\",\\n \\"Output\\": \\"\\\\\\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ok\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"execution_count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"text/plain\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\"}}\\\\\\"\\",\\n \\"Id\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C5DB60E0-6EB3-493C-8956-DA0D3A2EE656</RequestId>\\n<Data>\\n <CompletedTime>1623033200754</CompletedTime>\\n <State>available</State>\\n <Output>{\\"status\\":\\"ok\\",\\"execution_count\\":1,\\"data\\":{\\"text/plain\\":\\"4\\"}}</Output>\\n <StartedTime>1623033200753</StartedTime>\\n <Process>1</Process>\\n <Id>1</Id>\\n <Code>print(2 + 2)\\n</Code>\\n</Data>","errorExample":""}]',
- 'title' => 'GetSparkStatement',
+ 'errorCodes' => [
+ 401 => [
+ ['errorCode' => 'Openanalytics.Unauthorized.Exception', 'errorMessage' => 'You do not have permission to perform the operation.', 'description' => ''],
+ ],
+ 404 => [
+ ['errorCode' => 'Openanalytics.NotFound.Exception', 'errorMessage' => 'The specified instance does not exist.', 'description' => ''],
+ ],
+ 600 => [
+ ['errorCode' => 'Openanalytics.Internal.Exception', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"312F48C7-AFA0-46AA-B8F6-1B16B8808045\\",\\n \\"ErrorInfo\\": \\"An internal error occurred\\",\\n \\"Result\\": \\"true\\",\\n \\"ErrorCode\\": \\"600\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'Release an instance',
+ 'summary' => 'Releases an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListSparkStatements' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'SubmitSparkJob' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1347,15 +1014,14 @@
'systemTags' => [],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'VcName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202106071620hangzhou00000000001',
- ],
+ 'schema' => ['description' => 'The name of the virtual cluster on which to run the job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MyCluster', 'title' => ''],
+ ],
+ [
+ 'name' => 'ConfigJson',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The JSON character string that defines the Spark job. For the metric description of the job parameters in the JSON character string, see [Job configuration guide](~~185924~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "name": "SparkPi", "file": "local:///tmp/spark-examples.jar", "className": "org.apache.spark.examples.SparkPi", "args": [ "100" ], "conf": { "spark.driver.resourceSpec": "medium", "spark.executor.instances": 5, "spark.executor.resourceSpec": "medium" } }', 'title' => ''],
],
],
'responses' => [
@@ -1363,120 +1029,48 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'C2AB7692-B9EF-4A50-BCFF-0DC5B6F080E8',
- ],
- 'Statements' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Progress' => [
- 'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'CompletedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1623033200754',
- ],
- 'State' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'running',
- ],
- 'StartedTime' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1623033200750',
- ],
- 'Code' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'print(2 + 2)',
- ],
- 'Output' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{\\"status\\":\\"ok\\",\\"execution_count\\":1,\\"data\\":{\\"text/plain\\":\\"4\\"}}',
- ],
- 'Id' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
- ],
+ 'JobId' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'example' => 'j202011032013hangzhouf742a4330003679', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C039FD4D-2F3C-4556-AF09-864D3A6485B2', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2AB7692-B9EF-4A50-BCFF-0DC5B6F080E8\\",\\n \\"Statements\\": [\\n {\\n \\"Progress\\": 1,\\n \\"CompletedTime\\": 1623033200754,\\n \\"State\\": \\"running\\",\\n \\"StartedTime\\": 1623033200750,\\n \\"Code\\": \\"print(2 + 2)\\",\\n \\"Output\\": \\"{\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ok\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"execution_count\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"text/plain\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\"}}\\",\\n \\"Id\\": 2\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C2AB7692-B9EF-4A50-BCFF-0DC5B6F080E8</RequestId>\\n<Statements>\\n <Progress>1</Progress>\\n <CompletedTime>1623033200078</CompletedTime>\\n <State>available</State>\\n <Output>{\\"status\\":\\"ok\\",\\"execution_count\\":0,\\"data\\":{\\"text/plain\\":\\"&lt;pyspark.sql.session.SparkSession object at 0x7f5e4a550390&gt;\\"}}</Output>\\n <StartedTime>1623033200077</StartedTime>\\n <Id>0</Id>\\n <Code>spark</Code>\\n</Statements>\\n<Statements>\\n <Progress>1</Progress>\\n <CompletedTime>1623033200754</CompletedTime>\\n <State>available</State>\\n <Output>{\\"status\\":\\"ok\\",\\"execution_count\\":1,\\"data\\":{\\"text/plain\\":\\"4\\"}}</Output>\\n <StartedTime>1623033200753</StartedTime>\\n <Id>1</Id>\\n <Code>print(2 + 2)\\n</Code>\\n</Statements>","errorExample":""}]',
- 'title' => 'ListSparkStatements',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"j202011032013hangzhouf742a4330003679\\",\\n \\"RequestId\\": \\"C039FD4D-2F3C-4556-AF09-864D3A6485B2\\"\\n}","type":"json"}]',
+ 'title' => 'Submit a spark job',
+ 'summary' => 'Submits a Spark job.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetJobAttemptLog' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'SubmitSparkSQL' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202105272322hangzhou5d64f1560000128',
- ],
- ],
- [
'name' => 'VcName',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'release-test',
- ],
+ 'schema' => ['description' => 'The name of the virtual cluster in which to run the Spark SQL job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySparkCluster', 'title' => ''],
],
[
- 'name' => 'JobAttemptId',
+ 'name' => 'Sql',
'in' => 'formData',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202105272322hangzhou5d64f1560000128-0001',
- ],
+ 'schema' => ['description' => 'The Spark SQL content. For more information, see [Spark SQL](~~185724~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'set spark.driver.resourceSpec=medium;set spark.executor.instances=5; set spark.executor.resourceSpec=medium; set spark.app.name=sparksqltest; show databases;', 'title' => ''],
],
],
'responses' => [
@@ -1484,36 +1078,30 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'local:///opt/spark/jars/offline-sql.jar, main_file\\n+ exec /usr/bin/tini -s -- /jdk/jdk8/bin/java -cp \'/opt/tools/exec-wrapper.jar:.:::/opt/spark/jars/*\' com.aliyun.dla.spark.SparkJobWrapper /opt/spark/bin/spark-submit --conf spark.driver.host=172.16.6.205 --conf spark.ui.port=4040 --conf \'spark.driver.extraJavaOptions=-Dlog4j.configuration=file:///opt/spark/log-conf/log4j.properties -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp/dump.hprof -XX:OnOutOfMemoryError=\\"bash /opt/tools/oss-cp.sh /tmp/dump.hprof oss://dla-test-cn-hangzhou/spark-logs/release-test/j202105272322hangzhou5d64f1560000128-0001/driver/dump.hprof; bash /opt/tools/job-stop.sh\\" \'',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '9CE8F271-F918-43B6-8F58-F9F1C2DCFDB8',
- ],
+ 'JobId' => ['description' => 'The ID of the Spark job.', 'type' => 'string', 'example' => 'j202104261729hangzhou224ee5230000930', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B570310A-8A49-461B-B81D-AE0B58D63DA4', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"local:///opt/spark/jars/offline-sql.jar, main_file\\\\\\\\n+ exec /usr/bin/tini -s -- /jdk/jdk8/bin/java -cp \'/opt/tools/exec-wrapper.jar:.:::/opt/spark/jars/*\' com.aliyun.dla.spark.SparkJobWrapper /opt/spark/bin/spark-submit --conf spark.driver.host=172.16.6.205 --conf spark.ui.port=4040 --conf \'spark.driver.extraJavaOptions=-Dlog4j.configuration=file:///opt/spark/log-conf/log4j.properties -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp/dump.hprof -XX:OnOutOfMemoryError=\\\\\\\\\\\\\\"bash /opt/tools/oss-cp.sh /tmp/dump.hprof oss://dla-test-cn-hangzhou/spark-logs/release-test/j202105272322hangzhou5d64f1560000128-0001/driver/dump.hprof; bash /opt/tools/job-stop.sh\\\\\\\\\\\\\\" \'\\",\\n \\"RequestId\\": \\"9CE8F271-F918-43B6-8F58-F9F1C2DCFDB8\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>9CE8F271-F918-43B6-8F58-F9F1C2DCFDB8</RequestId>\\n<Data>local:///opt/spark/jars/offline-sql.jar, main_file\\\\n+ exec /usr/bin/tini -s -- /jdk/jdk8/bin/java -cp \'/opt/tools/exec-wrapper.jar:.:::/opt/spark/jars/*\' com.aliyun.dla.spark.SparkJobWrapper /opt/spark/bin/spark-submit --conf spark.driver.host=172.16.6.205 --conf spark.ui.port=4040 --conf \'spark.driver.extraJavaOptions=-Dlog4j.configuration=file:///opt/spark/log-conf/log4j.properties -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp/dump.hprof -XX:OnOutOfMemoryError=\\\\\\"bash /opt/tools/oss-cp.sh /tmp/dump.hprof oss://dla-test-cn-hangzhou/spark-logs/release-test/j202105272322hangzhou5d64f1560000128-0001/driver/dump.hprof; bash /opt/tools/job-stop.sh\\\\\\" \'</Data>","errorExample":""}]',
- 'title' => 'GetJobAttemptLog',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"j202104261729hangzhou224ee5230000930\\",\\n \\"RequestId\\": \\"B570310A-8A49-461B-B81D-AE0B58D63DA4\\"\\n}","type":"json"}]',
+ 'title' => 'Submit a spark SQL job',
+ 'summary' => 'Submits a Spark SQL job.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListSparkJobAttempt' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ValidateVirtualClusterName' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1521,68 +1109,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'VcName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'release-test',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Condition',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"status":"success", "createTime":"2021-05-27 11:00:00", "timeZone":"Asia/Shanghai"}',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'j202105272322hangzhou5d64f1560000128',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'The name of the virtual cluster to validate.', 'type' => 'string', 'required' => false, 'example' => 'abc123', 'title' => ''],
],
],
'responses' => [
@@ -1590,333 +1122,144 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '4A839055-70C7-423D-A6F2-E714EA4502DB',
- ],
- 'DataResult' => [
- 'description' => '',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C039FD4D-2F3C-4556-AF09-864D3A6485B2', 'title' => ''],
+ 'Data' => [
+ 'description' => 'The validation result.',
'type' => 'object',
'properties' => [
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'JobAttemptList' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'DurationTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '00:01:12',
- ],
- 'TerminatedTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-05-27 23:23:20',
- ],
- 'DurationTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '72000',
- ],
- 'CreateTime' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-05-27 23:22:08',
- ],
- 'CreateTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1622128928000',
- ],
- 'SparkUI' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'JobAttemptId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'j202105272322hangzhou5d64f1560000128-0001',
- ],
- 'JobName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'JobId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'j202105272322hangzhou5d64f1560000128',
- ],
- 'TerminatedTimeValue' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '1622129000000',
- ],
- 'VcName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'release-test',
- ],
- 'Detail' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{"xxx":"xxx"}',
- ],
- ],
- ],
- ],
+ 'Message' => ['description' => 'The error message returned if the virtual cluster name is invalid.', 'type' => 'string', 'example' => 'null', 'title' => ''],
+ 'Legal' => ['description' => 'Indicates whether the virtual cluster name is valid. Valid values:'."\n"
+ ."\n"
+ .'- **true**: Valid.'."\n"
+ ."\n"
+ .'- **false**: Invalid.', 'type' => 'string', 'example' => 'true', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'errorCodes' => [],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A839055-70C7-423D-A6F2-E714EA4502DB\\",\\n \\"DataResult\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"JobAttemptList\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"DurationTime\\": \\"00:01:12\\",\\n \\"TerminatedTime\\": \\"2021-05-27 23:23:20\\",\\n \\"DurationTimeValue\\": \\"72000\\",\\n \\"CreateTime\\": \\"2021-05-27 23:22:08\\",\\n \\"CreateTimeValue\\": \\"1622128928000\\",\\n \\"SparkUI\\": \\"xxx\\",\\n \\"JobAttemptId\\": \\"j202105272322hangzhou5d64f1560000128-0001\\",\\n \\"JobName\\": \\"xxx\\",\\n \\"JobId\\": \\"j202105272322hangzhou5d64f1560000128\\",\\n \\"TerminatedTimeValue\\": \\"1622129000000\\",\\n \\"VcName\\": \\"release-test\\",\\n \\"Detail\\": \\"{\\\\\\"xxx\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DataResult>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <JobAttemptList>\\n <VcName>release-test</VcName>\\n <Status>success</Status>\\n <JobAttemptId>j202105272322hangzhou5d64f1560000128-0001</JobAttemptId>\\n <TerminatedTime>2021-05-27 23:23:20</TerminatedTime>\\n <SparkUI>xxx</SparkUI>\\n <DurationTimeValue>72000</DurationTimeValue>\\n <CreateTime>2021-05-27 23:22:08</CreateTime>\\n <JobName>xxx</JobName>\\n <TerminatedTimeValue>1622129000000</TerminatedTimeValue>\\n <JobId>j202105272322hangzhou5d64f1560000128</JobId>\\n <Detail>{\\"xxx\\":\\"xxx\\"}</Detail>\\n <CreateTimeValue>1622128928000</CreateTimeValue>\\n <DurationTime>00:01:12</DurationTime>\\n </JobAttemptList>\\n</DataResult>\\n<RequestId>4A839055-70C7-423D-A6F2-E714EA4502DB</RequestId>","errorExample":""}]',
- 'title' => 'ListSparkJobAttempt',
+ 'errorCodes' => [
+ 404 => [
+ ['errorCode' => 'EmptyResult', 'errorMessage' => 'The result is empty.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C039FD4D-2F3C-4556-AF09-864D3A6485B2\\",\\n \\"Data\\": {\\n \\"Message\\": \\"null\\",\\n \\"Legal\\": \\"true\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'Validate a virtual cluster name',
+ 'summary' => 'Calls ValidateVirtualClusterName to check whether a virtual cluster name is valid.',
+ 'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'openanalytics.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'openanalytics.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'openanalytics.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'openanalytics.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'openanalytics.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'openanalytics.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'openanalytics.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-2',
- 'endpoint' => 'datalakeanalytics.ap-southeast-2.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'openanalytics.ap-southeast-3.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'datalakeanalytics.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'openanalytics.eu-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'openanalytics.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'datalakeanalytics.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'datalakeanalytics.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-south-1',
- 'endpoint' => 'openanalytics.ap-south-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'openanalytics.ap-southeast-5.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'openanalytics.cn-huhehaote.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'openanalytics.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'openanalytics.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'me-east-1',
- 'endpoint' => 'openanalytics.me-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com',
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datalakeanalytics.ap-northeast-1.aliyuncs.com', 'endpoint' => 'datalakeanalytics.ap-northeast-1.aliyuncs.com', 'vpc' => 'openanalytics-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.ap-southeast-1.aliyuncs.com', 'endpoint' => 'openanalytics.ap-southeast-1.aliyuncs.com', 'vpc' => 'openanalytics-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'datalakeanalytics.ap-southeast-2.aliyuncs.com', 'endpoint' => 'datalakeanalytics.ap-southeast-2.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.ap-southeast-3.aliyuncs.com', 'endpoint' => 'openanalytics.ap-southeast-3.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.ap-southeast-5.aliyuncs.com', 'endpoint' => 'openanalytics.ap-southeast-5.aliyuncs.com', 'vpc' => 'openanalytics-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-beijing.aliyuncs.com', 'endpoint' => 'openanalytics.cn-beijing.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.aliyuncs.com', 'endpoint' => 'openanalytics.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-hangzhou.aliyuncs.com', 'endpoint' => 'openanalytics.cn-hangzhou.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-hongkong.aliyuncs.com', 'endpoint' => 'openanalytics.cn-hongkong.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-huhehaote.aliyuncs.com', 'endpoint' => 'openanalytics.cn-huhehaote.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-qingdao.aliyuncs.com', 'endpoint' => 'openanalytics.cn-qingdao.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-shanghai.aliyuncs.com', 'endpoint' => 'openanalytics.cn-shanghai.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-shenzhen.aliyuncs.com', 'endpoint' => 'openanalytics.cn-shenzhen.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'openanalytics.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'openanalytics.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'openanalytics.us-west-1.aliyuncs.com', 'endpoint' => 'openanalytics.us-west-1.aliyuncs.com', 'vpc' => 'openanalytics-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'datalakeanalytics.us-east-1.aliyuncs.com', 'endpoint' => 'datalakeanalytics.us-east-1.aliyuncs.com', 'vpc' => 'openanalytics-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'openanalytics.eu-west-1.aliyuncs.com', 'endpoint' => 'openanalytics.eu-west-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'datalakeanalytics.eu-central-1.aliyuncs.com', 'endpoint' => 'datalakeanalytics.eu-central-1.aliyuncs.com', 'vpc' => 'openanalytics-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'openanalytics.me-east-1.aliyuncs.com', 'endpoint' => 'openanalytics.me-east-1.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'openanalytics.ap-south-1.aliyuncs.com', 'endpoint' => 'openanalytics.ap-south-1.aliyuncs.com', 'vpc' => 'openanalytics-vpc.ap-south-1.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'openanalytics.aliyuncs.com', 'endpoint' => 'openanalytics.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'openanalytics.aliyuncs.com', 'endpoint' => 'openanalytics.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'openanalytics.aliyuncs.com', 'endpoint' => 'openanalytics.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-north-2-gov-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'openanalytics.aliyuncs.com', 'endpoint' => 'openanalytics.aliyuncs.com', 'vpc' => 'openanalytics-vpc.cn-hangzhou-finance.aliyuncs.com'],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'openanalytics.aliyuncs.com', 'endpoint' => 'openanalytics.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AlreadyExists', 'message' => 'The formation task already exists.', 'http_code' => 409, 'description' => ''],
+ ['code' => 'AlreadyRunning', 'message' => 'The crawler instance is already running.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Business.Not.Register', 'message' => 'Your application is not registered in DLA', 'http_code' => 403, 'description' => 'Your application is not registered in DLA'],
+ ['code' => 'EmptyResult', 'message' => 'The result is empty.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'Endpoint.Exist', 'message' => 'The specified endpoint already exists.', 'http_code' => 409, 'description' => 'The specified endpoint already exists.'],
+ ['code' => 'Endpoint.Lock', 'message' => 'The specified endpoint is locked and you are not authorized to perform the operation.You can delete it and try again.', 'http_code' => 410, 'description' => 'The specified endpoint is locked and you are not authorized to perform the operation.You can delete it and try again.'],
+ ['code' => 'Endpoint.NotFound', 'message' => 'The specified endpoint does not exist.', 'http_code' => 404, 'description' => 'The specified endpoint does not exist.'],
+ ['code' => 'InvalidInput', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'InvalidTaskStatus', 'message' => 'The formation task status is invalid.', 'http_code' => 406, 'description' => ''],
+ ['code' => 'MetaInfo.Discount.AddFailed', 'message' => 'An error occurred while adding discount information.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.Execute', 'message' => 'An SQL execution error occurred.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.Finish', 'message' => 'The table has been created.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.GeneraterDDL', 'message' => 'An error occurred while generating DDL.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.InitFailed', 'message' => 'An error occurred while initializing the table.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.MissingLocation', 'message' => 'You must specify table location.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.MissingTableName', 'message' => 'You must specify table name.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.NotFound', 'message' => 'The table does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.NotReady', 'message' => 'The table is not ready.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.NotSupport', 'message' => 'The specified data source type is invalid.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.OnlySupportCreate', 'message' => 'An SQL parsing error occurred. Only create statement is supported.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.Parser', 'message' => 'An SQL parsing error occurred.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.TaskFailed', 'message' => 'An error occurred while scheduling a job. Please try again.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'MetaInfo.GuidTable.Unauthorized', 'message' => 'You are not authorized to access the specified table.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'MissingParameter', 'message' => 'Some required parameters are missing or invalid. Please check the SDK documentation and complete the parameters.', 'http_code' => 400, 'description' => 'Some required parameters are missing or invalid. Please check the SDK documentation and complete the parameters.'],
+ ['code' => 'NotExists', 'message' => 'The formation task does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NotExists', 'message' => 'The crawler task does not exist.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'NotFound', 'message' => 'The formation task does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'NotRunning', 'message' => 'The instance is not running.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Openanalytics.Internal.Exception', 'message' => 'An internal error occurred.', 'http_code' => 600, 'description' => ''],
+ ['code' => 'Openanalytics.NotFound.Exception', 'message' => 'The specified instance does not exist.', 'http_code' => 404, 'description' => ''],
+ ['code' => 'Openanalytics.Unauthorized.Exception', 'message' => 'You do not have permission to perform the operation.', 'http_code' => 401, 'description' => ''],
+ ['code' => 'Parameter.Account.Format', 'message' => 'The account name must only contain letters (a-z, A-Z) and numbers (0-9).', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.Account.Length', 'message' => 'The account name can be 1 to 64 characters in length, and the password can be 1 to 32 characters in length.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.Account.Password', 'message' => 'The password must contain at least three types of the following characters: upper case letters, lower case letters, numbers, and special characters ( `~!@#$%^&*()_+-=[]|;\':,./<>? ).', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.Account.RamUid.ALREADY.BINGING', 'message' => 'The specified RamUid is already used by another account.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.Account.RamUid.ALREADY.BINGING.other.ramUid', 'message' => 'The current user has already bound another RamUid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.Account.RamUid.is.not.belong.to.current.uid', 'message' => 'The RamUid does not belong to the current user.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.InputError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Parameter.NetworkType', 'message' => 'The specified network type is invalid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'RamUid.is.empty', 'message' => 'You must specify RamUid.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'ServerError.Check', 'message' => 'An internal error has occurred, resulting in the failure of status check.', 'http_code' => 401, 'description' => 'An internal error has occurred, resulting in the failure of status check.'],
+ ['code' => 'ServerError.Inner', 'message' => 'An internal error occurred.', 'http_code' => 430, 'description' => ''],
+ ['code' => 'ServerError.Internal', 'message' => 'An internal error has occurred.', 'http_code' => 402, 'description' => 'An internal error has occurred.'],
+ ['code' => 'ServerError.Store', 'message' => 'An internal error has occurred, resulting in the failure of status check.', 'http_code' => 430, 'description' => 'An internal error has occurred, resulting in the failure of status check.'],
+ ['code' => 'ServerStoreError', 'message' => 'A server storage error occurred.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'Service.Forbidden', 'message' => 'The user service has been disabled. Certain user actions may have triggered the banning of using any Alibaba Cloud service. For more information, submit a service ticket.', 'http_code' => 403, 'description' => 'The user service has been disabled. Certain user actions may have triggered the banning of using any Alibaba Cloud service. For more information, submit a service ticket.'],
+ ['code' => 'Service.HasMoreResource', 'message' => 'Delete all tables, schema and endpoints before you disable the DLA service in the specified region.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'Service.Initialized', 'message' => 'The service has been initialized.', 'http_code' => 304, 'description' => 'The service has been initialized.'],
+ ['code' => 'Service.Invalid', 'message' => 'The specified service for the user has not been activated.', 'http_code' => 403, 'description' => 'The specified service for the user has not been activated.'],
+ ['code' => 'Service.NotFound', 'message' => 'The service has not been initialized.', 'http_code' => 404, 'description' => 'The service has not been initialized.'],
+ ['code' => 'User.Exist', 'message' => 'The specified user already exists.', 'http_code' => 409, 'description' => 'The specified user already exists.'],
+ ['code' => 'User.Invalid', 'message' => 'The user status is invalid or the user has unsubscribed from the DLA service.', 'http_code' => 403, 'description' => 'The user status is invalid or the user has unsubscribed from the DLA service.'],
+ ['code' => 'User.MaxCount', 'message' => 'The number of accounts has reached the maximum.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'User.MetaInfo.Invalid', 'message' => 'You need to activate MetaInfo service.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'User.NotFound', 'message' => 'The specified user does not exist.', 'http_code' => 404, 'description' => 'The specified user does not exist.'],
+ ['code' => 'User.Unauthorized', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 401, 'description' => 'You are not authorized to perform the operation.'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
+ 'ram' => [
+ 'productCode' => 'DataLakeAnalytics',
+ 'productName' => 'Data Lake Analytics',
+ 'ramCodes' => ['openanalytics'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
+ ],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:33:35 +0000