From 57a0d535be6da9dff2a48a0d969adba3add7c872 Mon Sep 17 00:00:00 2001 From: "Su, Xiaomeng" Date: Mon, 16 Oct 2023 22:01:57 +0000 Subject: [PATCH] dli_api_0910_version_api Reviewed-by: Pruthi, Vineet Co-authored-by: Su, Xiaomeng Co-committed-by: Su, Xiaomeng --- docs/dli/api-ref/ALL_META.TXT.json | 20 ++-- docs/dli/api-ref/CLASS.TXT.json | 18 ++-- docs/dli/api-ref/dli_02_00003.html | 10 +- docs/dli/api-ref/dli_02_0011.html | 2 +- docs/dli/api-ref/dli_02_0016.html | 4 +- docs/dli/api-ref/dli_02_0019.html | 5 +- docs/dli/api-ref/dli_02_0020.html | 7 +- docs/dli/api-ref/dli_02_0021.html | 4 +- docs/dli/api-ref/dli_02_0022.html | 2 +- docs/dli/api-ref/dli_02_0024.html | 7 +- docs/dli/api-ref/dli_02_0025.html | 4 +- docs/dli/api-ref/dli_02_0028.html | 5 +- docs/dli/api-ref/dli_02_0029.html | 4 +- docs/dli/api-ref/dli_02_0030.html | 6 +- docs/dli/api-ref/dli_02_0033.html | 2 +- docs/dli/api-ref/dli_02_0034.html | 6 +- docs/dli/api-ref/dli_02_0035.html | 4 +- docs/dli/api-ref/dli_02_0037.html | 19 ++-- docs/dli/api-ref/dli_02_0038.html | 16 +-- docs/dli/api-ref/dli_02_0039.html | 21 ++-- docs/dli/api-ref/dli_02_0040.html | 14 +-- docs/dli/api-ref/dli_02_0041.html | 4 +- docs/dli/api-ref/dli_02_0042.html | 11 +- docs/dli/api-ref/dli_02_0056.html | 2 +- docs/dli/api-ref/dli_02_0102.html | 5 +- docs/dli/api-ref/dli_02_0104.html | 2 +- docs/dli/api-ref/dli_02_0105.html | 2 +- docs/dli/api-ref/dli_02_0107.html | 5 +- docs/dli/api-ref/dli_02_0108.html | 6 +- docs/dli/api-ref/dli_02_0124.html | 11 +- docs/dli/api-ref/dli_02_0125.html | 6 +- docs/dli/api-ref/dli_02_0126.html | 2 +- docs/dli/api-ref/dli_02_0127.html | 4 +- docs/dli/api-ref/dli_02_0128.html | 2 +- docs/dli/api-ref/dli_02_0129.html | 2 +- docs/dli/api-ref/dli_02_0130.html | 13 +-- docs/dli/api-ref/dli_02_0164.html | 5 +- docs/dli/api-ref/dli_02_0168.html | 8 +- docs/dli/api-ref/dli_02_0169.html | 9 +- docs/dli/api-ref/dli_02_0170.html | 9 +- docs/dli/api-ref/dli_02_0171.html | 9 +- docs/dli/api-ref/dli_02_0172.html | 6 +- docs/dli/api-ref/dli_02_0173.html | 4 +- docs/dli/api-ref/dli_02_0187.html | 5 +- docs/dli/api-ref/dli_02_0188.html | 2 +- docs/dli/api-ref/dli_02_0189.html | 71 ++----------- docs/dli/api-ref/dli_02_0190.html | 8 +- docs/dli/api-ref/dli_02_0191.html | 14 +-- docs/dli/api-ref/dli_02_0192.html | 14 +-- docs/dli/api-ref/dli_02_0194.html | 15 ++- docs/dli/api-ref/dli_02_0195.html | 4 +- docs/dli/api-ref/dli_02_0196.html | 6 +- docs/dli/api-ref/dli_02_0200.html | 5 +- docs/dli/api-ref/dli_02_0201.html | 165 +++++++++++++---------------- docs/dli/api-ref/dli_02_0225.html | 7 +- docs/dli/api-ref/dli_02_0228.html | 22 +++- docs/dli/api-ref/dli_02_0229.html | 16 ++- docs/dli/api-ref/dli_02_0230.html | 5 +- docs/dli/api-ref/dli_02_0231.html | 7 +- docs/dli/api-ref/dli_02_0233.html | 5 +- docs/dli/api-ref/dli_02_0234.html | 8 +- docs/dli/api-ref/dli_02_0235.html | 62 +---------- docs/dli/api-ref/dli_02_0236.html | 2 +- docs/dli/api-ref/dli_02_0241.html | 5 +- docs/dli/api-ref/dli_02_0242.html | 2 +- docs/dli/api-ref/dli_02_0243.html | 5 +- docs/dli/api-ref/dli_02_0245.html | 9 +- docs/dli/api-ref/dli_02_0246.html | 5 +- docs/dli/api-ref/dli_02_0247.html | 2 +- docs/dli/api-ref/dli_02_0248.html | 6 +- docs/dli/api-ref/dli_02_0249.html | 8 +- docs/dli/api-ref/dli_02_0250.html | 8 +- docs/dli/api-ref/dli_02_0252.html | 4 +- docs/dli/api-ref/dli_02_0253.html | 5 +- docs/dli/api-ref/dli_02_0254.html | 7 +- docs/dli/api-ref/dli_02_0255.html | 7 +- docs/dli/api-ref/dli_02_0256.html | 2 +- docs/dli/api-ref/dli_02_0258.html | 5 +- docs/dli/api-ref/dli_02_0259.html | 2 +- docs/dli/api-ref/dli_02_0260.html | 5 +- docs/dli/api-ref/dli_02_0261.html | 4 +- docs/dli/api-ref/dli_02_0284.html | 7 +- docs/dli/api-ref/dli_02_0285.html | 4 +- docs/dli/api-ref/dli_02_0291.html | 7 +- docs/dli/api-ref/dli_02_0292.html | 2 +- docs/dli/api-ref/dli_02_0293.html | 5 +- docs/dli/api-ref/dli_02_0294.html | 4 +- docs/dli/api-ref/dli_02_0295.html | 11 +- docs/dli/api-ref/dli_02_0296.html | 2 +- docs/dli/api-ref/dli_02_0298.html | 4 +- docs/dli/api-ref/dli_02_0299.html | 18 ++-- docs/dli/api-ref/dli_02_0312.html | 6 +- docs/dli/api-ref/dli_02_0316.html | 10 +- 93 files changed, 422 insertions(+), 499 deletions(-) diff --git a/docs/dli/api-ref/ALL_META.TXT.json b/docs/dli/api-ref/ALL_META.TXT.json index eba9434d..cb7f8c49 100644 --- a/docs/dli/api-ref/ALL_META.TXT.json +++ b/docs/dli/api-ref/ALL_META.TXT.json @@ -173,7 +173,7 @@ "uri":"dli_02_0298.html", "product_code":"dli", "code":"18", - "des":"This API is used to obtain the agency information of a DLI user.URI formatGET /v2/{project_id}/agencyGET /v2/{project_id}/agencyParameter descriptionURI parametersParam", + "des":"This API is used to obtain the agency information of a DLI user.URI formatGET /v2/{project_id}/agencyGET /v2/{project_id}/agencyParameter descriptionURI parametersParamet", "doc_type":"api", "kw":"Obtaining DLI Agency Information,Agency-related APIs,API Reference", "title":"Obtaining DLI Agency Information", @@ -183,7 +183,7 @@ "uri":"dli_02_0299.html", "product_code":"dli", "code":"19", - "des":"This API is used to create an agency for a DLI user.URI formatPOST /v2/{project_id}/agencyPOST /v2/{project_id}/agencyParameter descriptionURI parametersParameterMandat", + "des":"This API is used to create an agency for a DLI user.URI formatPOST /v2/{project_id}/agencyPOST /v2/{project_id}/agencyParameter descriptionURI parametersParameterMandator", "doc_type":"api", "kw":"Creating a DLI Agency,Agency-related APIs,API Reference", "title":"Creating a DLI Agency", @@ -253,7 +253,7 @@ "uri":"dli_02_0284.html", "product_code":"dli", "code":"26", - "des":"This API is used to send an address connectivity test request to a specified queue and insert the test address into the table.URI formatPOST /v1.0/{project_id}/queues/{q", + "des":"This API is used to send an address connectivity test request to a specified queue and insert the test address into the table.URI formatPOST /v1.0/{project_id}/queues/{qu", "doc_type":"api", "kw":"Creating an Address Connectivity Test Request,Queue-related APIs (Recommended),API Reference", "title":"Creating an Address Connectivity Test Request", @@ -263,7 +263,7 @@ "uri":"dli_02_0285.html", "product_code":"dli", "code":"27", - "des":"This API is used to query the connectivity test result after the test is submitted.URI formatGET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}GET /v1", + "des":"This API is used to query the connectivity test result after the test is submitted.URI formatGET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}GET /v1.0", "doc_type":"api", "kw":"Querying Connectivity Test Details of a Specified Address,Queue-related APIs (Recommended),API Refer", "title":"Querying Connectivity Test Details of a Specified Address", @@ -273,7 +273,7 @@ "uri":"dli_02_0291.html", "product_code":"dli", "code":"28", - "des":"This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.URI formatPOST /v1/{project_id}/queues/{queue_name}/plan", + "des":"This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.URI formatPOST /v1/{project_id}/queues/{queue_name}/plans", "doc_type":"api", "kw":"Creating a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", "title":"Creating a Scheduled CU Change", @@ -303,7 +303,7 @@ "uri":"dli_02_0294.html", "product_code":"dli", "code":"31", - "des":"This API is used to delete a scheduled CU change for a queue with a specified ID.URI formatDELETE /v1/{project_id}/queues/{queue_name}/plans/{plan_id}DELETE /v1/{projec", + "des":"This API is used to delete a scheduled CU change for a queue with a specified ID.URI formatDELETE /v1/{project_id}/queues/{queue_name}/plans/{plan_id}DELETE /v1/{project_", "doc_type":"api", "kw":"Deleting a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", "title":"Deleting a Scheduled CU Change", @@ -313,7 +313,7 @@ "uri":"dli_02_0295.html", "product_code":"dli", "code":"32", - "des":"This API is used to modify a scheduled CU change for a queue with a specified ID.URI formatPUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}PUT /v1/{project_id}/", + "des":"This API is used to modify a scheduled CU change for a queue with a specified ID.URI formatPUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}PUT /v1/{project_id}/qu", "doc_type":"api", "kw":"Modifying a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", "title":"Modifying a Scheduled CU Change", @@ -643,7 +643,7 @@ "uri":"dli_02_0108.html", "product_code":"dli", "code":"65", - "des":"This API is used to preview the first ten rows of a table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/previewGET /v1.0/{project_id}/dat", + "des":"This API is used to preview the first 10 rows in a table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/previewGET /v1.0/{project_id}/data", "doc_type":"api", "kw":"Previewing Table Content,Table-related APIs,API Reference", "title":"Previewing Table Content", @@ -1125,8 +1125,8 @@ "code":"113", "des":"If an error occurs in API calling, no result is returned. Identify the cause of error based on the error codes of each API. If an error occurs in API calling, HTTP status", "doc_type":"api", - "kw":"Error Code,Public Parameters,API Reference", - "title":"Error Code", + "kw":"Error Codes,Public Parameters,API Reference", + "title":"Error Codes", "githuburl":"" }, { diff --git a/docs/dli/api-ref/CLASS.TXT.json b/docs/dli/api-ref/CLASS.TXT.json index 0e75a24e..68fc2d59 100644 --- a/docs/dli/api-ref/CLASS.TXT.json +++ b/docs/dli/api-ref/CLASS.TXT.json @@ -153,7 +153,7 @@ "code":"17" }, { - "desc":"This API is used to obtain the agency information of a DLI user.URI formatGET /v2/{project_id}/agencyGET /v2/{project_id}/agencyParameter descriptionURI parametersParam", + "desc":"This API is used to obtain the agency information of a DLI user.URI formatGET /v2/{project_id}/agencyGET /v2/{project_id}/agencyParameter descriptionURI parametersParamet", "product_code":"dli", "title":"Obtaining DLI Agency Information", "uri":"dli_02_0298.html", @@ -162,7 +162,7 @@ "code":"18" }, { - "desc":"This API is used to create an agency for a DLI user.URI formatPOST /v2/{project_id}/agencyPOST /v2/{project_id}/agencyParameter descriptionURI parametersParameterMandat", + "desc":"This API is used to create an agency for a DLI user.URI formatPOST /v2/{project_id}/agencyPOST /v2/{project_id}/agencyParameter descriptionURI parametersParameterMandator", "product_code":"dli", "title":"Creating a DLI Agency", "uri":"dli_02_0299.html", @@ -225,7 +225,7 @@ "code":"25" }, { - "desc":"This API is used to send an address connectivity test request to a specified queue and insert the test address into the table.URI formatPOST /v1.0/{project_id}/queues/{q", + "desc":"This API is used to send an address connectivity test request to a specified queue and insert the test address into the table.URI formatPOST /v1.0/{project_id}/queues/{qu", "product_code":"dli", "title":"Creating an Address Connectivity Test Request", "uri":"dli_02_0284.html", @@ -234,7 +234,7 @@ "code":"26" }, { - "desc":"This API is used to query the connectivity test result after the test is submitted.URI formatGET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}GET /v1", + "desc":"This API is used to query the connectivity test result after the test is submitted.URI formatGET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}GET /v1.0", "product_code":"dli", "title":"Querying Connectivity Test Details of a Specified Address", "uri":"dli_02_0285.html", @@ -243,7 +243,7 @@ "code":"27" }, { - "desc":"This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.URI formatPOST /v1/{project_id}/queues/{queue_name}/plan", + "desc":"This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.URI formatPOST /v1/{project_id}/queues/{queue_name}/plans", "product_code":"dli", "title":"Creating a Scheduled CU Change", "uri":"dli_02_0291.html", @@ -270,7 +270,7 @@ "code":"30" }, { - "desc":"This API is used to delete a scheduled CU change for a queue with a specified ID.URI formatDELETE /v1/{project_id}/queues/{queue_name}/plans/{plan_id}DELETE /v1/{projec", + "desc":"This API is used to delete a scheduled CU change for a queue with a specified ID.URI formatDELETE /v1/{project_id}/queues/{queue_name}/plans/{plan_id}DELETE /v1/{project_", "product_code":"dli", "title":"Deleting a Scheduled CU Change", "uri":"dli_02_0294.html", @@ -279,7 +279,7 @@ "code":"31" }, { - "desc":"This API is used to modify a scheduled CU change for a queue with a specified ID.URI formatPUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}PUT /v1/{project_id}/", + "desc":"This API is used to modify a scheduled CU change for a queue with a specified ID.URI formatPUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}PUT /v1/{project_id}/qu", "product_code":"dli", "title":"Modifying a Scheduled CU Change", "uri":"dli_02_0295.html", @@ -576,7 +576,7 @@ "code":"64" }, { - "desc":"This API is used to preview the first ten rows of a table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/previewGET /v1.0/{project_id}/dat", + "desc":"This API is used to preview the first 10 rows in a table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/previewGET /v1.0/{project_id}/data", "product_code":"dli", "title":"Previewing Table Content", "uri":"dli_02_0108.html", @@ -1010,7 +1010,7 @@ { "desc":"If an error occurs in API calling, no result is returned. Identify the cause of error based on the error codes of each API. If an error occurs in API calling, HTTP status", "product_code":"dli", - "title":"Error Code", + "title":"Error Codes", "uri":"dli_02_0056.html", "doc_type":"api", "p_code":"111", diff --git a/docs/dli/api-ref/dli_02_00003.html b/docs/dli/api-ref/dli_02_00003.html index 69640514..9f98ace2 100644 --- a/docs/dli/api-ref/dli_02_00003.html +++ b/docs/dli/api-ref/dli_02_00003.html @@ -2,13 +2,19 @@

Change History

-
Table 1 Change History

Released On

+
- + + + diff --git a/docs/dli/api-ref/dli_02_0011.html b/docs/dli/api-ref/dli_02_0011.html index 02e45091..1d1f3c64 100644 --- a/docs/dli/api-ref/dli_02_0011.html +++ b/docs/dli/api-ref/dli_02_0011.html @@ -6,7 +6,7 @@
  • Status Codes
    • -
  • Error Code
    +
  • Error Codes
  • Obtaining a Project ID
    • diff --git a/docs/dli/api-ref/dli_02_0016.html b/docs/dli/api-ref/dli_02_0016.html index ba488a14..c131f767 100644 --- a/docs/dli/api-ref/dli_02_0016.html +++ b/docs/dli/api-ref/dli_02_0016.html @@ -166,7 +166,7 @@
-
Table 1 Change history

Released On

Description

2023-01-30

+

2023-09-07

+

This issue is the second official release.

+ +

2023-01-30

This issue is the first official release.

Integer

Specifications of a queue. For a queue whose billing mode is yearly/monthly, this parameter indicates the CU value of the yearly/monthly part. For a pay-per-use queue, this parameter indicates the initial value when a user purchases a queue.

+

Specifications of a queue.

cu_scale_out_limit

@@ -236,7 +236,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0019.html b/docs/dli/api-ref/dli_02_0019.html index 24367a2d..7fe82a55 100644 --- a/docs/dli/api-ref/dli_02_0019.html +++ b/docs/dli/api-ref/dli_02_0019.html @@ -357,7 +357,8 @@
-

Example Request

{
+
Example Request
Import the CSV data stored on OBS to db2.t2.

+
{
     "data_path": "obs://home/data1/DLI/t1.csv",
     "data_type": "csv",
     "database_name": "db2",
@@ -410,7 +411,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0020.html b/docs/dli/api-ref/dli_02_0020.html index a3e0b63f..4d1b4472 100644 --- a/docs/dli/api-ref/dli_02_0020.html +++ b/docs/dli/api-ref/dli_02_0020.html @@ -113,7 +113,7 @@

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.
@@ -172,7 +172,8 @@
-

Example Request

{
+
Example Request
Export data from db2.t2 to OBS and store the data in JSON format.

+
{
     "data_path": "obs://home/data1/DLI/test",
     "data_type": "json",
     "database_name": "db2",
@@ -216,7 +217,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0021.html b/docs/dli/api-ref/dli_02_0021.html index 6a6b1578..f394a3ec 100644 --- a/docs/dli/api-ref/dli_02_0021.html +++ b/docs/dli/api-ref/dli_02_0021.html @@ -203,7 +203,7 @@

String

-

JSON character string for information about related columns.

+

JSON string for information about related columns.

statement

@@ -308,7 +308,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0022.html b/docs/dli/api-ref/dli_02_0022.html index 9e837bd6..66a5c914 100644 --- a/docs/dli/api-ref/dli_02_0022.html +++ b/docs/dli/api-ref/dli_02_0022.html @@ -324,7 +324,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0024.html b/docs/dli/api-ref/dli_02_0024.html index 2e119d1d..90b52380 100644 --- a/docs/dli/api-ref/dli_02_0024.html +++ b/docs/dli/api-ref/dli_02_0024.html @@ -104,7 +104,7 @@

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.

limit_num

@@ -181,7 +181,8 @@
-

Example Request

{
+
Example Request
Export query results of SQL statements to OBS and stores the results in JSON format.

+
{
   "data_path": "obs://obs-bucket1/path",
   "data_type": "json",
   "compress": "gzip",
@@ -224,7 +225,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0025.html b/docs/dli/api-ref/dli_02_0025.html index 3827385b..a29a77ce 100644 --- a/docs/dli/api-ref/dli_02_0025.html +++ b/docs/dli/api-ref/dli_02_0025.html @@ -365,7 +365,7 @@

String

-

JSON character string of related columns queried by using SQL statements.

+

JSON string of related columns queried using SQL statements.

statement

@@ -495,7 +495,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0028.html b/docs/dli/api-ref/dli_02_0028.html index af25cb25..c626e49f 100644 --- a/docs/dli/api-ref/dli_02_0028.html +++ b/docs/dli/api-ref/dli_02_0028.html @@ -150,7 +150,8 @@
-

Example Request

{
+
Example Request
Create a test database named db1.

+
{
   "database_name": "db1",
   "description": "this is for test"
 }

@@ -187,7 +188,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0029.html b/docs/dli/api-ref/dli_02_0029.html index 07b0ccbf..ff4126ef 100644 --- a/docs/dli/api-ref/dli_02_0029.html +++ b/docs/dli/api-ref/dli_02_0029.html @@ -28,7 +28,7 @@
-
Table 2 query parameter description

Parameter

+
@@ -257,7 +257,7 @@
Table 2 query parameter description

Parameter

Mandatory

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0030.html b/docs/dli/api-ref/dli_02_0030.html index 3a45942b..45c31979 100644 --- a/docs/dli/api-ref/dli_02_0030.html +++ b/docs/dli/api-ref/dli_02_0030.html @@ -37,7 +37,7 @@
-
Table 2 query parameter description

Parameter

+
@@ -62,7 +62,7 @@ - @@ -182,7 +182,7 @@
Table 2 query parameter description

Parameter

Mandatory

Boolean

Specifies whether to delete the database in asynchronous mode. The value can be true or false. Default value: false.

+

Specifies whether to delete the database in asynchronous mode. The value can be true or false. Default value: false.
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0033.html b/docs/dli/api-ref/dli_02_0033.html index 37921312..23f68716 100644 --- a/docs/dli/api-ref/dli_02_0033.html +++ b/docs/dli/api-ref/dli_02_0033.html @@ -341,7 +341,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0034.html b/docs/dli/api-ref/dli_02_0034.html index 03aa65cf..8df5a862 100644 --- a/docs/dli/api-ref/dli_02_0034.html +++ b/docs/dli/api-ref/dli_02_0034.html @@ -305,7 +305,7 @@
-

Example Request

  • Sample request when data_location is OBS.
    {
+
    Example Request
    • Create a table whose data_location is OBS and data format of CSV.
      {
   "table_name": "tb1",
   "data_location": "OBS",
   "description": "",
@@ -334,7 +334,7 @@
 }
      
 
       
      The values of date_format and timestamp_format must be the same as the time format in the imported CSV file.
      
 
      
-
    • Sample request when data_location is VIEW.
      {
+
    • Create a table whose data_location is VIEW.
      {
   "table_name": "view1",
   "data_location": "VIEW",
   "columns": [
@@ -387,7 +387,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0035.html b/docs/dli/api-ref/dli_02_0035.html index fb51df3b..ff73f7c8 100644 --- a/docs/dli/api-ref/dli_02_0035.html +++ b/docs/dli/api-ref/dli_02_0035.html @@ -46,7 +46,7 @@
-
- - - @@ -74,8 +74,8 @@ - @@ -101,7 +101,7 @@ - -
Table 2 query parameter description

Parameter

+
@@ -152,7 +152,7 @@
Table 2 query parameter description

Parameter

Mandatory

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0037.html b/docs/dli/api-ref/dli_02_0037.html index 9e3396f7..30c50e5f 100644 --- a/docs/dli/api-ref/dli_02_0037.html +++ b/docs/dli/api-ref/dli_02_0037.html @@ -46,7 +46,7 @@

String

Name of a queue.

+

Name of a queue. Example value: queue1.

user_name

@@ -55,7 +55,7 @@

String

Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated.

+

Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated. Example value: tenant2.

action

@@ -64,7 +64,7 @@

String

Grants or revokes the permission. The parameter value can be grant, revoke, or update. Users can perform the update operation only when they have been granted with the grant and revoke permissions.

+

Grants or revokes the permission. The parameter value can be grant, revoke, or update. Users can perform the update operation only when they have been granted with the grant and revoke permissions. Example value: grant.

  • grant: Indicates to grant users with permissions.
  • revoke: Indicates to revoke permissions.
  • update: Indicates to clear all the original permissions and assign the permissions in the provided permission array.

Array of Strings

List of permissions to be granted, revoked, or updated. The following permissions are supported:

-
  • SUBMIT_JOB: indicates to submit a job.
  • CANCEL_JOB: indicates to cancel a job.
  • DROP_QUEUE: indicates to a delete a queue.
  • GRANT_PRIVILEGE: indicates to assign a permission.
  • REVOKE_PRIVILEGE: indicates to revoke a permission.
  • SHOW_PRIVILEGE: indicates to view other user's permissions.
  • RESTART: indicates to restart the queue.
  • SCALE_QUEUE: indicates to change the queue specifications.
    NOTE:

    If the update list is empty, all permissions of the queue granted to the user are revoked.

    +

List of permissions to be granted, revoked, or updated. The following permissions are supported: Example value: [DROP_QUEUE, SUBMIT_JOB].

+
  • SUBMIT_JOB: indicates to submit a job.
  • CANCEL_JOB: indicates to cancel a job.
  • DROP_QUEUE: indicates to a delete a queue.
  • GRANT_PRIVILEGE: indicates to assign a permission.
  • REVOKE_PRIVILEGE: indicates to revoke a permission.
  • SHOW_PRIVILEGES: indicates to view the permissions of other users
  • RESTART: indicates to restart the queue.
  • SCALE_QUEUE: indicates to change the queue specifications.
    NOTE:

    If the update list is empty, all permissions of the queue granted to the user are revoked.

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

+

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.

message

@@ -110,14 +110,15 @@

String

System prompt. If execution succeeds, the parameter setting may be left blank.

+

System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.
-

Example Request

{
+
Example Request
Grant a user the permission to submit jobs on queue1 and delete queue1.

+
{
     "queue_name": "queue1",
     "user_name": "tenant2",
     "action": "grant",
@@ -156,7 +157,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0038.html b/docs/dli/api-ref/dli_02_0038.html index 43f910c1..ea75ae80 100644 --- a/docs/dli/api-ref/dli_02_0038.html +++ b/docs/dli/api-ref/dli_02_0038.html @@ -37,7 +37,7 @@
-
- - - @@ -91,7 +92,8 @@ - @@ -126,7 +128,7 @@ - -
Table 2 query parameter description

Parameter

+
@@ -89,7 +89,7 @@ - - - - - - @@ -216,7 +216,7 @@
Table 2 query parameter description

Parameter

Mandatory

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

+

Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.

message

@@ -98,7 +98,7 @@

String

System prompt. If execution succeeds, the parameter setting may be left blank.

+

System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.

queue_name

@@ -107,7 +107,7 @@

String

Name of a queue.

+

Name of a queue. Example value: queue1.

privileges

@@ -140,7 +140,7 @@

Boolean

Whether the database user is an administrator.

+

Whether the database user is an administrator. Example value: false.

user_name

@@ -149,7 +149,7 @@

String

Name of the user who has permission on the current queue.

+

Name of the user who has permission on the current queue. Example value: user2.

privileges

@@ -158,7 +158,7 @@

Array of Strings

Permission of the user on the queue.

+

Permission of the user on the queue. Example value: [SUBMIT_JOB].
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0039.html b/docs/dli/api-ref/dli_02_0039.html index 5f6f0710..e8ace9fa 100644 --- a/docs/dli/api-ref/dli_02_0039.html +++ b/docs/dli/api-ref/dli_02_0039.html @@ -46,7 +46,7 @@

String

Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated.

+

Name of the user who is granted with usage permission on a queue or whose queue usage permission is revoked or updated. Example value: user2.

action

@@ -55,7 +55,7 @@

String

Grants or revokes the permission. The parameter value can be grant, revoke, or update.

+

Grants or revokes the permission. The parameter value can be grant, revoke, or update. Example value: grant.

  • grant: Indicates to grant users with permissions.
  • revoke: Indicates to revoke permissions.
  • update: Indicates to clear all the original permissions and assign the permissions in the provided permission array.
NOTE:

Users can perform the update operation only when they have been granted with the grant and revoke permissions.

@@ -67,7 +67,8 @@

Array of Objects

Permission granting information. For details, see Table 3.

+

Permission granting information. For details, see Table 3. Example value:

+

[ {"object": "databases.db1.tables.tb2.columns.column1","privileges": ["SELECT"]},"object": "databases.db1.tables.tbl","privileges": [ "DROP_TABLE"]

String

Data objects to be assigned. If they are named:

-
  • databases.Database name, data in the entire database will be shared.
  • databases.Database name.tables.Table name, data in the specified table will be shared.
  • databases.Database name.tables.Table name.columns.Column name, data in the specified column will be shared.
  • jobs.flink.Flink job ID, data the specified job will be shared.
  • groups. Package group name, data in the specified package group will be shared.
  • resources. Package name, data in the specified package will be shared.
+
  • databases.Database name, data in the entire database will be shared.
  • databases.Database name.tables.Table name, data in the specified table will be shared.
  • databases.Database name.tables.Table name.columns.Column name, data in the specified column will be shared.
  • jobs.flink.Flink job ID, data the specified job will be shared.
  • groups.Package group name, data in the specified package group will be shared.
  • resources.Package name, data in the specified package will be shared.

    Example value: databases.db1.tables.tb2.columns.column1.

    +

privileges

@@ -100,7 +102,7 @@

Array of Strings

List of permissions to be granted, revoked, or updated.

+

List of permissions to be granted, revoked, or updated. Example value: [SELECT].

NOTE:

If Action is Update and the update list is empty, all permissions of the user in the database or table are revoked.

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

+

Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.

message

@@ -135,14 +137,15 @@

String

System prompt. If execution succeeds, the parameter setting may be left blank.

+

System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.
-

Example Request

{
+
Example Request
Grant user2 the permission to query data in the database db1, delete the data table db1.tbl, and query data in a specified column db1.tbl.column1 of a data table.

+
{
   "user_name": "user2",
   "action": "grant",
   "privileges": [
@@ -199,7 +202,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0040.html b/docs/dli/api-ref/dli_02_0040.html index f752fa9a..d7ab0387 100644 --- a/docs/dli/api-ref/dli_02_0040.html +++ b/docs/dli/api-ref/dli_02_0040.html @@ -51,7 +51,7 @@

Boolean

-

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

+

Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.

message

@@ -60,7 +60,7 @@

String

-

System prompt. If execution succeeds, the parameter setting may be left blank.

+

System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.

database_name

@@ -69,7 +69,7 @@

String

-

Name of the database to be queried.

+

Name of the database to be queried. Example value: dsstest.

privileges

@@ -101,7 +101,7 @@

Boolean

-

Whether the database user is an administrator.

+

Whether the database user is an administrator. Example value: true.

user_name

@@ -110,7 +110,7 @@

String

-

Name of the user who has permission on the current database.

+

Name of the user who has permission on the current database. Example value: test.

privileges

@@ -119,7 +119,7 @@

Array of Strings

-

Permission of the user on the database.

+

Permission of the user on the database. Example value: [ALTER_TABLE_ADD_PARTITION].

@@ -156,7 +156,7 @@ } ] } -

If 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 Code.

+

If 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.

diff --git a/docs/dli/api-ref/dli_02_0041.html b/docs/dli/api-ref/dli_02_0041.html index 2d1a2a9c..9ca78901 100644 --- a/docs/dli/api-ref/dli_02_0041.html +++ b/docs/dli/api-ref/dli_02_0041.html @@ -99,7 +99,7 @@

Boolean

-

Whether the table user is an administrator.

+

Determines whether a user is an administrator. The value false indicates that the user is not an administrator, and the value true indicates that the user is an administrator.

object

@@ -158,7 +158,7 @@ } ] } -

If 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 Code.

+

If 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.

diff --git a/docs/dli/api-ref/dli_02_0042.html b/docs/dli/api-ref/dli_02_0042.html index d8361aef..afd6e6cc 100644 --- a/docs/dli/api-ref/dli_02_0042.html +++ b/docs/dli/api-ref/dli_02_0042.html @@ -75,7 +75,7 @@

Boolean

-

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

+

Whether the request is successfully executed. Value true indicates that the request is successfully executed. Example value: true.

message

@@ -84,7 +84,7 @@

String

-

System prompt. If execution succeeds, the parameter setting may be left blank.

+

System prompt. If execution succeeds, the parameter setting may be left blank. Example value: left blank.

user_name

@@ -126,7 +126,8 @@

String

Objects on which a user has permission.

-
  • If the object is in the format of databases.Database name.tables.Table name, the user has permission on the database.
  • If the object is in the format of databases.Database name.tables.Table namecolumns.Column name, the user has permission on the table.
+
  • If the object is in the format of databases.Database name.tables.Table name, the user has permission on the database.
  • If the object is in the format of databases.Database name.tables.Table namecolumns.Column name, the user has permission on the table.

    Example value: databases.dsstest.tables.obs_231.

    +

privileges

@@ -135,7 +136,7 @@

Array of Strings

-

Permission of the user on a specified object.

+

Permission of the user on a specified object. Example value: [DESCRIBE_TABLE].

@@ -191,7 +192,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0056.html b/docs/dli/api-ref/dli_02_0056.html index cd3eff05..238a7f2f 100644 --- a/docs/dli/api-ref/dli_02_0056.html +++ b/docs/dli/api-ref/dli_02_0056.html @@ -1,6 +1,6 @@ -

Error Code

+

Error Codes

If an error occurs in API calling, no result is returned. Identify the cause of error based on the error codes of each API. If an error occurs in API calling, HTTP status code 4xx or 5xx is returned. The response body contains the specific error code and information. If you are unable to identify the cause of an error, contact technical personnel and provide the error code so that we can help you solve the problem as soon as possible.

Format of an Error Response Body

If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:

{
diff --git a/docs/dli/api-ref/dli_02_0102.html b/docs/dli/api-ref/dli_02_0102.html
index 8a038834..56fec221 100644
--- a/docs/dli/api-ref/dli_02_0102.html
+++ b/docs/dli/api-ref/dli_02_0102.html
@@ -277,7 +277,8 @@
-

Example Request

{
+
Example Request
Submit a SQL job. The job execution database and queue are db1 and default, respectively. Then, add the tags workspace=space1 and jobName=name1 for the job.

+
{
     "currentdb": "db1",
     "sql": "desc table1",
     "queue_name": "default",
@@ -354,7 +355,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0104.html b/docs/dli/api-ref/dli_02_0104.html index a6cb5338..97796947 100644 --- a/docs/dli/api-ref/dli_02_0104.html +++ b/docs/dli/api-ref/dli_02_0104.html @@ -107,7 +107,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0105.html b/docs/dli/api-ref/dli_02_0105.html index 870b8382..ffa4b327 100644 --- a/docs/dli/api-ref/dli_02_0105.html +++ b/docs/dli/api-ref/dli_02_0105.html @@ -359,7 +359,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0107.html b/docs/dli/api-ref/dli_02_0107.html index abfb48eb..48a93a65 100644 --- a/docs/dli/api-ref/dli_02_0107.html +++ b/docs/dli/api-ref/dli_02_0107.html @@ -106,7 +106,8 @@
-

Example Request

{
+
Example Request
Check the syntax of the SQL statement select * from t1.

+
{
    "currentdb": "db1",
    "sql": "select * from t1"   
 }

@@ -144,7 +145,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0108.html b/docs/dli/api-ref/dli_02_0108.html index 1203e008..dd12d441 100644 --- a/docs/dli/api-ref/dli_02_0108.html +++ b/docs/dli/api-ref/dli_02_0108.html @@ -1,7 +1,7 @@

Previewing Table Content

-

Function

This API is used to preview the first ten rows of a table.

+

Function

This API is used to preview the first 10 rows in a table.

URI

  • URI format

    GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview

  • Parameter description @@ -46,7 +46,7 @@
-
- @@ -576,9 +576,10 @@
Table 2 query parameter description

Parameter

+
@@ -186,7 +186,7 @@
Table 2 query parameter description

Parameter

Mandatory

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0124.html b/docs/dli/api-ref/dli_02_0124.html index 870082f2..d57de124 100644 --- a/docs/dli/api-ref/dli_02_0124.html +++ b/docs/dli/api-ref/dli_02_0124.html @@ -214,7 +214,7 @@

Integer

Number of Executors in a Spark application. This configuration item replaces the default parameter in sc_type.

+

Number of Executors in a Spark application. This configuration item replaces the default parameter in sc_type.

obs_bucket

@@ -494,7 +494,7 @@

String

Queue name. Set this parameter to the name of the created DLI queue.

-
NOTE:
  • This parameter is compatible with the cluster_name parameter. That is, if cluster_name is used to specify a queue, the queue is still valid.
  • You are advised to use the queue parameter. The queue and cluster_name parameters cannot coexist.
+
NOTE:
  • This parameter is compatible with the cluster_name parameter. That is, if cluster_name is used to specify a queue, the queue is still valid.
  • You are advised to use the queue parameter. The queue and cluster_name parameters cannot coexist.
-

Example Request

{
+
Example Request
Create a Spark job. Set the Spark main class of the job to org.apache.spark.examples.SparkPi, specify the program package to batchTest/spark-examples_2.11-2.1.0.luxor.jar, and load the program package whose type is jar and the resource package whose type is files.

+
{
     "file": "batchTest/spark-examples_2.11-2.1.0.luxor.jar",
-    "class_name": "org.apache.spark.examples.SparkPi",
+    "className": "org.apache.spark.examples.SparkPi",
     "sc_type": "A",
     "jars": ["demo-1.0.0.jar"],
     "files": ["count.txt"],
@@ -639,7 +640,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0125.html b/docs/dli/api-ref/dli_02_0125.html index 3b01be61..f77030b9 100644 --- a/docs/dli/api-ref/dli_02_0125.html +++ b/docs/dli/api-ref/dli_02_0125.html @@ -28,7 +28,7 @@
-
Table 2 query parameter description

Parameter

+
@@ -118,7 +118,7 @@

Request

None

Response

-
Table 2 query parameter description

Parameter

Mandatory
Table 3 Response parameter description

Parameter

+
@@ -367,7 +367,7 @@
Table 3 Response parameters

Parameter

Mandatory

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0126.html b/docs/dli/api-ref/dli_02_0126.html index 455eeb7a..bbc6b908 100644 --- a/docs/dli/api-ref/dli_02_0126.html +++ b/docs/dli/api-ref/dli_02_0126.html @@ -221,7 +221,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0127.html b/docs/dli/api-ref/dli_02_0127.html index dab2a612..6d32f3a8 100644 --- a/docs/dli/api-ref/dli_02_0127.html +++ b/docs/dli/api-ref/dli_02_0127.html @@ -35,7 +35,7 @@

Request

None

Response

-
Table 2 Response parameter description

Parameter

+
@@ -98,7 +98,7 @@
Table 2 Response parameters

Parameter

Mandatory

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0128.html b/docs/dli/api-ref/dli_02_0128.html index ad08f5e3..0b7848aa 100644 --- a/docs/dli/api-ref/dli_02_0128.html +++ b/docs/dli/api-ref/dli_02_0128.html @@ -179,7 +179,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0129.html b/docs/dli/api-ref/dli_02_0129.html index 49ef7fa5..8372aaff 100644 --- a/docs/dli/api-ref/dli_02_0129.html +++ b/docs/dli/api-ref/dli_02_0129.html @@ -99,7 +99,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0130.html b/docs/dli/api-ref/dli_02_0130.html index c43c2ee5..3d4662e7 100644 --- a/docs/dli/api-ref/dli_02_0130.html +++ b/docs/dli/api-ref/dli_02_0130.html @@ -5,7 +5,7 @@

URI

  • URI format

    POST /v2.0/{project_id}/resources

  • Parameter description -
    Table 1 URI parameter description

    Parameter

    +
    @@ -195,7 +195,7 @@ -
    Table 1 URI parameter

    Parameter

    Mandatory

    Boolean

    Whether to upload resource packages in asynchronous mode. The default value is false, indicating that the asynchronous mode is not used. You are advised to upload resource packages in asynchronous mode.

    +

    Whether to upload resource packages in asynchronous mode. The default value is false, indicating that the asynchronous mode is not used. You are advised to upload resource packages in asynchronous mode.

    owner

    @@ -211,7 +211,7 @@
    -
    Table 5 details parameter description

    Parameter

    +
    @@ -281,14 +281,15 @@ -
    Table 5 details parameter description

    Parameter

    Mandatory

    Boolean

    Whether to upload resource packages in asynchronous mode. The default value is false, indicating that the asynchronous mode is not used. You are advised to upload resource packages in asynchronous mode.

    +

    Whether to upload resource packages in asynchronous mode. The default value is false, indicating that the asynchronous mode is not used. You are advised to upload resource packages in asynchronous mode.
    -

    Example Request

    {
+
    Example Request
    Upload a JAR file from OBS to DLI and name the group gatk.
    
+
    {
     "paths": [
         "https://xkftest.obs.xxx.com/txr_test/jars/spark-sdv-app.jar",
         "https://xkftest.obs.xxx.com/txr_test/jars/wordcount",
@@ -364,7 +365,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0164.html b/docs/dli/api-ref/dli_02_0164.html index 4e9823d1..253c5783 100644 --- a/docs/dli/api-ref/dli_02_0164.html +++ b/docs/dli/api-ref/dli_02_0164.html @@ -95,7 +95,8 @@
-

Example Request

{
+
Example Request
Change the owner of the database to scuser1.

+
{
     "new_owner": "scuser1"
 }

 

@@ -131,7 +132,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0168.html b/docs/dli/api-ref/dli_02_0168.html index 49f0631b..8d9e2a64 100644 --- a/docs/dli/api-ref/dli_02_0168.html +++ b/docs/dli/api-ref/dli_02_0168.html @@ -5,7 +5,7 @@

URI

  • URI format

    GET /v2.0/{project_id}/resources

  • Parameter description -
    Table 1 URI parameter description

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 URI parameter

    Parameter

    Mandatory

    -
    Table 2 query parameter description

    Parameter

    +
    @@ -88,7 +88,7 @@ - @@ -354,7 +354,7 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    No

    Array of Objects

    +

    Array of Objects

    List of built-in resource groups. For details about the groups, see Table 5.

    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0169.html b/docs/dli/api-ref/dli_02_0169.html index 964aac2d..7afd3133 100644 --- a/docs/dli/api-ref/dli_02_0169.html +++ b/docs/dli/api-ref/dli_02_0169.html @@ -7,7 +7,7 @@

    URI

    • URI format

      POST /v2.0/{project_id}/resources/jars

    • Parameter description -
      - @@ -213,7 +217,8 @@
      Table 1 URI parameter description

      Parameter

      +
      @@ -179,7 +179,7 @@
      Table 1 URI parameter

      Parameter

      Mandatory

      -
      Table 4 details parameter description

      Parameter

      +
      @@ -256,7 +256,8 @@
      Table 4 details parameter description

      Parameter

      Mandatory

      -

      Example Request

      {
+
      Example Request
      Upload a JAR file from OBS to DLI and name the group gatk.
      
+
      {
     "paths": [
         "https://test.obs.xxx.com/test_dli.jar"
     ],
@@ -311,7 +312,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0170.html b/docs/dli/api-ref/dli_02_0170.html index 39876f0b..10be1b19 100644 --- a/docs/dli/api-ref/dli_02_0170.html +++ b/docs/dli/api-ref/dli_02_0170.html @@ -7,7 +7,7 @@

      URI

      • URI format

        POST /v2.0/{project_id}/resources/pyfiles

      • Parameter description -
        Table 1 URI parameters

        Parameter

        +
        @@ -179,7 +179,7 @@
        Table 1 URI parameter

        Parameter

        Mandatory

        -
        Table 4 details parameter description

        Parameter

        +
        @@ -256,7 +256,8 @@
        Table 4 details parameter description

        Parameter

        Mandatory

        -

        Example Request

        {
+
        Example Request
        Upload a Python file from OBS to DLI and name the group gatk.
        
+
        {
     "paths": [
         "https://test.obs.xxx.com/dli_tf.py"
     ],
@@ -311,7 +312,7 @@
        -

        Error Codes

        If 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 Code.

        +

        Error Codes

        If 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.

        diff --git a/docs/dli/api-ref/dli_02_0171.html b/docs/dli/api-ref/dli_02_0171.html index ecdacdb8..ca1b708e 100644 --- a/docs/dli/api-ref/dli_02_0171.html +++ b/docs/dli/api-ref/dli_02_0171.html @@ -7,7 +7,7 @@

        URI

        • URI format

          POST /v2.0/{project_id}/resources/files

        • Parameter description -
          Table 1 URI parameters

          Parameter

          +
          @@ -179,7 +179,7 @@
          Table 1 URI parameter

          Parameter

          Mandatory

          -
          Table 4 details parameter description

          Parameter

          +
          @@ -256,7 +256,8 @@
          Table 4 details parameter description

          Parameter

          Mandatory

          -

          Example Request

          {
+
          Example Request
          Upload a file from OBS to DLI and name the group gatk.
          
+
          {
     "paths": [
         "https: //test.obs.xxx.com/test_dli.jar",
         "https://test.obs.xxx.com/dli_tf.py"
@@ -321,7 +322,7 @@
          -

          Error Codes

          If 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 Code.

          +

          Error Codes

          If 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.

          diff --git a/docs/dli/api-ref/dli_02_0172.html b/docs/dli/api-ref/dli_02_0172.html index cc214d9c..5673b7f0 100644 --- a/docs/dli/api-ref/dli_02_0172.html +++ b/docs/dli/api-ref/dli_02_0172.html @@ -5,7 +5,7 @@

          URI

          • URI format

            GET /v2.0/{project_id}/resources/{resource_name}

          • Parameter description -
            Table 1 URI parameter description

            Parameter

            +
            @@ -37,7 +37,7 @@
            Table 1 URI parameters

            Parameter

            Mandatory

            -
            Table 2 query parameter description

            Parameter

            +
            @@ -166,7 +166,7 @@
            Table 2 query parameter description

            Parameter

            Mandatory

            -

            Error Codes

            If 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 Code.

            +

            Error Codes

            If 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.

            diff --git a/docs/dli/api-ref/dli_02_0173.html b/docs/dli/api-ref/dli_02_0173.html index 44d4944f..66fc22ed 100644 --- a/docs/dli/api-ref/dli_02_0173.html +++ b/docs/dli/api-ref/dli_02_0173.html @@ -37,7 +37,7 @@
            -
            Table 2 query parameter description

            Parameter

            +
            @@ -94,7 +94,7 @@
            Table 2 query parameter description

            Parameter

            Mandatory

            -

            Error Codes

            If 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 Code.

            +

            Error Codes

            If 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.

            diff --git a/docs/dli/api-ref/dli_02_0187.html b/docs/dli/api-ref/dli_02_0187.html index 12a7eed8..918f5fb3 100644 --- a/docs/dli/api-ref/dli_02_0187.html +++ b/docs/dli/api-ref/dli_02_0187.html @@ -206,7 +206,8 @@
            -

            Example Request

            {
+
            Example Request
            Create an enhanced datasource connection for a queue and configure host information.
            
+
            {
   "name": "test",
   "dest_vpc_id": "22094d8f-c310-4621-913d-4c4d655d8495",
   "dest_network_id": "78f2562a-36e4-4b39-95b9-f5aab22e1281",
@@ -259,7 +260,7 @@
          -

          Error Codes

          If 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 Code.

          +

          Error Codes

          If 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.

          diff --git a/docs/dli/api-ref/dli_02_0188.html b/docs/dli/api-ref/dli_02_0188.html index 43d61013..f00fd4b5 100644 --- a/docs/dli/api-ref/dli_02_0188.html +++ b/docs/dli/api-ref/dli_02_0188.html @@ -103,7 +103,7 @@
        -

        Error Codes

        If 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 Code.

        +

        Error Codes

        If 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.

        diff --git a/docs/dli/api-ref/dli_02_0189.html b/docs/dli/api-ref/dli_02_0189.html index 4e0f5637..e2f7d1ab 100644 --- a/docs/dli/api-ref/dli_02_0189.html +++ b/docs/dli/api-ref/dli_02_0189.html @@ -5,7 +5,7 @@

        URI

        • URI format

          GET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}

        • Parameter description -
          Table 1 URI parameter

          Parameter

          +
          @@ -146,7 +146,7 @@
          Table 1 URI parameters

          Parameter

          Mandatory

          -
          - - - - -
          Table 3 available_queue_info parameter description

          Parameter

          +
          @@ -205,7 +205,7 @@
          Table 3 available_queue_info parameter description

          Parameter

          Mandatory

          -
          Table 4 hosts parameter description

          Parameter

          +
          @@ -269,65 +269,6 @@
          Table 4 hosts parameter description

          Parameter

          Mandatory
          - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 6 elastic_resource_pools parameters

          Parameter

          -

          Mandatory

          -

          Type

          -

          Description

          -

          peer_id

          -

          No

          -

          String

          -

          ID of a datasource connection.

          -

          status

          -

          No

          -

          String

          -

          Connection status. For details about the status code, see Table 5.

          -

          name

          -

          No

          -

          String

          -

          Elastic resource pool name

          -

          err_msg

          -

          No

          -

          String

          -

          Detailed error message when the status is FAILED.

          -

          update_time

          -

          No

          -

          Long

          -

          Update time

          -
          -

          Example Request

          None

          @@ -361,9 +302,9 @@ ] } -

          Status Codes

          Table 7 describes the status code.

          +

          Status Codes

          Table 6 describes the status code.

          -
          Table 7 Status codes

          Status Code

          +
          @@ -388,7 +329,7 @@
          Table 6 Status codes

          Status Code

          Description

          -

          Error Codes

          If 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 Code.

          +

          Error Codes

          If 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.

          diff --git a/docs/dli/api-ref/dli_02_0190.html b/docs/dli/api-ref/dli_02_0190.html index 2fb89aa5..25ce7312 100644 --- a/docs/dli/api-ref/dli_02_0190.html +++ b/docs/dli/api-ref/dli_02_0190.html @@ -28,7 +28,7 @@
          -
          Table 2 query parameter description

          Parameter

          +
          @@ -234,7 +234,7 @@ - @@ -243,7 +243,7 @@
          Table 2 query parameter description

          Parameter

          Mandatory

          No

          Array of Objects

          +

          Array of objects

          User-defined host information. For details, see Table 6.

          -
          - - - - -
          Table 5 available_queue_info parameter description

          Parameter

          +
          @@ -422,7 +422,7 @@
          Table 5 available_queue_info parameter description

          Parameter

          Mandatory

          -

          Error Codes

          If 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 Code.

          +

          Error Codes

          If 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.

          diff --git a/docs/dli/api-ref/dli_02_0191.html b/docs/dli/api-ref/dli_02_0191.html index 58afd26d..dd8d3a67 100644 --- a/docs/dli/api-ref/dli_02_0191.html +++ b/docs/dli/api-ref/dli_02_0191.html @@ -58,15 +58,6 @@

          List of queue names that are available for datasource connections.

          elastic_resource_pools

          -

          No

          -

          Array of Strings

          -

          Elastic resource pools you want to bind to the enhanced datasource connection.

          -
          @@ -98,7 +89,8 @@
          -

          Example Request

          {
+
          Example Request
          Bind created enhanced datasource connections to queues q1 and q2.
          
+
          {
   "queues": [
     "q1",
     "q2"
@@ -137,7 +129,7 @@
          -

          Error Codes

          If 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 Code.

          +

          Error Codes

          If 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.

          diff --git a/docs/dli/api-ref/dli_02_0192.html b/docs/dli/api-ref/dli_02_0192.html index 98212c98..4589c0ad 100644 --- a/docs/dli/api-ref/dli_02_0192.html +++ b/docs/dli/api-ref/dli_02_0192.html @@ -58,15 +58,6 @@

          List of queue names that are available for datasource connections.

          elastic_resource_pools

          -

          No

          -

          Array of Strings

          -

          Elastic resource pools you want to unbind from the enhanced datasource connection.

          -
          @@ -98,7 +89,8 @@
        -

        Example Request

        {
+
        Example Request
        Unbind queues q1 and q2 from enhanced datasource connections.
        
+
        {
   "queues": [
     "q1",
     "q2"
@@ -137,7 +129,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0194.html b/docs/dli/api-ref/dli_02_0194.html index fc734dcb..8167027b 100644 --- a/docs/dli/api-ref/dli_02_0194.html +++ b/docs/dli/api-ref/dli_02_0194.html @@ -111,8 +111,8 @@

      Integer

      Queue resource mode. The options are as follows:

      -

      0: indicates the shared resource mode.

      -

      1: indicates the exclusive resource mode.

      +

      0: shared resource mode

      +

      1: dedicated resource mode

      labels

      @@ -121,7 +121,7 @@

      Array of Strings

      Tag information of the queue to be created. Currently, the tag information includes whether the queue is cross-AZ (JSON character string). The value can only be 2, that is, a dual-AZ queue whose compute resources are distributed in two AZs is created.

      +

      Tag information of the queue to be created. Currently, the tag information includes whether the queue is cross-AZ (JSON string). The value can only be 2, that is, a dual-AZ queue whose compute resources are distributed in two AZs is created.

      tags

      @@ -154,6 +154,8 @@

      String

      Tag key.

      +
      NOTE:

      A tag key can contain a maximum of 36 characters. Special characters (=*<>\|) are not allowed, and the key cannot start with a space.

      +

      value

      @@ -163,6 +165,8 @@

      String

      Tag value.

      +
      NOTE:

      A tag value can contain a maximum of 43 characters. Special characters (=*<>\|) are not allowed, and the value cannot start with a space.

      +
    -

    Example Request

    {
+
    Example Request
    Create a dedicated general-purpose queue named queue1, with specifications of 16 CUs and compute resources distributed in two AZs.
    
+
    {
     "queue_name": "queue1",
     "description": "test",
     "cu_count": 16,
@@ -255,7 +260,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0195.html b/docs/dli/api-ref/dli_02_0195.html index f4413e60..f457003c 100644 --- a/docs/dli/api-ref/dli_02_0195.html +++ b/docs/dli/api-ref/dli_02_0195.html @@ -7,7 +7,7 @@

    URI

    • URI format

      DELETE /v1.0/{project_id}/queues/{queue_name}

    • Parameter description -
      Table 1 URI parameter

      Parameter

      +
      @@ -109,7 +109,7 @@
      Table 1 URI parameters

      Parameter

      Mandatory

      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0196.html b/docs/dli/api-ref/dli_02_0196.html index fbe75626..8333ad4a 100644 --- a/docs/dli/api-ref/dli_02_0196.html +++ b/docs/dli/api-ref/dli_02_0196.html @@ -28,7 +28,7 @@
      -
      Table 2 query parameter description

      Parameter

      +
      @@ -301,7 +301,7 @@ -
      Table 2 query parameter description

      Parameter

      Mandatory

      Integer

      Specifications of a queue. For a queue whose billing mode is yearly/monthly, this parameter indicates the CU value of the yearly/monthly part. For a pay-per-use queue, this parameter indicates the initial value when a user purchases a queue.

      +

      Specifications of a queue.

      cu_scale_out_limit

      @@ -380,7 +380,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0200.html b/docs/dli/api-ref/dli_02_0200.html index e81a78c6..9672180d 100644 --- a/docs/dli/api-ref/dli_02_0200.html +++ b/docs/dli/api-ref/dli_02_0200.html @@ -121,7 +121,8 @@
    -

    Example Request

    {
+
    Example Request
    Modify the host information of an enhanced datasource connection.
    
+
    {
   "hosts": [
     {
       "ip":"192.168.0.1",
@@ -166,7 +167,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0201.html b/docs/dli/api-ref/dli_02_0201.html index b0fdf4c9..f146d54d 100644 --- a/docs/dli/api-ref/dli_02_0201.html +++ b/docs/dli/api-ref/dli_02_0201.html @@ -35,7 +35,7 @@

POST /v1.0/{project_id}/queues

-

dli:queue:create_queue

+

dli:queue:createQueue

-

@@ -48,7 +48,7 @@

DELETE /v1.0/{project_id}/queues/{queue_name}

-

dli:queue:drop_queue

+

dli:queue:dropQueue

-

@@ -61,7 +61,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:queue:submit_job

+

dli:queue:submitJob

-

@@ -74,7 +74,7 @@

DELETE /v1.0/{project_id}/jobs/{job_id}

-

dli:queue:cancel_job

+

dli:queue:cancelJob

-

@@ -87,7 +87,7 @@

GET /v1.0/{project_id}/queues/{queue_name}/users

-

dli:queue:show_privileges

+

dli:queue:showPrivileges

-

@@ -113,7 +113,7 @@

PUT /v1.0/{project_id}/queues/{queue_name}/action

-

dli:queue:scale_queue

+

dli:queue:scaleQueue

-

@@ -122,11 +122,11 @@

×

-

Granting permissions to a specified user queue

+

Granting elastic resource pool permissions

PUT /v1.0/{project_id}/user-authorization

-

dli:queue:grant_privilege

+

dli:elasticresourcepool:grantPrivilege

-

@@ -135,11 +135,11 @@

×

-

Removing permissions of a specified user queue

+

Revoking elastic resource pool permissions

-

POST /v1.0/{project_id}/databases

+

PUT /v1.0/{project_id}/user-authorization

-

dli:database:create_database

+

dli:elasticresourcepool:revokePrivilege

-

@@ -152,7 +152,7 @@

POST /v1.0/{project_id}/databases

-

dli:database:create_database

+

dli:database:createDatabase

-

@@ -165,7 +165,7 @@

DELETE /v1.0/{project_id}/databases/{database_name}

-

dli:database:drop_database

+

dli:database:dropDatabase

-

@@ -178,7 +178,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:database:alter_database_properties

+

dli:database:alterDatabaseProperties

-

@@ -191,7 +191,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:explain

+

dli:database:explain

-

@@ -204,7 +204,7 @@

POST /v1.0/{project_id}/databases/{database_name}/tables

-

dli:database:create_table

+

dli:database:createTable

-

@@ -217,7 +217,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

database:create_view

+

dli:database:createView

-

@@ -230,7 +230,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:create_function

+

dli:database:createFunction

-

@@ -243,7 +243,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:describe_function

+

dli:database:describeFunction

-

@@ -256,7 +256,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:drop_function

+

dli:database:dropFunction

-

@@ -269,7 +269,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:show_functions

+

dli:database:showFunctions

-

@@ -282,7 +282,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:create_role

+

dli:database:createRole

-

@@ -295,7 +295,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:drop_role

+

dli:database:dropRole

-

@@ -308,7 +308,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:show_roles

+

dli:database:showRoles

-

@@ -321,7 +321,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:show_all_roles

+

dli:database:showAllRoles

-

@@ -334,7 +334,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:grant_role

+

dli:database:grantRole

-

@@ -347,7 +347,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:revoke_role

+

dli:database:revokeRole

-

@@ -360,7 +360,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:database:show_users

+

dli:database:showUsers

-

@@ -373,7 +373,7 @@

GET /v1.0/{project_id}/databases/{database_name}/users

-

dli:database:show_privileges

+

dli:database:showPrivileges

-

@@ -399,7 +399,7 @@

GET /v1.0/{project_id}/databases

-

dli:database:display_all_databases

+

dli:database:displayAllDatabases

-

@@ -412,7 +412,7 @@

GET /v1.0/{project_id}/databases

-

dli:database:display_all_tables

+

dli:database:displayAllTables

-

@@ -425,7 +425,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:database:grant_privilege

+

dli:database:grantPrivilege

-

@@ -438,7 +438,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:database:revoke_privilege

+

dli:database:revokePrivilege

-

@@ -451,7 +451,7 @@

DELETE /v1.0/{project_id}/databases/{database_name}/tables/{table_name}

-

dli:table:drop_table

+

dli:table:dropTable

-

@@ -464,7 +464,7 @@

GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}

-

dli:table:describe_table

+

dli:table:describeTable

-

@@ -490,7 +490,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:show_table_properties

+

dli:table:showTableProperties

-

@@ -503,7 +503,7 @@

GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/preview

-

dli:table:show_create_table

+

dli:table:showCreateTable

-

@@ -516,7 +516,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:show_partitions

+

dli:table:showPartitions

-

@@ -529,7 +529,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_set_properties

+

dli:table:alterTableSetProperties

-

@@ -542,7 +542,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_add_columns

+

dli:table:alterTableAddColumns

-

@@ -555,7 +555,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_add_partition

+

dli:table:alterTableAddPartition

-

@@ -568,7 +568,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_rename_partition

+

dli:table:alterTableRenamePartition

-

@@ -581,7 +581,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_drop_partition

+

dli:table:alterTableDropPartition

-

@@ -594,7 +594,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_recover_partition

+

dli:table:alterTableRecoverPartition

-

@@ -607,7 +607,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_rename

+

dli:table:alterTableRename

-

@@ -620,7 +620,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_table_set_location

+

dli:table:alterTableSetLocation

-

@@ -633,7 +633,7 @@

POST /v1.0/{project_id}/jobs/submit-job, statement invoking

-

dli:table:insert_into_table

+

dli:table:insertIntoTable

-

@@ -646,7 +646,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:insert_overwrite_table

+

dli:table:insertOverwriteTable

-

@@ -659,7 +659,7 @@

GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/users

-

dli:table:show_privileges

+

dli:table:showPrivileges

-

@@ -672,7 +672,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:table:truncate_table

+

dli:table:truncateTable

-

@@ -711,7 +711,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:table:alter_table_change_column

+

dli:table:alterTableChangeColumn

-

@@ -724,7 +724,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:table:alter_table_drop_columns

+

dli:table:alterTableDropColumns

-

@@ -737,7 +737,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:table:show_segments

+

dli:table:showSegments

-

@@ -750,7 +750,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:table:compaction

+

dli:table:compaction

-

@@ -763,7 +763,7 @@

POST /v1.0/{project_id}/jobs/submit-job, SQL statement invoking

-

dli:table:alter_view

+

dli:table:alterView

-

@@ -772,11 +772,11 @@

×

-

Displaying a table

+

Displaying the table structure

POST /v1.0/{project_id}/jobs/submit-job

-

dli:table:display_table

+

dli:table:describeTable

-

@@ -789,7 +789,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:table:grant_privilege

+

dli:table:grantPrivilege

-

@@ -802,7 +802,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:table:revoke_privilege

+

dli:table:revokePrivilege

-

@@ -815,7 +815,7 @@

GET /v1.0/{project_id}/datasource/auth-infos/{auth_name}/users

-

dli:datasourceauth:show_privileges

+

dli:datasourceauth:showPrivileges

-

@@ -828,7 +828,7 @@

POST /v1.0/{project_id}/jobs/submit-job

-

dli:datasourceauth:use_auth

+

dli:datasourceauth:useAuth

-

@@ -841,7 +841,7 @@

DELETE /v2.0/{project_id}/datasource/auth-infos/{auth_info_name}

-

dli:datasourceauth:drop_auth

+

dli:datasourceauth:dropAuth

-

@@ -850,24 +850,11 @@

×

-

Granting security authentication permissions to a specified user

- -

PUT /v1.0/{project_id}/user-authorization

- -

dli:datasourceauth:grant_privilege

- -

-

- -

√

- -

×

- -

Updating security authentication information

PUT /v2.0/{project_id}/datasource/auth-infos

-

dli:datasourceauth:update_auth

+

dli:datasourceauth:updateAuth

-

@@ -880,7 +867,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:datasourceauth:grant_privilege

+

dli:datasourceauth:grantPrivilege

-

@@ -893,7 +880,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:datasourceauth:revoke_privilege

+

dli:datasourceauth:revokePrivilege

-

@@ -919,7 +906,7 @@

GET /v1.0/:x_project_id/streaming/jobs

-

dli:jobs:list_all

+

dli:jobs:listAll

-

@@ -1010,7 +997,7 @@

PUT /v1.0/{{project_id}}/authorization

-

dli:jobs:grant_privilege

+

dli:jobs:grantPrivilege

-

@@ -1049,7 +1036,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:column:grant_privilege

+

dli:column:grantPrivilege

-

@@ -1062,7 +1049,7 @@

PUT /v1.0/{project_id}/user-authorization

-

dli:column:revoke_privilege

+

dli:column:revokePrivilege

-

@@ -1075,7 +1062,7 @@

GET /v1.0/:x_project_id/jobs

-

dli:jobs:list_job

+

dli:jobs:listAll

-

@@ -1088,7 +1075,7 @@

GET /v1.0/:x_project_id/job/:job_id

-

dli:jobs:get_job

+

dli:jobs:get

-

@@ -1101,7 +1088,7 @@

POST /v1.0/:x_project_id/sql_job

-

dli:jobs:create_job

+

dli:jobs:create

-

@@ -1114,7 +1101,7 @@

PATCH /v1.0/:x_project_id/sql_job

-

dli:jobs:update_job

+

dli:jobs:update

-

@@ -1127,7 +1114,7 @@

DELETE /v1.0/:x_project_id/job/:job_id

-

dli:jobs:delete_job

+

dli:jobs:delete

-

@@ -1140,7 +1127,7 @@

POST v1.0/:x_project_id/job/:job_id/run

-

dli:queue:submit_job

+

dli:jobs:start

-

@@ -1153,7 +1140,7 @@

POST /v1.0/:x_project_id/job/:job_id/stop

-

dli:queue:cancel_job

+

dli:jobs:stop

-

diff --git a/docs/dli/api-ref/dli_02_0225.html b/docs/dli/api-ref/dli_02_0225.html index a3e64768..0a8215b9 100644 --- a/docs/dli/api-ref/dli_02_0225.html +++ b/docs/dli/api-ref/dli_02_0225.html @@ -5,7 +5,7 @@

URI

  • URI format

    POST /v1.0/{project_id}/dli/obs-authorize

  • Parameter description -
    Table 1 URI parameters

    Parameter

    +
    @@ -86,7 +86,8 @@
    Table 1 URI parameter

    Parameter

    Mandatory

    -

    Example Request

    {
+
    Example Request
    Grant DLI the permission to access the OBS bucket bucket1 so that DLI can save job checkpoints and run logs to the bucket.
    
+
    {
     "obs_buckets": [
         "bucket1"
     ]
@@ -119,7 +120,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0228.html b/docs/dli/api-ref/dli_02_0228.html index 4e9191f4..cf7f2b07 100644 --- a/docs/dli/api-ref/dli_02_0228.html +++ b/docs/dli/api-ref/dli_02_0228.html @@ -83,7 +83,7 @@

String

-

Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.

+

Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1,024 x 1,024 characters.

run_mode

@@ -191,7 +191,7 @@

Integer

-

Retention time of the idle state. The unit is hour. The default value is 1.

+

Retention time of the idle state. The unit is second. The default value is 3600.

job_type

@@ -287,6 +287,15 @@

Customizes optimization parameters when a Flink job is running.

+

flink_version

+ +

No

+ +

String

+ +

Flink version. Currently, only 1.10 and 1.12 are supported.

+ +
@@ -308,6 +317,8 @@

String

Tag key.

+
NOTE:

A tag key can contain a maximum of 36 characters. Only letters, digits, hyphens (-), underscores (_), and spaces are allowed. The key cannot start or end with a space.

+

value

@@ -317,6 +328,8 @@

String

Tag key.

+
NOTE:

A tag value can contain a maximum of 43 characters. Only letters, digits, hyphens (-), underscores (_), periods (.), and spaces are allowed. The value cannot start or end with a space.

+
@@ -406,7 +419,8 @@
-

Example Request

{
+
Example Request
Use the template whose ID is 100000 to create a Flink SQL job named myjob. The job runs in dedicated mode on the testQueue queue.

+
{
     "name": "myjob",
     "desc": "This is a job used for counting characters.",
     "template_id": 100000,
@@ -459,7 +473,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0229.html b/docs/dli/api-ref/dli_02_0229.html index 16a88122..fe721c81 100644 --- a/docs/dli/api-ref/dli_02_0229.html +++ b/docs/dli/api-ref/dli_02_0229.html @@ -279,7 +279,7 @@

String

-

Traffic or hit ratio of each operator, which is a character string in JSON format. Example:

+

Traffic or hit ratio of each operator, which is a string in JSON format. Example:

{"operator_list":[{"id":"0a448493b4782967b150582570326227","rate_factor":0.55},{"id":"6d2677a0ecc3fd8df0b72ec675edf8f4","rate_factor":1},{"id":"ea632d67b7d595e5b851708ae9ad79d6","rate_factor":0.55},{"id":"bc764cd8ddf7a0cff126f51c16239658","output_rate":2000}]}
@@ -292,6 +292,15 @@

Customizes optimization parameters when a Flink job is running.

+

flink_version

+ +

No

+ +

String

+ +

Flink version. Currently, only 1.10 and 1.12 are supported.

+ +
@@ -361,7 +370,8 @@ -

Example Request

{
+
Example Request
Update an existing SQL job. The updated job is named myjob and runs on testQueue in shared mode.

+
{
     "name": "myjob",
     "desc": "My first job",
     "queue_name": "testQueue",
@@ -415,7 +425,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0230.html b/docs/dli/api-ref/dli_02_0230.html index ae249435..a1eedd62 100644 --- a/docs/dli/api-ref/dli_02_0230.html +++ b/docs/dli/api-ref/dli_02_0230.html @@ -362,7 +362,8 @@
-

Example Request

{
+
Example Request
Create a Flink Jar job named test, set the job to be executed on testQueue, set the number of CUs used by the job, and enable the job log function.

+
{
     "name": "test",
     "desc": "job for test",
     "queue_name": "testQueue",
@@ -420,7 +421,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0231.html b/docs/dli/api-ref/dli_02_0231.html index 8c787233..2873835d 100644 --- a/docs/dli/api-ref/dli_02_0231.html +++ b/docs/dli/api-ref/dli_02_0231.html @@ -100,7 +100,7 @@

Integer

-

Number of parallel operations selected for a job. The default value is 1.

+

Number of parallel operations selected for a job. The default value is 1.

log_enabled

@@ -319,7 +319,8 @@
-

Example Request

{
+
Example Request
Update the Flink Jar job information. After the update, the job name is test1, the job execution queue is testQueue, and the job log function is disabled.

+
{
     "name": "test1",
     "desc": "job for test",
     "job_type": "flink_jar_job",
@@ -371,7 +372,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0233.html b/docs/dli/api-ref/dli_02_0233.html index aa650de6..5889860c 100644 --- a/docs/dli/api-ref/dli_02_0233.html +++ b/docs/dli/api-ref/dli_02_0233.html @@ -120,7 +120,8 @@
-

Example Request

{
+
Example Request
Run the jobs whose IDs are 131, 130, 138, and 137 and allow the jobs to be restored from their latest savepoints.

+
{
     "job_ids": [131,130,138,137],
     "resume_savepoint": true
 }

@@ -166,7 +167,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0234.html b/docs/dli/api-ref/dli_02_0234.html index 149da331..8426846c 100644 --- a/docs/dli/api-ref/dli_02_0234.html +++ b/docs/dli/api-ref/dli_02_0234.html @@ -5,7 +5,7 @@

URI

  • URI format

    GET /v1.0/{project_id}/streaming/jobs

  • Parameter description -
    Table 1 URI parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 URI parameter

    Parameter

    Mandatory

    -
    Table 2 query parameter description

    Parameter

    +
    @@ -541,7 +541,7 @@ @@ -688,7 +688,7 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    Integer

    Number of concurrent jobs set by a user. This parameter is valid only when show_detail is set to true.

    -
    • Minimum value: 1
    • Maximum value: 2,000
    +
    • Minimum value: 1
    • Maximum value: 2000

    The default value is 1.
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0235.html b/docs/dli/api-ref/dli_02_0235.html index c5830011..ab395581 100644 --- a/docs/dli/api-ref/dli_02_0235.html +++ b/docs/dli/api-ref/dli_02_0235.html @@ -629,66 +629,6 @@ "start_time": null } } -
  • The following example takes the flink_opensource_sql_job type as an example:
    {
-    "is_success": "true",
-    "message": "The job information query succeeds.",
-    "job_detail": {
-        "job_type": "flink_opensource_sql_job",
-        "status_desc": "",
-        "create_time": 1637632872828,
-        "sql_body": "xxx",
-        "savepoint_path": null,
-        "main_class": null,
-        "queue_name": "xie_container_general",
-        "execution_graph": "xxx",
-        "start_time": 1638433497621,
-        "update_time": 1638449337993,
-        "job_config": {
-            "checkpoint_enabled": true,
-            "checkpoint_interval": 600,
-            "checkpoint_mode": "exactly_once",
-            "log_enabled": true,
-            "obs_bucket": "dli-test",
-            "root_id": -1,
-            "edge_group_ids": null,
-            "graph_editor_enabled": false,
-            "graph_editor_data": "",
-            "manager_cu_number": 1,
-            "executor_number": null,
-            "executor_cu_number": null,
-            "cu_number": 2,
-            "parallel_number": 3,
-            "smn_topic": "",
-            "restart_when_exception": true,
-            "resume_checkpoint": true,
-            "resume_max_num": -1,
-            "checkpoint_path": null,
-            "idle_state_retention": 3600,
-            "config_url": null,
-            "udf_jar_url": "test/flink_test-1.0-SNAPSHOT-jar-with-dependencies.jar",
-            "dirty_data_strategy": "0",
-            "entrypoint": "test/flink_test-1.0-SNAPSHOT-jar-with-dependencies.jar",
-            "dependency_jars": null,
-            "dependency_files": null,
-            "tm_cus": 1,
-            "tm_slot_num": 3,
-            "image": null,
-            "feature": null,
-            "flink_version": null,
-            "operator_config": "xxx",
-            "static_estimator_config": "xxx",
-            "runtime_config": null
-        },
-        "user_id": "xxx",
-        "project_id": "xxx",
-        "run_mode": "exclusive_cluster",
-        "job_id": 90634,
-        "name": "test_guoquan",
-        "desc": "",
-        "entrypoint_args": null,
-        "status": "job_cancel_success"
-    }
-}

    • Status Codes

    Table 5 describes the status code.

    @@ -713,7 +653,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0236.html b/docs/dli/api-ref/dli_02_0236.html index db215ad4..25821dee 100644 --- a/docs/dli/api-ref/dli_02_0236.html +++ b/docs/dli/api-ref/dli_02_0236.html @@ -196,7 +196,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0241.html b/docs/dli/api-ref/dli_02_0241.html index 3e39ab1e..1d3d6262 100644 --- a/docs/dli/api-ref/dli_02_0241.html +++ b/docs/dli/api-ref/dli_02_0241.html @@ -119,7 +119,8 @@
-

Example Request

{
+
Example Request
Stop the jobs whose IDs are 128 and 137.

+
{
   "job_ids": [128, 137],
   "trigger_savepoint": false
 }

@@ -149,7 +150,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0242.html b/docs/dli/api-ref/dli_02_0242.html index c0b3adda..a93374df 100644 --- a/docs/dli/api-ref/dli_02_0242.html +++ b/docs/dli/api-ref/dli_02_0242.html @@ -104,7 +104,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0243.html b/docs/dli/api-ref/dli_02_0243.html index 2ae9e3d0..946a2e51 100644 --- a/docs/dli/api-ref/dli_02_0243.html +++ b/docs/dli/api-ref/dli_02_0243.html @@ -86,7 +86,8 @@
-

Example Request

{
+
Example Request
Delete the jobs whose IDs are 12 and 232.

+
{
   "job_ids":[12,232]
 }

 

@@ -117,7 +118,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0245.html b/docs/dli/api-ref/dli_02_0245.html index 358cbb9c..3d66601b 100644 --- a/docs/dli/api-ref/dli_02_0245.html +++ b/docs/dli/api-ref/dli_02_0245.html @@ -5,7 +5,7 @@

URI

  • URI format

    POST /v1.0/{project_id}/streaming/job-templates

  • Parameter description -
    Table 1 URI parameters

    Parameter

    +
    @@ -82,7 +82,7 @@ - @@ -222,7 +222,8 @@
    Table 1 URI parameter

    Parameter

    Mandatory

    String

    Flink job template type. The default value is flink_sql_job. You can set this parameter to flink_sql_job or flink_opensource_sql_job only.

    +

    Flink job template type.

    -

    Example Request

    {
+
    Example Request
    Create a job template named simple_stream_sql.
    
+
    {
     "name": "simple_stream_sql",
     "desc": "Example of quick start",
     "sql_body": "select * from source_table"
@@ -262,7 +263,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0246.html b/docs/dli/api-ref/dli_02_0246.html index fea57bcf..cf629473 100644 --- a/docs/dli/api-ref/dli_02_0246.html +++ b/docs/dli/api-ref/dli_02_0246.html @@ -113,7 +113,8 @@
-

Example Request

{
+
Example Request
Update job template information, including the template name, template description, and template SQL statements.

+
{
     "name": "simple_stream_sql",
     "desc": "Example of quick start",
     "sql_body": "select * from source_table"
@@ -146,7 +147,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0247.html b/docs/dli/api-ref/dli_02_0247.html index 9e0d4d91..ba3dcd22 100644 --- a/docs/dli/api-ref/dli_02_0247.html +++ b/docs/dli/api-ref/dli_02_0247.html @@ -138,7 +138,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0248.html b/docs/dli/api-ref/dli_02_0248.html index 0117d25d..bc4b6058 100644 --- a/docs/dli/api-ref/dli_02_0248.html +++ b/docs/dli/api-ref/dli_02_0248.html @@ -5,7 +5,7 @@

URI

  • URI format

    GET /v1.0/{project_id}/streaming/job-templates

  • Parameter description -
    Table 1 URI parameters

    Parameter

    +
    @@ -28,7 +28,7 @@
    Table 1 URI parameter

    Parameter

    Mandatory

    -
    Table 2 query parameter description

    Parameter

    +
    @@ -294,7 +294,7 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0249.html b/docs/dli/api-ref/dli_02_0249.html index 97f94d2f..07bdc9cf 100644 --- a/docs/dli/api-ref/dli_02_0249.html +++ b/docs/dli/api-ref/dli_02_0249.html @@ -5,7 +5,7 @@

    Only SQL queues in the Available status can be restarted. (The queue status is Available only after the SQL job is successfully executed.)

    -

    URI

    • URI format

      PUT /v1.0/{project_id}/queues/{queue_name}/action

      +

      URI

      • URI format

        PUT /v1.0/{project_id}/queues/{queue_name}/action

      • Parameter description
        @@ -145,11 +145,11 @@
        Table 1 URI parameters

        Parameter

      -

      Example Request

      • Restarting the queue: 
        {
+
        Example Request
        • Restart a queue.
          {
     "action": "restart",
     "force": "false"
 }
          
-
        • Scaling out the queue:
          {
+
        • Increase the number of CUs of the queue to 16.
          {
     "action": "scale_out",
     "cu_count": 16
 }
          
@@ -197,7 +197,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0250.html b/docs/dli/api-ref/dli_02_0250.html index c68a464a..913fedaf 100644 --- a/docs/dli/api-ref/dli_02_0250.html +++ b/docs/dli/api-ref/dli_02_0250.html @@ -46,7 +46,7 @@
    Table 5 Error codes

    Error Code

    -
    Table 2 query parameter description

    Parameter

    +
    @@ -133,7 +133,7 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    -
    Table 4 partitions parameter description

    Parameter

    +
    @@ -165,7 +165,7 @@
    Table 4 partitions parameter description

    Parameter

    Mandatory

    -
    Table 5 partition_infos parameter description

    Parameter

    +
    @@ -334,7 +334,7 @@
    Table 5 partition_infos parameter description

    Parameter

    Mandatory

    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0252.html b/docs/dli/api-ref/dli_02_0252.html index 261abea5..d8833c3a 100644 --- a/docs/dli/api-ref/dli_02_0252.html +++ b/docs/dli/api-ref/dli_02_0252.html @@ -31,7 +31,7 @@
    -
    Table 2 query parameter description

    Parameter

    +
    @@ -242,7 +242,7 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0253.html b/docs/dli/api-ref/dli_02_0253.html index db937421..19b0b154 100644 --- a/docs/dli/api-ref/dli_02_0253.html +++ b/docs/dli/api-ref/dli_02_0253.html @@ -108,7 +108,8 @@
    Table 6 Error codes

    Error Code

    -

    Example Request

    {
+
    Example Request
    Change the group name of the program package to groupName and the user name to scuser1.
    
+
    {
     "new_owner": "scuser1",
     "group_name": "groupName"
 }
    
@@ -140,7 +141,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0254.html b/docs/dli/api-ref/dli_02_0254.html index f19eb0bc..484b114b 100644 --- a/docs/dli/api-ref/dli_02_0254.html +++ b/docs/dli/api-ref/dli_02_0254.html @@ -5,7 +5,7 @@

    URI

    • URI format

      POST /v1.0/{project_id}/streaming/jobs/export

    • Parameter description -
    Table 5 Error codes

    Error Code
    Table 1 URI parameters

    Parameter

    +
    @@ -115,7 +115,8 @@
    Table 1 URI parameter

    Parameter

    Mandatory

    -

    Example Request

    {
+
    Example Request
    Export the job whose ID is 100 to OBS.
    
+
    {
     "obs_dir": "obs-test",
     "is_selected": true,
     "job_selected": [100]
@@ -149,7 +150,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0255.html b/docs/dli/api-ref/dli_02_0255.html index e6f3a5fa..de070694 100644 --- a/docs/dli/api-ref/dli_02_0255.html +++ b/docs/dli/api-ref/dli_02_0255.html @@ -106,7 +106,7 @@
    -
    Table 4 job_mapping parameter description

    Parameter

    +
    @@ -147,7 +147,8 @@
    Table 4 job_mapping parameter description

    Parameter

    Mandatory

    -

    Example Request

    {
+
    Example Request
    Whether to overwrite the existing job if the name of the imported job is the same as that of an existing job when Flink job data is imported from OBS.
    
+
    {
     "zip_file": "test/ggregate_1582677879475.zip",
     "is_cover": true
 }
    
@@ -186,7 +187,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0256.html b/docs/dli/api-ref/dli_02_0256.html index 177d8bc0..4ba0de4d 100644 --- a/docs/dli/api-ref/dli_02_0256.html +++ b/docs/dli/api-ref/dli_02_0256.html @@ -169,7 +169,7 @@
    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0258.html b/docs/dli/api-ref/dli_02_0258.html index 83eaaec1..75ffd163 100644 --- a/docs/dli/api-ref/dli_02_0258.html +++ b/docs/dli/api-ref/dli_02_0258.html @@ -104,7 +104,8 @@
    Table 5 Error codes

    Error Code

    -

    Example Request

    {
+
    Example Request
    Create a global variable that is sensitive.
    
+
    {
     "var_name": "string",
     "var_value": "string",
     "is_sensitive": true
@@ -137,7 +138,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0259.html b/docs/dli/api-ref/dli_02_0259.html index 2cb2db44..b2064410 100644 --- a/docs/dli/api-ref/dli_02_0259.html +++ b/docs/dli/api-ref/dli_02_0259.html @@ -105,7 +105,7 @@
Table 5 Error codes

Error Code

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0260.html b/docs/dli/api-ref/dli_02_0260.html index cb7d8268..747c0831 100644 --- a/docs/dli/api-ref/dli_02_0260.html +++ b/docs/dli/api-ref/dli_02_0260.html @@ -95,7 +95,8 @@
Table 4 Error codes

Error Code

-

Example Request

{
+
Example Request
Change the value of a sensitive variable.

+
{
     "var_value": "string"
 }

 

@@ -126,7 +127,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0261.html b/docs/dli/api-ref/dli_02_0261.html index 85d9d395..e88e258a 100644 --- a/docs/dli/api-ref/dli_02_0261.html +++ b/docs/dli/api-ref/dli_02_0261.html @@ -28,7 +28,7 @@
Table 5 Error codes

Error Code

-
Table 2 query parameter description

Parameter

+
@@ -247,7 +247,7 @@
Table 2 query parameter description

Parameter

Mandatory

-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0284.html b/docs/dli/api-ref/dli_02_0284.html index 3a9c2dcc..6a165de8 100644 --- a/docs/dli/api-ref/dli_02_0284.html +++ b/docs/dli/api-ref/dli_02_0284.html @@ -3,7 +3,7 @@

Creating an Address Connectivity Test Request

Function

This API is used to send an address connectivity test request to a specified queue and insert the test address into the table.

-

URI

  • URI format

    POST /v1.0/{project_id}/queues/{queue_name}/connection-test

    +

    URI

    • URI format

      POST /v1.0/{project_id}/queues/{queue_name}/connection-test

    • Parameter description
Table 6 Error codes

Error Code
@@ -104,7 +104,8 @@
Table 1 URI parameters

Parameter

-

Example Request

{
+
Example Request
Test the connectivity between the queue and the address iam.xxx.com:443.

+
{
     "address": "iam.xxx.com:443"
 }

 

@@ -141,7 +142,7 @@
-

Error Codes

If 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 Code.

+

Error Codes

If 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.

diff --git a/docs/dli/api-ref/dli_02_0285.html b/docs/dli/api-ref/dli_02_0285.html index e4b536aa..a2703136 100644 --- a/docs/dli/api-ref/dli_02_0285.html +++ b/docs/dli/api-ref/dli_02_0285.html @@ -3,7 +3,7 @@

Querying Connectivity Test Details of a Specified Address

Function

This API is used to query the connectivity test result after the test is submitted.

-

URI

  • URI format

    GET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}

    +

    URI

    • URI format

      GET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}

    • Parameter description
      @@ -126,7 +126,7 @@
      Table 1 URI parameters

      Parameter

    -

    Error Codes

    If 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 Code.

    +

    Error Codes

    If 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.

    diff --git a/docs/dli/api-ref/dli_02_0291.html b/docs/dli/api-ref/dli_02_0291.html index 4add05b1..f142f158 100644 --- a/docs/dli/api-ref/dli_02_0291.html +++ b/docs/dli/api-ref/dli_02_0291.html @@ -3,7 +3,7 @@

    Creating a Scheduled CU Change

    Function

    This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.

    -

    URI

    • URI format

      POST /v1/{project_id}/queues/{queue_name}/plans

      +

      URI

      • URI format

        POST /v1/{project_id}/queues/{queue_name}/plans

      • Parameter description
        @@ -159,7 +159,8 @@
        Table 1 URI parameters

        Parameter

      -

      Example Request

      {
+
      Example Request
      Create a scaling plan named plan_A for the queue. According to the plan, the queue is scaled out at 20:30 on Monday, Tuesday, Wednesday, and Sunday, to 64 CUs.
      
+
      {
     "plan_name": "plan_A",
     "target_cu": 64,
     "start_hour": 20,
@@ -207,7 +208,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0292.html b/docs/dli/api-ref/dli_02_0292.html index f56f17db..3ad5a89c 100644 --- a/docs/dli/api-ref/dli_02_0292.html +++ b/docs/dli/api-ref/dli_02_0292.html @@ -256,7 +256,7 @@
      Table 5 Error codes

      Error Code

      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0293.html b/docs/dli/api-ref/dli_02_0293.html index a378f3d5..c24efb05 100644 --- a/docs/dli/api-ref/dli_02_0293.html +++ b/docs/dli/api-ref/dli_02_0293.html @@ -95,7 +95,8 @@
      Table 5 Error codes

      Error Code

      -

      Example Request

      {
+
      Example Request
      Delete the scaling plans whose IDs are 3 and 4.
      
+
      {
    "plan_ids": [3,4]
 }
      
 
      
@@ -131,7 +132,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0294.html b/docs/dli/api-ref/dli_02_0294.html index 260fab09..547376c8 100644 --- a/docs/dli/api-ref/dli_02_0294.html +++ b/docs/dli/api-ref/dli_02_0294.html @@ -3,7 +3,7 @@

      Deleting a Scheduled CU Change

      Function

      This API is used to delete a scheduled CU change for a queue with a specified ID.

      -

      URI

      • URI format

        DELETE /v1/{project_id}/queues/{queue_name}/plans/{plan_id}

        +

        URI

        • URI format

          DELETE /v1/{project_id}/queues/{queue_name}/plans/{plan_id}

        • Parameter description
      Table 5 Error codes

      Error Code
      @@ -116,7 +116,7 @@
      Table 1 URI parameters

      Parameter

      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0295.html b/docs/dli/api-ref/dli_02_0295.html index e9c76800..63a29b1f 100644 --- a/docs/dli/api-ref/dli_02_0295.html +++ b/docs/dli/api-ref/dli_02_0295.html @@ -3,7 +3,7 @@

      Modifying a Scheduled CU Change

      Function

      This API is used to modify a scheduled CU change for a queue with a specified ID.

      -

      URI

      • URI format

        PUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}

        +

        URI

        • URI format

          PUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id}

        • Parameter description
      Table 4 Error codes

      Error Code
      @@ -186,12 +186,13 @@
      Table 1 URI parameters

      Parameter

      -

      Example Request

      {
-    "plan_name": "plan_Ad",
+
      Example Request
      Modify the scaling plan named plan_A. After the modification, the number of CUs of the queue is scaled to 64 at 19:30 on Thursday and Friday, and the scaling plan is not activated.
      
+
      {
+    "plan_name": "plan_A",
     "target_cu": 64,
     "start_hour": 19,
     "start_minute": 30,
-    "repeat_day": ["THURSDAY","friday"],
+    "repeat_day": ["THURSDAY","FRIDAY"],
     "activate": false
 }
      
 
      
@@ -229,7 +230,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0296.html b/docs/dli/api-ref/dli_02_0296.html index 2d697e12..cc8915bf 100644 --- a/docs/dli/api-ref/dli_02_0296.html +++ b/docs/dli/api-ref/dli_02_0296.html @@ -369,7 +369,7 @@
      Table 5 Error codes

      Error Code

      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0298.html b/docs/dli/api-ref/dli_02_0298.html index 42748d80..b5b1987a 100644 --- a/docs/dli/api-ref/dli_02_0298.html +++ b/docs/dli/api-ref/dli_02_0298.html @@ -3,7 +3,7 @@

      Obtaining DLI Agency Information

      Function

      This API is used to obtain the agency information of a DLI user.

      -

      URI

      • URI format

        GET /v2/{project_id}/agency

        +

        URI

        • URI format

          GET /v2/{project_id}/agency

        • Parameter description
      Table 5 Error codes

      Error Code
      @@ -136,7 +136,7 @@
      Table 1 URI parameters

      Parameter

      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0299.html b/docs/dli/api-ref/dli_02_0299.html index 9ab4816f..5579d148 100644 --- a/docs/dli/api-ref/dli_02_0299.html +++ b/docs/dli/api-ref/dli_02_0299.html @@ -3,7 +3,7 @@

      Creating a DLI Agency

      Function

      This API is used to create an agency for a DLI user.

      -

      URI

      • URI format

        POST /v2/{project_id}/agency

        +

        URI

        • URI format

          POST /v2/{project_id}/agency

        • Parameter description
      Table 4 Error codes

      Error Code
      @@ -46,13 +46,10 @@ - @@ -92,7 +89,8 @@
      Table 1 URI parameters

      Parameter

      Array of Strings

      Role. Currently, only obs_adm, dis_adm, ctable_adm, vpc_netadm, smn_adm, and te_admin are supported.

      -

      obs_adm: Administrator permissions for accessing and using the Object Storage Service.

      -

      dis_adm: Administrator permissions for using Data Ingestion Service data as the data source

      -

      ctable_adm: Administrator permissions for accessing and using the CloudTable service

      -

      vpc_netadm: Administrator permissions for using the Virtual Private Cloud service

      -

      smn_adm: Administrator permissions for using the Simple Message Notification service

      -

      te_admin: Tenant Administrator permissions

      +

      Role.

      +

      Currently, only obs_adm, dis_adm, ctable_adm, vpc_netadm, smn_adm, and te_admin are supported.

      +

      +
      • obs_adm: Administrator permissions for accessing and using the Object Storage Service.
      • dis_adm: Administrator permissions for using Data Ingestion Service data as the data source
      • ctable_adm: Administrator permissions for accessing and using the CloudTable service
      • vpc_netadm: Administrator permissions for using the Virtual Private Cloud service
      • smn_adm: Administrator permissions for using the Simple Message Notification service
      • te_admin: Tenant Administrator permissions
      -

      Example Request

      {
+
      Example Request
      Create a DLI user agency. The agency has the following permissions: CloudTable Administrator for accessing and using CloudTable, VPC Administrator for using VPC, DIS Administrator for accessing and using DIS, SMN Administrator for using SMN, and accessing and using OBS.
      
+
      {
     "roles": [
         "ctable_adm",
         "vpc_netadm",
@@ -129,7 +127,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0312.html b/docs/dli/api-ref/dli_02_0312.html index 5966da78..087210e8 100644 --- a/docs/dli/api-ref/dli_02_0312.html +++ b/docs/dli/api-ref/dli_02_0312.html @@ -122,7 +122,7 @@

      String

      Job type, including DDL, DCL, IMPORT, EXPORT, QUERY, INSERT, DATA_MIGRATION, UPDATE, DELETE, RESTART_QUEUE and SCALE_QUEUE.

      -

      Currently, you can only query execution results of jobs of the QUERY type.

      +

      Currently, you can only query execution results of jobs of the QUERY type.

      row_count

      @@ -147,7 +147,7 @@

      No

      -

      Array of Objects

      +

      Array of Objects

      Name and type of the job result column.

      @@ -217,7 +217,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.

      diff --git a/docs/dli/api-ref/dli_02_0316.html b/docs/dli/api-ref/dli_02_0316.html index 6296955b..82a92138 100644 --- a/docs/dli/api-ref/dli_02_0316.html +++ b/docs/dli/api-ref/dli_02_0316.html @@ -118,7 +118,8 @@

      String

      -

      Job types. Only flink_opensource_sql_job job is supported.

      +

      Job types.

      +

      Only flink_opensource_sql_job job is supported.

      graph_type

      @@ -137,7 +138,7 @@

      String

      -

      Traffic or hit ratio of each operator, which is a character string in JSON format.

      +

      Traffic or hit ratio of each operator, which is a string in JSON format.

      @@ -195,7 +196,8 @@
      -

      Example Request

      {
+
      Example Request
      Generate a static stream graph for a Flink SQL job.
      
+
      {
    "cu_number": 4,
    "manager_cu_number": 1,
    "parallel_number": 4,
@@ -238,7 +240,7 @@
      -

      Error Codes

      If 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 Code.

      +

      Error Codes

      If 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.