500
diff --git a/docs/dli/api-ref/dli_02_0016.html b/docs/dli/api-ref/dli_02_0016.html
index 61653aa88..6355094c7 100644
--- a/docs/dli/api-ref/dli_02_0016.html
+++ b/docs/dli/api-ref/dli_02_0016.html
@@ -1,10 +1,10 @@
-Viewing Details of a Queue
+Querying Queue Details
FunctionThis API is used to list details of a specific queue in a project.
- Status CodesTable 3 describes the status code.
+ Status CodesTable 3 describes status codes.
Table 3 Status codesStatus Code
|
@@ -238,14 +310,14 @@
|---|
500
|
-Internal service error.
+ | Internal server error.
|
- Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
+ Error CodesIf an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.
diff --git a/docs/dli/api-ref/dli_02_0019.html b/docs/dli/api-ref/dli_02_0019.html
index c617c44fd..0c5c85cb2 100644
--- a/docs/dli/api-ref/dli_02_0019.html
+++ b/docs/dli/api-ref/dli_02_0019.html
@@ -32,7 +32,7 @@
- Request
+ Request Parameters
Table 2 Request parametersParameter
|
Mandatory
@@ -305,7 +305,7 @@
|
|---|
- Response
+ Response Parameters
Table 4 Response parametersParameter
|
Mandatory
diff --git a/docs/dli/api-ref/dli_02_0020.html b/docs/dli/api-ref/dli_02_0020.html
index 4005836ae..716eb6542 100644
--- a/docs/dli/api-ref/dli_02_0020.html
+++ b/docs/dli/api-ref/dli_02_0020.html
@@ -3,7 +3,7 @@
Exporting Data (Deprecated)
FunctionThis API is used to export data from a DLI table to a file.
- This API is asynchronous.
- Currently, data can be exported only from a DLI table to OBS, and the OBS path must be specified to the folder level. The OBS path cannot contain commas (,). The OBS bucket name cannot end with the regular expression format .[0-9]+(.*). Specifically, if the bucket name contains dots (.), the last dot (.) cannot be followed by a digit, for example, **.12abc and **.12.
- Data can be exported across accounts. That is, after account B authorizes account A, account A can export data to the OBS path of account B if account A has the permission to read the metadata and permission information about the OBS bucket of account B and read and write the path.
-  This API has been deprecated and is not recommended.
+ This API has been deprecated and is not recommended.
- Request
+ Request Parameters
Table 2 Request parametersParameter
|
Mandatory
@@ -114,14 +114,14 @@
| Boolean
|
Whether to export column names when exporting CSV and JSON data.
-- If this parameter is set to true, the column names are exported.
- If this parameter is set to false, the column names are not exported.
- If this parameter is left blank, the default value false is used.
+- If this parameter is set to true, the column names are exported.
- If this parameter is set to false, the column names are not exported.
- If this parameter is left blank, the default value false is used.
|
|---|
- Response
+ Response Parameters
Table 3 Response parametersParameter
|
Mandatory
diff --git a/docs/dli/api-ref/dli_02_0021.html b/docs/dli/api-ref/dli_02_0021.html
index e8234e44e..092789e29 100644
--- a/docs/dli/api-ref/dli_02_0021.html
+++ b/docs/dli/api-ref/dli_02_0021.html
@@ -5,7 +5,7 @@
URI
- - Parameter description
+
- Parameter descriptions
Table 1 URI parametersParameter
|
Mandatory
@@ -22,7 +22,15 @@
| String
|
-Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
+ | Definition
+Project ID, which is used for resource isolation. For how to obtain a project ID, see Obtaining a Project ID.
+Example: 48cc2c48765f481480c7db940d6409d1
+Constraints
+None
+Range
+The value can contain 1 to 64 characters. Only letters and digits are allowed.
+Default Value
+None
|
|---|
job_id
@@ -31,7 +39,15 @@
|
String
|
-Job ID.
+ | Definition
+Job ID. For details about how to obtain a job ID, see Querying Job Details.
+Example: 6d2146a0-c2d5-41bd-8ca0-ca9694ada992
+Constraints
+None
+Range
+The value can contain 1 to 64 characters. Only letters and digits are allowed.
+Default Value
+None
|
@@ -39,9 +55,9 @@
-RequestNone
+
- Response
+ Response Parameters
Table 2 Response parametersParameter
|
Type
@@ -54,155 +70,232 @@
| Boolean
|
-Whether the request is successfully executed. Value true indicates that the request is successfully executed.
+ | Definition
+Whether the request is successfully executed
+Range
+true indicates that the request is successfully executed.
+false indicates that the request fails to be executed.
|
|---|
message
|
String
|
-System prompt. If execution succeeds, this parameter is left blank.
+ | Definition
+System prompt. If the execution succeeds, this parameter is left blank.
+Range
+None
|
job_id
|
String
|
-Job ID. You can get the value by calling Submitting a SQL Job (Recommended).
+ | Definition
+Job ID
+Range
+None
|
job_type
|
String
|
-Type of a job, Includes DDL, DCL, IMPORT, EXPORT, QUERY, INSERT, DATA_MIGRATION, UPDATE, DELETE, RESTART_QUEUE and SCALE_QUEUE.
+ | Definition
+Job type
+Range
+Options: DDL, DCL, IMPORT, EXPORT, QUERY, INSERT, DATA_MIGRATION, UPDATE, DELETE, RESTART_QUEUE, and SCALE_QUEUE.
+- DDL: jobs that create, modify, and delete metadata files
- DCL: jobs that grant and revoke permissions
- IMPORT: jobs that import external data into the database
- EXPORT: jobs that export data to an external database
- QUERY: jobs that run query statements
- INSERT: jobs that add new data to tables
- DATA_MIGRATION: jobs that migrate data across sources
- UPDATE: jobs that update table data
- DELETE: jobs that delete data from specified tables
- RESTART_QUEUE: jobs that restart specified queues
- SCALE_QUEUE: jobs that scale in or out specified queues
|
job_mode
|
String
|
-Job execution mode. The options are as follows:
-- async: asynchronous
- sync: synchronous
+ | Definition
+Job execution mode
+Range
+- async: asynchronous
- sync: synchronous
|
queue_name
|
String
|
-Name of the queue where the job is submitted.
+ | Definition
+Name of the queue where the job is submitted
+Range
+None
|
owner
|
String
|
-User who submits a job.
+ | Definition
+User who submits a job
+Range
+None
|
start_time
|
Long
|
-Time when a job is started. The timestamp is in milliseconds.
+ | Definition
+Time when a job is started. The timestamp is in milliseconds.
+Range
+None
|
duration
|
Long
|
-Job running duration (unit: millisecond).
+ | Definition
+Job running duration, in milliseconds.
+Range
+None
|
status
|
String
|
-Status of a job, including RUNNING, SCALING, LAUNCHING, FINISHED, FAILED, and CANCELLED.
+ | Definition
+Job status
+Range
+- RUNNING: The job is running.
- SCALING: The job is modifying specifications.
- LAUNCHING: The job is being submitted.
- FINISHED: The job has been completed.
- FAILED: The job has failed.
- CANCELLED: The job has been canceled.
|
input_row_count
|
Long
|
-Number of records scanned during the Insert job execution.
+ | Definition
+Number of records scanned during the Insert job execution
+Range
+None
|
bad_row_count
|
Long
|
-Number of error records scanned during the Insert job execution.
+ | Definition
+Number of error records scanned during the Insert job execution
+Range
+None
|
input_size
|
Long
|
-Size of scanned files during job execution (unit: byte).
+ | Definition
+Size of files scanned during job execution, in bytes
+Range
+None
|
result_count
|
Integer
|
-Total number of records returned by the current job or total number of records inserted by the Insert job.
+ | Definition
+Total number of records returned by the current job or total number of records inserted by the Insert job.
+Range
+None
|
database_name
|
String
|
-Name of the database where the target table resides. database_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.
+ | Definition
+Name of the database where the target table resides. database_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.
+Range
+None
|
table_name
|
String
|
-Name of the target table. table_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.
+ | Definition
+Name of the target table. table_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.
+Range
+None
|
detail
|
String
|
-JSON string for information about related columns.
+ | Definition
+JSON string for information about related columns
+Default Value
+None
|
statement
|
String
|
-SQL statements of a job.
+ | Definition
+SQL statements of a job
+Range
+None
|
tags
|
Array of objects
|
-Job tags. For details, see Table 3.
+ | Definition
+Job tags. For details, see Table 3.
+Range
+None
|
user_conf
|
String
|
-JSON string of related columns queried using SQL statements.
+ | Definition
+Spark parameters configured when a user submits a SQL job.
+Range
+You can set the parameter in key-value pairs. For details about the supported configuration items, see Table 3.
|
result_format
|
String
|
-Storage format of job results. Currently, only CSV is supported.
+ | Definition
+Storage format of job results
+Range
+Currently, only CSV is supported.
|
result_path
|
String
|
-OBS path of job results.
+ | Definition
+OBS path of job results
+Range
+None
+ |
+
+execution_details_path
+ |
+String
+ |
+Definition
+OBS path of the job query execution plan.
+Range
+None
|
@@ -225,7 +318,10 @@
String
|
-Tag key
+ | Definition
+Tag key
+Range
+None
|
value
@@ -234,7 +330,10 @@
|
String
|
-Tag value
+ | Definition
+Tag value
+Range
+None
|
@@ -262,7 +361,7 @@
"statement": "select * from t1"
}
-Status CodesTable 4 describes the status code.
+ Status CodesTable 4 describes status codes.
Table 4 Status codesStatus Code
|
@@ -282,14 +381,14 @@
|---|
500
|
-Internal service error.
+ | Internal server error.
|
- Error CodesIf an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.
+ Error CodesIf an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.
diff --git a/docs/dli/api-ref/dli_02_0022.html b/docs/dli/api-ref/dli_02_0022.html
index 134ba6157..65579e394 100644
--- a/docs/dli/api-ref/dli_02_0022.html
+++ b/docs/dli/api-ref/dli_02_0022.html
@@ -3,9 +3,9 @@
Querying Job Details
FunctionThis API is used to query details about jobs, including databasename, tablename, file size, and export mode.
-
|
|---|
|
|---|
|