mikacur/MRS-operation-guide-lts
1
0
Fork 0
forked from docs/mapreduce-service
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2022-10-19 21:29:42 +00:00
parent 9317d125f3
commit 464bc6ed53
6 changed files with 133 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst
View File

@ -145,7 +145,7 @@ Request
| tags | No | Array | Cluster tag | | tags | No | Array | Cluster tag |
| | | | | | | | | |
| | | | - A cluster allows a maximum of 10 tags. A tag name (key) must be unique in a cluster. | | | | | - A cluster allows a maximum of 10 tags. A tag name (key) must be unique in a cluster. |
| | | | - A tag key or value cannot contain the following special characters: =*<>\,|/ | | | | | - A tag key or value cannot contain the following special characters: ``=*<>\,|/`` |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cluster_version | Yes | String | Cluster version | | cluster_version | Yes | String | Cluster version |
| | | | | | | | | |
@ -412,7 +412,7 @@ Request
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| jar_path | No | String | Path of the JAR or SQL file for program execution. The parameter must meet the following requirements: | | jar_path | No | String | Path of the JAR or SQL file for program execution. The parameter must meet the following requirements: |
| | | | | | | | | |
| | | | - Contains a maximum of 1,023 characters, excluding special characters such as ;|&><'$. The parameter value cannot be empty or full of spaces. | | | | | - Contains a maximum of 1,023 characters, excluding special characters such as ``;|&><'$.`` The parameter value cannot be empty or full of spaces. |
| | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. | | | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. |
| | | | | | | | | |
| | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. | | | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. |
@ -422,7 +422,7 @@ Request
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| arguments | No | String | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. | | arguments | No | String | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 2,047 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 2,047 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| input | No | String | Address for inputting data. | | input | No | String | Address for inputting data. |
| | | | | | | | | |
@ -431,7 +431,7 @@ Request
| | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. | | | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. |
| | | | - HDFS: The path starts with a slash (**/**). | | | | | - HDFS: The path starts with a slash (**/**). |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| output | No | String | Address for outputting data. | | output | No | String | Address for outputting data. |
| | | | | | | | | |
@ -442,7 +442,7 @@ Request
| | | | | | | | | |
| | | | If the specified path does not exist, the system will automatically create it. | | | | | If the specified path does not exist, the system will automatically create it. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_log | No | String | Path for storing job logs that record job running status. | | job_log | No | String | Path for storing job logs that record job running status. |
| | | | | | | | | |
@ -451,7 +451,7 @@ Request
| | | | - OBS: The path must start with **s3a://**. | | | | | - OBS: The path must start with **s3a://**. |
| | | | - HDFS: The path starts with a slash (**/**). | | | | | - HDFS: The path starts with a slash (**/**). |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| shutdown_cluster | No | Bool | Whether to delete the cluster after the job execution is complete | | shutdown_cluster | No | Bool | Whether to delete the cluster after the job execution is complete |
| | | | | | | | | |
@ -472,7 +472,7 @@ Request
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| hive_script_path | Yes | String | SQL program path. This parameter is needed by Spark Script and Hive Script jobs only, and must meet the following requirements: | | hive_script_path | Yes | String | SQL program path. This parameter is needed by Spark Script and Hive Script jobs only, and must meet the following requirements: |
| | | | | | | | | |
| | | | - Contains a maximum of 1,023 characters, excluding special characters such as ;|&><'$. The parameter value cannot be empty or full of spaces. | | | | | - Contains a maximum of 1,023 characters, excluding special characters such as ``;|&><'$.`` The parameter value cannot be empty or full of spaces. |
| | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. | | | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. |
| | | | | | | | | |
| | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. | | | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. |

12
api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst
View File

@ -377,7 +377,7 @@ Request
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| jar_path | No | String | Path of the JAR or SQL file for program execution. The parameter must meet the following requirements: | | jar_path | No | String | Path of the JAR or SQL file for program execution. The parameter must meet the following requirements: |
| | | | | | | | | |
| | | | - Contains a maximum of 1,023 characters, excluding special characters such as ;|&><'$. The parameter value cannot be empty or full of spaces. | | | | | - Contains a maximum of 1,023 characters, excluding special characters such as ``;|&><'$.`` The parameter value cannot be empty or full of spaces. |
| | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. | | | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. |
| | | | | | | | | |
| | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. | | | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. |
@ -387,7 +387,7 @@ Request
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| arguments | No | String | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. | | arguments | No | String | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 2,047 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 2,047 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| input | No | String | Address for inputting data | | input | No | String | Address for inputting data |
| | | | | | | | | |
@ -396,7 +396,7 @@ Request
| | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. | | | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. |
| | | | - HDFS: The path starts with a slash (**/**). | | | | | - HDFS: The path starts with a slash (**/**). |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| output | No | String | Address for outputting data | | output | No | String | Address for outputting data |
| | | | | | | | | |
@ -407,7 +407,7 @@ Request
| | | | | | | | | |
| | | | If the specified path does not exist, the system will automatically create it. | | | | | If the specified path does not exist, the system will automatically create it. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_log | No | String | Path for storing job logs that record job running status. | | job_log | No | String | Path for storing job logs that record job running status. |
| | | | | | | | | |
@ -416,7 +416,7 @@ Request
| | | | - OBS: The path must start with **s3a://**. | | | | | - OBS: The path must start with **s3a://**. |
| | | | - HDFS: The path starts with a slash (**/**). | | | | | - HDFS: The path starts with a slash (**/**). |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| shutdown_cluster | No | Bool | Whether to delete the cluster after the job execution is complete | | shutdown_cluster | No | Bool | Whether to delete the cluster after the job execution is complete |
| | | | | | | | | |
@ -437,7 +437,7 @@ Request
+-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| hive_script_path | Yes | String | SQL program path. This parameter is needed by Spark Script and Hive Script jobs only, and must meet the following requirements: | | hive_script_path | Yes | String | SQL program path. This parameter is needed by Spark Script and Hive Script jobs only, and must meet the following requirements: |
| | | | | | | | | |
| | | | - Contains a maximum of 1,023 characters, excluding special characters such as ;|&><'$. The address cannot be empty or full of spaces. | | | | | - Contains a maximum of 1,023 characters, excluding special characters such as ``;|&><'$.`` The address cannot be empty or full of spaces. |
| | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. | | | | | - Files can be stored in HDFS or OBS. The path varies depending on the file system. |
| | | | | | | | | |
| | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. | | | | | - OBS: The path must start with **s3a://**. Files or programs encrypted by KMS are not supported. |

12
api-ref/source/apis/job_object_apis_v1,_not_recommended/adding_a_job_and_executing_the_job.rst
View File

@ -63,13 +63,13 @@ Request
| | | | | | | | | |
| | | | The parameter must meet the following requirements: | | | | | The parameter must meet the following requirements: |
| | | | | | | | | |
| | | | - Contains a maximum of 1,023 characters, excluding special characters such as ;|&><'$. The address cannot be empty or full of spaces. | | | | | - Contains a maximum of 1,023 characters, excluding special characters such as ``;|&><'$.`` The address cannot be empty or full of spaces. |
| | | | - Starts with **/** or **s3a://**. The OBS path does not support files or programs encrypted by KMS. | | | | | - Starts with **/** or **s3a://**. The OBS path does not support files or programs encrypted by KMS. |
| | | | - Spark Script must end with **.sql** while MapReduce and Spark Jar must end with **.jar**.\ **sql** and **jar** are case-insensitive. | | | | | - Spark Script must end with **.sql** while MapReduce and Spark Jar must end with **.jar**.\ **sql** and **jar** are case-insensitive. |
+------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| arguments | No | String | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. | | arguments | No | String | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 2,047 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 2,047 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
| | | | | | | | | |
| | | | .. note:: | | | | | .. note:: |
| | | | | | | | | |
@ -79,21 +79,21 @@ Request
+------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| input | No | String | Path for inputting data, which must start with **/** or **s3a://**. Set this parameter to a correct OBS path. The OBS path does not support files or programs encrypted by KMS. | | input | No | String | Path for inputting data, which must start with **/** or **s3a://**. Set this parameter to a correct OBS path. The OBS path does not support files or programs encrypted by KMS. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| output | No | String | Path for outputting data, which must start with **/** or **s3a://**. A correct OBS path is required. If the path does not exist, the system automatically creates it. | | output | No | String | Path for outputting data, which must start with **/** or **s3a://**. A correct OBS path is required. If the path does not exist, the system automatically creates it. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_log | No | String | Path for storing job logs that record job running status. The path must start with **/** or **s3a://**. A correct OBS path is required. | | job_log | No | String | Path for storing job logs that record job running status. The path must start with **/** or **s3a://**. A correct OBS path is required. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 1,023 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| hive_script_path | Yes | String | SQL program path | | hive_script_path | Yes | String | SQL program path |
| | | | | | | | | |
| | | | This parameter is needed by Spark Script and Hive Script jobs only, and must meet the following requirements: | | | | | This parameter is needed by Spark Script and Hive Script jobs only, and must meet the following requirements: |
| | | | | | | | | |
| | | | - Contains a maximum of 1,023 characters, excluding special characters such as ;|&><'$. The address cannot be empty or full of spaces. | | | | | - Contains a maximum of 1,023 characters, excluding special characters such as ``;|&><'$.`` The address cannot be empty or full of spaces. |
| | | | - The path must start with **/** or **s3a://**. The OBS path does not support files or programs encrypted by KMS. | | | | | - The path must start with **/** or **s3a://**. The OBS path does not support files or programs encrypted by KMS. |
| | | | - The path must end with **.sql**.\ **sql** is case-insensitive. | | | | | - The path must end with **.sql**.\ **sql** is case-insensitive. |
+------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

4
api-ref/source/apis/job_object_apis_v2/adding_and_executing_a_job.rst
View File

@ -64,7 +64,7 @@ Request
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| arguments | No | Array | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. | | arguments | No | Array | Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 4,096 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | | | | The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
| | | | | | | | | |
| | | | .. note:: | | | | | .. note:: |
| | | | | | | | | |
@ -73,7 +73,7 @@ Request
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| properties | No | Object | Program system parameter. | | properties | No | Object | Program system parameter. |
| | | | | | | | | |
| | | | The parameter contains a maximum of 2,048 characters, excluding special characters such as ><|'`&!\, and can be left blank. | | | | | The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\,` and can be left blank. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Response

38
api-ref/source/apis/job_object_apis_v2/querying_a_list_of_jobs.rst
View File

@ -101,22 +101,22 @@ Response
.. table:: **Table 4** Job parameter description .. table:: **Table 4** Job parameter description
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+====================================================================================================================================================================================================+ +=======================+=======================+===============================================================================================================================================================================================================+
| job_id | String | Job ID | | job_id | String | Job ID |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user | String | Name of the user who submits a job. | | user | String | Name of the user who submits a job. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | | job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_result | String | Final result of a job. | | job_result | String | Final result of a job. |
| | | | | | | |
| | | - **FAILED**: indicates that the job fails to be executed. | | | | - **FAILED**: indicates that the job fails to be executed. |
| | | - **KILLED**: indicates that the job is manually terminated during execution. | | | | - **KILLED**: indicates that the job is manually terminated during execution. |
| | | - **UNDEFINED**: indicates that the job is being executed. | | | | - **UNDEFINED**: indicates that the job is being executed. |
| | | - **SUCCEEDED**: indicates that the job has been successfully executed. | | | | - **SUCCEEDED**: indicates that the job has been successfully executed. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_state | String | Execution status of a job. | | job_state | String | Execution status of a job. |
| | | | | | | |
| | | - **FAILED**: indicates that the job fails to be executed. | | | | - **FAILED**: indicates that the job fails to be executed. |
@ -127,9 +127,9 @@ Response
| | | - **ACCEPTED**: indicates that the job is accepted. | | | | - **ACCEPTED**: indicates that the job is accepted. |
| | | - **RUNNING**: indicates that the job is running. | | | | - **RUNNING**: indicates that the job is running. |
| | | - **FINISHED**: indicates that the job is completed. | | | | - **FINISHED**: indicates that the job is completed. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_progress | Float | Job execution progress. | | job_progress | Float | Job execution progress. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_type | String | Type of a job. | | job_type | String | Type of a job. |
| | | | | | | |
| | | - MapReduce | | | | - MapReduce |
@ -140,23 +140,23 @@ Response
| | | - SparkScript | | | | - SparkScript |
| | | - SparkSql | | | | - SparkSql |
| | | - Flink | | | | - Flink |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| started_time | Long | Start time to run a job. Unit: milliseconds | | started_time | Long | Start time to run a job. Unit: milliseconds |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| submitted_time | Long | Time when a job is submitted. Unit: milliseconds | | submitted_time | Long | Time when a job is submitted. Unit: milliseconds |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| finished_time | Long | End time to run a job. Unit: milliseconds | | finished_time | Long | End time to run a job. Unit: milliseconds |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| elapsed_time | Long | Running duration of a job. Unit: milliseconds | | elapsed_time | Long | Running duration of a job. Unit: milliseconds |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| arguments | Array | Run parameters. The parameter contains a maximum of 4,096 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | arguments | Array | Run parameters. The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as ><|'`&!\, and can be left blank. | | properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\,` and can be left blank. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| launcher_id | String | Launcher job ID. | | launcher_id | String | Launcher job ID. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| app_id | String | Actual job ID. | | app_id | String | Actual job ID. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Example
------- -------

38
api-ref/source/apis/job_object_apis_v2/querying_information_about_a_job.rst
View File

@ -53,22 +53,22 @@ Response
.. table:: **Table 3** Job parameter description .. table:: **Table 3** Job parameter description
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+====================================================================================================================================================================================================+ +=======================+=======================+===============================================================================================================================================================================================================+
| job_id | String | Job ID. | | job_id | String | Job ID. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user | String | Name of the user who submits a job. | | user | String | Name of the user who submits a job. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | | job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_result | String | Final result of a job. | | job_result | String | Final result of a job. |
| | | | | | | |
| | | - **FAILED**: indicates that the job fails to be executed. | | | | - **FAILED**: indicates that the job fails to be executed. |
| | | - **KILLED**: indicates that the job is manually terminated during execution. | | | | - **KILLED**: indicates that the job is manually terminated during execution. |
| | | - **UNDEFINED**: indicates that the job is being executed. | | | | - **UNDEFINED**: indicates that the job is being executed. |
| | | - **SUCCEEDED**: indicates that the job has been successfully executed. | | | | - **SUCCEEDED**: indicates that the job has been successfully executed. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_state | String | Execution status of a job. | | job_state | String | Execution status of a job. |
| | | | | | | |
| | | - FAILED: failed | | | | - FAILED: failed |
@ -79,9 +79,9 @@ Response
| | | - **ACCEPTED**: indicates that the job is accepted. | | | | - **ACCEPTED**: indicates that the job is accepted. |
| | | - **RUNNING**: indicates that the job is running. | | | | - **RUNNING**: indicates that the job is running. |
| | | - **FINISHED**: indicates that the job is completed. | | | | - **FINISHED**: indicates that the job is completed. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_progress | Float | Job execution progress. | | job_progress | Float | Job execution progress. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_type | String | Type of a job. | | job_type | String | Type of a job. |
| | | | | | | |
| | | - MapReduce | | | | - MapReduce |
@ -92,23 +92,23 @@ Response
| | | - SparkScript | | | | - SparkScript |
| | | - SparkSql | | | | - SparkSql |
| | | - Flink | | | | - Flink |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| started_time | Long | Start time to run a job. Unit: ms. | | started_time | Long | Start time to run a job. Unit: ms. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| submitted_time | Long | Time when a job is submitted. Unit: ms. | | submitted_time | Long | Time when a job is submitted. Unit: ms. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| finished_time | Long | End time to run a job. Unit: ms. | | finished_time | Long | End time to run a job. Unit: ms. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| elapsed_time | Long | Running duration of a job. Unit: ms. | | elapsed_time | Long | Running duration of a job. Unit: ms. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| arguments | Array | Running parameter. The parameter contains a maximum of 4,096 characters, excluding special characters such as ;|&>'<$, and can be left blank. | | arguments | Array | Running parameter. The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as ><|'`&!\, and can be left blank. | | properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\,` and can be left blank. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| launcher_id | String | Launcher job ID. | | launcher_id | String | Launcher job ID. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| app_id | String | Actual job ID. | | app_id | String | Actual job ID. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Example
------- -------