diff --git a/docs/dli/api-ref/ALL_META.TXT.json b/docs/dli/api-ref/ALL_META.TXT.json index 59cb6e9c..eba9434d 100644 --- a/docs/dli/api-ref/ALL_META.TXT.json +++ b/docs/dli/api-ref/ALL_META.TXT.json @@ -5,8 +5,8 @@ "code":"1", "des":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", "doc_type":"api", - "kw":"Calling APIs,API Reference", - "title":"Calling APIs", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", "githuburl":"" }, { @@ -325,254 +325,114 @@ "code":"33", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"APIs Related to SQL Jobs", - "title":"APIs Related to SQL Jobs", - "githuburl":"" - }, - { - "uri":"dli_02_0027.html", - "product_code":"dli", - "code":"34", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Database-related APIs", - "title":"Database-related APIs", - "githuburl":"" - }, - { - "uri":"dli_02_0028.html", - "product_code":"dli", - "code":"35", - "des":"This API is used to add a database.URI formatPOST /v1.0/{project_id}/databasesPOST /v1.0/{project_id}/databasesParameter descriptionURI parameterParameterMandatoryTypeDes", - "doc_type":"api", - "kw":"Creating a Database,Database-related APIs,API Reference", - "title":"Creating a Database", - "githuburl":"" - }, - { - "uri":"dli_02_0030.html", - "product_code":"dli", - "code":"36", - "des":"This API is used to delete an empty database. If there are tables in the database to be deleted, delete all tables first. For details about the API used to delete tables,", - "doc_type":"api", - "kw":"Deleting a Database,Database-related APIs,API Reference", - "title":"Deleting a Database", - "githuburl":"" - }, - { - "uri":"dli_02_0029.html", - "product_code":"dli", - "code":"37", - "des":"This API is used to query the information about all the databases.URI formatGET /v1.0/{project_id}/databasesGET /v1.0/{project_id}/databasesParameter descriptionURI param", - "doc_type":"api", - "kw":"Querying All Databases,Database-related APIs,API Reference", - "title":"Querying All Databases", - "githuburl":"" - }, - { - "uri":"dli_02_0164.html", - "product_code":"dli", - "code":"38", - "des":"This API is used to modify the owner of a database.URI formatPUT /v1.0/{project_id}/databases/{database_name}/ownerPUT /v1.0/{project_id}/databases/{database_name}/ownerP", - "doc_type":"api", - "kw":"Modifying a Database Owner,Database-related APIs,API Reference", - "title":"Modifying a Database Owner", - "githuburl":"" - }, - { - "uri":"dli_02_0031.html", - "product_code":"dli", - "code":"39", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Table-related APIs", - "title":"Table-related APIs", - "githuburl":"" - }, - { - "uri":"dli_02_0034.html", - "product_code":"dli", - "code":"40", - "des":"This API is used to create a table.This API is a synchronous API.URI formatPOST /v1.0/{project_id}/databases/{database_name}/tablesPOST /v1.0/{project_id}/databases/{data", - "doc_type":"api", - "kw":"Creating a Table,Table-related APIs,API Reference", - "title":"Creating a Table", - "githuburl":"" - }, - { - "uri":"dli_02_0035.html", - "product_code":"dli", - "code":"41", - "des":"This API is used to delete a specified table.URI formatDELETE /v1.0/{project_id}/databases/{database_name}/tables/{table_name}DELETE /v1.0/{project_id}/databases/{databas", - "doc_type":"api", - "kw":"Deleting a Table,Table-related APIs,API Reference", - "title":"Deleting a Table", - "githuburl":"" - }, - { - "uri":"dli_02_0105.html", - "product_code":"dli", - "code":"42", - "des":"This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.URI formatGET /v1.0/{project_id}/databases", - "doc_type":"api", - "kw":"Querying All Tables (Recommended),Table-related APIs,API Reference", - "title":"Querying All Tables (Recommended)", - "githuburl":"" - }, - { - "uri":"dli_02_0033.html", - "product_code":"dli", - "code":"43", - "des":"This API is used to describe metadata information in the specified table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}GET /v1.0/{project_", - "doc_type":"api", - "kw":"Describing the Table Information,Table-related APIs,API Reference", - "title":"Describing the Table Information", - "githuburl":"" - }, - { - "uri":"dli_02_0108.html", - "product_code":"dli", - "code":"44", - "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", - "doc_type":"api", - "kw":"Previewing Table Content,Table-related APIs,API Reference", - "title":"Previewing Table Content", - "githuburl":"" - }, - { - "uri":"dli_02_0250.html", - "product_code":"dli", - "code":"45", - "des":"This API is used to obtain the partition list.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitionsGET /v1.0/{project_id}/databases/{d", - "doc_type":"api", - "kw":"Obtaining the Partition List,Table-related APIs,API Reference", - "title":"Obtaining the Partition List", - "githuburl":"" - }, - { - "uri":"dli_02_0017.html", - "product_code":"dli", - "code":"46", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Job-related APIs", - "title":"Job-related APIs", - "githuburl":"" - }, - { - "uri":"dli_02_0019.html", - "product_code":"dli", - "code":"47", - "des":"This API is used to import data from a file to a DLI or OBS table. Currently, only OBS data can be imported to a DLI or OBS table.This API is asynchronous.When importing ", - "doc_type":"api", - "kw":"Importing Data,Job-related APIs,API Reference", - "title":"Importing Data", - "githuburl":"" - }, - { - "uri":"dli_02_0020.html", - "product_code":"dli", - "code":"48", - "des":"This API is used to export data from a DLI table to a file.This API is asynchronous.Currently, data can be exported only from a DLI table to OBS, and the OBS path must be", - "doc_type":"api", - "kw":"Exporting Data,Job-related APIs,API Reference", - "title":"Exporting Data", + "kw":"SQL Job related APIs", + "title":"SQL Job related APIs", "githuburl":"" }, { "uri":"dli_02_0102.html", "product_code":"dli", - "code":"49", + "code":"34", "des":"This API is used to submit jobs to a queue using SQL statements.The job types support DDL, DCL, IMPORT, QUERY, and INSERT. The IMPORT function is the same as that describ", "doc_type":"api", - "kw":"Submitting a SQL Job (Recommended),Job-related APIs,API Reference", + "kw":"Submitting a SQL Job (Recommended),SQL Job related APIs,API Reference", "title":"Submitting a SQL Job (Recommended)", "githuburl":"" }, { "uri":"dli_02_0104.html", "product_code":"dli", - "code":"50", + "code":"35", "des":"This API is used to cancel a submitted job. If execution of a job completes or fails, this job cannot be canceled.URI formatDELETE /v1.0/{project_id}/jobs/{job_id}DELETE ", "doc_type":"api", - "kw":"Canceling a Job (Recommended),Job-related APIs,API Reference", + "kw":"Canceling a Job (Recommended),SQL Job related APIs,API Reference", "title":"Canceling a Job (Recommended)", "githuburl":"" }, { "uri":"dli_02_0025.html", "product_code":"dli", - "code":"51", + "code":"36", "des":"This API is used to query information about all jobs in the current project.URI formatGET /v1.0/{project_id}/jobsGET /v1.0/{project_id}/jobsParameter descriptionURI param", "doc_type":"api", - "kw":"Querying All Jobs,Job-related APIs,API Reference", + "kw":"Querying All Jobs,SQL Job related APIs,API Reference", "title":"Querying All Jobs", "githuburl":"" }, { "uri":"dli_02_0312.html", "product_code":"dli", - "code":"52", + "code":"37", "des":"This API is used to view the job execution result after a job is executed using SQL query statements. Currently, you can only query execution results of jobs of the QUERY", "doc_type":"api", - "kw":"Previewing SQL Job Query Results,Job-related APIs,API Reference", + "kw":"Previewing SQL Job Query Results,SQL Job related APIs,API Reference", "title":"Previewing SQL Job Query Results", "githuburl":"" }, { "uri":"dli_02_0021.html", "product_code":"dli", - "code":"53", + "code":"38", "des":"This API is used to query the status of a submitted job.URI formatGET /v1.0/{project_id}/jobs/{job_id}/statusGET /v1.0/{project_id}/jobs/{job_id}/statusParameter descript", "doc_type":"api", - "kw":"Querying Job Status,Job-related APIs,API Reference", + "kw":"Querying Job Status,SQL Job related APIs,API Reference", "title":"Querying Job Status", "githuburl":"" }, { "uri":"dli_02_0022.html", "product_code":"dli", - "code":"54", + "code":"39", "des":"This API is used to query details about jobs, including databasename, tablename, file size, and export mode.URI formatGET/v1.0/{project_id}/jobs/{job_id}/detailGET/v1.0/{", "doc_type":"api", - "kw":"Querying Job Details,Job-related APIs,API Reference", + "kw":"Querying Job Details,SQL Job related APIs,API Reference", "title":"Querying Job Details", "githuburl":"" }, { "uri":"dli_02_0107.html", "product_code":"dli", - "code":"55", + "code":"40", "des":"This API is used to check the SQL syntax.URI formatPOST /v1.0/{project_id}/jobs/check-sqlPOST /v1.0/{project_id}/jobs/check-sqlParameter descriptionURI parametersParamete", "doc_type":"api", - "kw":"Checking SQL Syntax,Job-related APIs,API Reference", + "kw":"Checking SQL Syntax,SQL Job related APIs,API Reference", "title":"Checking SQL Syntax", "githuburl":"" }, { "uri":"dli_02_0024.html", "product_code":"dli", - "code":"56", + "code":"41", "des":"This API is used to export results returned from the query using SQL statements to OBS. Only the query result of QUERY jobs can be exported.This API is asynchronous.Curre", "doc_type":"api", - "kw":"Exporting Query Results,Job-related APIs,API Reference", + "kw":"Exporting Query Results,SQL Job related APIs,API Reference", "title":"Exporting Query Results", "githuburl":"" }, { "uri":"dli_02_0296.html", "product_code":"dli", - "code":"57", + "code":"42", "des":"This API is used to obtain the job execution progress. If a job is being executed, information about its subjobs can be obtained. If a job has just started or has ended, ", "doc_type":"api", - "kw":"Querying the Job Execution Progress,Job-related APIs,API Reference", + "kw":"Querying the Job Execution Progress,SQL Job related APIs,API Reference", "title":"Querying the Job Execution Progress", "githuburl":"" }, + { + "uri":"dli_02_0356.html", + "product_code":"dli", + "code":"43", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource-related APIs", + "title":"Resource-related APIs", + "githuburl":"" + }, { "uri":"dli_02_0166.html", "product_code":"dli", - "code":"58", + "code":"44", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Package Group-related APIs", @@ -582,7 +442,7 @@ { "uri":"dli_02_0130.html", "product_code":"dli", - "code":"59", + "code":"45", "des":"This API is used to upload a package group to a project. The function is similar to creating a package on the management console.URI formatPOST /v2.0/{project_id}/resourc", "doc_type":"api", "kw":"Uploading a Package Group,Package Group-related APIs,API Reference", @@ -592,7 +452,7 @@ { "uri":"dli_02_0168.html", "product_code":"dli", - "code":"60", + "code":"46", "des":"This API is used to query all resources in a project, including groups.URI formatGET /v2.0/{project_id}/resourcesGET /v2.0/{project_id}/resourcesParameter descriptionURI ", "doc_type":"api", "kw":"Querying Package Group List,Package Group-related APIs,API Reference", @@ -602,7 +462,7 @@ { "uri":"dli_02_0169.html", "product_code":"dli", - "code":"61", + "code":"47", "des":"This API is used to upload a group of JAR packages to a project.When a resource group with the same name is uploaded, the new group overwrites the old group.URI formatPOS", "doc_type":"api", "kw":"Uploading a JAR Package Group,Package Group-related APIs,API Reference", @@ -612,7 +472,7 @@ { "uri":"dli_02_0170.html", "product_code":"dli", - "code":"62", + "code":"48", "des":"This API is used to upload a group of PyFile packages to a project.When a group with the same name as the PyFile package is uploaded, the new group overwrites the old gro", "doc_type":"api", "kw":"Uploading a PyFile Package Group,Package Group-related APIs,API Reference", @@ -622,7 +482,7 @@ { "uri":"dli_02_0171.html", "product_code":"dli", - "code":"63", + "code":"49", "des":"This API is used to upload a group of File packages to a project.When the File package group with the same name is uploaded, the new group overwrites the old group.URI fo", "doc_type":"api", "kw":"Uploading a File Package Group,Package Group-related APIs,API Reference", @@ -632,7 +492,7 @@ { "uri":"dli_02_0172.html", "product_code":"dli", - "code":"64", + "code":"50", "des":"This API is used to query resource information of a package group in a Project.URI formatGET /v2.0/{project_id}/resources/{resource_name}GET /v2.0/{project_id}/resources/", "doc_type":"api", "kw":"Querying Resource Packages in a Group,Package Group-related APIs,API Reference", @@ -642,7 +502,7 @@ { "uri":"dli_02_0173.html", "product_code":"dli", - "code":"65", + "code":"51", "des":"This API is used to delete resource packages in a group in a Project.URI formatDELETE /v2.0/{project_id}/resources/{resource_name}DELETE /v2.0/{project_id}/resources/{res", "doc_type":"api", "kw":"Deleting a Resource Package from a Group,Package Group-related APIs,API Reference", @@ -652,13 +512,153 @@ { "uri":"dli_02_0253.html", "product_code":"dli", - "code":"66", + "code":"52", "des":"This API is used to change the owner of a program package.URI formatPUT /v2.0/{project_id}/resources/ownerPUT /v2.0/{project_id}/resources/ownerParameter descriptionURI p", "doc_type":"api", "kw":"Changing the Owner of a Group or Resource Package,Package Group-related APIs,API Reference", "title":"Changing the Owner of a Group or Resource Package", "githuburl":"" }, + { + "uri":"dli_02_0027.html", + "product_code":"dli", + "code":"53", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Database-related APIs", + "title":"Database-related APIs", + "githuburl":"" + }, + { + "uri":"dli_02_0028.html", + "product_code":"dli", + "code":"54", + "des":"This API is used to add a database.URI formatPOST /v1.0/{project_id}/databasesPOST /v1.0/{project_id}/databasesParameter descriptionURI parameterParameterMandatoryTypeDes", + "doc_type":"api", + "kw":"Creating a Database,Database-related APIs,API Reference", + "title":"Creating a Database", + "githuburl":"" + }, + { + "uri":"dli_02_0030.html", + "product_code":"dli", + "code":"55", + "des":"This API is used to delete an empty database. If there are tables in the database to be deleted, delete all tables first. For details about the API used to delete tables,", + "doc_type":"api", + "kw":"Deleting a Database,Database-related APIs,API Reference", + "title":"Deleting a Database", + "githuburl":"" + }, + { + "uri":"dli_02_0029.html", + "product_code":"dli", + "code":"56", + "des":"This API is used to query the information about all the databases.URI formatGET /v1.0/{project_id}/databasesGET /v1.0/{project_id}/databasesParameter descriptionURI param", + "doc_type":"api", + "kw":"Querying All Databases,Database-related APIs,API Reference", + "title":"Querying All Databases", + "githuburl":"" + }, + { + "uri":"dli_02_0164.html", + "product_code":"dli", + "code":"57", + "des":"This API is used to modify the owner of a database.URI formatPUT /v1.0/{project_id}/databases/{database_name}/ownerPUT /v1.0/{project_id}/databases/{database_name}/ownerP", + "doc_type":"api", + "kw":"Modifying a Database Owner,Database-related APIs,API Reference", + "title":"Modifying a Database Owner", + "githuburl":"" + }, + { + "uri":"dli_02_0031.html", + "product_code":"dli", + "code":"58", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Table-related APIs", + "title":"Table-related APIs", + "githuburl":"" + }, + { + "uri":"dli_02_0034.html", + "product_code":"dli", + "code":"59", + "des":"This API is used to create a table.This API is a synchronous API.URI formatPOST /v1.0/{project_id}/databases/{database_name}/tablesPOST /v1.0/{project_id}/databases/{data", + "doc_type":"api", + "kw":"Creating a Table,Table-related APIs,API Reference", + "title":"Creating a Table", + "githuburl":"" + }, + { + "uri":"dli_02_0035.html", + "product_code":"dli", + "code":"60", + "des":"This API is used to delete a specified table.URI formatDELETE /v1.0/{project_id}/databases/{database_name}/tables/{table_name}DELETE /v1.0/{project_id}/databases/{databas", + "doc_type":"api", + "kw":"Deleting a Table,Table-related APIs,API Reference", + "title":"Deleting a Table", + "githuburl":"" + }, + { + "uri":"dli_02_0019.html", + "product_code":"dli", + "code":"61", + "des":"This API is used to import data from a file to a DLI or OBS table. Currently, only OBS data can be imported to a DLI or OBS table.This API is asynchronous.When importing ", + "doc_type":"api", + "kw":"Importing Data,Table-related APIs,API Reference", + "title":"Importing Data", + "githuburl":"" + }, + { + "uri":"dli_02_0020.html", + "product_code":"dli", + "code":"62", + "des":"This API is used to export data from a DLI table to a file.This API is asynchronous.Currently, data can be exported only from a DLI table to OBS, and the OBS path must be", + "doc_type":"api", + "kw":"Exporting Data,Table-related APIs,API Reference", + "title":"Exporting Data", + "githuburl":"" + }, + { + "uri":"dli_02_0105.html", + "product_code":"dli", + "code":"63", + "des":"This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.URI formatGET /v1.0/{project_id}/databases", + "doc_type":"api", + "kw":"Querying All Tables (Recommended),Table-related APIs,API Reference", + "title":"Querying All Tables (Recommended)", + "githuburl":"" + }, + { + "uri":"dli_02_0033.html", + "product_code":"dli", + "code":"64", + "des":"This API is used to describe metadata information in the specified table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}GET /v1.0/{project_", + "doc_type":"api", + "kw":"Describing the Table Information,Table-related APIs,API Reference", + "title":"Describing the Table Information", + "githuburl":"" + }, + { + "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", + "doc_type":"api", + "kw":"Previewing Table Content,Table-related APIs,API Reference", + "title":"Previewing Table Content", + "githuburl":"" + }, + { + "uri":"dli_02_0250.html", + "product_code":"dli", + "code":"66", + "des":"This API is used to obtain the partition list.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitionsGET /v1.0/{project_id}/databases/{d", + "doc_type":"api", + "kw":"Obtaining the Partition List,Table-related APIs,API Reference", + "title":"Obtaining the Partition List", + "githuburl":"" + }, { "uri":"dli_02_0223.html", "product_code":"dli", diff --git a/docs/dli/api-ref/CLASS.TXT.json b/docs/dli/api-ref/CLASS.TXT.json index b8d22363..0e75a24e 100644 --- a/docs/dli/api-ref/CLASS.TXT.json +++ b/docs/dli/api-ref/CLASS.TXT.json @@ -2,7 +2,7 @@ { "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", "product_code":"dli", - "title":"Calling APIs", + "title":"API Usage Guidelines", "uri":"dli_02_0500.html", "doc_type":"api", "p_code":"", @@ -290,155 +290,20 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dli", - "title":"APIs Related to SQL Jobs", + "title":"SQL Job related APIs", "uri":"dli_02_0158.html", "doc_type":"api", "p_code":"", "code":"33" }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dli", - "title":"Database-related APIs", - "uri":"dli_02_0027.html", - "doc_type":"api", - "p_code":"33", - "code":"34" - }, - { - "desc":"This API is used to add a database.URI formatPOST /v1.0/{project_id}/databasesPOST /v1.0/{project_id}/databasesParameter descriptionURI parameterParameterMandatoryTypeDes", - "product_code":"dli", - "title":"Creating a Database", - "uri":"dli_02_0028.html", - "doc_type":"api", - "p_code":"34", - "code":"35" - }, - { - "desc":"This API is used to delete an empty database. If there are tables in the database to be deleted, delete all tables first. For details about the API used to delete tables,", - "product_code":"dli", - "title":"Deleting a Database", - "uri":"dli_02_0030.html", - "doc_type":"api", - "p_code":"34", - "code":"36" - }, - { - "desc":"This API is used to query the information about all the databases.URI formatGET /v1.0/{project_id}/databasesGET /v1.0/{project_id}/databasesParameter descriptionURI param", - "product_code":"dli", - "title":"Querying All Databases", - "uri":"dli_02_0029.html", - "doc_type":"api", - "p_code":"34", - "code":"37" - }, - { - "desc":"This API is used to modify the owner of a database.URI formatPUT /v1.0/{project_id}/databases/{database_name}/ownerPUT /v1.0/{project_id}/databases/{database_name}/ownerP", - "product_code":"dli", - "title":"Modifying a Database Owner", - "uri":"dli_02_0164.html", - "doc_type":"api", - "p_code":"34", - "code":"38" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dli", - "title":"Table-related APIs", - "uri":"dli_02_0031.html", - "doc_type":"api", - "p_code":"33", - "code":"39" - }, - { - "desc":"This API is used to create a table.This API is a synchronous API.URI formatPOST /v1.0/{project_id}/databases/{database_name}/tablesPOST /v1.0/{project_id}/databases/{data", - "product_code":"dli", - "title":"Creating a Table", - "uri":"dli_02_0034.html", - "doc_type":"api", - "p_code":"39", - "code":"40" - }, - { - "desc":"This API is used to delete a specified table.URI formatDELETE /v1.0/{project_id}/databases/{database_name}/tables/{table_name}DELETE /v1.0/{project_id}/databases/{databas", - "product_code":"dli", - "title":"Deleting a Table", - "uri":"dli_02_0035.html", - "doc_type":"api", - "p_code":"39", - "code":"41" - }, - { - "desc":"This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.URI formatGET /v1.0/{project_id}/databases", - "product_code":"dli", - "title":"Querying All Tables (Recommended)", - "uri":"dli_02_0105.html", - "doc_type":"api", - "p_code":"39", - "code":"42" - }, - { - "desc":"This API is used to describe metadata information in the specified table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}GET /v1.0/{project_", - "product_code":"dli", - "title":"Describing the Table Information", - "uri":"dli_02_0033.html", - "doc_type":"api", - "p_code":"39", - "code":"43" - }, - { - "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", - "product_code":"dli", - "title":"Previewing Table Content", - "uri":"dli_02_0108.html", - "doc_type":"api", - "p_code":"39", - "code":"44" - }, - { - "desc":"This API is used to obtain the partition list.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitionsGET /v1.0/{project_id}/databases/{d", - "product_code":"dli", - "title":"Obtaining the Partition List", - "uri":"dli_02_0250.html", - "doc_type":"api", - "p_code":"39", - "code":"45" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dli", - "title":"Job-related APIs", - "uri":"dli_02_0017.html", - "doc_type":"api", - "p_code":"33", - "code":"46" - }, - { - "desc":"This API is used to import data from a file to a DLI or OBS table. Currently, only OBS data can be imported to a DLI or OBS table.This API is asynchronous.When importing ", - "product_code":"dli", - "title":"Importing Data", - "uri":"dli_02_0019.html", - "doc_type":"api", - "p_code":"46", - "code":"47" - }, - { - "desc":"This API is used to export data from a DLI table to a file.This API is asynchronous.Currently, data can be exported only from a DLI table to OBS, and the OBS path must be", - "product_code":"dli", - "title":"Exporting Data", - "uri":"dli_02_0020.html", - "doc_type":"api", - "p_code":"46", - "code":"48" - }, { "desc":"This API is used to submit jobs to a queue using SQL statements.The job types support DDL, DCL, IMPORT, QUERY, and INSERT. The IMPORT function is the same as that describ", "product_code":"dli", "title":"Submitting a SQL Job (Recommended)", "uri":"dli_02_0102.html", "doc_type":"api", - "p_code":"46", - "code":"49" + "p_code":"33", + "code":"34" }, { "desc":"This API is used to cancel a submitted job. If execution of a job completes or fails, this job cannot be canceled.URI formatDELETE /v1.0/{project_id}/jobs/{job_id}DELETE ", @@ -446,8 +311,8 @@ "title":"Canceling a Job (Recommended)", "uri":"dli_02_0104.html", "doc_type":"api", - "p_code":"46", - "code":"50" + "p_code":"33", + "code":"35" }, { "desc":"This API is used to query information about all jobs in the current project.URI formatGET /v1.0/{project_id}/jobsGET /v1.0/{project_id}/jobsParameter descriptionURI param", @@ -455,8 +320,8 @@ "title":"Querying All Jobs", "uri":"dli_02_0025.html", "doc_type":"api", - "p_code":"46", - "code":"51" + "p_code":"33", + "code":"36" }, { "desc":"This API is used to view the job execution result after a job is executed using SQL query statements. Currently, you can only query execution results of jobs of the QUERY", @@ -464,8 +329,8 @@ "title":"Previewing SQL Job Query Results", "uri":"dli_02_0312.html", "doc_type":"api", - "p_code":"46", - "code":"52" + "p_code":"33", + "code":"37" }, { "desc":"This API is used to query the status of a submitted job.URI formatGET /v1.0/{project_id}/jobs/{job_id}/statusGET /v1.0/{project_id}/jobs/{job_id}/statusParameter descript", @@ -473,8 +338,8 @@ "title":"Querying Job Status", "uri":"dli_02_0021.html", "doc_type":"api", - "p_code":"46", - "code":"53" + "p_code":"33", + "code":"38" }, { "desc":"This API is used to query details about jobs, including databasename, tablename, file size, and export mode.URI formatGET/v1.0/{project_id}/jobs/{job_id}/detailGET/v1.0/{", @@ -482,8 +347,8 @@ "title":"Querying Job Details", "uri":"dli_02_0022.html", "doc_type":"api", - "p_code":"46", - "code":"54" + "p_code":"33", + "code":"39" }, { "desc":"This API is used to check the SQL syntax.URI formatPOST /v1.0/{project_id}/jobs/check-sqlPOST /v1.0/{project_id}/jobs/check-sqlParameter descriptionURI parametersParamete", @@ -491,8 +356,8 @@ "title":"Checking SQL Syntax", "uri":"dli_02_0107.html", "doc_type":"api", - "p_code":"46", - "code":"55" + "p_code":"33", + "code":"40" }, { "desc":"This API is used to export results returned from the query using SQL statements to OBS. Only the query result of QUERY jobs can be exported.This API is asynchronous.Curre", @@ -500,8 +365,8 @@ "title":"Exporting Query Results", "uri":"dli_02_0024.html", "doc_type":"api", - "p_code":"46", - "code":"56" + "p_code":"33", + "code":"41" }, { "desc":"This API is used to obtain the job execution progress. If a job is being executed, information about its subjobs can be obtained. If a job has just started or has ended, ", @@ -509,8 +374,17 @@ "title":"Querying the Job Execution Progress", "uri":"dli_02_0296.html", "doc_type":"api", - "p_code":"46", - "code":"57" + "p_code":"33", + "code":"42" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dli", + "title":"Resource-related APIs", + "uri":"dli_02_0356.html", + "doc_type":"api", + "p_code":"", + "code":"43" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -518,8 +392,8 @@ "title":"Package Group-related APIs", "uri":"dli_02_0166.html", "doc_type":"api", - "p_code":"", - "code":"58" + "p_code":"43", + "code":"44" }, { "desc":"This API is used to upload a package group to a project. The function is similar to creating a package on the management console.URI formatPOST /v2.0/{project_id}/resourc", @@ -527,8 +401,8 @@ "title":"Uploading a Package Group", "uri":"dli_02_0130.html", "doc_type":"api", - "p_code":"58", - "code":"59" + "p_code":"44", + "code":"45" }, { "desc":"This API is used to query all resources in a project, including groups.URI formatGET /v2.0/{project_id}/resourcesGET /v2.0/{project_id}/resourcesParameter descriptionURI ", @@ -536,8 +410,8 @@ "title":"Querying Package Group List", "uri":"dli_02_0168.html", "doc_type":"api", - "p_code":"58", - "code":"60" + "p_code":"44", + "code":"46" }, { "desc":"This API is used to upload a group of JAR packages to a project.When a resource group with the same name is uploaded, the new group overwrites the old group.URI formatPOS", @@ -545,8 +419,8 @@ "title":"Uploading a JAR Package Group", "uri":"dli_02_0169.html", "doc_type":"api", - "p_code":"58", - "code":"61" + "p_code":"44", + "code":"47" }, { "desc":"This API is used to upload a group of PyFile packages to a project.When a group with the same name as the PyFile package is uploaded, the new group overwrites the old gro", @@ -554,8 +428,8 @@ "title":"Uploading a PyFile Package Group", "uri":"dli_02_0170.html", "doc_type":"api", - "p_code":"58", - "code":"62" + "p_code":"44", + "code":"48" }, { "desc":"This API is used to upload a group of File packages to a project.When the File package group with the same name is uploaded, the new group overwrites the old group.URI fo", @@ -563,8 +437,8 @@ "title":"Uploading a File Package Group", "uri":"dli_02_0171.html", "doc_type":"api", - "p_code":"58", - "code":"63" + "p_code":"44", + "code":"49" }, { "desc":"This API is used to query resource information of a package group in a Project.URI formatGET /v2.0/{project_id}/resources/{resource_name}GET /v2.0/{project_id}/resources/", @@ -572,8 +446,8 @@ "title":"Querying Resource Packages in a Group", "uri":"dli_02_0172.html", "doc_type":"api", - "p_code":"58", - "code":"64" + "p_code":"44", + "code":"50" }, { "desc":"This API is used to delete resource packages in a group in a Project.URI formatDELETE /v2.0/{project_id}/resources/{resource_name}DELETE /v2.0/{project_id}/resources/{res", @@ -581,8 +455,8 @@ "title":"Deleting a Resource Package from a Group", "uri":"dli_02_0173.html", "doc_type":"api", - "p_code":"58", - "code":"65" + "p_code":"44", + "code":"51" }, { "desc":"This API is used to change the owner of a program package.URI formatPUT /v2.0/{project_id}/resources/ownerPUT /v2.0/{project_id}/resources/ownerParameter descriptionURI p", @@ -590,6 +464,132 @@ "title":"Changing the Owner of a Group or Resource Package", "uri":"dli_02_0253.html", "doc_type":"api", + "p_code":"44", + "code":"52" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dli", + "title":"Database-related APIs", + "uri":"dli_02_0027.html", + "doc_type":"api", + "p_code":"43", + "code":"53" + }, + { + "desc":"This API is used to add a database.URI formatPOST /v1.0/{project_id}/databasesPOST /v1.0/{project_id}/databasesParameter descriptionURI parameterParameterMandatoryTypeDes", + "product_code":"dli", + "title":"Creating a Database", + "uri":"dli_02_0028.html", + "doc_type":"api", + "p_code":"53", + "code":"54" + }, + { + "desc":"This API is used to delete an empty database. If there are tables in the database to be deleted, delete all tables first. For details about the API used to delete tables,", + "product_code":"dli", + "title":"Deleting a Database", + "uri":"dli_02_0030.html", + "doc_type":"api", + "p_code":"53", + "code":"55" + }, + { + "desc":"This API is used to query the information about all the databases.URI formatGET /v1.0/{project_id}/databasesGET /v1.0/{project_id}/databasesParameter descriptionURI param", + "product_code":"dli", + "title":"Querying All Databases", + "uri":"dli_02_0029.html", + "doc_type":"api", + "p_code":"53", + "code":"56" + }, + { + "desc":"This API is used to modify the owner of a database.URI formatPUT /v1.0/{project_id}/databases/{database_name}/ownerPUT /v1.0/{project_id}/databases/{database_name}/ownerP", + "product_code":"dli", + "title":"Modifying a Database Owner", + "uri":"dli_02_0164.html", + "doc_type":"api", + "p_code":"53", + "code":"57" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dli", + "title":"Table-related APIs", + "uri":"dli_02_0031.html", + "doc_type":"api", + "p_code":"43", + "code":"58" + }, + { + "desc":"This API is used to create a table.This API is a synchronous API.URI formatPOST /v1.0/{project_id}/databases/{database_name}/tablesPOST /v1.0/{project_id}/databases/{data", + "product_code":"dli", + "title":"Creating a Table", + "uri":"dli_02_0034.html", + "doc_type":"api", + "p_code":"58", + "code":"59" + }, + { + "desc":"This API is used to delete a specified table.URI formatDELETE /v1.0/{project_id}/databases/{database_name}/tables/{table_name}DELETE /v1.0/{project_id}/databases/{databas", + "product_code":"dli", + "title":"Deleting a Table", + "uri":"dli_02_0035.html", + "doc_type":"api", + "p_code":"58", + "code":"60" + }, + { + "desc":"This API is used to import data from a file to a DLI or OBS table. Currently, only OBS data can be imported to a DLI or OBS table.This API is asynchronous.When importing ", + "product_code":"dli", + "title":"Importing Data", + "uri":"dli_02_0019.html", + "doc_type":"api", + "p_code":"58", + "code":"61" + }, + { + "desc":"This API is used to export data from a DLI table to a file.This API is asynchronous.Currently, data can be exported only from a DLI table to OBS, and the OBS path must be", + "product_code":"dli", + "title":"Exporting Data", + "uri":"dli_02_0020.html", + "doc_type":"api", + "p_code":"58", + "code":"62" + }, + { + "desc":"This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.URI formatGET /v1.0/{project_id}/databases", + "product_code":"dli", + "title":"Querying All Tables (Recommended)", + "uri":"dli_02_0105.html", + "doc_type":"api", + "p_code":"58", + "code":"63" + }, + { + "desc":"This API is used to describe metadata information in the specified table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}GET /v1.0/{project_", + "product_code":"dli", + "title":"Describing the Table Information", + "uri":"dli_02_0033.html", + "doc_type":"api", + "p_code":"58", + "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", + "product_code":"dli", + "title":"Previewing Table Content", + "uri":"dli_02_0108.html", + "doc_type":"api", + "p_code":"58", + "code":"65" + }, + { + "desc":"This API is used to obtain the partition list.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/partitionsGET /v1.0/{project_id}/databases/{d", + "product_code":"dli", + "title":"Obtaining the Partition List", + "uri":"dli_02_0250.html", + "doc_type":"api", "p_code":"58", "code":"66" }, diff --git a/docs/dli/api-ref/dli_02_0017.html b/docs/dli/api-ref/dli_02_0017.html deleted file mode 100644 index 88fccf45..00000000 --- a/docs/dli/api-ref/dli_02_0017.html +++ /dev/null @@ -1,35 +0,0 @@ - - -

Job-related APIs

-
-
- - -
-
Parent topic: APIs Related to SQL Jobs
-
-
- diff --git a/docs/dli/api-ref/dli_02_0019.html b/docs/dli/api-ref/dli_02_0019.html index 0db25037..24367a2d 100644 --- a/docs/dli/api-ref/dli_02_0019.html +++ b/docs/dli/api-ref/dli_02_0019.html @@ -415,7 +415,7 @@
-
Parent topic: Job-related APIs
+
Parent topic: Table-related APIs
diff --git a/docs/dli/api-ref/dli_02_0020.html b/docs/dli/api-ref/dli_02_0020.html index d201b206..a3e0b63f 100644 --- a/docs/dli/api-ref/dli_02_0020.html +++ b/docs/dli/api-ref/dli_02_0020.html @@ -221,7 +221,7 @@
-
Parent topic: Job-related APIs
+
Parent topic: Table-related APIs
diff --git a/docs/dli/api-ref/dli_02_0021.html b/docs/dli/api-ref/dli_02_0021.html index d70ccbdd..6a6b1578 100644 --- a/docs/dli/api-ref/dli_02_0021.html +++ b/docs/dli/api-ref/dli_02_0021.html @@ -313,7 +313,7 @@
-
Parent topic: Job-related APIs
+
Parent topic: SQL Job related APIs
diff --git a/docs/dli/api-ref/dli_02_0022.html b/docs/dli/api-ref/dli_02_0022.html index 8c347c1b..9e837bd6 100644 --- a/docs/dli/api-ref/dli_02_0022.html +++ b/docs/dli/api-ref/dli_02_0022.html @@ -329,7 +329,7 @@
-
Parent topic: Job-related APIs
+
Parent topic: SQL Job related APIs
diff --git a/docs/dli/api-ref/dli_02_0024.html b/docs/dli/api-ref/dli_02_0024.html index e261d291..2e119d1d 100644 --- a/docs/dli/api-ref/dli_02_0024.html +++ b/docs/dli/api-ref/dli_02_0024.html @@ -229,7 +229,7 @@
-
Parent topic: Job-related APIs
+
Parent topic: SQL Job related APIs
diff --git a/docs/dli/api-ref/dli_02_0025.html b/docs/dli/api-ref/dli_02_0025.html index 29b2f2fd..3827385b 100644 --- a/docs/dli/api-ref/dli_02_0025.html +++ b/docs/dli/api-ref/dli_02_0025.html @@ -500,7 +500,7 @@
-
Parent topic: Job-related APIs
+
Parent topic: SQL Job related APIs
diff --git a/docs/dli/api-ref/dli_02_0027.html b/docs/dli/api-ref/dli_02_0027.html index e0eb6b67..0896609c 100644 --- a/docs/dli/api-ref/dli_02_0027.html +++ b/docs/dli/api-ref/dli_02_0027.html @@ -15,7 +15,7 @@
-
Parent topic: APIs Related to SQL Jobs
+
Parent topic: Resource-related APIs
diff --git a/docs/dli/api-ref/dli_02_0031.html b/docs/dli/api-ref/dli_02_0031.html index 1146a97c..4a9b4cdd 100644 --- a/docs/dli/api-ref/dli_02_0031.html +++ b/docs/dli/api-ref/dli_02_0031.html @@ -8,6 +8,10 @@
  • Deleting a Table
    • +
  • Importing Data
    +
    • +
  • Exporting Data
    +
  • Querying All Tables (Recommended)
  • Describing the Table Information
    @@ -19,7 +23,7 @@
    -
    Parent topic: APIs Related to SQL Jobs
    +
    Parent topic: Resource-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0034.html b/docs/dli/api-ref/dli_02_0034.html index 85fed689..03aa65cf 100644 --- a/docs/dli/api-ref/dli_02_0034.html +++ b/docs/dli/api-ref/dli_02_0034.html @@ -86,7 +86,7 @@

    Array of Objects

    -

    Columns of the new table. For details about column parameters, see Table 3. This parameter is optional when data_location is VIEW.

    +

    Columns of the new table. For details about column parameters, see Table 4. This parameter is optional when data_location is VIEW.

    select_statement

    @@ -175,54 +175,95 @@

    User-defined timestamp type. yyyy-MM-dd HH:mm:ss is used by default. For definitions about characters in the timestamp format, see Table 3. Only data in CSV and JSON files has this attribute. This parameter is mandatory when data_location is OBS.

    +

    tags

    + +

    No

    + +

    Array of Objects

    + +

    Database tag. For details about this object, see tags parameters.

    + + -
    Table 3 columns parameters

    Parameter

    +
    - - - - - - - - - - - - +
    Table 3 tags parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    column_name

    +

    key

    Yes

    +

    Yes

    String

    +

    String

    Name of a column.

    +

    Tag key

    type

    +

    value

    Yes

    +

    Yes

    String

    +

    String

    Data type of a column.

    +

    Tag value

    description

    +
    +
    + +
    + + + + + + - - - - - - - + + + + + + + + + + @@ -232,7 +273,7 @@

    Response

    -
    Table 4 columns parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    column_name

    No

    +

    Yes

    String

    +

    String

    Description of a column.

    +

    Name of a column.

    is_partition_column

    +

    type

    No

    +

    Yes

    Boolean

    +

    String

    Whether the column is a partition column. The value true indicates a partition column, and the value false indicates a non-partition column. The default value is false.

    +

    Data type of a column.

    +

    description

    +

    No

    +

    String

    +

    Description of a column.

    +

    is_partition_column

    +

    No

    +

    Boolean

    +

    Whether the column is a partition column. The value true indicates a partition column, and the value false indicates a non-partition column. The default value is false.

    NOTE:

    When creating a partition table, ensure that at least one column in the table is a non-partition column. For details, see "Request example".
    Table 4 Response parameters

    Parameter

    +
    @@ -319,9 +360,9 @@ "message": "" } -

    Status Codes

    Table 5 describes the status code.

    +

    Status Codes

    Table 6 describes the status code.

    -
    Table 5 Response parameters

    Parameter

    Mandatory
    Table 5 Status codes

    Status Code

    +
    diff --git a/docs/dli/api-ref/dli_02_0102.html b/docs/dli/api-ref/dli_02_0102.html index 72f66cd8..8a038834 100644 --- a/docs/dli/api-ref/dli_02_0102.html +++ b/docs/dli/api-ref/dli_02_0102.html @@ -359,7 +359,7 @@
    -
    Parent topic: Job-related APIs
    +
    Parent topic: SQL Job related APIs
    diff --git a/docs/dli/api-ref/dli_02_0104.html b/docs/dli/api-ref/dli_02_0104.html index ea35b7c6..a6cb5338 100644 --- a/docs/dli/api-ref/dli_02_0104.html +++ b/docs/dli/api-ref/dli_02_0104.html @@ -112,7 +112,7 @@
    -
    Parent topic: Job-related APIs
    +
    Parent topic: SQL Job related APIs
    diff --git a/docs/dli/api-ref/dli_02_0107.html b/docs/dli/api-ref/dli_02_0107.html index 34f1b759..abfb48eb 100644 --- a/docs/dli/api-ref/dli_02_0107.html +++ b/docs/dli/api-ref/dli_02_0107.html @@ -149,7 +149,7 @@
    -
    Parent topic: Job-related APIs
    +
    Parent topic: SQL Job related APIs
    diff --git a/docs/dli/api-ref/dli_02_0124.html b/docs/dli/api-ref/dli_02_0124.html index deb627ac..870082f2 100644 --- a/docs/dli/api-ref/dli_02_0124.html +++ b/docs/dli/api-ref/dli_02_0124.html @@ -32,9 +32,9 @@

    Request

    Table 6 Status codes

    Status Code

    Description
    - - @@ -42,27 +42,27 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -494,7 +494,7 @@ diff --git a/docs/dli/api-ref/dli_02_0158.html b/docs/dli/api-ref/dli_02_0158.html index b5b49d2e..b8ae9129 100644 --- a/docs/dli/api-ref/dli_02_0158.html +++ b/docs/dli/api-ref/dli_02_0158.html @@ -1,15 +1,30 @@ -

    APIs Related to SQL Jobs

    -

    + +

    SQL Job related APIs

    + +

    + diff --git a/docs/dli/api-ref/dli_02_0166.html b/docs/dli/api-ref/dli_02_0166.html index 77f20e0b..4bb31609 100644 --- a/docs/dli/api-ref/dli_02_0166.html +++ b/docs/dli/api-ref/dli_02_0166.html @@ -21,5 +21,9 @@
  • Changing the Owner of a Group or Resource Package
    • + +
    +
    Parent topic: Resource-related APIs
    +
    diff --git a/docs/dli/api-ref/dli_02_0181.html b/docs/dli/api-ref/dli_02_0181.html index d69d1b67..f3ddc9c5 100644 --- a/docs/dli/api-ref/dli_02_0181.html +++ b/docs/dli/api-ref/dli_02_0181.html @@ -47,7 +47,7 @@ - - -
    Table 2 Request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    file

    Yes

    +

    Yes

    String

    +

    String

    Name of the package that is of the JAR or pyFile type and has been uploaded to the DLI resource management system. You can also specify an OBS path, for example, obs://Bucket name/Package name.

    class_name

    +

    className

    Yes

    +

    Yes

    String

    +

    String

    Java/Spark main class of the batch processing job.

    queue

    No

    +

    No

    String

    +

    String

    Queue name. Set this parameter to the name of the created DLI queue. The queue must be of the general-purpose type.

    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.
    @@ -71,9 +71,9 @@

    cluster_name

    No

    +

    No

    String

    +

    String

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

    NOTE:

    You are advised to use the queue parameter. The queue and cluster_name parameters cannot coexist.

    @@ -82,54 +82,54 @@

    args

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Input parameters of the main class, that is, application parameters.

    sc_type

    No

    +

    No

    String

    +

    String

    Compute resource type. Currently, resource types A, B, and C are available. If this parameter is not specified, the minimum configuration (type A) is used. For details about resource types, see Table 3.

    jars

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Name of the package that is of the JAR type and has been uploaded to the DLI resource management system. You can also specify an OBS path, for example, obs://Bucket name/Package name.

    python_files

    +

    pyFiles

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Name of the package that is of the PyFile type and has been uploaded to the DLI resource management system. You can also specify an OBS path, for example, obs://Bucket name/Package name.

    files

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Name of the package that is of the file type and has been uploaded to the DLI resource management system. You can also specify an OBS path, for example, obs://Bucket name/Package name.

    modules

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Name of the dependent system resource module. You can view the module name using the API related to Querying Resource Packages in a Group.

    DLI provides dependencies for executing datasource jobs. The following table lists the dependency modules corresponding to different services.
    • CloudTable/MRS HBase: sys.datasource.hbase
    • CloudTable/MRS OpenTSDB: sys.datasource.opentsdb
    • RDS MySQL: sys.datasource.rds
    • RDS Postgre: preset
    • DWS: preset
    • CSS: sys.datasource.css
    @@ -138,117 +138,117 @@

    resources

    No

    +

    No

    Array of Objects

    +

    Array of Objects

    JSON object list, including the name and type of the JSON package that has been uploaded to the queue. For details, see Table 4.

    groups

    No

    +

    No

    Array of Objects

    +

    Array of Objects

    JSON object list, including the package group resource. For details about the format, see the request example. If the type of the name in resources is not verified, the package with the name exists in the group. For details, see Table 5.

    conf

    No

    +

    No

    Array of Objects

    +

    Object

    Batch configuration item.

    name

    No

    +

    No

    String

    +

    String

    Batch processing task name. The value contains a maximum of 128 characters.

    driver_memory

    +

    driverMemory

    No

    +

    No

    String

    +

    String

    Driver memory of the Spark application, for example, 2 GB and 2048 MB. This configuration item replaces the default parameter in sc_type. The unit must be provided. Otherwise, the startup fails.

    driver_cores

    +

    driverCores

    No

    +

    No

    Integer

    +

    Integer

    Number of CPU cores of the Spark application driver. This configuration item replaces the default parameter in sc_type.

    executor_memory

    +

    executorMemory

    No

    +

    No

    String

    +

    String

    Executor memory of the Spark application, for example, 2 GB and 2048 MB. This configuration item replaces the default parameter in sc_type. The unit must be provided. Otherwise, the startup fails.

    executor_cores

    +

    executorCores

    No

    +

    No

    Integer

    +

    Integer

    Number of CPU cores of each Executor in the Spark application. This configuration item replaces the default parameter in sc_type.

    num_executors

    +

    numExecutors

    No

    +

    No

    Integer

    +

    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

    No

    +

    No

    String

    +

    String

    OBS bucket for storing the Spark jobs. Set this parameter when you need to save jobs.

    auto_recovery

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to enable the retry function. If enabled, Spark jobs will be automatically retried after an exception occurs. The default value is false.

    max_retry_times

    No

    +

    No

    Integer

    +

    Integer

    Maximum retry times. The maximum value is 100, and the default value is 20.

    catalog_name

    No

    +

    No

    String

    +

    String

    To access metadata, set this parameter to dli.

    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.

    Job-related APIs

    You can import and export data, submitting SQL jobs, canceling jobs, querying all jobs, previewing job results, querying job status, querying job details, checking SQL syntax, and exporting query results.

    +

    You can import and export data, submit SQL jobs, cancel jobs, query all jobs, preview job results, query job status, query job details, check SQL syntax, and export query results.

    Package Group-related APIs

    @@ -89,10 +89,9 @@

    -

    You can creat, delete, modify, and query global variables.

    +

    You can create, delete, modify, and query global variables.
    diff --git a/docs/dli/api-ref/dli_02_0189.html b/docs/dli/api-ref/dli_02_0189.html index 2b342d0a..4e0f5637 100644 --- a/docs/dli/api-ref/dli_02_0189.html +++ b/docs/dli/api-ref/dli_02_0189.html @@ -269,6 +269,65 @@
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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

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

    Status Codes

    Table 6 describes the status code.

    +

    Status Codes

    Table 7 describes the status code.

    -
    - + + + + +
    Table 6 Status codes

    Status Code

    +
    diff --git a/docs/dli/api-ref/dli_02_0191.html b/docs/dli/api-ref/dli_02_0191.html index ae0ed4d9..58afd26d 100644 --- a/docs/dli/api-ref/dli_02_0191.html +++ b/docs/dli/api-ref/dli_02_0191.html @@ -51,13 +51,22 @@ - + + + + +
    Table 7 Status codes

    Status Code

    Description

    queues

    Yes

    +

    No

    Array of Strings

    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.

    +
    diff --git a/docs/dli/api-ref/dli_02_0192.html b/docs/dli/api-ref/dli_02_0192.html index 52208350..98212c98 100644 --- a/docs/dli/api-ref/dli_02_0192.html +++ b/docs/dli/api-ref/dli_02_0192.html @@ -51,13 +51,22 @@

    queues

    Yes

    +

    No

    Array of String

    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.

    +
    diff --git a/docs/dli/api-ref/dli_02_0296.html b/docs/dli/api-ref/dli_02_0296.html index 6d55a562..2d697e12 100644 --- a/docs/dli/api-ref/dli_02_0296.html +++ b/docs/dli/api-ref/dli_02_0296.html @@ -389,7 +389,7 @@
    -
    Parent topic: Job-related APIs
    +
    Parent topic: SQL Job related APIs
    diff --git a/docs/dli/api-ref/dli_02_0312.html b/docs/dli/api-ref/dli_02_0312.html index e81f86ff..5966da78 100644 --- a/docs/dli/api-ref/dli_02_0312.html +++ b/docs/dli/api-ref/dli_02_0312.html @@ -222,7 +222,7 @@
    -
    Parent topic: Job-related APIs
    +
    Parent topic: SQL Job related APIs
    diff --git a/docs/dli/api-ref/dli_02_0356.html b/docs/dli/api-ref/dli_02_0356.html new file mode 100644 index 00000000..3b5e52cb --- /dev/null +++ b/docs/dli/api-ref/dli_02_0356.html @@ -0,0 +1,19 @@ + + + +

    Resource-related APIs

    + +

    +
    + + + diff --git a/docs/dli/api-ref/dli_02_0500.html b/docs/dli/api-ref/dli_02_0500.html index 82c37349..d8bd5a71 100644 --- a/docs/dli/api-ref/dli_02_0500.html +++ b/docs/dli/api-ref/dli_02_0500.html @@ -1,6 +1,6 @@ -

    Calling APIs

    +

    API Usage Guidelines

    Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

    Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

    For details about how to use APIs, see API Usage Guidelines.