From 483e5cc6cc2458c5d287db808b0164a41bc9556b Mon Sep 17 00:00:00 2001 From: "Su, Xiaomeng" Date: Wed, 15 May 2024 12:04:03 +0000 Subject: [PATCH] dli_api_20240430 Reviewed-by: Pruthi, Vineet Co-authored-by: Su, Xiaomeng Co-committed-by: Su, Xiaomeng --- docs/dli/api-ref/ALL_META.TXT.json | 3492 ++++++++++++++++++++-------- docs/dli/api-ref/CLASS.TXT.json | 1869 ++++++++------- docs/dli/api-ref/dli_02_00003.html | 21 +- docs/dli/api-ref/dli_02_0013.html | 2 +- docs/dli/api-ref/dli_02_0019.html | 6 +- docs/dli/api-ref/dli_02_0020.html | 9 +- docs/dli/api-ref/dli_02_0021.html | 181 +- 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 | 196 +- docs/dli/api-ref/dli_02_0027.html | 12 +- docs/dli/api-ref/dli_02_0028.html | 12 +- docs/dli/api-ref/dli_02_0029.html | 6 +- docs/dli/api-ref/dli_02_0030.html | 10 +- docs/dli/api-ref/dli_02_0031.html | 18 +- docs/dli/api-ref/dli_02_0033.html | 10 +- docs/dli/api-ref/dli_02_0034.html | 108 +- docs/dli/api-ref/dli_02_0035.html | 6 +- docs/dli/api-ref/dli_02_0036.html | 20 +- docs/dli/api-ref/dli_02_0037.html | 8 +- docs/dli/api-ref/dli_02_0038.html | 16 +- docs/dli/api-ref/dli_02_0039.html | 22 +- docs/dli/api-ref/dli_02_0040.html | 6 +- docs/dli/api-ref/dli_02_0041.html | 6 +- docs/dli/api-ref/dli_02_0042.html | 6 +- docs/dli/api-ref/dli_02_0065.html | 25 + docs/dli/api-ref/dli_02_0102.html | 63 +- docs/dli/api-ref/dli_02_0104.html | 2 +- docs/dli/api-ref/dli_02_0105.html | 184 +- docs/dli/api-ref/dli_02_0107.html | 2 +- docs/dli/api-ref/dli_02_0108.html | 8 +- docs/dli/api-ref/dli_02_0109.html | 12 +- docs/dli/api-ref/dli_02_0124.html | 18 +- docs/dli/api-ref/dli_02_0125.html | 17 +- docs/dli/api-ref/dli_02_0126.html | 11 +- docs/dli/api-ref/dli_02_0127.html | 2 +- docs/dli/api-ref/dli_02_0128.html | 6 +- docs/dli/api-ref/dli_02_0129.html | 2 +- docs/dli/api-ref/dli_02_0130.html | 17 +- docs/dli/api-ref/dli_02_0158.html | 6 +- docs/dli/api-ref/dli_02_0162.html | 25 - docs/dli/api-ref/dli_02_0164.html | 6 +- docs/dli/api-ref/dli_02_0166.html | 20 +- docs/dli/api-ref/dli_02_0168.html | 12 +- docs/dli/api-ref/dli_02_0169.html | 7 +- docs/dli/api-ref/dli_02_0170.html | 8 +- docs/dli/api-ref/dli_02_0171.html | 8 +- docs/dli/api-ref/dli_02_0172.html | 6 +- docs/dli/api-ref/dli_02_0173.html | 6 +- docs/dli/api-ref/dli_02_0181.html | 78 +- docs/dli/api-ref/dli_02_0186.html | 2 +- docs/dli/api-ref/dli_02_0187.html | 104 +- docs/dli/api-ref/dli_02_0189.html | 6 +- docs/dli/api-ref/dli_02_0190.html | 8 +- docs/dli/api-ref/dli_02_0193.html | 10 - docs/dli/api-ref/dli_02_0194.html | 83 +- docs/dli/api-ref/dli_02_0201.html | 1052 ++++----- docs/dli/api-ref/dli_02_0223.html | 6 +- docs/dli/api-ref/dli_02_0225.html | 16 +- docs/dli/api-ref/dli_02_0228.html | 257 +- docs/dli/api-ref/dli_02_0229.html | 162 +- docs/dli/api-ref/dli_02_0230.html | 206 +- docs/dli/api-ref/dli_02_0231.html | 8 +- docs/dli/api-ref/dli_02_0233.html | 2 +- docs/dli/api-ref/dli_02_0234.html | 446 ++-- docs/dli/api-ref/dli_02_0235.html | 210 +- docs/dli/api-ref/dli_02_0236.html | 2 +- docs/dli/api-ref/dli_02_0238.html | 309 +++ docs/dli/api-ref/dli_02_0241.html | 2 +- docs/dli/api-ref/dli_02_0242.html | 2 +- docs/dli/api-ref/dli_02_0243.html | 2 +- docs/dli/api-ref/dli_02_0245.html | 167 +- docs/dli/api-ref/dli_02_0250.html | 20 +- docs/dli/api-ref/dli_02_0252.html | 69 +- docs/dli/api-ref/dli_02_0253.html | 6 +- docs/dli/api-ref/dli_02_0254.html | 2 +- docs/dli/api-ref/dli_02_0255.html | 2 +- docs/dli/api-ref/dli_02_0258.html | 2 +- docs/dli/api-ref/dli_02_0291.html | 6 +- docs/dli/api-ref/dli_02_0292.html | 8 +- docs/dli/api-ref/dli_02_0293.html | 8 +- docs/dli/api-ref/dli_02_0294.html | 8 +- docs/dli/api-ref/dli_02_0295.html | 8 +- docs/dli/api-ref/dli_02_0296.html | 2 +- docs/dli/api-ref/dli_02_0297.html | 15 +- docs/dli/api-ref/dli_02_0298.html | 8 +- docs/dli/api-ref/dli_02_0299.html | 8 +- docs/dli/api-ref/dli_02_0300.html | 29 + docs/dli/api-ref/dli_02_0308.html | 10 +- docs/dli/api-ref/dli_02_0309.html | 8 +- docs/dli/api-ref/dli_02_0310.html | 4 +- docs/dli/api-ref/dli_02_0311.html | 2 +- docs/dli/api-ref/dli_02_0312.html | 32 +- docs/dli/api-ref/dli_02_0316.html | 107 +- docs/dli/api-ref/dli_02_0325.html | 26 + docs/dli/api-ref/dli_02_0326.html | 250 ++ docs/dli/api-ref/dli_02_0327.html | 409 ++++ docs/dli/api-ref/dli_02_0328.html | 107 + docs/dli/api-ref/dli_02_0329.html | 152 ++ docs/dli/api-ref/dli_02_0330.html | 333 +++ docs/dli/api-ref/dli_02_0331.html | 132 ++ docs/dli/api-ref/dli_02_0332.html | 212 ++ docs/dli/api-ref/dli_02_0333.html | 18 + docs/dli/api-ref/dli_02_0336.html | 245 ++ docs/dli/api-ref/dli_02_0356.html | 17 +- docs/dli/api-ref/dli_02_0359.html | 16 + docs/dli/api-ref/dli_02_0360.html | 18 + docs/dli/api-ref/dli_02_0361.html | 24 + 108 files changed, 8055 insertions(+), 3932 deletions(-) create mode 100644 docs/dli/api-ref/dli_02_0065.html delete mode 100644 docs/dli/api-ref/dli_02_0162.html create mode 100644 docs/dli/api-ref/dli_02_0238.html create mode 100644 docs/dli/api-ref/dli_02_0300.html create mode 100644 docs/dli/api-ref/dli_02_0325.html create mode 100644 docs/dli/api-ref/dli_02_0326.html create mode 100644 docs/dli/api-ref/dli_02_0327.html create mode 100644 docs/dli/api-ref/dli_02_0328.html create mode 100644 docs/dli/api-ref/dli_02_0329.html create mode 100644 docs/dli/api-ref/dli_02_0330.html create mode 100644 docs/dli/api-ref/dli_02_0331.html create mode 100644 docs/dli/api-ref/dli_02_0332.html create mode 100644 docs/dli/api-ref/dli_02_0333.html create mode 100644 docs/dli/api-ref/dli_02_0336.html create mode 100644 docs/dli/api-ref/dli_02_0359.html create mode 100644 docs/dli/api-ref/dli_02_0360.html create mode 100644 docs/dli/api-ref/dli_02_0361.html diff --git a/docs/dli/api-ref/ALL_META.TXT.json b/docs/dli/api-ref/ALL_META.TXT.json index cb7f8c49..33579d98 100644 --- a/docs/dli/api-ref/ALL_META.TXT.json +++ b/docs/dli/api-ref/ALL_META.TXT.json @@ -1,1161 +1,2743 @@ [ + { + "dockw":"API Reference" + }, { "uri":"dli_02_0500.html", + "node_id":"dli_02_0500.xml", "product_code":"dli", "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":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { "uri":"dli_02_0181.html", + "node_id":"dli_02_0181.xml", "product_code":"dli", "code":"2", "des":"This section describes the APIs provided by DLI.", "doc_type":"api", "kw":"Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Overview", "githuburl":"" }, { "uri":"dli_02_0306.html", + "node_id":"dli_02_0306.xml", "product_code":"dli", "code":"3", "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":"Getting Started", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Getting Started", "githuburl":"" }, { "uri":"dli_02_0307.html", + "node_id":"dli_02_0307.xml", "product_code":"dli", "code":"4", "des":"This section describes how to create and query a queue using APIs.Queues created using this API will be bound to specified compute resources.It takes 6 to 10 minutes to s", "doc_type":"api", "kw":"Creating a Queue,Getting Started,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Creating a Queue", "githuburl":"" }, { "uri":"dli_02_0308.html", + "node_id":"dli_02_0308.xml", "product_code":"dli", "code":"5", "des":"This section describes how to create and query SQL jobs using APIs.It takes 6 to 10 minutes to start a job using a new queue for the first time.Creating a Queue: Create a", "doc_type":"api", "kw":"Creating and Submitting a SQL Job,Getting Started,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Creating and Submitting a SQL Job", "githuburl":"" }, { "uri":"dli_02_0309.html", + "node_id":"dli_02_0309.xml", "product_code":"dli", "code":"6", "des":"This section describes how to create and submit Spark jobs using APIs.It takes 6 to 10 minutes to start a job using a new queue for the first time.Creating a Queue: Creat", "doc_type":"api", "kw":"Creating and Submitting a Spark Job,Getting Started,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Creating and Submitting a Spark Job", "githuburl":"" }, { "uri":"dli_02_0310.html", + "node_id":"dli_02_0310.xml", "product_code":"dli", "code":"7", "des":"This section describes how to create and run a user-defined Flink job using APIs.It takes 6 to 10 minutes to start a job using a new queue for the first time.Creating a Q", "doc_type":"api", "kw":"Creating and Submitting a Flink Job,Getting Started,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Creating and Submitting a Flink Job", "githuburl":"" }, { "uri":"dli_02_0311.html", + "node_id":"dli_02_0311.xml", "product_code":"dli", "code":"8", "des":"This section describes how to create an enhanced datasource connection using an API.It takes 6 to 10 minutes to start a job using a new queue for the first time.Before cr", "doc_type":"api", "kw":"Creating and Using a Datasource Connection,Getting Started,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Creating and Using a Datasource Connection", "githuburl":"" }, { "uri":"dli_02_0036.html", + "node_id":"dli_02_0036.xml", "product_code":"dli", "code":"9", "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":"Permission-related APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli" + } + ], "title":"Permission-related APIs", "githuburl":"" }, { - "uri":"dli_02_0037.html", + "uri":"dli_02_0252.html", + "node_id":"dli_02_0252.xml", "product_code":"dli", "code":"10", - "des":"This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.URI formatPUT /v1", - "doc_type":"api", - "kw":"Granting Users with the Queue Usage Permission,Permission-related APIs,API Reference", - "title":"Granting Users with the Queue Usage Permission", - "githuburl":"" - }, - { - "uri":"dli_02_0038.html", - "product_code":"dli", - "code":"11", - "des":"This API is used to query names of all users who can use a specified queue.URI formatGET /v1.0/{project_id}/queues/{queue_name}/usersGET /v1.0/{project_id}/queues/{queue_", - "doc_type":"api", - "kw":"Querying Queue Users,Permission-related APIs,API Reference", - "title":"Querying Queue Users", - "githuburl":"" - }, - { - "uri":"dli_02_0039.html", - "product_code":"dli", - "code":"12", - "des":"This API is used to grant database or table data usage permission to specified users.URI formatPUT /v1.0/{project_id}/user-authorizationPUT /v1.0/{project_id}/user-author", - "doc_type":"api", - "kw":"Granting Data Permission to Users,Permission-related APIs,API Reference", - "title":"Granting Data Permission to Users", - "githuburl":"" - }, - { - "uri":"dli_02_0040.html", - "product_code":"dli", - "code":"13", - "des":"This API is used query names of all users who have permission to use or access the database.URI formatGET /v1.0/{project_id}/databases/{database_name}/usersGET /v1.0/{pro", - "doc_type":"api", - "kw":"Querying Database Users,Permission-related APIs,API Reference", - "title":"Querying Database Users", - "githuburl":"" - }, - { - "uri":"dli_02_0041.html", - "product_code":"dli", - "code":"14", - "des":"This API is used to query users who have permission to access the specified table or column in the table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables", - "doc_type":"api", - "kw":"Querying Table Users,Permission-related APIs,API Reference", - "title":"Querying Table Users", - "githuburl":"" - }, - { - "uri":"dli_02_0042.html", - "product_code":"dli", - "code":"15", - "des":"This API is used to query the permission of a specified user on a table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/users/{user_name}GE", - "doc_type":"api", - "kw":"Querying a User's Table Permissions,Permission-related APIs,API Reference", - "title":"Querying a User's Table Permissions", - "githuburl":"" - }, - { - "uri":"dli_02_0252.html", - "product_code":"dli", - "code":"16", "des":"This API is used to view the permissions granted to a user.URI formatGET /v1.0/{project_id}/authorization/privilegesGET /v1.0/{project_id}/authorization/privilegesParamet", "doc_type":"api", "kw":"Viewing the Granted Permissions of a User,Permission-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Viewing the Granted Permissions of a User", "githuburl":"" }, - { - "uri":"dli_02_0297.html", - "product_code":"dli", - "code":"17", - "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":"Agency-related APIs", - "title":"Agency-related APIs", - "githuburl":"" - }, - { - "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 parametersParamet", - "doc_type":"api", - "kw":"Obtaining DLI Agency Information,Agency-related APIs,API Reference", - "title":"Obtaining DLI Agency Information", - "githuburl":"" - }, - { - "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 parametersParameterMandator", - "doc_type":"api", - "kw":"Creating a DLI Agency,Agency-related APIs,API Reference", - "title":"Creating a DLI Agency", - "githuburl":"" - }, - { - "uri":"dli_02_0193.html", - "product_code":"dli", - "code":"20", - "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":"Queue-related APIs (Recommended)", - "title":"Queue-related APIs (Recommended)", - "githuburl":"" - }, - { - "uri":"dli_02_0194.html", - "product_code":"dli", - "code":"21", - "des":"This API is used to create a queue. The queue will be bound to specified compute resources.It takes 5 to 15 minutes to start a job using a new queue for the first time.UR", - "doc_type":"api", - "kw":"Creating a Queue,Queue-related APIs (Recommended),API Reference", - "title":"Creating a Queue", - "githuburl":"" - }, - { - "uri":"dli_02_0195.html", - "product_code":"dli", - "code":"22", - "des":"This API is used to delete a specified queue.If a task is being executed in a specified queue, the queue cannot be deleted.URI formatDELETE /v1.0/{project_id}/queues/{que", - "doc_type":"api", - "kw":"Deleting a Queue,Queue-related APIs (Recommended),API Reference", - "title":"Deleting a Queue", - "githuburl":"" - }, - { - "uri":"dli_02_0196.html", - "product_code":"dli", - "code":"23", - "des":"This API is used to list all queues under the project.URI formatGET/v1.0/{project_id}/queuesGET/v1.0/{project_id}/queuesParameter descriptionURI parameterParameterMandato", - "doc_type":"api", - "kw":"Querying All Queues,Queue-related APIs (Recommended),API Reference", - "title":"Querying All Queues", - "githuburl":"" - }, - { - "uri":"dli_02_0016.html", - "product_code":"dli", - "code":"24", - "des":"This API is used to list details of a specific queue in a project.URI formatGET /v1.0/{project_id}/queues/{queue_name}GET /v1.0/{project_id}/queues/{queue_name}Parameter ", - "doc_type":"api", - "kw":"Viewing Details of a Queue,Queue-related APIs (Recommended),API Reference", - "title":"Viewing Details of a Queue", - "githuburl":"" - }, - { - "uri":"dli_02_0249.html", - "product_code":"dli", - "code":"25", - "des":"This API is used to restart, scale out, and scale in queues.Only SQL queues in the Available status can be restarted. (The queue status is Available only after the SQL jo", - "doc_type":"api", - "kw":"Restarting, Scaling Out, and Scaling In Queues,Queue-related APIs (Recommended),API Reference", - "title":"Restarting, Scaling Out, and Scaling In Queues", - "githuburl":"" - }, - { - "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/{qu", - "doc_type":"api", - "kw":"Creating an Address Connectivity Test Request,Queue-related APIs (Recommended),API Reference", - "title":"Creating an Address Connectivity Test Request", - "githuburl":"" - }, - { - "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.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", - "githuburl":"" - }, - { - "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}/plans", - "doc_type":"api", - "kw":"Creating a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", - "title":"Creating a Scheduled CU Change", - "githuburl":"" - }, - { - "uri":"dli_02_0292.html", - "product_code":"dli", - "code":"29", - "des":"This API is used to query the scheduled CU changes and list the changes of a specified queue.URI formatGET /v1/{project_id}/queues/{queue_name}/plansGET /v1/{project_id}/", - "doc_type":"api", - "kw":"Viewing a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", - "title":"Viewing a Scheduled CU Change", - "githuburl":"" - }, - { - "uri":"dli_02_0293.html", - "product_code":"dli", - "code":"30", - "des":"This API is used to delete scheduled CU changes in batches.URI formatPOST /v1/{project_id}/queues/{queue_name}/plans/batch-deletePOST /v1/{project_id}/queues/{queue_name}", - "doc_type":"api", - "kw":"Deleting Scheduled CU Changes in Batches,Queue-related APIs (Recommended),API Reference", - "title":"Deleting Scheduled CU Changes in Batches", - "githuburl":"" - }, - { - "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/{project_", - "doc_type":"api", - "kw":"Deleting a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", - "title":"Deleting a Scheduled CU Change", - "githuburl":"" - }, - { - "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}/qu", - "doc_type":"api", - "kw":"Modifying a Scheduled CU Change,Queue-related APIs (Recommended),API Reference", - "title":"Modifying a Scheduled CU Change", - "githuburl":"" - }, - { - "uri":"dli_02_0158.html", - "product_code":"dli", - "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":"SQL Job related APIs", - "title":"SQL Job related APIs", - "githuburl":"" - }, - { - "uri":"dli_02_0102.html", - "product_code":"dli", - "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),SQL Job related APIs,API Reference", - "title":"Submitting a SQL Job (Recommended)", - "githuburl":"" - }, - { - "uri":"dli_02_0104.html", - "product_code":"dli", - "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),SQL Job related APIs,API Reference", - "title":"Canceling a Job (Recommended)", - "githuburl":"" - }, - { - "uri":"dli_02_0025.html", - "product_code":"dli", - "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,SQL Job related APIs,API Reference", - "title":"Querying All Jobs", - "githuburl":"" - }, - { - "uri":"dli_02_0312.html", - "product_code":"dli", - "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,SQL Job related APIs,API Reference", - "title":"Previewing SQL Job Query Results", - "githuburl":"" - }, - { - "uri":"dli_02_0021.html", - "product_code":"dli", - "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,SQL Job related APIs,API Reference", - "title":"Querying Job Status", - "githuburl":"" - }, - { - "uri":"dli_02_0022.html", - "product_code":"dli", - "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,SQL Job related APIs,API Reference", - "title":"Querying Job Details", - "githuburl":"" - }, - { - "uri":"dli_02_0107.html", - "product_code":"dli", - "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,SQL Job related APIs,API Reference", - "title":"Checking SQL Syntax", - "githuburl":"" - }, - { - "uri":"dli_02_0024.html", - "product_code":"dli", - "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,SQL Job related APIs,API Reference", - "title":"Exporting Query Results", - "githuburl":"" - }, - { - "uri":"dli_02_0296.html", - "product_code":"dli", - "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,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":"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", - "title":"Package Group-related APIs", - "githuburl":"" - }, - { - "uri":"dli_02_0130.html", - "product_code":"dli", - "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", - "title":"Uploading a Package Group", - "githuburl":"" - }, - { - "uri":"dli_02_0168.html", - "product_code":"dli", - "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", - "title":"Querying Package Group List", - "githuburl":"" - }, - { - "uri":"dli_02_0169.html", - "product_code":"dli", - "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", - "title":"Uploading a JAR Package Group", - "githuburl":"" - }, - { - "uri":"dli_02_0170.html", - "product_code":"dli", - "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", - "title":"Uploading a PyFile Package Group", - "githuburl":"" - }, - { - "uri":"dli_02_0171.html", - "product_code":"dli", - "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", - "title":"Uploading a File Package Group", - "githuburl":"" - }, - { - "uri":"dli_02_0172.html", - "product_code":"dli", - "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", - "title":"Querying Resource Packages in a Group", - "githuburl":"" - }, - { - "uri":"dli_02_0173.html", - "product_code":"dli", - "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", - "title":"Deleting a Resource Package from a Group", - "githuburl":"" - }, - { - "uri":"dli_02_0253.html", - "product_code":"dli", - "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 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", - "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", - "code":"67", - "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 Flink Jobs", - "title":"APIs Related to Flink Jobs", - "githuburl":"" - }, - { - "uri":"dli_02_0225.html", - "product_code":"dli", - "code":"68", - "des":"This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.URI formatPOST /v1.0/{project_id}/dli/obs-authorizePOST /v1.0/{", - "doc_type":"api", - "kw":"Granting OBS Permissions to DLI,APIs Related to Flink Jobs,API Reference", - "title":"Granting OBS Permissions to DLI", - "githuburl":"" - }, - { - "uri":"dli_02_0228.html", - "product_code":"dli", - "code":"69", - "des":"This API is used to create a Flink streaming SQL job.URI formatPOST /v1.0/{project_id}/streaming/sql-jobsPOST /v1.0/{project_id}/streaming/sql-jobsParameter descriptionUR", - "doc_type":"api", - "kw":"Creating a SQL Job,APIs Related to Flink Jobs,API Reference", - "title":"Creating a SQL Job", - "githuburl":"" - }, - { - "uri":"dli_02_0229.html", - "product_code":"dli", - "code":"70", - "des":"This API is used to modify a Flink SQL job.URI formatPUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}Parameter descrip", - "doc_type":"api", - "kw":"Updating a SQL Job,APIs Related to Flink Jobs,API Reference", - "title":"Updating a SQL Job", - "githuburl":"" - }, - { - "uri":"dli_02_0230.html", - "product_code":"dli", - "code":"71", - "des":"This API is used to create custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPOST /v1.0/{project_id}/streaming/flink-jobsPOST /v1.", - "doc_type":"api", - "kw":"Creating a Flink Jar job,APIs Related to Flink Jobs,API Reference", - "title":"Creating a Flink Jar job", - "githuburl":"" - }, - { - "uri":"dli_02_0231.html", - "product_code":"dli", - "code":"72", - "des":"This API is used to update custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPUT /v1.0/{project_id}/streaming/flink-jobs/{job_id}P", - "doc_type":"api", - "kw":"Updating a Flink Jar Job,APIs Related to Flink Jobs,API Reference", - "title":"Updating a Flink Jar Job", - "githuburl":"" - }, - { - "uri":"dli_02_0233.html", - "product_code":"dli", - "code":"73", - "des":"This API is used to trigger batch job running.URI formatPOST /v1.0/{project_id}/streaming/jobs/runPOST /v1.0/{project_id}/streaming/jobs/runParameter descriptionURI param", - "doc_type":"api", - "kw":"Running Jobs in Batches,APIs Related to Flink Jobs,API Reference", - "title":"Running Jobs in Batches", - "githuburl":"" - }, - { - "uri":"dli_02_0234.html", - "product_code":"dli", - "code":"74", - "des":"This API is used to query the list of the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can als", - "doc_type":"api", - "kw":"Querying the Job List,APIs Related to Flink Jobs,API Reference", - "title":"Querying the Job List", - "githuburl":"" - }, - { - "uri":"dli_02_0235.html", - "product_code":"dli", - "code":"75", - "des":"This API is used to query details of a job.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}GET /v1.0/{project_id}/streaming/jobs/{job_id}Parameter descriptionURI ", - "doc_type":"api", - "kw":"Querying Job Details,APIs Related to Flink Jobs,API Reference", - "title":"Querying Job Details", - "githuburl":"" - }, - { - "uri":"dli_02_0236.html", - "product_code":"dli", - "code":"76", - "des":"This API is used to query a job execution plan.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}/execute-graphGET /v1.0/{project_id}/streaming/jobs/{job_id}/execut", - "doc_type":"api", - "kw":"Querying the Job Execution Plan,APIs Related to Flink Jobs,API Reference", - "title":"Querying the Job Execution Plan", - "githuburl":"" - }, - { - "uri":"dli_02_0241.html", - "product_code":"dli", - "code":"77", - "des":"This API is used to stop running jobs in batches.URI formatPOST /v1.0/{project_id}/streaming/jobs/stopPOST /v1.0/{project_id}/streaming/jobs/stopParameter descriptionURI ", - "doc_type":"api", - "kw":"Stopping Jobs in Batches,APIs Related to Flink Jobs,API Reference", - "title":"Stopping Jobs in Batches", - "githuburl":"" - }, - { - "uri":"dli_02_0242.html", - "product_code":"dli", - "code":"78", - "des":"This API is used to delete a Flink job at any state.The job records will not be deleted.URI formatDELETE /v1.0/{project_id}/streaming/jobs/{job_id}DELETE /v1.0/{project_i", - "doc_type":"api", - "kw":"Deleting a Job,APIs Related to Flink Jobs,API Reference", - "title":"Deleting a Job", - "githuburl":"" - }, - { - "uri":"dli_02_0243.html", - "product_code":"dli", - "code":"79", - "des":"This API is used to batch delete jobs at any state.URI formatPOST /v1.0/{project_id}/streaming/jobs/deletePOST /v1.0/{project_id}/streaming/jobs/deleteParameter descripti", - "doc_type":"api", - "kw":"Deleting Jobs in Batches,APIs Related to Flink Jobs,API Reference", - "title":"Deleting Jobs in Batches", - "githuburl":"" - }, - { - "uri":"dli_02_0254.html", - "product_code":"dli", - "code":"80", - "des":"This API is used to export Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/exportPOST /v1.0/{project_id}/streaming/jobs/exportParameter descriptionURI par", - "doc_type":"api", - "kw":"Exporting a Flink Job,APIs Related to Flink Jobs,API Reference", - "title":"Exporting a Flink Job", - "githuburl":"" - }, - { - "uri":"dli_02_0255.html", - "product_code":"dli", - "code":"81", - "des":"This API is used to import Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/importPOST /v1.0/{project_id}/streaming/jobs/importParameter descriptionURI par", - "doc_type":"api", - "kw":"Importing a Flink Job,APIs Related to Flink Jobs,API Reference", - "title":"Importing a Flink Job", - "githuburl":"" - }, - { - "uri":"dli_02_0316.html", - "product_code":"dli", - "code":"82", - "des":"This API is used to generate a static stream graph for a Flink SQL job.URI formatPOST /v3/{project_id}/streaming/jobs/{job_id}/gen-graphPOST /v3/{project_id}/streaming/jo", - "doc_type":"api", - "kw":"Generating a Static Stream Graph for a Flink SQL Job,APIs Related to Flink Jobs,API Reference", - "title":"Generating a Static Stream Graph for a Flink SQL Job", - "githuburl":"" - }, - { - "uri":"dli_02_0109.html", - "product_code":"dli", - "code":"83", - "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 Spark jobs", - "title":"APIs Related to Spark jobs", - "githuburl":"" - }, - { - "uri":"dli_02_0162.html", - "product_code":"dli", - "code":"84", - "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":"Batch Processing-related APIs", - "title":"Batch Processing-related APIs", - "githuburl":"" - }, - { - "uri":"dli_02_0124.html", - "product_code":"dli", - "code":"85", - "des":"This API is used to create a batch processing job in a queue.URI formatPOST /v2.0/{project_id}/batchesPOST /v2.0/{project_id}/batchesParameter descriptionURI parameterPar", - "doc_type":"api", - "kw":"Creating a Batch Processing Job,Batch Processing-related APIs,API Reference", - "title":"Creating a Batch Processing Job", - "githuburl":"" - }, - { - "uri":"dli_02_0129.html", - "product_code":"dli", - "code":"86", - "des":"This API is used to cancel a batch processing job.Batch processing jobs in the Successful or Failed state cannot be canceled.URI formatDELETE /v2.0/{project_id}/batches/{", - "doc_type":"api", - "kw":"Canceling a Batch Processing Job,Batch Processing-related APIs,API Reference", - "title":"Canceling a Batch Processing Job", - "githuburl":"" - }, - { - "uri":"dli_02_0125.html", - "product_code":"dli", - "code":"87", - "des":"This API is used to obtain the list of batch processing jobs in a queue of a project.URI formatGET /v2.0/{project_id}/batchesGET /v2.0/{project_id}/batchesParameter descr", - "doc_type":"api", - "kw":"Obtaining the List of Batch Processing Jobs,Batch Processing-related APIs,API Reference", - "title":"Obtaining the List of Batch Processing Jobs", - "githuburl":"" - }, - { - "uri":"dli_02_0126.html", - "product_code":"dli", - "code":"88", - "des":"This API is used to query details about a batch processing job based on the job ID.URI formatGET /v2.0/{project_id}/batches/{batch_id}GET /v2.0/{project_id}/batches/{batc", - "doc_type":"api", - "kw":"Querying Batch Job Details,Batch Processing-related APIs,API Reference", - "title":"Querying Batch Job Details", - "githuburl":"" - }, - { - "uri":"dli_02_0127.html", - "product_code":"dli", - "code":"89", - "des":"This API is used to obtain the execution status of a batch processing job.URI formatGET /v2.0/{project_id}/batches/{batch_id}/stateGET /v2.0/{project_id}/batches/{batch_i", - "doc_type":"api", - "kw":"Querying a Batch Job Status,Batch Processing-related APIs,API Reference", - "title":"Querying a Batch Job Status", - "githuburl":"" - }, - { - "uri":"dli_02_0128.html", - "product_code":"dli", - "code":"90", - "des":"This API is used to query the back-end logs of batch processing jobs.URI formatGET /v2.0/{project_id}/batches/{batch_id}/logGET /v2.0/{project_id}/batches/{batch_id}/logP", - "doc_type":"api", - "kw":"Querying Batch Job Logs,Batch Processing-related APIs,API Reference", - "title":"Querying Batch Job Logs", - "githuburl":"" - }, - { - "uri":"dli_02_0244.html", - "product_code":"dli", - "code":"91", - "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 Flink Job Templates", - "title":"APIs Related to Flink Job Templates", - "githuburl":"" - }, - { - "uri":"dli_02_0245.html", - "product_code":"dli", - "code":"92", - "des":"This API is used to create a user template for the DLI service. A maximum of 100 user templates can be created.URI formatPOST /v1.0/{project_id}/streaming/job-templatesPO", - "doc_type":"api", - "kw":"Creating a Template,APIs Related to Flink Job Templates,API Reference", - "title":"Creating a Template", - "githuburl":"" - }, - { - "uri":"dli_02_0246.html", - "product_code":"dli", - "code":"93", - "des":"This API is used to update existing templates in DLI.URI formatPUT /v1.0/{project_id}/streaming/job-templates/{template_id}PUT /v1.0/{project_id}/streaming/job-templates/", - "doc_type":"api", - "kw":"Updating a Template,APIs Related to Flink Job Templates,API Reference", - "title":"Updating a Template", - "githuburl":"" - }, - { - "uri":"dli_02_0247.html", - "product_code":"dli", - "code":"94", - "des":"This API is used to delete a template. A template used by jobs can also be deleted.URI formatDELETE /v1.0/{project_id}/streaming/job-templates/{template_id}DELETE /v1.0/{", - "doc_type":"api", - "kw":"Deleting a Template,APIs Related to Flink Job Templates,API Reference", - "title":"Deleting a Template", - "githuburl":"" - }, - { - "uri":"dli_02_0248.html", - "product_code":"dli", - "code":"95", - "des":"This API is used to query the job template list. Currently, only custom templates can be queried.URI formatGET /v1.0/{project_id}/streaming/job-templatesGET /v1.0/{projec", - "doc_type":"api", - "kw":"Querying the Template List,APIs Related to Flink Job Templates,API Reference", - "title":"Querying the Template List", - "githuburl":"" - }, - { - "uri":"dli_02_0186.html", - "product_code":"dli", - "code":"96", - "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 Enhanced Datasource Connections", - "title":"APIs Related to Enhanced Datasource Connections", - "githuburl":"" - }, - { - "uri":"dli_02_0187.html", - "product_code":"dli", - "code":"97", - "des":"This API is used to create an enhanced datasource connection with other services.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connectionsPOST /v2.0/{project_id}/", - "doc_type":"api", - "kw":"Creating an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Connections,API Refer", - "title":"Creating an Enhanced Datasource Connection", - "githuburl":"" - }, - { - "uri":"dli_02_0188.html", - "product_code":"dli", - "code":"98", - "des":"This API is used to delete an enhanced datasource connection.The connection that is being created cannot be deleted.URI formatDELETE /v2.0/{project_id}/datasource/enhance", - "doc_type":"api", - "kw":"Deleting an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Connections,API Refer", - "title":"Deleting an Enhanced Datasource Connection", - "githuburl":"" - }, - { - "uri":"dli_02_0190.html", - "product_code":"dli", - "code":"99", - "des":"This API is used to query the list of created enhanced datasource connections.URI formatGET /v2.0/{project_id}/datasource/enhanced-connectionsGET /v2.0/{project_id}/datas", - "doc_type":"api", - "kw":"Querying an Enhanced Datasource Connection List,APIs Related to Enhanced Datasource Connections,API ", - "title":"Querying an Enhanced Datasource Connection List", - "githuburl":"" - }, - { - "uri":"dli_02_0189.html", - "product_code":"dli", - "code":"100", - "des":"This API is used to query the created enhanced datasource connections.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}GET /v2.0/{project_i", - "doc_type":"api", - "kw":"Querying an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Connections,API Refer", - "title":"Querying an Enhanced Datasource Connection", - "githuburl":"" - }, - { - "uri":"dli_02_0191.html", - "product_code":"dli", - "code":"101", - "des":"This API is used to bind a queue to a created enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/associate-q", - "doc_type":"api", - "kw":"Binding a Queue,APIs Related to Enhanced Datasource Connections,API Reference", - "title":"Binding a Queue", - "githuburl":"" - }, - { - "uri":"dli_02_0192.html", - "product_code":"dli", - "code":"102", - "des":"This API is used to unbind a queue from an enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/disassociate-q", - "doc_type":"api", - "kw":"Unbinding a Queue,APIs Related to Enhanced Datasource Connections,API Reference", - "title":"Unbinding a Queue", - "githuburl":"" - }, - { - "uri":"dli_02_0200.html", - "product_code":"dli", - "code":"103", - "des":"This API is used to modify the host information of a connected datasource. Only full overwriting is supported.URI formatPUT /v2.0/{project_id}/datasource/enhanced-connect", - "doc_type":"api", - "kw":"Modifying the Host Information,APIs Related to Enhanced Datasource Connections,API Reference", - "title":"Modifying the Host Information", - "githuburl":"" - }, - { - "uri":"dli_02_0256.html", - "product_code":"dli", - "code":"104", - "des":"This API is used to query the authorization about an enhanced datasource connection.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/privi", - "doc_type":"api", - "kw":"Querying Authorization of an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Conn", - "title":"Querying Authorization of an Enhanced Datasource Connection", - "githuburl":"" - }, { "uri":"dli_02_0257.html", + "node_id":"dli_02_0257.xml", "product_code":"dli", - "code":"105", + "code":"11", "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":"Global Variable-related APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], "title":"Global Variable-related APIs", "githuburl":"" }, { "uri":"dli_02_0258.html", + "node_id":"dli_02_0258.xml", "product_code":"dli", - "code":"106", - "des":"This API is used to create a global variable.URI formatPOST /v1.0/{project_id}/variablesPOST /v1.0/{project_id}/variablesParameter descriptionURI parametersParameterManda", + "code":"12", + "des":"This API is used to create a global variable.URI formatPOST /v1.0/{project_id}/variablesPOST /v1.0/{project_id}/variablesParameter descriptionURI parameterParameterMandat", "doc_type":"api", "kw":"Creating a Global Variable,Global Variable-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Creating a Global Variable", "githuburl":"" }, { "uri":"dli_02_0259.html", + "node_id":"dli_02_0259.xml", "product_code":"dli", - "code":"107", + "code":"13", "des":"This API is used to delete a global variable.Only the user who creates a global variable can delete the variable.URI formatDELETE /v1.0/{project_id}/variables/{var_name}D", "doc_type":"api", "kw":"Deleting a Global Variable,Global Variable-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Deleting a Global Variable", "githuburl":"" }, { "uri":"dli_02_0260.html", + "node_id":"dli_02_0260.xml", "product_code":"dli", - "code":"108", + "code":"14", "des":"This API is used to modify a global variable.URI formatPUT /v1.0/{project_id}/variables/{var_name}PUT /v1.0/{project_id}/variables/{var_name}Parameter descriptionURI para", "doc_type":"api", "kw":"Modifying a Global Variable,Global Variable-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Modifying a Global Variable", "githuburl":"" }, { "uri":"dli_02_0261.html", + "node_id":"dli_02_0261.xml", "product_code":"dli", - "code":"109", + "code":"15", "des":"This API is used to query information about all global variables in the current project.URI formatGET /v1.0/{project_id}/variablesGET /v1.0/{project_id}/variablesParamete", "doc_type":"api", "kw":"Querying All Global Variables,Global Variable-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Querying All Global Variables", "githuburl":"" }, { - "uri":"dli_02_0201.html", + "uri":"dli_02_0186.html", + "node_id":"dli_02_0186.xml", "product_code":"dli", - "code":"110", + "code":"16", + "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 Enhanced Datasource Connections", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"APIs Related to Enhanced Datasource Connections", + "githuburl":"" + }, + { + "uri":"dli_02_0187.html", + "node_id":"dli_02_0187.xml", + "product_code":"dli", + "code":"17", + "des":"This API is used to create an enhanced datasource connection with other services.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connectionsPOST /v2.0/{project_id}/", + "doc_type":"api", + "kw":"Creating an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Connections,API Refer", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating an Enhanced Datasource Connection", + "githuburl":"" + }, + { + "uri":"dli_02_0188.html", + "node_id":"dli_02_0188.xml", + "product_code":"dli", + "code":"18", + "des":"This API is used to delete an enhanced datasource connection.The connection that is being created cannot be deleted.URI formatDELETE /v2.0/{project_id}/datasource/enhance", + "doc_type":"api", + "kw":"Deleting an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Connections,API Refer", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting an Enhanced Datasource Connection", + "githuburl":"" + }, + { + "uri":"dli_02_0190.html", + "node_id":"dli_02_0190.xml", + "product_code":"dli", + "code":"19", + "des":"This API is used to list the created enhanced datasource connections.URI formatGET /v2.0/{project_id}/datasource/enhanced-connectionsGET /v2.0/{project_id}/datasource/enh", + "doc_type":"api", + "kw":"Listing Enhanced Datasource Connections,APIs Related to Enhanced Datasource Connections,API Referenc", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Listing Enhanced Datasource Connections", + "githuburl":"" + }, + { + "uri":"dli_02_0189.html", + "node_id":"dli_02_0189.xml", + "product_code":"dli", + "code":"20", + "des":"This API is used to query a created enhanced datasource connection.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}GET /v2.0/{project_id}/", + "doc_type":"api", + "kw":"Querying an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Connections,API Refer", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying an Enhanced Datasource Connection", + "githuburl":"" + }, + { + "uri":"dli_02_0191.html", + "node_id":"dli_02_0191.xml", + "product_code":"dli", + "code":"21", + "des":"This API is used to bind a queue to a created enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/associate-q", + "doc_type":"api", + "kw":"Binding a Queue,APIs Related to Enhanced Datasource Connections,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Binding a Queue", + "githuburl":"" + }, + { + "uri":"dli_02_0192.html", + "node_id":"dli_02_0192.xml", + "product_code":"dli", + "code":"22", + "des":"This API is used to unbind a queue from an enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/disassociate-q", + "doc_type":"api", + "kw":"Unbinding a Queue,APIs Related to Enhanced Datasource Connections,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Unbinding a Queue", + "githuburl":"" + }, + { + "uri":"dli_02_0200.html", + "node_id":"dli_02_0200.xml", + "product_code":"dli", + "code":"23", + "des":"This API is used to modify the host information of a connected datasource. Only full overwriting is supported.URI formatPUT /v2.0/{project_id}/datasource/enhanced-connect", + "doc_type":"api", + "kw":"Modifying the Host Information,APIs Related to Enhanced Datasource Connections,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Modifying the Host Information", + "githuburl":"" + }, + { + "uri":"dli_02_0256.html", + "node_id":"dli_02_0256.xml", + "product_code":"dli", + "code":"24", + "des":"This API is used to query the authorization about an enhanced datasource connection.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/privi", + "doc_type":"api", + "kw":"Querying Authorization of an Enhanced Datasource Connection,APIs Related to Enhanced Datasource Conn", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Authorization of an Enhanced Datasource Connection", + "githuburl":"" + }, + { + "uri":"dli_02_0325.html", + "node_id":"dli_02_0325.xml", + "product_code":"dli", + "code":"25", + "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 Elastic Resource Pools", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"APIs Related to Elastic Resource Pools", + "githuburl":"" + }, + { + "uri":"dli_02_0326.html", + "node_id":"dli_02_0326.xml", + "product_code":"dli", + "code":"26", + "des":"This API is used to create elastic resource pools.URI formatPOST /v3/{project_id}/elastic-resource-poolsPOST /v3/{project_id}/elastic-resource-poolsParameter descriptionU", + "doc_type":"api", + "kw":"Creating an Elastic Resource Pool,APIs Related to Elastic Resource Pools,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating an Elastic Resource Pool", + "githuburl":"" + }, + { + "uri":"dli_02_0327.html", + "node_id":"dli_02_0327.xml", + "product_code":"dli", + "code":"27", + "des":"This API is used to query all elastic resource pools.URI formatGET /v3/{project_id}/elastic-resource-poolsGET /v3/{project_id}/elastic-resource-poolsParameter description", + "doc_type":"api", + "kw":"Querying All Elastic Resource Pools,APIs Related to Elastic Resource Pools,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying All Elastic Resource Pools", + "githuburl":"" + }, + { + "uri":"dli_02_0328.html", + "node_id":"dli_02_0328.xml", + "product_code":"dli", + "code":"28", + "des":"This API is used to delete an elastic resource pool.URI formatDELETE /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}DELETE /v3/{project_id}/elastic-r", + "doc_type":"api", + "kw":"Deleting an Elastic Resource Pool,APIs Related to Elastic Resource Pools,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting an Elastic Resource Pool", + "githuburl":"" + }, + { + "uri":"dli_02_0329.html", + "node_id":"dli_02_0329.xml", + "product_code":"dli", + "code":"29", + "des":"This API is used to modify elastic resource pool information.URI formatPUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}PUT /v3/{project_id}/elasti", + "doc_type":"api", + "kw":"Modifying Elastic Resource Pool Information,APIs Related to Elastic Resource Pools,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Modifying Elastic Resource Pool Information", + "githuburl":"" + }, + { + "uri":"dli_02_0330.html", + "node_id":"dli_02_0330.xml", + "product_code":"dli", + "code":"30", + "des":"This API is used to query all queues in an elastic resource pool.URI formatGET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queuesGET /v3/{project", + "doc_type":"api", + "kw":"Querying All Queues in an Elastic Resource Pool,APIs Related to Elastic Resource Pools,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying All Queues in an Elastic Resource Pool", + "githuburl":"" + }, + { + "uri":"dli_02_0331.html", + "node_id":"dli_02_0331.xml", + "product_code":"dli", + "code":"31", + "des":"This API is used to associate a queue with an elastic resource pool.URI formatPOST /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queuesPOST /v3/{pr", + "doc_type":"api", + "kw":"Associating a Queue with an Elastic Resource Pool,APIs Related to Elastic Resource Pools,API Referen", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Associating a Queue with an Elastic Resource Pool", + "githuburl":"" + }, + { + "uri":"dli_02_0332.html", + "node_id":"dli_02_0332.xml", + "product_code":"dli", + "code":"32", + "des":"This API is used to modify the scaling policy of a queue associated with an elastic resource pool.URI formatPUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_", + "doc_type":"api", + "kw":"Modifying the Scaling Policy of a Queue Associated with an Elastic Resource Pool,APIs Related to Ela", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Modifying the Scaling Policy of a Queue Associated with an Elastic Resource Pool", + "githuburl":"" + }, + { + "uri":"dli_02_0336.html", + "node_id":"dli_02_0336.xml", + "product_code":"dli", + "code":"33", + "des":"This API is used to view scaling history of an elastic resource pool.GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/scale-recordsNoneThe followi", + "doc_type":"api", + "kw":"Viewing Scaling History of an Elastic Resource Pool,APIs Related to Elastic Resource Pools,API Refer", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Viewing Scaling History of an Elastic Resource Pool", + "githuburl":"" + }, + { + "uri":"dli_02_0193.html", + "node_id":"dli_02_0193.xml", + "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":"Queue-related APIs (Recommended)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Queue-related APIs (Recommended)", + "githuburl":"" + }, + { + "uri":"dli_02_0194.html", + "node_id":"dli_02_0194.xml", + "product_code":"dli", + "code":"35", + "des":"This API is used to create a queue. The queue will be bound to specified compute resources.It takes 5 to 15 minutes to start a job using a new queue for the first time.UR", + "doc_type":"api", + "kw":"Creating a Queue,Queue-related APIs (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Queue", + "githuburl":"" + }, + { + "uri":"dli_02_0195.html", + "node_id":"dli_02_0195.xml", + "product_code":"dli", + "code":"36", + "des":"This API is used to delete a specified queue.If a task is being executed in a specified queue, the queue cannot be deleted.URI formatDELETE /v1.0/{project_id}/queues/{que", + "doc_type":"api", + "kw":"Deleting a Queue,Queue-related APIs (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting a Queue", + "githuburl":"" + }, + { + "uri":"dli_02_0196.html", + "node_id":"dli_02_0196.xml", + "product_code":"dli", + "code":"37", + "des":"This API is used to list all queues under the project.URI formatGET/v1.0/{project_id}/queuesGET/v1.0/{project_id}/queuesParameter descriptionURI parameterParameterMandato", + "doc_type":"api", + "kw":"Querying All Queues,Queue-related APIs (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying All Queues", + "githuburl":"" + }, + { + "uri":"dli_02_0016.html", + "node_id":"dli_02_0016.xml", + "product_code":"dli", + "code":"38", + "des":"This API is used to list details of a specific queue in a project.URI formatGET /v1.0/{project_id}/queues/{queue_name}GET /v1.0/{project_id}/queues/{queue_name}Parameter ", + "doc_type":"api", + "kw":"Viewing Details of a Queue,Queue-related APIs (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Viewing Details of a Queue", + "githuburl":"" + }, + { + "uri":"dli_02_0249.html", + "node_id":"dli_02_0249.xml", + "product_code":"dli", + "code":"39", + "des":"This API is used to restart, scale out, and scale in queues.Only SQL queues in the Available status can be restarted. (The queue status is Available only after the SQL jo", + "doc_type":"api", + "kw":"Restarting, Scaling Out, and Scaling In Queues,Queue-related APIs (Recommended),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Restarting, Scaling Out, and Scaling In Queues", + "githuburl":"" + }, + { + "uri":"dli_02_0284.html", + "node_id":"dli_02_0284.xml", + "product_code":"dli", + "code":"40", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating an Address Connectivity Test Request", + "githuburl":"" + }, + { + "uri":"dli_02_0285.html", + "node_id":"dli_02_0285.xml", + "product_code":"dli", + "code":"41", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Querying Connectivity Test Details of a Specified Address", + "githuburl":"" + }, + { + "uri":"dli_02_0158.html", + "node_id":"dli_02_0158.xml", + "product_code":"dli", + "code":"42", + "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":"SQL Job-related APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"SQL Job-related APIs", + "githuburl":"" + }, + { + "uri":"dli_02_0102.html", + "node_id":"dli_02_0102.xml", + "product_code":"dli", + "code":"43", + "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),SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Submitting a SQL Job (Recommended)", + "githuburl":"" + }, + { + "uri":"dli_02_0104.html", + "node_id":"dli_02_0104.xml", + "product_code":"dli", + "code":"44", + "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),SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Canceling a Job (Recommended)", + "githuburl":"" + }, + { + "uri":"dli_02_0025.html", + "node_id":"dli_02_0025.xml", + "product_code":"dli", + "code":"45", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying All Jobs", + "githuburl":"" + }, + { + "uri":"dli_02_0312.html", + "node_id":"dli_02_0312.xml", + "product_code":"dli", + "code":"46", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Previewing SQL Job Query Results", + "githuburl":"" + }, + { + "uri":"dli_02_0024.html", + "node_id":"dli_02_0024.xml", + "product_code":"dli", + "code":"47", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Exporting Query Results", + "githuburl":"" + }, + { + "uri":"dli_02_0021.html", + "node_id":"dli_02_0021.xml", + "product_code":"dli", + "code":"48", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Job Status", + "githuburl":"" + }, + { + "uri":"dli_02_0022.html", + "node_id":"dli_02_0022.xml", + "product_code":"dli", + "code":"49", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Querying Job Details", + "githuburl":"" + }, + { + "uri":"dli_02_0107.html", + "node_id":"dli_02_0107.xml", + "product_code":"dli", + "code":"50", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Checking SQL Syntax", + "githuburl":"" + }, + { + "uri":"dli_02_0296.html", + "node_id":"dli_02_0296.xml", + "product_code":"dli", + "code":"51", + "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,SQL Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Querying the Job Execution Progress", + "githuburl":"" + }, + { + "uri":"dli_02_0223.html", + "node_id":"dli_02_0223.xml", + "product_code":"dli", + "code":"52", + "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":"Flink Job-related APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Flink Job-related APIs", + "githuburl":"" + }, + { + "uri":"dli_02_0228.html", + "node_id":"dli_02_0228.xml", + "product_code":"dli", + "code":"53", + "des":"This API is used to create a Flink streaming SQL job.URI formatPOST /v1.0/{project_id}/streaming/sql-jobsPOST /v1.0/{project_id}/streaming/sql-jobsParameter descriptionUR", + "doc_type":"api", + "kw":"Creating a SQL Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a SQL Job", + "githuburl":"" + }, + { + "uri":"dli_02_0229.html", + "node_id":"dli_02_0229.xml", + "product_code":"dli", + "code":"54", + "des":"This API is used to modify a Flink SQL job.URI formatPUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}Parameter descrip", + "doc_type":"api", + "kw":"Updating a SQL Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Updating a SQL Job", + "githuburl":"" + }, + { + "uri":"dli_02_0230.html", + "node_id":"dli_02_0230.xml", + "product_code":"dli", + "code":"55", + "des":"This API is used to create custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPOST /v1.0/{project_id}/streaming/flink-jobsPOST /v1.", + "doc_type":"api", + "kw":"Creating a Flink Jar job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Flink Jar job", + "githuburl":"" + }, + { + "uri":"dli_02_0231.html", + "node_id":"dli_02_0231.xml", + "product_code":"dli", + "code":"56", + "des":"This API is used to update custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPUT /v1.0/{project_id}/streaming/flink-jobs/{job_id}P", + "doc_type":"api", + "kw":"Updating a Flink Jar Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Updating a Flink Jar Job", + "githuburl":"" + }, + { + "uri":"dli_02_0233.html", + "node_id":"dli_02_0233.xml", + "product_code":"dli", + "code":"57", + "des":"This API is used to trigger batch job running.URI formatPOST /v1.0/{project_id}/streaming/jobs/runPOST /v1.0/{project_id}/streaming/jobs/runParameter descriptionURI param", + "doc_type":"api", + "kw":"Running Jobs in Batches,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Running Jobs in Batches", + "githuburl":"" + }, + { + "uri":"dli_02_0234.html", + "node_id":"dli_02_0234.xml", + "product_code":"dli", + "code":"58", + "des":"This API is used to list the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can also query jobs ", + "doc_type":"api", + "kw":"Listing Jobs,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Listing Jobs", + "githuburl":"" + }, + { + "uri":"dli_02_0235.html", + "node_id":"dli_02_0235.xml", + "product_code":"dli", + "code":"59", + "des":"This API is used to query details of a job.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}GET /v1.0/{project_id}/streaming/jobs/{job_id}Parameter descriptionURI ", + "doc_type":"api", + "kw":"Querying Job Details,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Job Details", + "githuburl":"" + }, + { + "uri":"dli_02_0236.html", + "node_id":"dli_02_0236.xml", + "product_code":"dli", + "code":"60", + "des":"This API is used to query a job execution plan.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}/execute-graphGET /v1.0/{project_id}/streaming/jobs/{job_id}/execut", + "doc_type":"api", + "kw":"Querying the Job Execution Plan,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Querying the Job Execution Plan", + "githuburl":"" + }, + { + "uri":"dli_02_0241.html", + "node_id":"dli_02_0241.xml", + "product_code":"dli", + "code":"61", + "des":"This API is used to stop running jobs in batches.URI formatPOST /v1.0/{project_id}/streaming/jobs/stopPOST /v1.0/{project_id}/streaming/jobs/stopParameter descriptionURI ", + "doc_type":"api", + "kw":"Stopping Jobs in Batches,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Stopping Jobs in Batches", + "githuburl":"" + }, + { + "uri":"dli_02_0242.html", + "node_id":"dli_02_0242.xml", + "product_code":"dli", + "code":"62", + "des":"This API is used to delete a Flink job at any state.The job records will not be deleted.URI formatDELETE /v1.0/{project_id}/streaming/jobs/{job_id}DELETE /v1.0/{project_i", + "doc_type":"api", + "kw":"Deleting a Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Deleting a Job", + "githuburl":"" + }, + { + "uri":"dli_02_0243.html", + "node_id":"dli_02_0243.xml", + "product_code":"dli", + "code":"63", + "des":"This API is used to batch delete jobs at any state.URI formatPOST /v1.0/{project_id}/streaming/jobs/deletePOST /v1.0/{project_id}/streaming/jobs/deleteParameter descripti", + "doc_type":"api", + "kw":"Deleting Jobs in Batches,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Deleting Jobs in Batches", + "githuburl":"" + }, + { + "uri":"dli_02_0254.html", + "node_id":"dli_02_0254.xml", + "product_code":"dli", + "code":"64", + "des":"This API is used to export Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/exportPOST /v1.0/{project_id}/streaming/jobs/exportParameter descriptionURI par", + "doc_type":"api", + "kw":"Exporting a Flink Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Exporting a Flink Job", + "githuburl":"" + }, + { + "uri":"dli_02_0255.html", + "node_id":"dli_02_0255.xml", + "product_code":"dli", + "code":"65", + "des":"This API is used to import Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/importPOST /v1.0/{project_id}/streaming/jobs/importParameter descriptionURI par", + "doc_type":"api", + "kw":"Importing a Flink Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Importing a Flink Job", + "githuburl":"" + }, + { + "uri":"dli_02_0316.html", + "node_id":"dli_02_0316.xml", + "product_code":"dli", + "code":"66", + "des":"This API is used to generate a static stream graph for a Flink SQL job.URI formatPOST /v3/{project_id}/streaming/jobs/{job_id}/gen-graphPOST /v3/{project_id}/streaming/jo", + "doc_type":"api", + "kw":"Generating a Static Stream Graph for a Flink SQL Job,Flink Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Generating a Static Stream Graph for a Flink SQL Job", + "githuburl":"" + }, + { + "uri":"dli_02_0244.html", + "node_id":"dli_02_0244.xml", + "product_code":"dli", + "code":"67", + "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 Flink Job Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"APIs Related to Flink Job Templates", + "githuburl":"" + }, + { + "uri":"dli_02_0245.html", + "node_id":"dli_02_0245.xml", + "product_code":"dli", + "code":"68", + "des":"This API is used to create a user template for the DLI service. A maximum of 100 user templates can be created.URI formatPOST /v1.0/{project_id}/streaming/job-templatesPO", + "doc_type":"api", + "kw":"Creating a Template,APIs Related to Flink Job Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Template", + "githuburl":"" + }, + { + "uri":"dli_02_0246.html", + "node_id":"dli_02_0246.xml", + "product_code":"dli", + "code":"69", + "des":"This API is used to update existing templates in DLI.URI formatPUT /v1.0/{project_id}/streaming/job-templates/{template_id}PUT /v1.0/{project_id}/streaming/job-templates/", + "doc_type":"api", + "kw":"Updating a Template,APIs Related to Flink Job Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Updating a Template", + "githuburl":"" + }, + { + "uri":"dli_02_0247.html", + "node_id":"dli_02_0247.xml", + "product_code":"dli", + "code":"70", + "des":"This API is used to delete a template. A template used by jobs can also be deleted.URI formatDELETE /v1.0/{project_id}/streaming/job-templates/{template_id}DELETE /v1.0/{", + "doc_type":"api", + "kw":"Deleting a Template,APIs Related to Flink Job Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Deleting a Template", + "githuburl":"" + }, + { + "uri":"dli_02_0248.html", + "node_id":"dli_02_0248.xml", + "product_code":"dli", + "code":"71", + "des":"This API is used to query the job template list. Currently, only custom templates can be queried.URI formatGET /v1.0/{project_id}/streaming/job-templatesGET /v1.0/{projec", + "doc_type":"api", + "kw":"Querying the Template List,APIs Related to Flink Job Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying the Template List", + "githuburl":"" + }, + { + "uri":"dli_02_0109.html", + "node_id":"dli_02_0109.xml", + "product_code":"dli", + "code":"72", + "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":"Spark Job-related APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Spark Job-related APIs", + "githuburl":"" + }, + { + "uri":"dli_02_0124.html", + "node_id":"dli_02_0124.xml", + "product_code":"dli", + "code":"73", + "des":"This API is used to create a batch processing job in a queue.URI formatPOST /v2.0/{project_id}/batchesPOST /v2.0/{project_id}/batchesParameter descriptionURI parameterPar", + "doc_type":"api", + "kw":"Creating a Batch Processing Job,Spark Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Batch Processing Job", + "githuburl":"" + }, + { + "uri":"dli_02_0125.html", + "node_id":"dli_02_0125.xml", + "product_code":"dli", + "code":"74", + "des":"This API is used to obtain the list of batch processing jobs in a queue of a project.URI formatGET /v2.0/{project_id}/batchesGET /v2.0/{project_id}/batchesParameter descr", + "doc_type":"api", + "kw":"Obtaining the List of Batch Processing Jobs,Spark Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Obtaining the List of Batch Processing Jobs", + "githuburl":"" + }, + { + "uri":"dli_02_0126.html", + "node_id":"dli_02_0126.xml", + "product_code":"dli", + "code":"75", + "des":"This API is used to query details about a batch processing job based on the job ID.URI formatGET /v2.0/{project_id}/batches/{batch_id}GET /v2.0/{project_id}/batches/{batc", + "doc_type":"api", + "kw":"Querying Batch Job Details,Spark Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Batch Job Details", + "githuburl":"" + }, + { + "uri":"dli_02_0127.html", + "node_id":"dli_02_0127.xml", + "product_code":"dli", + "code":"76", + "des":"This API is used to obtain the execution status of a batch processing job.URI formatGET /v2.0/{project_id}/batches/{batch_id}/stateGET /v2.0/{project_id}/batches/{batch_i", + "doc_type":"api", + "kw":"Querying a Batch Job Status,Spark Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying a Batch Job Status", + "githuburl":"" + }, + { + "uri":"dli_02_0129.html", + "node_id":"dli_02_0129.xml", + "product_code":"dli", + "code":"77", + "des":"This API is used to cancel a batch processing job.Batch processing jobs in the Successful or Failed state cannot be canceled.URI formatDELETE /v2.0/{project_id}/batches/{", + "doc_type":"api", + "kw":"Canceling a Batch Processing Job,Spark Job-related APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Canceling a Batch Processing Job", + "githuburl":"" + }, + { + "uri":"dli_02_0201.html", + "node_id":"dli_02_0201.xml", + "product_code":"dli", + "code":"78", "des":"This section describes fine-grained permissions management for your DLI. If your account does not need individual IAM users, then you may skip this section.By default, ne", "doc_type":"api", "kw":"Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Permissions Policies and Supported Actions", "githuburl":"" }, { - "uri":"dli_02_0011.html", + "uri":"dli_02_0300.html", + "node_id":"dli_02_0300.xml", + "product_code":"dli", + "code":"79", + "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":"Out-of-Date APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"Out-of-Date APIs", + "githuburl":"" + }, + { + "uri":"dli_02_0297.html", + "node_id":"dli_02_0297.xml", + "product_code":"dli", + "code":"80", + "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":"Agency-related APIs (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Agency-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0298.html", + "node_id":"dli_02_0298.xml", + "product_code":"dli", + "code":"81", + "des":"This API is used to obtain the agency information of a DLI user.This API has been discarded and is not recommended.URI formatGET /v2/{project_id}/agencyGET /v2/{project_i", + "doc_type":"api", + "kw":"Obtaining DLI Agency Information (Discarded),Agency-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Obtaining DLI Agency Information (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0299.html", + "node_id":"dli_02_0299.xml", + "product_code":"dli", + "code":"82", + "des":"This API is used to create an agency for a DLI user.This API has been discarded and is not recommended.URI formatPOST /v2/{project_id}/agencyPOST /v2/{project_id}/agencyP", + "doc_type":"api", + "kw":"Creating a DLI Agency (Discarded),Agency-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a DLI Agency (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0166.html", + "node_id":"dli_02_0166.xml", + "product_code":"dli", + "code":"83", + "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 (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Package Group-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0130.html", + "node_id":"dli_02_0130.xml", + "product_code":"dli", + "code":"84", + "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.This API has been discarded and is not re", + "doc_type":"api", + "kw":"Uploading a Package Group (Discarded),Package Group-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Uploading a Package Group (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0168.html", + "node_id":"dli_02_0168.xml", + "product_code":"dli", + "code":"85", + "des":"This API is used to query all resources in a project, including groups.This API has been discarded and is not recommended.URI formatGET /v2.0/{project_id}/resourcesGET /v", + "doc_type":"api", + "kw":"Listing Package Groups (Discarded),Package Group-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Listing Package Groups (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0169.html", + "node_id":"dli_02_0169.xml", + "product_code":"dli", + "code":"86", + "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.This API has ", + "doc_type":"api", + "kw":"Uploading a JAR Package Group (Discarded),Package Group-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Uploading a JAR Package Group (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0170.html", + "node_id":"dli_02_0170.xml", + "product_code":"dli", + "code":"87", + "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 gr", + "doc_type":"api", + "kw":"Uploading a PyFile Package Group (Discarded),Package Group-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Uploading a PyFile Package Group (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0171.html", + "node_id":"dli_02_0171.xml", + "product_code":"dli", + "code":"88", + "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.This ", + "doc_type":"api", + "kw":"Uploading a File Package Group (Discarded),Package Group-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Uploading a File Package Group (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0172.html", + "node_id":"dli_02_0172.xml", + "product_code":"dli", + "code":"89", + "des":"This API is used to query resource information of a package group in a Project.This API has been discarded and is not recommended.URI formatGET /v2.0/{project_id}/resourc", + "doc_type":"api", + "kw":"Querying Resource Packages in a Group (Discarded),Package Group-related APIs (Discarded),API Referen", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Resource Packages in a Group (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0173.html", + "node_id":"dli_02_0173.xml", + "product_code":"dli", + "code":"90", + "des":"This API is used to delete resource packages in a group in a Project.This API has been discarded and is not recommended.URI formatDELETE /v2.0/{project_id}/resources/{res", + "doc_type":"api", + "kw":"Deleting a Resource Package from a Group (Discarded),Package Group-related APIs (Discarded),API Refe", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting a Resource Package from a Group (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0253.html", + "node_id":"dli_02_0253.xml", + "product_code":"dli", + "code":"91", + "des":"This API is used to change the owner of a program package.This API has been discarded and is not recommended.URI formatPUT /v2.0/{project_id}/resources/ownerPUT /v2.0/{pr", + "doc_type":"api", + "kw":"Changing the Owner of a Group or Resource Package (Discarded),Package Group-related APIs (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Changing the Owner of a Group or Resource Package (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0359.html", + "node_id":"dli_02_0359.xml", + "product_code":"dli", + "code":"92", + "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 Spark Batch Processing (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli" + } + ], + "title":"APIs Related to Spark Batch Processing (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0128.html", + "node_id":"dli_02_0128.xml", + "product_code":"dli", + "code":"93", + "des":"This API is used to query the back-end logs of batch processing jobs.This API has been discarded and is not recommended.URI formatGET /v2.0/{project_id}/batches/{batch_id", + "doc_type":"api", + "kw":"Querying Batch Job Logs (Discarded),APIs Related to Spark Batch Processing (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Batch Job Logs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0360.html", + "node_id":"dli_02_0360.xml", + "product_code":"dli", + "code":"94", + "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":"SQL Job-related APIs (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli" + } + ], + "title":"SQL Job-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0019.html", + "node_id":"dli_02_0019.xml", + "product_code":"dli", + "code":"95", + "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 has been discarded and is not r", + "doc_type":"api", + "kw":"Importing Data (Discarded),SQL Job-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Importing Data (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0020.html", + "node_id":"dli_02_0020.xml", + "product_code":"dli", + "code":"96", + "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 (Discarded),SQL Job-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Exporting Data (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0356.html", + "node_id":"dli_02_0356.xml", + "product_code":"dli", + "code":"97", + "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 (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Resource-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0027.html", + "node_id":"dli_02_0027.xml", + "product_code":"dli", + "code":"98", + "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 (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Database-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0028.html", + "node_id":"dli_02_0028.xml", + "product_code":"dli", + "code":"99", + "des":"This API is used to add a database.This API has been discarded and is not recommended.URI formatPOST /v1.0/{project_id}/databasesPOST /v1.0/{project_id}/databasesParamete", + "doc_type":"api", + "kw":"Creating a Database (Discarded),Database-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Database (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0030.html", + "node_id":"dli_02_0030.xml", + "product_code":"dli", + "code":"100", + "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 (Discarded),Database-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting a Database (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0029.html", + "node_id":"dli_02_0029.xml", + "product_code":"dli", + "code":"101", + "des":"This API is used to query the information about all the databases.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databasesGET /v1.0/{", + "doc_type":"api", + "kw":"Querying All Databases (Discarded),Database-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying All Databases (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0164.html", + "node_id":"dli_02_0164.xml", + "product_code":"dli", + "code":"102", + "des":"This API is used to modify the owner of a database.This API has been discarded and is not recommended.URI formatPUT /v1.0/{project_id}/databases/{database_name}/ownerPUT ", + "doc_type":"api", + "kw":"Modifying a Database Owner (Discarded),Database-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Modifying a Database Owner (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0031.html", + "node_id":"dli_02_0031.xml", + "product_code":"dli", + "code":"103", + "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 (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Table-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0034.html", + "node_id":"dli_02_0034.xml", + "product_code":"dli", + "code":"104", + "des":"This API is used to create a table. This API is a synchronous API.This API has been discarded and is not recommended.URI formatPOST /v1.0/{project_id}/databases/{database", + "doc_type":"api", + "kw":"Creating a Table (Discarded),Table-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Table (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0035.html", + "node_id":"dli_02_0035.xml", + "product_code":"dli", + "code":"105", + "des":"This API is used to delete a specified table.This API has been discarded and is not recommended.URI formatDELETE /v1.0/{project_id}/databases/{database_name}/tables/{tabl", + "doc_type":"api", + "kw":"Deleting a Table (Discarded),Table-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting a Table (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0105.html", + "node_id":"dli_02_0105.xml", + "product_code":"dli", + "code":"106", + "des":"This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.This API has been discarded and is not rec", + "doc_type":"api", + "kw":"Querying All Tables (Recommended),Table-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying All Tables (Recommended)", + "githuburl":"" + }, + { + "uri":"dli_02_0033.html", + "node_id":"dli_02_0033.xml", + "product_code":"dli", + "code":"107", + "des":"This API is used to describe metadata information in the specified table.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{da", + "doc_type":"api", + "kw":"Describing Table Information (Discarded),Table-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Describing Table Information (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0108.html", + "node_id":"dli_02_0108.xml", + "product_code":"dli", + "code":"108", + "des":"This API is used to preview the first 10 rows in a table.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{database_name}/tab", + "doc_type":"api", + "kw":"Previewing Table Content (Discarded),Table-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Previewing Table Content (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0250.html", + "node_id":"dli_02_0250.xml", + "product_code":"dli", + "code":"109", + "des":"This API is used to list partitions.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/part", + "doc_type":"api", + "kw":"Listing Partitions (Discarded),Table-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Listing Partitions (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0065.html", + "node_id":"dli_02_0065.xml", + "product_code":"dli", + "code":"110", + "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":"Permission-related APIs (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], + "title":"Permission-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0037.html", + "node_id":"dli_02_0037.xml", "product_code":"dli", "code":"111", + "des":"This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.This API has been", + "doc_type":"api", + "kw":"Granting Queue Permissions to a User (Discarded),Permission-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Granting Queue Permissions to a User (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0038.html", + "node_id":"dli_02_0038.xml", + "product_code":"dli", + "code":"112", + "des":"This API is used to query names of all users who can use a specified queue.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/queues/{que", + "doc_type":"api", + "kw":"Querying Queue Users (Discarded),Permission-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Queue Users (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0039.html", + "node_id":"dli_02_0039.xml", + "product_code":"dli", + "code":"113", + "des":"This API is used to grant database or table data usage permission to specified users.This API has been discarded and is not recommended.URI formatPUT /v1.0/{project_id}/u", + "doc_type":"api", + "kw":"Granting Data Permission to Users (Discarded),Permission-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Granting Data Permission to Users (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0040.html", + "node_id":"dli_02_0040.xml", + "product_code":"dli", + "code":"114", + "des":"This API is used query names of all users who have permission to use or access the database.This API has been discarded and is not recommended.URI formatGET /v1.0/{projec", + "doc_type":"api", + "kw":"Querying Database Users (Discarded),Permission-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Database Users (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0041.html", + "node_id":"dli_02_0041.xml", + "product_code":"dli", + "code":"115", + "des":"This API is used to query users who have permission to access the specified table or column in the table.This API has been discarded and is not recommended.URI formatGET ", + "doc_type":"api", + "kw":"Querying Table Users (Discarded),Permission-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Table Users (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0042.html", + "node_id":"dli_02_0042.xml", + "product_code":"dli", + "code":"116", + "des":"This API is used to query the permission of a specified user on a table.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{dat", + "doc_type":"api", + "kw":"Querying a User's Table Permissions (Discarded),Permission-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying a User's Table Permissions (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0361.html", + "node_id":"dli_02_0361.xml", + "product_code":"dli", + "code":"117", + "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":"Queue-related APIs (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli" + } + ], + "title":"Queue-related APIs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0291.html", + "node_id":"dli_02_0291.xml", + "product_code":"dli", + "code":"118", + "des":"This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.This API has been discarded and is not recommended.URI fo", + "doc_type":"api", + "kw":"Creating a Scheduled CU Change (Discarded),Queue-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Creating a Scheduled CU Change (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0292.html", + "node_id":"dli_02_0292.xml", + "product_code":"dli", + "code":"119", + "des":"This API is used to query the scheduled CU changes and list the changes of a specified queue.This API has been discarded and is not recommended.URI formatGET /v1/{project", + "doc_type":"api", + "kw":"Viewing a Scheduled CU Change (Discarded),Queue-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Viewing a Scheduled CU Change (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0293.html", + "node_id":"dli_02_0293.xml", + "product_code":"dli", + "code":"120", + "des":"This API is used to delete scheduled CU changes in batches.This API has been discarded and is not recommended.URI formatPOST /v1/{project_id}/queues/{queue_name}/plans/ba", + "doc_type":"api", + "kw":"Deleting Scheduled CU Changes in Batches (Discarded),Queue-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting Scheduled CU Changes in Batches (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0294.html", + "node_id":"dli_02_0294.xml", + "product_code":"dli", + "code":"121", + "des":"This API is used to delete a scheduled CU change for a queue with a specified ID.This API has been discarded and is not recommended.URI formatDELETE /v1/{project_id}/queu", + "doc_type":"api", + "kw":"Deleting a Scheduled CU Change (Discarded),Queue-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Deleting a Scheduled CU Change (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0295.html", + "node_id":"dli_02_0295.xml", + "product_code":"dli", + "code":"122", + "des":"This API is used to modify a scheduled CU change for a queue with a specified ID.This API has been discarded and is not recommended.URI formatPUT /v1/{project_id}/queues/", + "doc_type":"api", + "kw":"Modifying a Scheduled CU Change (Discarded),Queue-related APIs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Modifying a Scheduled CU Change (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0333.html", + "node_id":"dli_02_0333.xml", + "product_code":"dli", + "code":"123", + "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 Flink Jobs (Discarded)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], + "title":"APIs Related to Flink Jobs (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0238.html", + "node_id":"dli_02_0238.xml", + "product_code":"dli", + "code":"124", + "des":"This API is used to query job monitoring information. You can query monitoring information about multiple jobs at the same time.This API has been discarded and is not rec", + "doc_type":"api", + "kw":"Querying Job Monitoring Information (Discarded),APIs Related to Flink Jobs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Querying Job Monitoring Information (Discarded)", + "githuburl":"" + }, + { + "uri":"dli_02_0225.html", + "node_id":"dli_02_0225.xml", + "product_code":"dli", + "code":"125", + "des":"This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.This API has been discarded and is not recommended.URI formatPO", + "doc_type":"api", + "kw":"Granting OBS Permissions to DLI,APIs Related to Flink Jobs (Discarded),API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], + "title":"Granting OBS Permissions to DLI", + "githuburl":"" + }, + { + "uri":"dli_02_0011.html", + "node_id":"dli_02_0011.xml", + "product_code":"dli", + "code":"126", "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":"Public Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Public Parameters", "githuburl":"" }, { "uri":"dli_02_0012.html", + "node_id":"dli_02_0012.xml", "product_code":"dli", - "code":"112", + "code":"127", "des":"Table 1 describes status codes.", "doc_type":"api", "kw":"Status Codes,Public Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"dli_02_0056.html", + "node_id":"dli_02_0056.xml", "product_code":"dli", - "code":"113", + "code":"128", "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 Codes,Public Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Error Codes", "githuburl":"" }, { "uri":"dli_02_0183.html", + "node_id":"dli_02_0183.xml", "product_code":"dli", - "code":"114", + "code":"129", "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":"Obtaining a Project ID,Public Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "opensource":"true", + "IsBot":"Yes", + "IsMulti":"No" + } + ], "title":"Obtaining a Project ID", "githuburl":"" }, { "uri":"dli_02_0013.html", + "node_id":"dli_02_0013.xml", "product_code":"dli", - "code":"115", + "code":"130", "des":"An account ID (domain-id) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:Log in to the management console.Hove", "doc_type":"api", "kw":"Obtaining an Account ID,Public Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "opensource":"true", + "IsBot":"Yes" + } + ], "title":"Obtaining an Account ID", "githuburl":"" }, { "uri":"dli_02_00003.html", + "node_id":"dli_02_00003.xml", "product_code":"dli", - "code":"116", + "code":"131", "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":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dli", + "IsMulti":"No", + "IsBot":"No", + "opensource":"true" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/dli/api-ref/CLASS.TXT.json b/docs/dli/api-ref/CLASS.TXT.json index 68fc2d59..74861a51 100644 --- a/docs/dli/api-ref/CLASS.TXT.json +++ b/docs/dli/api-ref/CLASS.TXT.json @@ -80,60 +80,6 @@ "p_code":"", "code":"9" }, - { - "desc":"This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.URI formatPUT /v1", - "product_code":"dli", - "title":"Granting Users with the Queue Usage Permission", - "uri":"dli_02_0037.html", - "doc_type":"api", - "p_code":"9", - "code":"10" - }, - { - "desc":"This API is used to query names of all users who can use a specified queue.URI formatGET /v1.0/{project_id}/queues/{queue_name}/usersGET /v1.0/{project_id}/queues/{queue_", - "product_code":"dli", - "title":"Querying Queue Users", - "uri":"dli_02_0038.html", - "doc_type":"api", - "p_code":"9", - "code":"11" - }, - { - "desc":"This API is used to grant database or table data usage permission to specified users.URI formatPUT /v1.0/{project_id}/user-authorizationPUT /v1.0/{project_id}/user-author", - "product_code":"dli", - "title":"Granting Data Permission to Users", - "uri":"dli_02_0039.html", - "doc_type":"api", - "p_code":"9", - "code":"12" - }, - { - "desc":"This API is used query names of all users who have permission to use or access the database.URI formatGET /v1.0/{project_id}/databases/{database_name}/usersGET /v1.0/{pro", - "product_code":"dli", - "title":"Querying Database Users", - "uri":"dli_02_0040.html", - "doc_type":"api", - "p_code":"9", - "code":"13" - }, - { - "desc":"This API is used to query users who have permission to access the specified table or column in the table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables", - "product_code":"dli", - "title":"Querying Table Users", - "uri":"dli_02_0041.html", - "doc_type":"api", - "p_code":"9", - "code":"14" - }, - { - "desc":"This API is used to query the permission of a specified user on a table.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/users/{user_name}GE", - "product_code":"dli", - "title":"Querying a User's Table Permissions", - "uri":"dli_02_0042.html", - "doc_type":"api", - "p_code":"9", - "code":"15" - }, { "desc":"This API is used to view the permissions granted to a user.URI formatGET /v1.0/{project_id}/authorization/privilegesGET /v1.0/{project_id}/authorization/privilegesParamet", "product_code":"dli", @@ -141,799 +87,7 @@ "uri":"dli_02_0252.html", "doc_type":"api", "p_code":"9", - "code":"16" - }, - { - "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":"Agency-related APIs", - "uri":"dli_02_0297.html", - "doc_type":"api", - "p_code":"", - "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 parametersParamet", - "product_code":"dli", - "title":"Obtaining DLI Agency Information", - "uri":"dli_02_0298.html", - "doc_type":"api", - "p_code":"17", - "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 parametersParameterMandator", - "product_code":"dli", - "title":"Creating a DLI Agency", - "uri":"dli_02_0299.html", - "doc_type":"api", - "p_code":"17", - "code":"19" - }, - { - "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":"Queue-related APIs (Recommended)", - "uri":"dli_02_0193.html", - "doc_type":"api", - "p_code":"", - "code":"20" - }, - { - "desc":"This API is used to create a queue. The queue will be bound to specified compute resources.It takes 5 to 15 minutes to start a job using a new queue for the first time.UR", - "product_code":"dli", - "title":"Creating a Queue", - "uri":"dli_02_0194.html", - "doc_type":"api", - "p_code":"20", - "code":"21" - }, - { - "desc":"This API is used to delete a specified queue.If a task is being executed in a specified queue, the queue cannot be deleted.URI formatDELETE /v1.0/{project_id}/queues/{que", - "product_code":"dli", - "title":"Deleting a Queue", - "uri":"dli_02_0195.html", - "doc_type":"api", - "p_code":"20", - "code":"22" - }, - { - "desc":"This API is used to list all queues under the project.URI formatGET/v1.0/{project_id}/queuesGET/v1.0/{project_id}/queuesParameter descriptionURI parameterParameterMandato", - "product_code":"dli", - "title":"Querying All Queues", - "uri":"dli_02_0196.html", - "doc_type":"api", - "p_code":"20", - "code":"23" - }, - { - "desc":"This API is used to list details of a specific queue in a project.URI formatGET /v1.0/{project_id}/queues/{queue_name}GET /v1.0/{project_id}/queues/{queue_name}Parameter ", - "product_code":"dli", - "title":"Viewing Details of a Queue", - "uri":"dli_02_0016.html", - "doc_type":"api", - "p_code":"20", - "code":"24" - }, - { - "desc":"This API is used to restart, scale out, and scale in queues.Only SQL queues in the Available status can be restarted. (The queue status is Available only after the SQL jo", - "product_code":"dli", - "title":"Restarting, Scaling Out, and Scaling In Queues", - "uri":"dli_02_0249.html", - "doc_type":"api", - "p_code":"20", - "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/{qu", - "product_code":"dli", - "title":"Creating an Address Connectivity Test Request", - "uri":"dli_02_0284.html", - "doc_type":"api", - "p_code":"20", - "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.0", - "product_code":"dli", - "title":"Querying Connectivity Test Details of a Specified Address", - "uri":"dli_02_0285.html", - "doc_type":"api", - "p_code":"20", - "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}/plans", - "product_code":"dli", - "title":"Creating a Scheduled CU Change", - "uri":"dli_02_0291.html", - "doc_type":"api", - "p_code":"20", - "code":"28" - }, - { - "desc":"This API is used to query the scheduled CU changes and list the changes of a specified queue.URI formatGET /v1/{project_id}/queues/{queue_name}/plansGET /v1/{project_id}/", - "product_code":"dli", - "title":"Viewing a Scheduled CU Change", - "uri":"dli_02_0292.html", - "doc_type":"api", - "p_code":"20", - "code":"29" - }, - { - "desc":"This API is used to delete scheduled CU changes in batches.URI formatPOST /v1/{project_id}/queues/{queue_name}/plans/batch-deletePOST /v1/{project_id}/queues/{queue_name}", - "product_code":"dli", - "title":"Deleting Scheduled CU Changes in Batches", - "uri":"dli_02_0293.html", - "doc_type":"api", - "p_code":"20", - "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/{project_", - "product_code":"dli", - "title":"Deleting a Scheduled CU Change", - "uri":"dli_02_0294.html", - "doc_type":"api", - "p_code":"20", - "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}/qu", - "product_code":"dli", - "title":"Modifying a Scheduled CU Change", - "uri":"dli_02_0295.html", - "doc_type":"api", - "p_code":"20", - "code":"32" - }, - { - "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":"SQL Job related APIs", - "uri":"dli_02_0158.html", - "doc_type":"api", - "p_code":"", - "code":"33" - }, - { - "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":"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 ", - "product_code":"dli", - "title":"Canceling a Job (Recommended)", - "uri":"dli_02_0104.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Querying All Jobs", - "uri":"dli_02_0025.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Previewing SQL Job Query Results", - "uri":"dli_02_0312.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Querying Job Status", - "uri":"dli_02_0021.html", - "doc_type":"api", - "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/{", - "product_code":"dli", - "title":"Querying Job Details", - "uri":"dli_02_0022.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Checking SQL Syntax", - "uri":"dli_02_0107.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Exporting Query Results", - "uri":"dli_02_0024.html", - "doc_type":"api", - "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, ", - "product_code":"dli", - "title":"Querying the Job Execution Progress", - "uri":"dli_02_0296.html", - "doc_type":"api", - "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.", - "product_code":"dli", - "title":"Package Group-related APIs", - "uri":"dli_02_0166.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Uploading a Package Group", - "uri":"dli_02_0130.html", - "doc_type":"api", - "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 ", - "product_code":"dli", - "title":"Querying Package Group List", - "uri":"dli_02_0168.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Uploading a JAR Package Group", - "uri":"dli_02_0169.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Uploading a PyFile Package Group", - "uri":"dli_02_0170.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Uploading a File Package Group", - "uri":"dli_02_0171.html", - "doc_type":"api", - "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/", - "product_code":"dli", - "title":"Querying Resource Packages in a Group", - "uri":"dli_02_0172.html", - "doc_type":"api", - "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", - "product_code":"dli", - "title":"Deleting a Resource Package from a Group", - "uri":"dli_02_0173.html", - "doc_type":"api", - "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", - "product_code":"dli", - "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 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", - "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" - }, - { - "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 Flink Jobs", - "uri":"dli_02_0223.html", - "doc_type":"api", - "p_code":"", - "code":"67" - }, - { - "desc":"This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.URI formatPOST /v1.0/{project_id}/dli/obs-authorizePOST /v1.0/{", - "product_code":"dli", - "title":"Granting OBS Permissions to DLI", - "uri":"dli_02_0225.html", - "doc_type":"api", - "p_code":"67", - "code":"68" - }, - { - "desc":"This API is used to create a Flink streaming SQL job.URI formatPOST /v1.0/{project_id}/streaming/sql-jobsPOST /v1.0/{project_id}/streaming/sql-jobsParameter descriptionUR", - "product_code":"dli", - "title":"Creating a SQL Job", - "uri":"dli_02_0228.html", - "doc_type":"api", - "p_code":"67", - "code":"69" - }, - { - "desc":"This API is used to modify a Flink SQL job.URI formatPUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}Parameter descrip", - "product_code":"dli", - "title":"Updating a SQL Job", - "uri":"dli_02_0229.html", - "doc_type":"api", - "p_code":"67", - "code":"70" - }, - { - "desc":"This API is used to create custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPOST /v1.0/{project_id}/streaming/flink-jobsPOST /v1.", - "product_code":"dli", - "title":"Creating a Flink Jar job", - "uri":"dli_02_0230.html", - "doc_type":"api", - "p_code":"67", - "code":"71" - }, - { - "desc":"This API is used to update custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPUT /v1.0/{project_id}/streaming/flink-jobs/{job_id}P", - "product_code":"dli", - "title":"Updating a Flink Jar Job", - "uri":"dli_02_0231.html", - "doc_type":"api", - "p_code":"67", - "code":"72" - }, - { - "desc":"This API is used to trigger batch job running.URI formatPOST /v1.0/{project_id}/streaming/jobs/runPOST /v1.0/{project_id}/streaming/jobs/runParameter descriptionURI param", - "product_code":"dli", - "title":"Running Jobs in Batches", - "uri":"dli_02_0233.html", - "doc_type":"api", - "p_code":"67", - "code":"73" - }, - { - "desc":"This API is used to query the list of the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can als", - "product_code":"dli", - "title":"Querying the Job List", - "uri":"dli_02_0234.html", - "doc_type":"api", - "p_code":"67", - "code":"74" - }, - { - "desc":"This API is used to query details of a job.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}GET /v1.0/{project_id}/streaming/jobs/{job_id}Parameter descriptionURI ", - "product_code":"dli", - "title":"Querying Job Details", - "uri":"dli_02_0235.html", - "doc_type":"api", - "p_code":"67", - "code":"75" - }, - { - "desc":"This API is used to query a job execution plan.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}/execute-graphGET /v1.0/{project_id}/streaming/jobs/{job_id}/execut", - "product_code":"dli", - "title":"Querying the Job Execution Plan", - "uri":"dli_02_0236.html", - "doc_type":"api", - "p_code":"67", - "code":"76" - }, - { - "desc":"This API is used to stop running jobs in batches.URI formatPOST /v1.0/{project_id}/streaming/jobs/stopPOST /v1.0/{project_id}/streaming/jobs/stopParameter descriptionURI ", - "product_code":"dli", - "title":"Stopping Jobs in Batches", - "uri":"dli_02_0241.html", - "doc_type":"api", - "p_code":"67", - "code":"77" - }, - { - "desc":"This API is used to delete a Flink job at any state.The job records will not be deleted.URI formatDELETE /v1.0/{project_id}/streaming/jobs/{job_id}DELETE /v1.0/{project_i", - "product_code":"dli", - "title":"Deleting a Job", - "uri":"dli_02_0242.html", - "doc_type":"api", - "p_code":"67", - "code":"78" - }, - { - "desc":"This API is used to batch delete jobs at any state.URI formatPOST /v1.0/{project_id}/streaming/jobs/deletePOST /v1.0/{project_id}/streaming/jobs/deleteParameter descripti", - "product_code":"dli", - "title":"Deleting Jobs in Batches", - "uri":"dli_02_0243.html", - "doc_type":"api", - "p_code":"67", - "code":"79" - }, - { - "desc":"This API is used to export Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/exportPOST /v1.0/{project_id}/streaming/jobs/exportParameter descriptionURI par", - "product_code":"dli", - "title":"Exporting a Flink Job", - "uri":"dli_02_0254.html", - "doc_type":"api", - "p_code":"67", - "code":"80" - }, - { - "desc":"This API is used to import Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/importPOST /v1.0/{project_id}/streaming/jobs/importParameter descriptionURI par", - "product_code":"dli", - "title":"Importing a Flink Job", - "uri":"dli_02_0255.html", - "doc_type":"api", - "p_code":"67", - "code":"81" - }, - { - "desc":"This API is used to generate a static stream graph for a Flink SQL job.URI formatPOST /v3/{project_id}/streaming/jobs/{job_id}/gen-graphPOST /v3/{project_id}/streaming/jo", - "product_code":"dli", - "title":"Generating a Static Stream Graph for a Flink SQL Job", - "uri":"dli_02_0316.html", - "doc_type":"api", - "p_code":"67", - "code":"82" - }, - { - "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 Spark jobs", - "uri":"dli_02_0109.html", - "doc_type":"api", - "p_code":"", - "code":"83" - }, - { - "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":"Batch Processing-related APIs", - "uri":"dli_02_0162.html", - "doc_type":"api", - "p_code":"83", - "code":"84" - }, - { - "desc":"This API is used to create a batch processing job in a queue.URI formatPOST /v2.0/{project_id}/batchesPOST /v2.0/{project_id}/batchesParameter descriptionURI parameterPar", - "product_code":"dli", - "title":"Creating a Batch Processing Job", - "uri":"dli_02_0124.html", - "doc_type":"api", - "p_code":"84", - "code":"85" - }, - { - "desc":"This API is used to cancel a batch processing job.Batch processing jobs in the Successful or Failed state cannot be canceled.URI formatDELETE /v2.0/{project_id}/batches/{", - "product_code":"dli", - "title":"Canceling a Batch Processing Job", - "uri":"dli_02_0129.html", - "doc_type":"api", - "p_code":"84", - "code":"86" - }, - { - "desc":"This API is used to obtain the list of batch processing jobs in a queue of a project.URI formatGET /v2.0/{project_id}/batchesGET /v2.0/{project_id}/batchesParameter descr", - "product_code":"dli", - "title":"Obtaining the List of Batch Processing Jobs", - "uri":"dli_02_0125.html", - "doc_type":"api", - "p_code":"84", - "code":"87" - }, - { - "desc":"This API is used to query details about a batch processing job based on the job ID.URI formatGET /v2.0/{project_id}/batches/{batch_id}GET /v2.0/{project_id}/batches/{batc", - "product_code":"dli", - "title":"Querying Batch Job Details", - "uri":"dli_02_0126.html", - "doc_type":"api", - "p_code":"84", - "code":"88" - }, - { - "desc":"This API is used to obtain the execution status of a batch processing job.URI formatGET /v2.0/{project_id}/batches/{batch_id}/stateGET /v2.0/{project_id}/batches/{batch_i", - "product_code":"dli", - "title":"Querying a Batch Job Status", - "uri":"dli_02_0127.html", - "doc_type":"api", - "p_code":"84", - "code":"89" - }, - { - "desc":"This API is used to query the back-end logs of batch processing jobs.URI formatGET /v2.0/{project_id}/batches/{batch_id}/logGET /v2.0/{project_id}/batches/{batch_id}/logP", - "product_code":"dli", - "title":"Querying Batch Job Logs", - "uri":"dli_02_0128.html", - "doc_type":"api", - "p_code":"84", - "code":"90" - }, - { - "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 Flink Job Templates", - "uri":"dli_02_0244.html", - "doc_type":"api", - "p_code":"", - "code":"91" - }, - { - "desc":"This API is used to create a user template for the DLI service. A maximum of 100 user templates can be created.URI formatPOST /v1.0/{project_id}/streaming/job-templatesPO", - "product_code":"dli", - "title":"Creating a Template", - "uri":"dli_02_0245.html", - "doc_type":"api", - "p_code":"91", - "code":"92" - }, - { - "desc":"This API is used to update existing templates in DLI.URI formatPUT /v1.0/{project_id}/streaming/job-templates/{template_id}PUT /v1.0/{project_id}/streaming/job-templates/", - "product_code":"dli", - "title":"Updating a Template", - "uri":"dli_02_0246.html", - "doc_type":"api", - "p_code":"91", - "code":"93" - }, - { - "desc":"This API is used to delete a template. A template used by jobs can also be deleted.URI formatDELETE /v1.0/{project_id}/streaming/job-templates/{template_id}DELETE /v1.0/{", - "product_code":"dli", - "title":"Deleting a Template", - "uri":"dli_02_0247.html", - "doc_type":"api", - "p_code":"91", - "code":"94" - }, - { - "desc":"This API is used to query the job template list. Currently, only custom templates can be queried.URI formatGET /v1.0/{project_id}/streaming/job-templatesGET /v1.0/{projec", - "product_code":"dli", - "title":"Querying the Template List", - "uri":"dli_02_0248.html", - "doc_type":"api", - "p_code":"91", - "code":"95" - }, - { - "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 Enhanced Datasource Connections", - "uri":"dli_02_0186.html", - "doc_type":"api", - "p_code":"", - "code":"96" - }, - { - "desc":"This API is used to create an enhanced datasource connection with other services.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connectionsPOST /v2.0/{project_id}/", - "product_code":"dli", - "title":"Creating an Enhanced Datasource Connection", - "uri":"dli_02_0187.html", - "doc_type":"api", - "p_code":"96", - "code":"97" - }, - { - "desc":"This API is used to delete an enhanced datasource connection.The connection that is being created cannot be deleted.URI formatDELETE /v2.0/{project_id}/datasource/enhance", - "product_code":"dli", - "title":"Deleting an Enhanced Datasource Connection", - "uri":"dli_02_0188.html", - "doc_type":"api", - "p_code":"96", - "code":"98" - }, - { - "desc":"This API is used to query the list of created enhanced datasource connections.URI formatGET /v2.0/{project_id}/datasource/enhanced-connectionsGET /v2.0/{project_id}/datas", - "product_code":"dli", - "title":"Querying an Enhanced Datasource Connection List", - "uri":"dli_02_0190.html", - "doc_type":"api", - "p_code":"96", - "code":"99" - }, - { - "desc":"This API is used to query the created enhanced datasource connections.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}GET /v2.0/{project_i", - "product_code":"dli", - "title":"Querying an Enhanced Datasource Connection", - "uri":"dli_02_0189.html", - "doc_type":"api", - "p_code":"96", - "code":"100" - }, - { - "desc":"This API is used to bind a queue to a created enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/associate-q", - "product_code":"dli", - "title":"Binding a Queue", - "uri":"dli_02_0191.html", - "doc_type":"api", - "p_code":"96", - "code":"101" - }, - { - "desc":"This API is used to unbind a queue from an enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/disassociate-q", - "product_code":"dli", - "title":"Unbinding a Queue", - "uri":"dli_02_0192.html", - "doc_type":"api", - "p_code":"96", - "code":"102" - }, - { - "desc":"This API is used to modify the host information of a connected datasource. Only full overwriting is supported.URI formatPUT /v2.0/{project_id}/datasource/enhanced-connect", - "product_code":"dli", - "title":"Modifying the Host Information", - "uri":"dli_02_0200.html", - "doc_type":"api", - "p_code":"96", - "code":"103" - }, - { - "desc":"This API is used to query the authorization about an enhanced datasource connection.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/privi", - "product_code":"dli", - "title":"Querying Authorization of an Enhanced Datasource Connection", - "uri":"dli_02_0256.html", - "doc_type":"api", - "p_code":"96", - "code":"104" + "code":"10" }, { "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.", @@ -942,16 +96,16 @@ "uri":"dli_02_0257.html", "doc_type":"api", "p_code":"", - "code":"105" + "code":"11" }, { - "desc":"This API is used to create a global variable.URI formatPOST /v1.0/{project_id}/variablesPOST /v1.0/{project_id}/variablesParameter descriptionURI parametersParameterManda", + "desc":"This API is used to create a global variable.URI formatPOST /v1.0/{project_id}/variablesPOST /v1.0/{project_id}/variablesParameter descriptionURI parameterParameterMandat", "product_code":"dli", "title":"Creating a Global Variable", "uri":"dli_02_0258.html", "doc_type":"api", - "p_code":"105", - "code":"106" + "p_code":"11", + "code":"12" }, { "desc":"This API is used to delete a global variable.Only the user who creates a global variable can delete the variable.URI formatDELETE /v1.0/{project_id}/variables/{var_name}D", @@ -959,8 +113,8 @@ "title":"Deleting a Global Variable", "uri":"dli_02_0259.html", "doc_type":"api", - "p_code":"105", - "code":"107" + "p_code":"11", + "code":"13" }, { "desc":"This API is used to modify a global variable.URI formatPUT /v1.0/{project_id}/variables/{var_name}PUT /v1.0/{project_id}/variables/{var_name}Parameter descriptionURI para", @@ -968,8 +122,8 @@ "title":"Modifying a Global Variable", "uri":"dli_02_0260.html", "doc_type":"api", - "p_code":"105", - "code":"108" + "p_code":"11", + "code":"14" }, { "desc":"This API is used to query information about all global variables in the current project.URI formatGET /v1.0/{project_id}/variablesGET /v1.0/{project_id}/variablesParamete", @@ -977,8 +131,566 @@ "title":"Querying All Global Variables", "uri":"dli_02_0261.html", "doc_type":"api", - "p_code":"105", - "code":"109" + "p_code":"11", + "code":"15" + }, + { + "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 Enhanced Datasource Connections", + "uri":"dli_02_0186.html", + "doc_type":"api", + "p_code":"", + "code":"16" + }, + { + "desc":"This API is used to create an enhanced datasource connection with other services.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connectionsPOST /v2.0/{project_id}/", + "product_code":"dli", + "title":"Creating an Enhanced Datasource Connection", + "uri":"dli_02_0187.html", + "doc_type":"api", + "p_code":"16", + "code":"17" + }, + { + "desc":"This API is used to delete an enhanced datasource connection.The connection that is being created cannot be deleted.URI formatDELETE /v2.0/{project_id}/datasource/enhance", + "product_code":"dli", + "title":"Deleting an Enhanced Datasource Connection", + "uri":"dli_02_0188.html", + "doc_type":"api", + "p_code":"16", + "code":"18" + }, + { + "desc":"This API is used to list the created enhanced datasource connections.URI formatGET /v2.0/{project_id}/datasource/enhanced-connectionsGET /v2.0/{project_id}/datasource/enh", + "product_code":"dli", + "title":"Listing Enhanced Datasource Connections", + "uri":"dli_02_0190.html", + "doc_type":"api", + "p_code":"16", + "code":"19" + }, + { + "desc":"This API is used to query a created enhanced datasource connection.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}GET /v2.0/{project_id}/", + "product_code":"dli", + "title":"Querying an Enhanced Datasource Connection", + "uri":"dli_02_0189.html", + "doc_type":"api", + "p_code":"16", + "code":"20" + }, + { + "desc":"This API is used to bind a queue to a created enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/associate-q", + "product_code":"dli", + "title":"Binding a Queue", + "uri":"dli_02_0191.html", + "doc_type":"api", + "p_code":"16", + "code":"21" + }, + { + "desc":"This API is used to unbind a queue from an enhanced datasource connection.URI formatPOST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/disassociate-q", + "product_code":"dli", + "title":"Unbinding a Queue", + "uri":"dli_02_0192.html", + "doc_type":"api", + "p_code":"16", + "code":"22" + }, + { + "desc":"This API is used to modify the host information of a connected datasource. Only full overwriting is supported.URI formatPUT /v2.0/{project_id}/datasource/enhanced-connect", + "product_code":"dli", + "title":"Modifying the Host Information", + "uri":"dli_02_0200.html", + "doc_type":"api", + "p_code":"16", + "code":"23" + }, + { + "desc":"This API is used to query the authorization about an enhanced datasource connection.URI formatGET /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/privi", + "product_code":"dli", + "title":"Querying Authorization of an Enhanced Datasource Connection", + "uri":"dli_02_0256.html", + "doc_type":"api", + "p_code":"16", + "code":"24" + }, + { + "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 Elastic Resource Pools", + "uri":"dli_02_0325.html", + "doc_type":"api", + "p_code":"", + "code":"25" + }, + { + "desc":"This API is used to create elastic resource pools.URI formatPOST /v3/{project_id}/elastic-resource-poolsPOST /v3/{project_id}/elastic-resource-poolsParameter descriptionU", + "product_code":"dli", + "title":"Creating an Elastic Resource Pool", + "uri":"dli_02_0326.html", + "doc_type":"api", + "p_code":"25", + "code":"26" + }, + { + "desc":"This API is used to query all elastic resource pools.URI formatGET /v3/{project_id}/elastic-resource-poolsGET /v3/{project_id}/elastic-resource-poolsParameter description", + "product_code":"dli", + "title":"Querying All Elastic Resource Pools", + "uri":"dli_02_0327.html", + "doc_type":"api", + "p_code":"25", + "code":"27" + }, + { + "desc":"This API is used to delete an elastic resource pool.URI formatDELETE /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}DELETE /v3/{project_id}/elastic-r", + "product_code":"dli", + "title":"Deleting an Elastic Resource Pool", + "uri":"dli_02_0328.html", + "doc_type":"api", + "p_code":"25", + "code":"28" + }, + { + "desc":"This API is used to modify elastic resource pool information.URI formatPUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}PUT /v3/{project_id}/elasti", + "product_code":"dli", + "title":"Modifying Elastic Resource Pool Information", + "uri":"dli_02_0329.html", + "doc_type":"api", + "p_code":"25", + "code":"29" + }, + { + "desc":"This API is used to query all queues in an elastic resource pool.URI formatGET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queuesGET /v3/{project", + "product_code":"dli", + "title":"Querying All Queues in an Elastic Resource Pool", + "uri":"dli_02_0330.html", + "doc_type":"api", + "p_code":"25", + "code":"30" + }, + { + "desc":"This API is used to associate a queue with an elastic resource pool.URI formatPOST /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queuesPOST /v3/{pr", + "product_code":"dli", + "title":"Associating a Queue with an Elastic Resource Pool", + "uri":"dli_02_0331.html", + "doc_type":"api", + "p_code":"25", + "code":"31" + }, + { + "desc":"This API is used to modify the scaling policy of a queue associated with an elastic resource pool.URI formatPUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_", + "product_code":"dli", + "title":"Modifying the Scaling Policy of a Queue Associated with an Elastic Resource Pool", + "uri":"dli_02_0332.html", + "doc_type":"api", + "p_code":"25", + "code":"32" + }, + { + "desc":"This API is used to view scaling history of an elastic resource pool.GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/scale-recordsNoneThe followi", + "product_code":"dli", + "title":"Viewing Scaling History of an Elastic Resource Pool", + "uri":"dli_02_0336.html", + "doc_type":"api", + "p_code":"25", + "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":"Queue-related APIs (Recommended)", + "uri":"dli_02_0193.html", + "doc_type":"api", + "p_code":"", + "code":"34" + }, + { + "desc":"This API is used to create a queue. The queue will be bound to specified compute resources.It takes 5 to 15 minutes to start a job using a new queue for the first time.UR", + "product_code":"dli", + "title":"Creating a Queue", + "uri":"dli_02_0194.html", + "doc_type":"api", + "p_code":"34", + "code":"35" + }, + { + "desc":"This API is used to delete a specified queue.If a task is being executed in a specified queue, the queue cannot be deleted.URI formatDELETE /v1.0/{project_id}/queues/{que", + "product_code":"dli", + "title":"Deleting a Queue", + "uri":"dli_02_0195.html", + "doc_type":"api", + "p_code":"34", + "code":"36" + }, + { + "desc":"This API is used to list all queues under the project.URI formatGET/v1.0/{project_id}/queuesGET/v1.0/{project_id}/queuesParameter descriptionURI parameterParameterMandato", + "product_code":"dli", + "title":"Querying All Queues", + "uri":"dli_02_0196.html", + "doc_type":"api", + "p_code":"34", + "code":"37" + }, + { + "desc":"This API is used to list details of a specific queue in a project.URI formatGET /v1.0/{project_id}/queues/{queue_name}GET /v1.0/{project_id}/queues/{queue_name}Parameter ", + "product_code":"dli", + "title":"Viewing Details of a Queue", + "uri":"dli_02_0016.html", + "doc_type":"api", + "p_code":"34", + "code":"38" + }, + { + "desc":"This API is used to restart, scale out, and scale in queues.Only SQL queues in the Available status can be restarted. (The queue status is Available only after the SQL jo", + "product_code":"dli", + "title":"Restarting, Scaling Out, and Scaling In Queues", + "uri":"dli_02_0249.html", + "doc_type":"api", + "p_code":"34", + "code":"39" + }, + { + "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", + "doc_type":"api", + "p_code":"34", + "code":"40" + }, + { + "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", + "doc_type":"api", + "p_code":"34", + "code":"41" + }, + { + "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":"SQL Job-related APIs", + "uri":"dli_02_0158.html", + "doc_type":"api", + "p_code":"", + "code":"42" + }, + { + "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":"42", + "code":"43" + }, + { + "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 ", + "product_code":"dli", + "title":"Canceling a Job (Recommended)", + "uri":"dli_02_0104.html", + "doc_type":"api", + "p_code":"42", + "code":"44" + }, + { + "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", + "product_code":"dli", + "title":"Querying All Jobs", + "uri":"dli_02_0025.html", + "doc_type":"api", + "p_code":"42", + "code":"45" + }, + { + "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", + "product_code":"dli", + "title":"Previewing SQL Job Query Results", + "uri":"dli_02_0312.html", + "doc_type":"api", + "p_code":"42", + "code":"46" + }, + { + "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", + "product_code":"dli", + "title":"Exporting Query Results", + "uri":"dli_02_0024.html", + "doc_type":"api", + "p_code":"42", + "code":"47" + }, + { + "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", + "product_code":"dli", + "title":"Querying Job Status", + "uri":"dli_02_0021.html", + "doc_type":"api", + "p_code":"42", + "code":"48" + }, + { + "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/{", + "product_code":"dli", + "title":"Querying Job Details", + "uri":"dli_02_0022.html", + "doc_type":"api", + "p_code":"42", + "code":"49" + }, + { + "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", + "product_code":"dli", + "title":"Checking SQL Syntax", + "uri":"dli_02_0107.html", + "doc_type":"api", + "p_code":"42", + "code":"50" + }, + { + "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, ", + "product_code":"dli", + "title":"Querying the Job Execution Progress", + "uri":"dli_02_0296.html", + "doc_type":"api", + "p_code":"42", + "code":"51" + }, + { + "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":"Flink Job-related APIs", + "uri":"dli_02_0223.html", + "doc_type":"api", + "p_code":"", + "code":"52" + }, + { + "desc":"This API is used to create a Flink streaming SQL job.URI formatPOST /v1.0/{project_id}/streaming/sql-jobsPOST /v1.0/{project_id}/streaming/sql-jobsParameter descriptionUR", + "product_code":"dli", + "title":"Creating a SQL Job", + "uri":"dli_02_0228.html", + "doc_type":"api", + "p_code":"52", + "code":"53" + }, + { + "desc":"This API is used to modify a Flink SQL job.URI formatPUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}Parameter descrip", + "product_code":"dli", + "title":"Updating a SQL Job", + "uri":"dli_02_0229.html", + "doc_type":"api", + "p_code":"52", + "code":"54" + }, + { + "desc":"This API is used to create custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPOST /v1.0/{project_id}/streaming/flink-jobsPOST /v1.", + "product_code":"dli", + "title":"Creating a Flink Jar job", + "uri":"dli_02_0230.html", + "doc_type":"api", + "p_code":"52", + "code":"55" + }, + { + "desc":"This API is used to update custom jobs, which currently support the JAR format and run in dedicated queues.URI formatPUT /v1.0/{project_id}/streaming/flink-jobs/{job_id}P", + "product_code":"dli", + "title":"Updating a Flink Jar Job", + "uri":"dli_02_0231.html", + "doc_type":"api", + "p_code":"52", + "code":"56" + }, + { + "desc":"This API is used to trigger batch job running.URI formatPOST /v1.0/{project_id}/streaming/jobs/runPOST /v1.0/{project_id}/streaming/jobs/runParameter descriptionURI param", + "product_code":"dli", + "title":"Running Jobs in Batches", + "uri":"dli_02_0233.html", + "doc_type":"api", + "p_code":"52", + "code":"57" + }, + { + "desc":"This API is used to list the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can also query jobs ", + "product_code":"dli", + "title":"Listing Jobs", + "uri":"dli_02_0234.html", + "doc_type":"api", + "p_code":"52", + "code":"58" + }, + { + "desc":"This API is used to query details of a job.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}GET /v1.0/{project_id}/streaming/jobs/{job_id}Parameter descriptionURI ", + "product_code":"dli", + "title":"Querying Job Details", + "uri":"dli_02_0235.html", + "doc_type":"api", + "p_code":"52", + "code":"59" + }, + { + "desc":"This API is used to query a job execution plan.URI formatGET /v1.0/{project_id}/streaming/jobs/{job_id}/execute-graphGET /v1.0/{project_id}/streaming/jobs/{job_id}/execut", + "product_code":"dli", + "title":"Querying the Job Execution Plan", + "uri":"dli_02_0236.html", + "doc_type":"api", + "p_code":"52", + "code":"60" + }, + { + "desc":"This API is used to stop running jobs in batches.URI formatPOST /v1.0/{project_id}/streaming/jobs/stopPOST /v1.0/{project_id}/streaming/jobs/stopParameter descriptionURI ", + "product_code":"dli", + "title":"Stopping Jobs in Batches", + "uri":"dli_02_0241.html", + "doc_type":"api", + "p_code":"52", + "code":"61" + }, + { + "desc":"This API is used to delete a Flink job at any state.The job records will not be deleted.URI formatDELETE /v1.0/{project_id}/streaming/jobs/{job_id}DELETE /v1.0/{project_i", + "product_code":"dli", + "title":"Deleting a Job", + "uri":"dli_02_0242.html", + "doc_type":"api", + "p_code":"52", + "code":"62" + }, + { + "desc":"This API is used to batch delete jobs at any state.URI formatPOST /v1.0/{project_id}/streaming/jobs/deletePOST /v1.0/{project_id}/streaming/jobs/deleteParameter descripti", + "product_code":"dli", + "title":"Deleting Jobs in Batches", + "uri":"dli_02_0243.html", + "doc_type":"api", + "p_code":"52", + "code":"63" + }, + { + "desc":"This API is used to export Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/exportPOST /v1.0/{project_id}/streaming/jobs/exportParameter descriptionURI par", + "product_code":"dli", + "title":"Exporting a Flink Job", + "uri":"dli_02_0254.html", + "doc_type":"api", + "p_code":"52", + "code":"64" + }, + { + "desc":"This API is used to import Flink job data.URI formatPOST /v1.0/{project_id}/streaming/jobs/importPOST /v1.0/{project_id}/streaming/jobs/importParameter descriptionURI par", + "product_code":"dli", + "title":"Importing a Flink Job", + "uri":"dli_02_0255.html", + "doc_type":"api", + "p_code":"52", + "code":"65" + }, + { + "desc":"This API is used to generate a static stream graph for a Flink SQL job.URI formatPOST /v3/{project_id}/streaming/jobs/{job_id}/gen-graphPOST /v3/{project_id}/streaming/jo", + "product_code":"dli", + "title":"Generating a Static Stream Graph for a Flink SQL Job", + "uri":"dli_02_0316.html", + "doc_type":"api", + "p_code":"52", + "code":"66" + }, + { + "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 Flink Job Templates", + "uri":"dli_02_0244.html", + "doc_type":"api", + "p_code":"", + "code":"67" + }, + { + "desc":"This API is used to create a user template for the DLI service. A maximum of 100 user templates can be created.URI formatPOST /v1.0/{project_id}/streaming/job-templatesPO", + "product_code":"dli", + "title":"Creating a Template", + "uri":"dli_02_0245.html", + "doc_type":"api", + "p_code":"67", + "code":"68" + }, + { + "desc":"This API is used to update existing templates in DLI.URI formatPUT /v1.0/{project_id}/streaming/job-templates/{template_id}PUT /v1.0/{project_id}/streaming/job-templates/", + "product_code":"dli", + "title":"Updating a Template", + "uri":"dli_02_0246.html", + "doc_type":"api", + "p_code":"67", + "code":"69" + }, + { + "desc":"This API is used to delete a template. A template used by jobs can also be deleted.URI formatDELETE /v1.0/{project_id}/streaming/job-templates/{template_id}DELETE /v1.0/{", + "product_code":"dli", + "title":"Deleting a Template", + "uri":"dli_02_0247.html", + "doc_type":"api", + "p_code":"67", + "code":"70" + }, + { + "desc":"This API is used to query the job template list. Currently, only custom templates can be queried.URI formatGET /v1.0/{project_id}/streaming/job-templatesGET /v1.0/{projec", + "product_code":"dli", + "title":"Querying the Template List", + "uri":"dli_02_0248.html", + "doc_type":"api", + "p_code":"67", + "code":"71" + }, + { + "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":"Spark Job-related APIs", + "uri":"dli_02_0109.html", + "doc_type":"api", + "p_code":"", + "code":"72" + }, + { + "desc":"This API is used to create a batch processing job in a queue.URI formatPOST /v2.0/{project_id}/batchesPOST /v2.0/{project_id}/batchesParameter descriptionURI parameterPar", + "product_code":"dli", + "title":"Creating a Batch Processing Job", + "uri":"dli_02_0124.html", + "doc_type":"api", + "p_code":"72", + "code":"73" + }, + { + "desc":"This API is used to obtain the list of batch processing jobs in a queue of a project.URI formatGET /v2.0/{project_id}/batchesGET /v2.0/{project_id}/batchesParameter descr", + "product_code":"dli", + "title":"Obtaining the List of Batch Processing Jobs", + "uri":"dli_02_0125.html", + "doc_type":"api", + "p_code":"72", + "code":"74" + }, + { + "desc":"This API is used to query details about a batch processing job based on the job ID.URI formatGET /v2.0/{project_id}/batches/{batch_id}GET /v2.0/{project_id}/batches/{batc", + "product_code":"dli", + "title":"Querying Batch Job Details", + "uri":"dli_02_0126.html", + "doc_type":"api", + "p_code":"72", + "code":"75" + }, + { + "desc":"This API is used to obtain the execution status of a batch processing job.URI formatGET /v2.0/{project_id}/batches/{batch_id}/stateGET /v2.0/{project_id}/batches/{batch_i", + "product_code":"dli", + "title":"Querying a Batch Job Status", + "uri":"dli_02_0127.html", + "doc_type":"api", + "p_code":"72", + "code":"76" + }, + { + "desc":"This API is used to cancel a batch processing job.Batch processing jobs in the Successful or Failed state cannot be canceled.URI formatDELETE /v2.0/{project_id}/batches/{", + "product_code":"dli", + "title":"Canceling a Batch Processing Job", + "uri":"dli_02_0129.html", + "doc_type":"api", + "p_code":"72", + "code":"77" }, { "desc":"This section describes fine-grained permissions management for your DLI. If your account does not need individual IAM users, then you may skip this section.By default, ne", @@ -987,8 +699,431 @@ "uri":"dli_02_0201.html", "doc_type":"api", "p_code":"", + "code":"78" + }, + { + "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":"Out-of-Date APIs", + "uri":"dli_02_0300.html", + "doc_type":"api", + "p_code":"", + "code":"79" + }, + { + "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":"Agency-related APIs (Discarded)", + "uri":"dli_02_0297.html", + "doc_type":"api", + "p_code":"79", + "code":"80" + }, + { + "desc":"This API is used to obtain the agency information of a DLI user.This API has been discarded and is not recommended.URI formatGET /v2/{project_id}/agencyGET /v2/{project_i", + "product_code":"dli", + "title":"Obtaining DLI Agency Information (Discarded)", + "uri":"dli_02_0298.html", + "doc_type":"api", + "p_code":"80", + "code":"81" + }, + { + "desc":"This API is used to create an agency for a DLI user.This API has been discarded and is not recommended.URI formatPOST /v2/{project_id}/agencyPOST /v2/{project_id}/agencyP", + "product_code":"dli", + "title":"Creating a DLI Agency (Discarded)", + "uri":"dli_02_0299.html", + "doc_type":"api", + "p_code":"80", + "code":"82" + }, + { + "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":"Package Group-related APIs (Discarded)", + "uri":"dli_02_0166.html", + "doc_type":"api", + "p_code":"79", + "code":"83" + }, + { + "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.This API has been discarded and is not re", + "product_code":"dli", + "title":"Uploading a Package Group (Discarded)", + "uri":"dli_02_0130.html", + "doc_type":"api", + "p_code":"83", + "code":"84" + }, + { + "desc":"This API is used to query all resources in a project, including groups.This API has been discarded and is not recommended.URI formatGET /v2.0/{project_id}/resourcesGET /v", + "product_code":"dli", + "title":"Listing Package Groups (Discarded)", + "uri":"dli_02_0168.html", + "doc_type":"api", + "p_code":"83", + "code":"85" + }, + { + "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.This API has ", + "product_code":"dli", + "title":"Uploading a JAR Package Group (Discarded)", + "uri":"dli_02_0169.html", + "doc_type":"api", + "p_code":"83", + "code":"86" + }, + { + "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 gr", + "product_code":"dli", + "title":"Uploading a PyFile Package Group (Discarded)", + "uri":"dli_02_0170.html", + "doc_type":"api", + "p_code":"83", + "code":"87" + }, + { + "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.This ", + "product_code":"dli", + "title":"Uploading a File Package Group (Discarded)", + "uri":"dli_02_0171.html", + "doc_type":"api", + "p_code":"83", + "code":"88" + }, + { + "desc":"This API is used to query resource information of a package group in a Project.This API has been discarded and is not recommended.URI formatGET /v2.0/{project_id}/resourc", + "product_code":"dli", + "title":"Querying Resource Packages in a Group (Discarded)", + "uri":"dli_02_0172.html", + "doc_type":"api", + "p_code":"83", + "code":"89" + }, + { + "desc":"This API is used to delete resource packages in a group in a Project.This API has been discarded and is not recommended.URI formatDELETE /v2.0/{project_id}/resources/{res", + "product_code":"dli", + "title":"Deleting a Resource Package from a Group (Discarded)", + "uri":"dli_02_0173.html", + "doc_type":"api", + "p_code":"83", + "code":"90" + }, + { + "desc":"This API is used to change the owner of a program package.This API has been discarded and is not recommended.URI formatPUT /v2.0/{project_id}/resources/ownerPUT /v2.0/{pr", + "product_code":"dli", + "title":"Changing the Owner of a Group or Resource Package (Discarded)", + "uri":"dli_02_0253.html", + "doc_type":"api", + "p_code":"83", + "code":"91" + }, + { + "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 Spark Batch Processing (Discarded)", + "uri":"dli_02_0359.html", + "doc_type":"api", + "p_code":"79", + "code":"92" + }, + { + "desc":"This API is used to query the back-end logs of batch processing jobs.This API has been discarded and is not recommended.URI formatGET /v2.0/{project_id}/batches/{batch_id", + "product_code":"dli", + "title":"Querying Batch Job Logs (Discarded)", + "uri":"dli_02_0128.html", + "doc_type":"api", + "p_code":"92", + "code":"93" + }, + { + "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":"SQL Job-related APIs (Discarded)", + "uri":"dli_02_0360.html", + "doc_type":"api", + "p_code":"79", + "code":"94" + }, + { + "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 has been discarded and is not r", + "product_code":"dli", + "title":"Importing Data (Discarded)", + "uri":"dli_02_0019.html", + "doc_type":"api", + "p_code":"94", + "code":"95" + }, + { + "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 (Discarded)", + "uri":"dli_02_0020.html", + "doc_type":"api", + "p_code":"94", + "code":"96" + }, + { + "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 (Discarded)", + "uri":"dli_02_0356.html", + "doc_type":"api", + "p_code":"79", + "code":"97" + }, + { + "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 (Discarded)", + "uri":"dli_02_0027.html", + "doc_type":"api", + "p_code":"97", + "code":"98" + }, + { + "desc":"This API is used to add a database.This API has been discarded and is not recommended.URI formatPOST /v1.0/{project_id}/databasesPOST /v1.0/{project_id}/databasesParamete", + "product_code":"dli", + "title":"Creating a Database (Discarded)", + "uri":"dli_02_0028.html", + "doc_type":"api", + "p_code":"98", + "code":"99" + }, + { + "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 (Discarded)", + "uri":"dli_02_0030.html", + "doc_type":"api", + "p_code":"98", + "code":"100" + }, + { + "desc":"This API is used to query the information about all the databases.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databasesGET /v1.0/{", + "product_code":"dli", + "title":"Querying All Databases (Discarded)", + "uri":"dli_02_0029.html", + "doc_type":"api", + "p_code":"98", + "code":"101" + }, + { + "desc":"This API is used to modify the owner of a database.This API has been discarded and is not recommended.URI formatPUT /v1.0/{project_id}/databases/{database_name}/ownerPUT ", + "product_code":"dli", + "title":"Modifying a Database Owner (Discarded)", + "uri":"dli_02_0164.html", + "doc_type":"api", + "p_code":"98", + "code":"102" + }, + { + "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 (Discarded)", + "uri":"dli_02_0031.html", + "doc_type":"api", + "p_code":"97", + "code":"103" + }, + { + "desc":"This API is used to create a table. This API is a synchronous API.This API has been discarded and is not recommended.URI formatPOST /v1.0/{project_id}/databases/{database", + "product_code":"dli", + "title":"Creating a Table (Discarded)", + "uri":"dli_02_0034.html", + "doc_type":"api", + "p_code":"103", + "code":"104" + }, + { + "desc":"This API is used to delete a specified table.This API has been discarded and is not recommended.URI formatDELETE /v1.0/{project_id}/databases/{database_name}/tables/{tabl", + "product_code":"dli", + "title":"Deleting a Table (Discarded)", + "uri":"dli_02_0035.html", + "doc_type":"api", + "p_code":"103", + "code":"105" + }, + { + "desc":"This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.This API has been discarded and is not rec", + "product_code":"dli", + "title":"Querying All Tables (Recommended)", + "uri":"dli_02_0105.html", + "doc_type":"api", + "p_code":"103", + "code":"106" + }, + { + "desc":"This API is used to describe metadata information in the specified table.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{da", + "product_code":"dli", + "title":"Describing Table Information (Discarded)", + "uri":"dli_02_0033.html", + "doc_type":"api", + "p_code":"103", + "code":"107" + }, + { + "desc":"This API is used to preview the first 10 rows in a table.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{database_name}/tab", + "product_code":"dli", + "title":"Previewing Table Content (Discarded)", + "uri":"dli_02_0108.html", + "doc_type":"api", + "p_code":"103", + "code":"108" + }, + { + "desc":"This API is used to list partitions.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}/part", + "product_code":"dli", + "title":"Listing Partitions (Discarded)", + "uri":"dli_02_0250.html", + "doc_type":"api", + "p_code":"103", + "code":"109" + }, + { + "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":"Permission-related APIs (Discarded)", + "uri":"dli_02_0065.html", + "doc_type":"api", + "p_code":"79", "code":"110" }, + { + "desc":"This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.This API has been", + "product_code":"dli", + "title":"Granting Queue Permissions to a User (Discarded)", + "uri":"dli_02_0037.html", + "doc_type":"api", + "p_code":"110", + "code":"111" + }, + { + "desc":"This API is used to query names of all users who can use a specified queue.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/queues/{que", + "product_code":"dli", + "title":"Querying Queue Users (Discarded)", + "uri":"dli_02_0038.html", + "doc_type":"api", + "p_code":"110", + "code":"112" + }, + { + "desc":"This API is used to grant database or table data usage permission to specified users.This API has been discarded and is not recommended.URI formatPUT /v1.0/{project_id}/u", + "product_code":"dli", + "title":"Granting Data Permission to Users (Discarded)", + "uri":"dli_02_0039.html", + "doc_type":"api", + "p_code":"110", + "code":"113" + }, + { + "desc":"This API is used query names of all users who have permission to use or access the database.This API has been discarded and is not recommended.URI formatGET /v1.0/{projec", + "product_code":"dli", + "title":"Querying Database Users (Discarded)", + "uri":"dli_02_0040.html", + "doc_type":"api", + "p_code":"110", + "code":"114" + }, + { + "desc":"This API is used to query users who have permission to access the specified table or column in the table.This API has been discarded and is not recommended.URI formatGET ", + "product_code":"dli", + "title":"Querying Table Users (Discarded)", + "uri":"dli_02_0041.html", + "doc_type":"api", + "p_code":"110", + "code":"115" + }, + { + "desc":"This API is used to query the permission of a specified user on a table.This API has been discarded and is not recommended.URI formatGET /v1.0/{project_id}/databases/{dat", + "product_code":"dli", + "title":"Querying a User's Table Permissions (Discarded)", + "uri":"dli_02_0042.html", + "doc_type":"api", + "p_code":"110", + "code":"116" + }, + { + "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":"Queue-related APIs (Discarded)", + "uri":"dli_02_0361.html", + "doc_type":"api", + "p_code":"79", + "code":"117" + }, + { + "desc":"This API is used to create a scheduled CU change, that is, to create a scheduled CU change for a specified queue.This API has been discarded and is not recommended.URI fo", + "product_code":"dli", + "title":"Creating a Scheduled CU Change (Discarded)", + "uri":"dli_02_0291.html", + "doc_type":"api", + "p_code":"117", + "code":"118" + }, + { + "desc":"This API is used to query the scheduled CU changes and list the changes of a specified queue.This API has been discarded and is not recommended.URI formatGET /v1/{project", + "product_code":"dli", + "title":"Viewing a Scheduled CU Change (Discarded)", + "uri":"dli_02_0292.html", + "doc_type":"api", + "p_code":"117", + "code":"119" + }, + { + "desc":"This API is used to delete scheduled CU changes in batches.This API has been discarded and is not recommended.URI formatPOST /v1/{project_id}/queues/{queue_name}/plans/ba", + "product_code":"dli", + "title":"Deleting Scheduled CU Changes in Batches (Discarded)", + "uri":"dli_02_0293.html", + "doc_type":"api", + "p_code":"117", + "code":"120" + }, + { + "desc":"This API is used to delete a scheduled CU change for a queue with a specified ID.This API has been discarded and is not recommended.URI formatDELETE /v1/{project_id}/queu", + "product_code":"dli", + "title":"Deleting a Scheduled CU Change (Discarded)", + "uri":"dli_02_0294.html", + "doc_type":"api", + "p_code":"117", + "code":"121" + }, + { + "desc":"This API is used to modify a scheduled CU change for a queue with a specified ID.This API has been discarded and is not recommended.URI formatPUT /v1/{project_id}/queues/", + "product_code":"dli", + "title":"Modifying a Scheduled CU Change (Discarded)", + "uri":"dli_02_0295.html", + "doc_type":"api", + "p_code":"117", + "code":"122" + }, + { + "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 Flink Jobs (Discarded)", + "uri":"dli_02_0333.html", + "doc_type":"api", + "p_code":"79", + "code":"123" + }, + { + "desc":"This API is used to query job monitoring information. You can query monitoring information about multiple jobs at the same time.This API has been discarded and is not rec", + "product_code":"dli", + "title":"Querying Job Monitoring Information (Discarded)", + "uri":"dli_02_0238.html", + "doc_type":"api", + "p_code":"123", + "code":"124" + }, + { + "desc":"This API is used to grant DLI the permission to access OBS buckets for saving job checkpoints and run logs.This API has been discarded and is not recommended.URI formatPO", + "product_code":"dli", + "title":"Granting OBS Permissions to DLI", + "uri":"dli_02_0225.html", + "doc_type":"api", + "p_code":"123", + "code":"125" + }, { "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", @@ -996,7 +1131,7 @@ "uri":"dli_02_0011.html", "doc_type":"api", "p_code":"", - "code":"111" + "code":"126" }, { "desc":"Table 1 describes status codes.", @@ -1004,8 +1139,8 @@ "title":"Status Codes", "uri":"dli_02_0012.html", "doc_type":"api", - "p_code":"111", - "code":"112" + "p_code":"126", + "code":"127" }, { "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", @@ -1013,8 +1148,8 @@ "title":"Error Codes", "uri":"dli_02_0056.html", "doc_type":"api", - "p_code":"111", - "code":"113" + "p_code":"126", + "code":"128" }, { "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.", @@ -1022,8 +1157,8 @@ "title":"Obtaining a Project ID", "uri":"dli_02_0183.html", "doc_type":"api", - "p_code":"111", - "code":"114" + "p_code":"126", + "code":"129" }, { "desc":"An account ID (domain-id) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:Log in to the management console.Hove", @@ -1031,8 +1166,8 @@ "title":"Obtaining an Account ID", "uri":"dli_02_0013.html", "doc_type":"api", - "p_code":"111", - "code":"115" + "p_code":"126", + "code":"130" }, { "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.", @@ -1041,6 +1176,6 @@ "uri":"dli_02_00003.html", "doc_type":"api", "p_code":"", - "code":"116" + "code":"131" } ] \ No newline at end of file diff --git a/docs/dli/api-ref/dli_02_00003.html b/docs/dli/api-ref/dli_02_00003.html index 9f98ace2..28437965 100644 --- a/docs/dli/api-ref/dli_02_00003.html +++ b/docs/dli/api-ref/dli_02_00003.html @@ -2,21 +2,30 @@

Change History

-
Table 1 Change history

Released On

+
- - - + + + - - diff --git a/docs/dli/api-ref/dli_02_0013.html b/docs/dli/api-ref/dli_02_0013.html index 4638b55b..10524a67 100644 --- a/docs/dli/api-ref/dli_02_0013.html +++ b/docs/dli/api-ref/dli_02_0013.html @@ -2,7 +2,7 @@

Obtaining an Account ID

An account ID (domain-id) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:

-
  1. Log in to the management console.
  2. Hover the cursor on the username in the upper right corner and select My Credentials from the drop-down list.
  3. On the API Credentials page, view Account ID.
+
  1. Log in to the management console.
  2. Hover the cursor on the username in the upper right corner and select My Credentials from the drop-down list.
  3. On the API Credentials page, view Account ID.
diff --git a/docs/dli/api-ref/dli_02_0019.html b/docs/dli/api-ref/dli_02_0019.html index 7fe82a55..23435de3 100644 --- a/docs/dli/api-ref/dli_02_0019.html +++ b/docs/dli/api-ref/dli_02_0019.html @@ -1,8 +1,8 @@ -

Importing Data

+

Importing Data (Discarded)

Function

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 data, you can select an existing OBS bucket path or create an OBS bucket path, but only one OBS bucket path can be specified.
  • If you need to create an OBS bucket, ensure that the bucket name complies with the following naming rules:
    • The name must be globally unique in OBS.
    • The name must contain 3 to 63 characters. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • The name cannot start or end with a period (.) or hyphen (-), and cannot contain two consecutive periods (.) or contain a period (.) and a hyphen (-) adjacent to each other.
    • The name cannot be an IP address.
    • If the name contains any period (.), the security certificate verification may be triggered when you access the bucket or objects in the bucket.
    +
    • This API has been discarded and is not recommended.
    • This API is asynchronous.
    • When importing data, you can select an existing OBS bucket path or create an OBS bucket path, but only one OBS bucket path can be specified.
    • If you need to create an OBS bucket, ensure that the bucket name complies with the following naming rules:
      • The name must be globally unique in OBS.
      • The name must contain 3 to 63 characters. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
      • The name cannot start or end with a period (.) or hyphen (-), and cannot contain two consecutive periods (.) or contain a period (.) and a hyphen (-) adjacent to each other.
      • The name cannot be an IP address.
      • If the name contains any period (.), the security certificate verification may be triggered when you access the bucket or objects in the bucket.
    • If the type of a column in the source file to be imported does not match that of the target table, the query result of the row will be null.
    • Two or more concurrent tasks of importing data to the same table are not allowed.
@@ -416,7 +416,7 @@
diff --git a/docs/dli/api-ref/dli_02_0020.html b/docs/dli/api-ref/dli_02_0020.html index 4d1b4472..9fea00db 100644 --- a/docs/dli/api-ref/dli_02_0020.html +++ b/docs/dli/api-ref/dli_02_0020.html @@ -1,8 +1,9 @@ -

Exporting Data

+

Exporting Data (Discarded)

Function

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 specified to the folder level. The OBS path cannot contain commas (,). The OBS bucket name cannot end with the regular expression format .[0-9]+(.*). Specifically, if the bucket name contains dots (.), the last dot (.) cannot be followed by a digit, for example, **.12abc and **.12.
  • Data can be exported across accounts. That is, after account B authorizes account A, account A can export data to the OBS path of account B if account A has the permission to read the metadata and permission information about the OBS bucket of account B and read and write the path.
+
  • This API is asynchronous.
  • Currently, data can be exported only from a DLI table to OBS, and the OBS path must be specified to the folder level. The OBS path cannot contain commas (,). The OBS bucket name cannot end with the regular expression format .[0-9]+(.*). Specifically, if the bucket name contains dots (.), the last dot (.) cannot be followed by a digit, for example, **.12abc and **.12.
  • Data can be exported across accounts. That is, after account B authorizes account A, account A can export data to the OBS path of account B if account A has the permission to read the metadata and permission information about the OBS bucket of account B and read and write the path.
+

This API has been discarded and is not recommended.

URI

  • URI format

    POST /v1.0/{project_id}/jobs/export-table

    @@ -113,7 +114,7 @@
@@ -222,7 +223,7 @@ diff --git a/docs/dli/api-ref/dli_02_0021.html b/docs/dli/api-ref/dli_02_0021.html index f394a3ec..e8234e44 100644 --- a/docs/dli/api-ref/dli_02_0021.html +++ b/docs/dli/api-ref/dli_02_0021.html @@ -42,186 +42,167 @@

Request

None

Response

-
Table 1 Change history

Released On

Description

+

What's New

2023-09-07

+

2024-04-28

This issue is the second official release.

+

This issue is the third official release.

+

Added the following API:

+ +

Taken offline the following APIs:

+ +

2023-09-07

+

This issue is the second official release.

2023-01-30

+

2023-01-30

This issue is the first official release.

+

This issue is the first official release.

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.
Table 2 Response parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + @@ -313,7 +294,7 @@
-
Parent topic: SQL 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 66a5c914..134ba615 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: SQL 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 90b52380..7c8effc0 100644 --- a/docs/dli/api-ref/dli_02_0024.html +++ b/docs/dli/api-ref/dli_02_0024.html @@ -2,8 +2,7 @@

Exporting Query Results

Function

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.
  • Currently, data can be exported only to OBS, and the OBS path must be specified to the folder level. The OBS path cannot contain commas (,). The OBS bucket name cannot end with the regular expression format ".[0-9]+(.*)". Specifically, if the bucket name contains dots (.), the last dot (.) cannot be followed by a digit, for example, "**.12abc" and "**.12".
-
+
  • This API is asynchronous.
  • Currently, data can be exported only to OBS, and the OBS path must be specified to the folder level. The OBS path cannot contain commas (,). The OBS bucket name cannot end with the regular expression format ".[0-9]+(.*)". Specifically, if the bucket name contains dots (.), the last dot (.) cannot be followed by a digit, for example, "**.12abc" and "**.12".

URI

  • URI format

    POST /v1.0/{project_id}/jobs/{job_id}/export-result

  • Parameter description @@ -104,7 +103,7 @@
Table 2 Response parameters

Parameter

Mandatory

+

Type

Type

-

Description

+

Description

is_success

+

is_success

Yes

+

Boolean

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.

message

+

message

Yes

+

String

String

-

System prompt. If execution succeeds, this parameter is left blank.

+

System prompt. If execution succeeds, this parameter is left blank.

job_id

+

job_id

Yes

+

String

String

-

Job ID. You can get the value by calling Submitting a SQL Job (Recommended).

+

Job ID. You can get the value by calling Submitting a SQL Job (Recommended).

job_type

+

job_type

Yes

+

String

String

-

Type of a job, Includes DDL, DCL, IMPORT, EXPORT, QUERY, INSERT, DATA_MIGRATION, UPDATE, DELETE, RESTART_QUEUE and SCALE_QUEUE.

+

Type of a job, Includes DDL, DCL, IMPORT, EXPORT, QUERY, INSERT, DATA_MIGRATION, UPDATE, DELETE, RESTART_QUEUE and SCALE_QUEUE.

job_mode

+

job_mode

Yes

+

String

String

-

Job execution mode. The options are as follows:

+

Job execution mode. The options are as follows:

  • async: asynchronous
  • sync: synchronous

queue_name

+

queue_name

Yes

+

String

String

-

Name of the queue where the job is submitted.

+

Name of the queue where the job is submitted.

owner

+

owner

Yes

+

String

String

-

User who submits a job.

+

User who submits a job.

start_time

+

start_time

Yes

+

Long

Long

-

Time when a job is started. The timestamp is in milliseconds.

+

Time when a job is started. The timestamp is in milliseconds.

duration

+

duration

No

+

Long

Long

-

Job running duration (unit: millisecond).

+

Job running duration (unit: millisecond).

status

+

status

Yes

+

String

String

-

Status of a job, including RUNNING, SCALING, LAUNCHING, FINISHED, FAILED, and CANCELLED.

+

Status of a job, including RUNNING, SCALING, LAUNCHING, FINISHED, FAILED, and CANCELLED.

input_row_count

+

input_row_count

No

+

Long

Long

-

Number of records scanned during the Insert job execution.

+

Number of records scanned during the Insert job execution.

bad_row_count

+

bad_row_count

No

+

Long

Long

-

Number of error records scanned during the Insert job execution.

+

Number of error records scanned during the Insert job execution.

input_size

+

input_size

Yes

+

Long

Long

-

Size of scanned files during job execution (unit: byte).

+

Size of scanned files during job execution (unit: byte).

result_count

+

result_count

Yes

+

Integer

Integer

-

Total number of records returned by the current job or total number of records inserted by the Insert job.

+

Total number of records returned by the current job or total number of records inserted by the Insert job.

database_name

+

database_name

No

+

String

String

-

Name of the database where the target table resides. database_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.

+

Name of the database where the target table resides. database_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.

table_name

+

table_name

No

+

String

String

-

Name of the target table. table_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.

+

Name of the target table. table_name is valid only for jobs of the IMPORT EXPORT, and QUERY types.

detail

+

detail

Yes

+

String

String

-

JSON string for information about related columns.

+

JSON string for information about related columns.

statement

+

statement

Yes

+

String

String

-

SQL statements of a job.

+

SQL statements of a job.

tags

+

tags

No

+

Array of objects

Array of objects

+

Job tags. For details, see Table 3.

Job tags. For details, see Table 3.

+

user_conf

+

String

+

JSON string of related columns queried using SQL statements.

+

result_format

+

String

+

Storage format of job results. Currently, only CSV is supported.

+

result_path

+

String

+

OBS path of job results.

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

@@ -230,7 +229,7 @@
-
Parent topic: SQL 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 a29a77ce..46ad2f86 100644 --- a/docs/dli/api-ref/dli_02_0025.html +++ b/docs/dli/api-ref/dli_02_0025.html @@ -5,7 +5,7 @@

URI

  • URI format

    GET /v1.0/{project_id}/jobs

  • Parameter description -
    Table 1 URI parameters

    Parameter

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

    Parameter

    Mandatory

    -
    Table 2 query parameter description

    Parameter

    +
    @@ -175,233 +175,233 @@

    Response

    Table 2 query parameter description

    Parameter

    Mandatory

    - - - - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    is_success

    Yes

    +

    Yes

    Boolean

    +

    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.

    message

    Yes

    +

    Yes

    String

    +

    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.

    job_count

    Yes

    +

    Yes

    Integer

    +

    Integer

    Indicates the total number of jobs.

    +

    Indicates the total number of jobs.

    jobs

    Yes

    +

    Yes

    Array of Objects

    +

    Array of objects

    Indicates the information about a job. For details, see Table 4.

    +

    Indicates the information about a job. For details, see Table 4.
    -
    Table 4 jobs parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -500,7 +500,7 @@
    -
    Parent topic: SQL 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 0896609c..d783fcb0 100644 --- a/docs/dli/api-ref/dli_02_0027.html +++ b/docs/dli/api-ref/dli_02_0027.html @@ -1,21 +1,21 @@ -

    Database-related APIs

    +

    Database-related APIs (Discarded)

    diff --git a/docs/dli/api-ref/dli_02_0028.html b/docs/dli/api-ref/dli_02_0028.html index c626e49f..110c040e 100644 --- a/docs/dli/api-ref/dli_02_0028.html +++ b/docs/dli/api-ref/dli_02_0028.html @@ -1,7 +1,9 @@ -

    Creating a Database

    +

    Creating a Database (Discarded)

    Function

    This API is used to add a database.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

      POST /v1.0/{project_id}/databases

    • Parameter description @@ -76,7 +78,7 @@
    - @@ -102,6 +104,8 @@ @@ -193,7 +199,7 @@ diff --git a/docs/dli/api-ref/dli_02_0029.html b/docs/dli/api-ref/dli_02_0029.html index ff4126ef..1198f3ba 100644 --- a/docs/dli/api-ref/dli_02_0029.html +++ b/docs/dli/api-ref/dli_02_0029.html @@ -1,7 +1,9 @@ -

    Querying All Databases

    +

    Querying All Databases (Discarded)

    Function

    This API is used to query the information about all the databases.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

      GET /v1.0/{project_id}/databases

    • Parameter description @@ -262,7 +264,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0030.html b/docs/dli/api-ref/dli_02_0030.html index 45c31979..c62f4598 100644 --- a/docs/dli/api-ref/dli_02_0030.html +++ b/docs/dli/api-ref/dli_02_0030.html @@ -1,7 +1,9 @@ -

    Deleting a Database

    -

    Function

    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, see Deleting a Table.

    +

    Deleting a Database (Discarded)

    +

    Function

    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, see Deleting a Table (Discarded).

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -62,7 +64,7 @@
    - @@ -187,7 +189,7 @@ diff --git a/docs/dli/api-ref/dli_02_0031.html b/docs/dli/api-ref/dli_02_0031.html index 4a9b4cdd..59c9a49d 100644 --- a/docs/dli/api-ref/dli_02_0031.html +++ b/docs/dli/api-ref/dli_02_0031.html @@ -1,29 +1,25 @@ -

    Table-related APIs

    +

    Table-related APIs (Discarded)

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

    Describing the Table Information

    +

    Describing Table Information (Discarded)

    Function

    This API is used to describe metadata information in the specified table.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -91,7 +93,7 @@
    - @@ -130,7 +132,7 @@ - @@ -346,7 +348,7 @@
    -
    Parent topic: Table-related APIs
    +
    Parent topic: Table-related APIs (Discarded)
    diff --git a/docs/dli/api-ref/dli_02_0034.html b/docs/dli/api-ref/dli_02_0034.html index 8df5a862..2d107e15 100644 --- a/docs/dli/api-ref/dli_02_0034.html +++ b/docs/dli/api-ref/dli_02_0034.html @@ -1,8 +1,8 @@ -

    Creating a Table

    -

    Function

    This API is used to create a table.

    -

    This API is a synchronous API.

    +

    Creating a Table (Discarded)

    +

    Function

    This API is used to create a table. This API is a synchronous API.

    +

    This API has been discarded and is not recommended.

    URI

    • URI format

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

      @@ -179,7 +179,7 @@
    - @@ -188,82 +188,86 @@
    Table 4 jobs parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    job_id

    +

    job_id

    Yes

    +

    Yes

    String

    +

    String

    Job ID.

    +

    Job ID.

    job_type

    +

    job_type

    Yes

    +

    Yes

    String

    +

    String

    Type of a job.

    +

    Type of a job.

    queue_name

    +

    queue_name

    Yes

    +

    Yes

    String

    +

    String

    Queue to which a job is submitted.

    +

    Queue to which a job is submitted.

    owner

    +

    owner

    Yes

    +

    Yes

    String

    +

    String

    User who submits a job.

    +

    User who submits a job.

    start_time

    +

    start_time

    Yes

    +

    Yes

    Long

    +

    Long

    Time when a job is started. The timestamp is expressed in milliseconds.

    +

    Time when a job is started. The timestamp is expressed in milliseconds.

    duration

    +

    duration

    Yes

    +

    Yes

    Long

    +

    Long

    Job running duration (unit: millisecond).

    +

    Job running duration (unit: millisecond).

    status

    +

    status

    Yes

    +

    Yes

    String

    +

    String

    Status of a job, including LAUNCHING, RUNNING, FINISHED, FAILED, and CANCELLED.

    +

    Status of a job, including LAUNCHING, RUNNING, FINISHED, FAILED, and CANCELLED.

    input_row_count

    +

    input_row_count

    No

    +

    No

    Long

    +

    Long

    Number of records scanned during the Insert job execution.

    +

    Number of records scanned during the Insert job execution.

    bad_row_count

    +

    bad_row_count

    No

    +

    No

    Long

    +

    Long

    Number of error records scanned during the Insert job execution.

    +

    Number of error records scanned during the Insert job execution.

    input_size

    +

    input_size

    Yes

    +

    Yes

    Long

    +

    Long

    Size of scanned files during job execution.

    +

    Size of scanned files during job execution.

    result_count

    +

    result_count

    Yes

    +

    Yes

    Integer

    +

    Integer

    Total number of records returned by the current job or total number of records inserted by the Insert job.

    +

    Total number of records returned by the current job or total number of records inserted by the Insert job.

    database_name

    +

    database_name

    No

    +

    No

    String

    +

    String

    Name of the database where the target table resides. database_name is valid only for jobs of the Import and Export types.

    +

    Name of the database where the target table resides. database_name is valid only for jobs of the Import and Export types.

    table_name

    +

    table_name

    No

    +

    No

    String

    +

    String

    Name of the target table. table_name is valid only for jobs of the Import and Export types.

    +

    Name of the target table. table_name is valid only for jobs of the Import and Export types.

    with_column_header

    +

    with_column_header

    No

    +

    No

    Boolean

    +

    Boolean

    Import jobs, which record whether the imported data contains column names.

    +

    Import jobs, which record whether the imported data contains column names.

    detail

    +

    detail

    Yes

    +

    Yes

    String

    +

    String

    JSON string of related columns queried using SQL statements.

    +

    JSON string of related columns queried using SQL statements.

    statement

    +

    statement

    Yes

    +

    Yes

    String

    +

    String

    SQL statements of a job.

    +

    SQL statements of a job.

    message

    +

    message

    No

    +

    No

    String

    +

    String

    System prompt

    +

    System prompt.

    end_time

    +

    end_time

    No

    +

    No

    Long

    +

    Long

    Job end time. The timestamp is in milliseconds.

    +

    Job end time. The timestamp is in milliseconds.

    tags

    +

    tags

    No

    +

    No

    Array of Objects

    +

    Array of objects

    Job tags. For details, see Table 5.

    +

    Job tags. For details, see Table 5.

    No

    Array of Objects

    +

    Array of objects

    Database tag. For details, see Table 3.

    String

    Tag key.

    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    @@ -111,6 +115,8 @@

    String

    Tag key.

    +
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

    +

    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.

    Yes

    Array of Objects

    +

    Array of objects

    Column information, including the column name, type, and description. For details, see Table 3.

    No

    Array of Objects

    +

    Array of objects

    Storage attribute, which is in the format of key/value and includes parameters delimiter, escape, quote, header, dateformat, and timestampformat.

    No

    Array of Objects

    +

    Array of objects

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

    -
    Table 3 tags parameters

    Parameter

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

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    Yes

    +

    Yes

    String

    +

    String

    Tag key

    +

    Tag key

    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    +

    value

    Yes

    +

    Yes

    String

    +

    String

    Tag value

    +

    Tag value

    +
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

    +
    -
    - - - @@ -89,9 +93,9 @@ - - @@ -100,9 +104,9 @@ - - @@ -207,7 +211,7 @@ diff --git a/docs/dli/api-ref/dli_02_0040.html b/docs/dli/api-ref/dli_02_0040.html index d7ab0387..7d191e29 100644 --- a/docs/dli/api-ref/dli_02_0040.html +++ b/docs/dli/api-ref/dli_02_0040.html @@ -1,7 +1,9 @@ -

    Querying Database Users

    +

    Querying Database Users (Discarded)

    Function

    This API is used query names of all users who have permission to use or access the database.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -162,7 +164,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0041.html b/docs/dli/api-ref/dli_02_0041.html index 9ca78901..834b7a62 100644 --- a/docs/dli/api-ref/dli_02_0041.html +++ b/docs/dli/api-ref/dli_02_0041.html @@ -1,7 +1,9 @@ -

    Querying Table Users

    +

    Querying Table Users (Discarded)

    Function

    This API is used to query users who have permission to access the specified table or column in the table.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -164,7 +166,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0042.html b/docs/dli/api-ref/dli_02_0042.html index afd6e6cc..55c430f2 100644 --- a/docs/dli/api-ref/dli_02_0042.html +++ b/docs/dli/api-ref/dli_02_0042.html @@ -1,7 +1,9 @@ -

    Querying a User's Table Permissions

    +

    Querying a User's Table Permissions (Discarded)

    Function

    This API is used to query the permission of a specified user on a table.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -197,7 +199,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0065.html b/docs/dli/api-ref/dli_02_0065.html new file mode 100644 index 00000000..73cf1871 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0065.html @@ -0,0 +1,25 @@ + + +

    Permission-related APIs (Discarded)

    +
    + + diff --git a/docs/dli/api-ref/dli_02_0102.html b/docs/dli/api-ref/dli_02_0102.html index 56fec221..4ec20f28 100644 --- a/docs/dli/api-ref/dli_02_0102.html +++ b/docs/dli/api-ref/dli_02_0102.html @@ -2,7 +2,7 @@

    Submitting a SQL Job (Recommended)

    Function

    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 described in Importing Data. The difference lies in the implementation method.

    +

    The job types support DDL, DCL, IMPORT, QUERY, and INSERT. The IMPORT function is the same as that described in Importing Data (Discarded). The difference lies in the implementation method.

    Additionally, you can use other APIs to query and manage jobs. For details, see the following sections:

    This API is synchronous if job_type in the response message is DCL.

    @@ -85,80 +85,89 @@
    - + + + + +
    Table 4 columns parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - @@ -334,8 +338,36 @@ }

    The values of date_format and timestamp_format must be the same as the time format in the imported CSV file.

    +
  • Create a table whose data_location is DLI.
    {
+  "table_name": "tb2", 
+  "data_location": "DLI", 
+  "columns": [
+    {
+      "column_name": "column1", 
+      "type": "string", 
+      "description": "", 
+      "is_partition_column": true
+    }, 
+    {
+      "column_name": "column2", 
+      "type": "string", 
+      "description": "", 
+      "is_partition_column": false
+    }
+  ], 
+  "tags": [
+    {
+      "key": "quarterly", 
+      "value": "Q3"
+    }, 
+    {
+      "key": "author", 
+      "value": "user"
+    }
+  ]
+}
  • Create a table whose data_location is VIEW.
    {
-  "table_name": "view1",
+  "table_name": "tb3",
   "data_location": "VIEW",
   "columns": [
   {
@@ -392,7 +424,7 @@
 
 
    
 
    
-
    Parent topic: Table-related APIs
    
+
    Parent topic: Table-related APIs (Discarded)
    
 
    
 
    
 
diff --git a/docs/dli/api-ref/dli_02_0035.html b/docs/dli/api-ref/dli_02_0035.html
index ff73f7c8..b8b94450 100644
--- a/docs/dli/api-ref/dli_02_0035.html
+++ b/docs/dli/api-ref/dli_02_0035.html
@@ -1,7 +1,9 @@
 
 
-
    Deleting a Table
    
+
    Deleting a Table (Discarded)
    
 
    Function
    This API is used to delete a specified table.
    
+
     
    This API has been discarded and is not recommended.
    
+
    
 
    
 
    URI
    • URI format
      DELETE /v1.0/{project_id}/databases/{database_name}/tables/{table_name}
      
 
    • Parameter description
@@ -157,7 +159,7 @@
 
    
 
    
 
    
-
    Parent topic: Table-related APIs
    
+
    Parent topic: Table-related APIs (Discarded)
    
 
    
 
    
 
diff --git a/docs/dli/api-ref/dli_02_0036.html b/docs/dli/api-ref/dli_02_0036.html
index 43f1a6cd..24fed3a9 100644
--- a/docs/dli/api-ref/dli_02_0036.html
+++ b/docs/dli/api-ref/dli_02_0036.html
@@ -1,21 +1,13 @@
 
 
-
    Permission-related APIs
    
-
    
+
+  
    Permission-related APIs
    
+
+  
    
+
    
+
 
    
 
diff --git a/docs/dli/api-ref/dli_02_0037.html b/docs/dli/api-ref/dli_02_0037.html
index 30c50e5f..e14da8fa 100644
--- a/docs/dli/api-ref/dli_02_0037.html
+++ b/docs/dli/api-ref/dli_02_0037.html
@@ -1,7 +1,11 @@
 
 
-
    Granting Users with the Queue Usage Permission
    
+
    Granting Queue Permissions to a User (Discarded)
    
 
    Function
    This API is used to share a specific queue with other users. You can grant users with the permission to use the specified queue or revoke the permission.
    
+
    
+
    
+
     
    This API has been discarded and is not recommended.
    
+
    
 
    
 
    URI
    • URI format
      PUT /v1.0/{project_id}/queues/user-authorization
      
 
    • Parameter description
@@ -162,7 +166,7 @@
 
    
 
 
diff --git a/docs/dli/api-ref/dli_02_0038.html b/docs/dli/api-ref/dli_02_0038.html
index ea75ae80..8ea3085a 100644
--- a/docs/dli/api-ref/dli_02_0038.html
+++ b/docs/dli/api-ref/dli_02_0038.html
@@ -1,7 +1,9 @@
 
 
-
    Querying Queue Users
    
+
    Querying Queue Users (Discarded)
    
 
    Function
    This API is used to query names of all users who can use a specified queue.
    
+
     
    This API has been discarded and is not recommended.
    
+
    
 
    
 
    URI
    • URI format
      GET /v1.0/{project_id}/queues/{queue_name}/users
      
 
    • Parameter description
@@ -120,6 +122,15 @@
 
      For details, see Table 4.
    • + + + + +
    Table 4 columns parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    column_name

    +

    column_name

    Yes

    +

    Yes

    String

    +

    String

    Name of a column.

    +

    Name of a column.

    type

    +

    type

    Yes

    +

    Yes

    String

    +

    String

    Data type of a column.

    +

    Data type of a column.

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Description of a column.

    +

    Description of a column.

    is_partition_column

    +

    is_partition_column

    No

    +

    No

    Boolean

    +

    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.

    +

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

    count

    +

    No

    +

    Long

    +

    Total number of users

    +
    @@ -170,6 +181,7 @@

    Example Response

    {
   "is_success": true,
   "message": "",
+  "count": 2,
   "privileges": [
     {
       "is_admin": true,
@@ -221,7 +233,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0039.html b/docs/dli/api-ref/dli_02_0039.html index e8ace9fa..f91007af 100644 --- a/docs/dli/api-ref/dli_02_0039.html +++ b/docs/dli/api-ref/dli_02_0039.html @@ -1,7 +1,11 @@ -

    Granting Data Permission to Users

    +

    Granting Data Permission to Users (Discarded)

    Function

    This API is used to grant database or table data usage permission to specified users.

    +

    +

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -65,7 +69,7 @@

    Yes

    Array of Objects

    +

    Array of objects

    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"]

    @@ -79,9 +83,9 @@

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    Yes

    String

    +

    String

    Data objects to be assigned. If they are named:

    +

    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.

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

    Yes

    Array of Strings

    +

    Array of Strings

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

    +

    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.

    No

    Array of Objects

    +

    Array of objects

    Label of a job. For details, see Table 4.

    engine_type

    +

    No

    +

    String

    +

    The default value is spark.

    +
    - - - - - - - - - - - - - - - - - - @@ -181,7 +190,9 @@ - - @@ -249,7 +261,7 @@ - @@ -260,7 +272,8 @@ -
    Table 3 Configuration parameters description

    Parameter

    Default Value

    +

    Default Value

    Description

    +

    Description

    spark.sql.files.maxRecordsPerFile

    0

    +

    0

    Maximum number of records to be written into a single file. If the value is zero or negative, there is no limit.

    +

    Maximum number of records to be written into a single file. If the value is zero or negative, there is no limit.

    spark.sql.autoBroadcastJoinThreshold

    209715200

    +

    209715200

    Maximum size of the table that displays all working nodes when a connection is executed. You can set this parameter to -1 to disable the display.

    +

    Maximum size of the table that displays all working nodes when a connection is executed. You can set this parameter to -1 to disable the display.

    NOTE:

    Currently, only the configuration unit metastore table that runs the ANALYZE TABLE COMPUTE statistics noscan command and the file-based data source table that directly calculates statistics based on data files are supported.

    spark.sql.shuffle.partitions

    200

    +

    200

    Default number of partitions used to filter data for join or aggregation.

    +

    Default number of partitions used to filter data for join or aggregation.

    spark.sql.dynamicPartitionOverwrite.enabled

    false

    +

    false

    Whether DLI overwrites the partitions where data will be written into during runtime. If you set this parameter to false, all partitions that meet the specified condition will be deleted before data overwrite starts. For example, if you set false and use INSERT OVERWRITE to write partition 2021-02 to a partitioned table that has the 2021-01 partition, this partition will be deleted.

    +

    Whether DLI overwrites the partitions where data will be written into during runtime. If you set this parameter to false, all partitions that meet the specified condition will be deleted before data overwrite starts. For example, if you set false and use INSERT OVERWRITE to write partition 2021-02 to a partitioned table that has the 2021-01 partition, this partition will be deleted.

    If you set this parameter to true, DLI does not delete partitions before overwrite starts.

    spark.sql.files.maxPartitionBytes

    134217728

    +

    134217728

    Maximum number of bytes to be packed into a single partition when a file is read.

    +

    Maximum number of bytes to be packed into a single partition when a file is read.

    spark.sql.badRecordsPath

    -

    +

    -

    Path of bad records.

    +

    Path of bad records.

    dli.sql.sqlasync.enabled

    false

    +

    true

    Indicates whether DDL and DCL statements are executed asynchronously. The value true indicates that asynchronous execution is enabled.

    +

    Indicates whether DDL and DCL statements are executed asynchronously. The value true indicates that asynchronous execution is enabled.

    dli.sql.job.timeout

    -

    +

    -

    Sets the job running timeout interval. If the timeout interval expires, the job is canceled. Unit: second

    +

    Sets the job running timeout interval. If the timeout interval expires, the job is canceled. Unit: second

    String

    Tag key.

    +

    Tag key

    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    @@ -190,7 +201,8 @@

    String

    Tag value

    +
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

    +

    No

    Array of objects

    +

    Array of Map

    If the statement type is DDL, the column name and type of DDL are displayed.

    Array of objects

    When the statement type is DDL, results of the DDL are displayed.

    +

    When the statement type is DDL and dli.sql.sqlasync.enabled is set to false, the execution results are returned directly. However, only a maximum of 1,000 rows can be returned.

    +

    If there are more than 1,000 rows, obtain the results asynchronously. That is, when submitting the job, set xxxx to true, and then obtain the results from the job bucket configured by DLI. The path of the results on the job bucket can be obtained from the result_path in the return value of the ShowSqlJobStatus API. The full data of the results will be automatically exported to the job bucket.

    job_mode

    @@ -360,7 +373,7 @@
    -
    Parent topic: SQL 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 97796947..073adc1c 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: SQL Job related APIs
    +
    Parent topic: SQL Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0105.html b/docs/dli/api-ref/dli_02_0105.html index ffa4b327..cb8bd638 100644 --- a/docs/dli/api-ref/dli_02_0105.html +++ b/docs/dli/api-ref/dli_02_0105.html @@ -2,6 +2,8 @@

    Querying All Tables (Recommended)

    Function

    This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -37,88 +39,88 @@
    -
    Table 2 query parameter description

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -173,7 +175,7 @@ - @@ -182,127 +184,127 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    keyword

    +

    keyword

    No

    +

    No

    String

    +

    String

    Keywords used to filter table names.

    +

    Keywords used to filter table names.

    with-detail

    +

    with-detail

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to obtain detailed information about tables (such as owner and size). The default value is false.

    +

    Whether to obtain detailed information about tables (such as owner and size). The default value is false.

    page-size

    +

    page-size

    No

    +

    No

    Integer

    +

    Integer

    Paging size. The minimum value is 1 and the maximum value is 100.

    +

    Paging size. The minimum value is 1 and the maximum value is 100.

    current-page

    +

    current-page

    No

    +

    No

    Integer

    +

    Integer

    Current page number. The minimum value is 1.

    +

    Current page number. The minimum value is 1.

    with-priv

    +

    with-priv

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to return permission information.

    +

    Whether to return permission information.

    table-type

    +

    table-type

    No

    +

    No

    String

    +

    String

    Database table type. The options are as follows:

    +

    Database table type. The options are as follows:

    • MANAGED_TABLE: DLI table
    • EXTERNAL_TABLE: OBS table
    • VIRTUAL_VIEW: view

    datasource-type

    +

    datasource-type

    No

    +

    No

    String

    +

    String

    Data source type. The options are as follows:

    -
    • CloudTable
    • CSS
    • DLI
    • DWS
    • Geomesa
    • HBase
    • JDBC
    • Mongo
    • OBS
    • ODPS
    • OpenTSDB
    • Redis
    • RDS
    +

    Data source type. The options are as follows:

    +
    • CloudTable
    • CSS
    • DLI
    • GaussDB(DWS)
    • Geomesa
    • HBase
    • JDBC
    • Mongo
    • OBS
    • ODPS
    • OpenTSDB
    • Redis
    • RDS

    without-tablemeta

    +

    without-tablemeta

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to obtain the metadata of a table. The default value is false. If this parameter is set to true, the response speed can be greatly improved.

    +

    Whether to obtain the metadata of a table. The default value is false. If this parameter is set to true, the response speed can be greatly improved.

    Yes

    Array of Objects

    +

    Array of objects

    Table information. For details, see Table 4.

    -
    Table 4 tables parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -364,7 +366,7 @@
    -
    Parent topic: Table-related APIs
    +
    Parent topic: Table-related APIs (Discarded)
    diff --git a/docs/dli/api-ref/dli_02_0107.html b/docs/dli/api-ref/dli_02_0107.html index 48a93a65..5f715845 100644 --- a/docs/dli/api-ref/dli_02_0107.html +++ b/docs/dli/api-ref/dli_02_0107.html @@ -150,7 +150,7 @@
    -
    Parent topic: SQL Job related APIs
    +
    Parent topic: SQL Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0108.html b/docs/dli/api-ref/dli_02_0108.html index dd12d441..b1996cfd 100644 --- a/docs/dli/api-ref/dli_02_0108.html +++ b/docs/dli/api-ref/dli_02_0108.html @@ -1,7 +1,9 @@ -

    Previewing Table Content

    +

    Previewing Table Content (Discarded)

    Function

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

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -108,7 +110,7 @@
    - @@ -191,7 +193,7 @@
    -
    Parent topic: Table-related APIs
    +
    Parent topic: Table-related APIs (Discarded)
    diff --git a/docs/dli/api-ref/dli_02_0109.html b/docs/dli/api-ref/dli_02_0109.html index 4bc8c982..6ce48d20 100644 --- a/docs/dli/api-ref/dli_02_0109.html +++ b/docs/dli/api-ref/dli_02_0109.html @@ -1,10 +1,18 @@ -

    APIs Related to Spark jobs

    +

    Spark Job-related APIs

    diff --git a/docs/dli/api-ref/dli_02_0124.html b/docs/dli/api-ref/dli_02_0124.html index d57de124..3dc5e2a6 100644 --- a/docs/dli/api-ref/dli_02_0124.html +++ b/docs/dli/api-ref/dli_02_0124.html @@ -131,7 +131,7 @@ - @@ -140,7 +140,7 @@ - @@ -149,7 +149,7 @@ - @@ -214,7 +214,7 @@ - - @@ -387,7 +387,7 @@

    Response

    -
    Table 4 tables parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    create_time

    +

    create_time

    Yes

    +

    Yes

    Long

    +

    Long

    Time when a table is created. The timestamp is expressed in milliseconds.

    +

    Time when a table is created. The timestamp is expressed in milliseconds.

    data_type

    +

    data_type

    No

    +

    No

    String

    +

    String

    Type of the data to be added to the OBS table. The options are as follows: Parquet, ORC, CSV, JSON, and Avro.

    +

    Type of the data to be added to the OBS table. The options are as follows: Parquet, ORC, CSV, JSON, and Avro.

    NOTE:

    This parameter is available only for OBS tables.

    data_location

    +

    data_location

    Yes

    +

    Yes

    String

    +

    String

    Data storage location, which can be DLI or OBS.

    +

    Data storage location, which can be DLI or OBS.

    last_access_time

    +

    last_access_time

    Yes

    +

    Yes

    Long

    +

    Long

    Time when the table was last updated. The timestamp is expressed in milliseconds.

    +

    Time when the table was last updated. The timestamp is expressed in milliseconds.

    location

    +

    location

    No

    +

    No

    String

    +

    String

    Storage path on the OBS table.

    +

    Storage path on the OBS table.

    NOTE:

    This parameter is available only for OBS tables.

    owner

    +

    owner

    Yes

    +

    Yes

    String

    +

    String

    Table owner.

    +

    Table owner.

    table_name

    +

    table_name

    Yes

    +

    Yes

    String

    +

    String

    Name of a table.

    +

    Name of a table.

    table_size

    +

    table_size

    Yes

    +

    Yes

    Long

    +

    Long

    Size of a DLI table. Set parameter to 0 for non-DLI tables. The unit is byte.

    +

    Size of a DLI table. Set parameter to 0 for non-DLI tables. The unit is byte.

    table_type

    +

    table_type

    Yes

    +

    Yes

    String

    +

    String

    Type of a table.

    +

    Type of a table.

    • EXTERNAL: Indicates an OBS table.
    • MANAGED: Indicates a DLI table.
    • VIEW: Indicates a view.

    partition_columns

    +

    partition_columns

    No

    +

    No

    String

    +

    Array of Strings

    Partition field. This parameter is valid only for OBS partition tables.

    +

    Partition field. This parameter is valid only for OBS partition tables.

    page-size

    +

    page-size

    No

    +

    No

    Integer

    +

    Integer

    Paging size. The minimum value is 1 and the maximum value is 100.

    +

    Paging size. The minimum value is 1 and the maximum value is 100.

    current-page

    +

    current-page

    No

    +

    No

    Integer

    +

    Integer

    Current page number. The minimum value is 1.

    +

    Current page number. The minimum value is 1.

    No

    Array of objects

    +

    Array of Map

    Column name and type of a table.

    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.

    +

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

    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

    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.

    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.

    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

    @@ -377,7 +377,7 @@

    No

    Array of Objects

    +

    Array of objects

    User group resource For details, see Table 4.
    Table 6 Response parameters

    Parameter

    +
    @@ -494,7 +494,7 @@ @@ -594,7 +594,7 @@ } -

    The batchTest/spark-examples_2.11-2.1.0.luxor.jar file has been uploaded through API involved in Uploading a Package Group.

    +

    The batchTest/spark-examples_2.11-2.1.0.luxor.jar file has been uploaded through API involved in Uploading a Package Group (Discarded).

    Example Response

    {
@@ -645,7 +645,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0125.html b/docs/dli/api-ref/dli_02_0125.html index f77030b9..d8eec8ef 100644 --- a/docs/dli/api-ref/dli_02_0125.html +++ b/docs/dli/api-ref/dli_02_0125.html @@ -47,7 +47,7 @@
    - @@ -152,7 +152,7 @@ -
    Table 6 Response parameters

    Parameter

    Mandatory

    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.

    Name of a batch processing job.

    job_id

    +

    job-id

    No

    Array of objects

    Batch job information. For details, see Table 6 in Creating a Batch Processing Job.

    +

    Batch job information. For details, see Table 4.

    create_time

    @@ -168,7 +168,7 @@
    -
    - @@ -109,6 +111,8 @@ - @@ -195,7 +200,7 @@ - - @@ -370,7 +375,7 @@ diff --git a/docs/dli/api-ref/dli_02_0158.html b/docs/dli/api-ref/dli_02_0158.html index b8ae9129..9ba7aaf1 100644 --- a/docs/dli/api-ref/dli_02_0158.html +++ b/docs/dli/api-ref/dli_02_0158.html @@ -1,7 +1,7 @@ -

    SQL Job related APIs

    +

    SQL Job-related APIs

    @@ -16,14 +16,14 @@
  • Previewing SQL Job Query Results
    • +
  • Exporting Query Results
    +
  • Querying Job Status
  • Querying Job Details
  • Checking SQL Syntax
    • -
  • Exporting Query Results
    -
  • Querying the Job Execution Progress
    • diff --git a/docs/dli/api-ref/dli_02_0162.html b/docs/dli/api-ref/dli_02_0162.html deleted file mode 100644 index 85a7b245..00000000 --- a/docs/dli/api-ref/dli_02_0162.html +++ /dev/null @@ -1,25 +0,0 @@ - - -

    Batch Processing-related APIs

    -
    - - diff --git a/docs/dli/api-ref/dli_02_0164.html b/docs/dli/api-ref/dli_02_0164.html index 253c5783..5cf77e6e 100644 --- a/docs/dli/api-ref/dli_02_0164.html +++ b/docs/dli/api-ref/dli_02_0164.html @@ -1,7 +1,9 @@ -

    Modifying a Database Owner

    +

    Modifying a Database Owner (Discarded)

    Function

    This API is used to modify the owner of a database.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

      PUT /v1.0/{project_id}/databases/{database_name}/owner

    • Parameter description @@ -137,7 +139,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0166.html b/docs/dli/api-ref/dli_02_0166.html index 4bb31609..6e214dd3 100644 --- a/docs/dli/api-ref/dli_02_0166.html +++ b/docs/dli/api-ref/dli_02_0166.html @@ -1,29 +1,29 @@ -

    Package Group-related APIs

    +

    Package Group-related APIs (Discarded)

    diff --git a/docs/dli/api-ref/dli_02_0168.html b/docs/dli/api-ref/dli_02_0168.html index 8d9e2a64..60571063 100644 --- a/docs/dli/api-ref/dli_02_0168.html +++ b/docs/dli/api-ref/dli_02_0168.html @@ -1,7 +1,9 @@ -

    Querying Package Group List

    +

    Listing Package Groups (Discarded)

    Function

    This API is used to query all resources in a project, including groups.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

      GET /v2.0/{project_id}/resources

    • Parameter description @@ -79,7 +81,7 @@
    - @@ -88,7 +90,7 @@ - @@ -97,7 +99,7 @@ - @@ -359,7 +361,7 @@ diff --git a/docs/dli/api-ref/dli_02_0169.html b/docs/dli/api-ref/dli_02_0169.html index 7afd3133..2336a433 100644 --- a/docs/dli/api-ref/dli_02_0169.html +++ b/docs/dli/api-ref/dli_02_0169.html @@ -1,8 +1,9 @@ -

    Uploading a JAR Package Group

    +

    Uploading a JAR Package Group (Discarded)

    Function

    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.

    +

    When a resource group with the same name is uploaded, the new group overwrites the old group.

    +

    This API has been discarded and is not recommended.

    URI

    • URI format

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

      @@ -317,7 +318,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0170.html b/docs/dli/api-ref/dli_02_0170.html index 10be1b19..2f630d31 100644 --- a/docs/dli/api-ref/dli_02_0170.html +++ b/docs/dli/api-ref/dli_02_0170.html @@ -1,8 +1,8 @@ -

    Uploading a PyFile Package Group

    -

    Function

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

    +

    Uploading a PyFile Package Group (Discarded)

    +

    Function

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

    +

    This API has been discarded and is not recommended.

    URI

    • URI format

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

      @@ -317,7 +317,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0171.html b/docs/dli/api-ref/dli_02_0171.html index ca1b708e..949786b0 100644 --- a/docs/dli/api-ref/dli_02_0171.html +++ b/docs/dli/api-ref/dli_02_0171.html @@ -1,8 +1,8 @@ -

    Uploading a File Package Group

    -

    Function

    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.

    +

    Uploading a File Package Group (Discarded)

    +

    Function

    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.

    +

    This API has been discarded and is not recommended.

    URI

    • URI format

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

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

    Querying Resource Packages in a Group

    +

    Querying Resource Packages in a Group (Discarded)

    Function

    This API is used to query resource information of a package group in a Project.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -171,7 +173,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0173.html b/docs/dli/api-ref/dli_02_0173.html index 66fc22ed..9426a0cb 100644 --- a/docs/dli/api-ref/dli_02_0173.html +++ b/docs/dli/api-ref/dli_02_0173.html @@ -1,7 +1,9 @@ -

    Deleting a Resource Package from a Group

    +

    Deleting a Resource Package from a Group (Discarded)

    Function

    This API is used to delete resource packages in a group in a Project.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

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

    • Parameter description @@ -99,7 +101,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0181.html b/docs/dli/api-ref/dli_02_0181.html index f3ddc9c5..9f815eda 100644 --- a/docs/dli/api-ref/dli_02_0181.html +++ b/docs/dli/api-ref/dli_02_0181.html @@ -3,93 +3,55 @@

    Overview

    This section describes the APIs provided by DLI.

    -
    Table 4 sessions parameters

    Parameter

    +
    @@ -305,6 +305,15 @@

    This parameter is valid only when feature is set to custom. You can use this parameter with the feature parameter to specify a user-defined Spark image for job running.

    + + + + + + + + + +
    Table 4 sessions parameters

    Parameter

    Mandatory

    req_body

    +

    No

    +

    String

    +

    Request parameter details.

    +

    update_time

    No

    @@ -372,7 +381,7 @@ diff --git a/docs/dli/api-ref/dli_02_0126.html b/docs/dli/api-ref/dli_02_0126.html index bbc6b908..497d37b1 100644 --- a/docs/dli/api-ref/dli_02_0126.html +++ b/docs/dli/api-ref/dli_02_0126.html @@ -168,6 +168,15 @@

    Time when a batch processing job is updated. The timestamp is expressed in milliseconds.

    req_body

    +

    No

    +

    String

    +

    Request parameter details.

    +
    @@ -226,7 +235,7 @@ diff --git a/docs/dli/api-ref/dli_02_0127.html b/docs/dli/api-ref/dli_02_0127.html index 6d32f3a8..0a215eed 100644 --- a/docs/dli/api-ref/dli_02_0127.html +++ b/docs/dli/api-ref/dli_02_0127.html @@ -103,7 +103,7 @@ diff --git a/docs/dli/api-ref/dli_02_0128.html b/docs/dli/api-ref/dli_02_0128.html index 0b7848aa..706db57d 100644 --- a/docs/dli/api-ref/dli_02_0128.html +++ b/docs/dli/api-ref/dli_02_0128.html @@ -1,7 +1,9 @@ -

    Querying Batch Job Logs

    +

    Querying Batch Job Logs (Discarded)

    Function

    This API is used to query the back-end logs of batch processing jobs.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

      GET /v2.0/{project_id}/batches/{batch_id}/log

    • Parameter description @@ -184,7 +186,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0129.html b/docs/dli/api-ref/dli_02_0129.html index 8372aaff..cf97fe6b 100644 --- a/docs/dli/api-ref/dli_02_0129.html +++ b/docs/dli/api-ref/dli_02_0129.html @@ -104,7 +104,7 @@
    diff --git a/docs/dli/api-ref/dli_02_0130.html b/docs/dli/api-ref/dli_02_0130.html index 3d4662e7..b0cd0f38 100644 --- a/docs/dli/api-ref/dli_02_0130.html +++ b/docs/dli/api-ref/dli_02_0130.html @@ -1,7 +1,9 @@ -

    Uploading a Package Group

    +

    Uploading a Package Group (Discarded)

    Function

    This API is used to upload a package group to a project. The function is similar to creating a package on the management console.

    +

    This API has been discarded and is not recommended.

    +

    URI

    • URI format

      POST /v2.0/{project_id}/resources

    • Parameter description @@ -83,7 +85,7 @@

    No

    Array of Objects

    +

    Array of objects

    Resource tag. For details, see Table 3.

    String

    Tag key.

    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    @@ -117,7 +121,8 @@

    String

    Tag key.

    +
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

    +

    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

    @@ -281,7 +286,7 @@

    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.

    No

    Array of Objects

    +

    Array of objects

    List of names of uploaded user resources. For details about resources, see Table 4.

    No

    Array of Objects

    +

    Array of objects

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

    No

    Array of Objects

    +

    Array of objects

    Uploaded package groups of a user.
    Table 1 DLI APIs

    Type

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/dli/api-ref/dli_02_0186.html b/docs/dli/api-ref/dli_02_0186.html index 5cda52bd..5e2e49f0 100644 --- a/docs/dli/api-ref/dli_02_0186.html +++ b/docs/dli/api-ref/dli_02_0186.html @@ -9,7 +9,7 @@
  • Deleting an Enhanced Datasource Connection
    • -
  • Querying an Enhanced Datasource Connection List
    +
  • Listing Enhanced Datasource Connections
  • Querying an Enhanced Datasource Connection
    • diff --git a/docs/dli/api-ref/dli_02_0187.html b/docs/dli/api-ref/dli_02_0187.html index 918f5fb3..c35e17eb 100644 --- a/docs/dli/api-ref/dli_02_0187.html +++ b/docs/dli/api-ref/dli_02_0187.html @@ -30,108 +30,108 @@

    Request

    -
    Table 1 DLI APIs

    Type

    Subtype

    -

    Description

    +

    Description

    Permission-related APIs

    +

    Permission-related APIs

    -

    -

    You can assign permissions to queues, view queue users, assign data permissions, view database users, view table users, view table user permissions, and view the permissions of authorized users.

    +

    You can assign permissions to queues, view queue users, assign data permissions, view database users, view table users, view table user permissions, and view the permissions of authorized users.

    Agency-related APIs

    +

    Global variable-related APIs

    -

    -

    Obtain the DLI agency information and create a DLI agency.

    +

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

    Queue-related APIs (Recommended)

    +

    APIs related to enhanced datasource connections

    -

    -

    You can create queues, delete queues, query all queues, modify the CIDR block of a queue, restart, scale out, or scale in a queue, query queue details, create a request for testing the connectivity of a specified address, query the connectivity of a specified address, create a scheduled queue scaling plan, query a scheduled queue scaling plan, delete scheduled queue scaling plans in batches, and delete or modify a scheduled queue scaling plan.

    +

    You can create, delete, and query enhanced datasource connections, as well as bind and unbind queues, modify host information, and query enhanced datasource connection permissions.

    APIs Related to SQL Jobs

    -

    +

    APIs related to elastic resource pools

    Database-related APIs

    -

    You can create a database, delete a database, view all databases, and modify database users.

    +

    You can create, modify, query, and delete elastic resource pools.

    Table-related APIs

    +

    Queue-related APIs (recommended)

    You can create, delete, and query tables, describe table information, preview table content, modify table users, and obtain the partition information list.

    +

    You can create, delete, and query all queues, modify the CIDR block of a queue, restart, scale up, and scale down queues, view detailed information about queues, create and query connectivity test requests for specific addresses, create, query, modify, and delete scheduled scaling plans for queues.

    Job-related APIs

    +

    SQL job-related APIs

    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.

    +

    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

    +

    Flink job-related APIs

    -

    -

    You can upload a group resource, query the group resource list, upload a group resource in JAR format, upload a PyFile group resource, upload a File type group resource, query a resource package in a group, delete a resource package in a group, and change the owner of a group or resource package.

    +

    You can authorize DLI to OBS, create and update SQL jobs and user-defined Flink jobs, run jobs in batches, query the job list, job details, job execution plans, and job monitoring information. You can also stop jobs in batches, delete and batch delete jobs, export and import Flink jobs, create IEF message channels, report Flink job status and callback Flink job actions at the edge, and report IEF system events.

    APIs Related to Flink Jobs

    +

    APIs related to Flink job templates

    -

    -

    You can authorize DLI to OBS, create and update SQL jobs and user-defined Flink jobs, run jobs in batches, query the job list, job details, job execution plans, and job monitoring information. You can also stop jobs in batches, delete and batch delete jobs, export and import Flink jobs, create IEF message channels, report Flink job status and callback Flink job actions at the edge, and report IEF system events.

    +

    You can create, update, and delete a template, and query the template list.

    APIs related to Spark jobs

    +

    APIs related to Spark jobs

    Batch Processing-related APIs

    -

    Creating batch jobs, cancel batch jobs, querying batch job lists, querying batch job details, querying batch job status, and querying batch job logs.

    -

    APIs Related to Flink Job Templates

    -

    -

    -

    You can create, update, and delete a template, and query the template list.

    -

    APIs Related to Enhanced Datasource Connections

    -

    -

    -

    You can create and delete enhanced datasource connections, query the enhanced datasource connection list as well as the connections, bind and unbind queues, modify host information, and query enhanced datasource connection permissions.

    -

    APIs Related to Global Variables

    -

    -

    -

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

    +

    Creating batch jobs, cancel batch jobs, querying batch job lists, querying batch job details, querying batch job status, and querying batch job logs.
    Table 2 Request parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    Yes

    +

    Yes

    String

    +

    String

    Name of the connection.

    +

    Name of the connection.

    • The name can contain only letters, digits, and underscores (_), and cannot be left empty.
    • A maximum of 64 characters are allowed.

    dest_vpc_id

    +

    dest_vpc_id

    Yes

    +

    Yes

    String

    +

    String

    The ID of the service VPC to be connected.

    +

    The ID of the service VPC to be connected.

    dest_network_id

    +

    dest_network_id

    Yes

    +

    Yes

    String

    +

    String

    The subnet ID of the to-be-connected service.

    +

    The subnet ID of the to-be-connected service.

    queues

    +

    queues

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    List of queue names that are available for datasource connections.

    +

    List of queue names that are available for datasource connections.

    routetable_id

    +

    routetable_id

    No

    +

    No

    String

    +

    String

    Route table associated with the subnet of the service.

    +

    Route table associated with the subnet of the service.

    hosts

    +

    hosts

    No

    +

    No

    Array of Objects

    +

    Array of objects

    The user-defined host information. A maximum of 20,000 records are supported. For details, see hosts request parameters.

    +

    The user-defined host information. A maximum of 20,000 records are supported. For details, see hosts request parameters.

    tags

    +

    tags

    No

    +

    No

    Array of Objects

    +

    Array of objects

    Tags of datasource connections. For details, see Table 4.

    +

    Tags of datasource connections. For details, see Table 4.
    -
    Table 3 hosts request parameters

    Parameter

    +
    - - - - - - - - @@ -157,6 +157,8 @@ @@ -173,31 +177,31 @@

    Response

    -
    Table 3 hosts request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    name

    +

    name

    No

    +

    No

    String

    +

    String

    The user-defined host name. The value can consist of 128 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). It must start with a letter.

    ip

    +

    ip

    No

    +

    No

    String

    +

    String

    The IPv4 address of the host.

    String

    Tag key.

    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    @@ -166,6 +168,8 @@

    String

    Tag key.

    +
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

    +
    Table 5 Response parameters

    Parameter

    +
    - - - - - - - @@ -229,7 +233,7 @@

    Example Response

    {
   "is_success": true,
-"message": "Create peer connection for queues:{queue list in the request parameter}",
+  "message": "Create peer connection for queues:{Queue list in the request parameter}",
   "connection_id": "2a620c33-5609-40c9-affd-2b6453071b0f"
 }
    diff --git a/docs/dli/api-ref/dli_02_0189.html b/docs/dli/api-ref/dli_02_0189.html index e2f7d1ab..86b4ae75 100644 --- a/docs/dli/api-ref/dli_02_0189.html +++ b/docs/dli/api-ref/dli_02_0189.html @@ -1,7 +1,7 @@

    Querying an Enhanced Datasource Connection

    -

    Function

    This API is used to query the created enhanced datasource connections.

    +

    Function

    This API is used to query a created enhanced datasource connection.

    URI

    • URI format

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

    • Parameter description @@ -101,7 +101,7 @@
    - @@ -137,7 +137,7 @@ - diff --git a/docs/dli/api-ref/dli_02_0190.html b/docs/dli/api-ref/dli_02_0190.html index 25ce7312..ddc0db5d 100644 --- a/docs/dli/api-ref/dli_02_0190.html +++ b/docs/dli/api-ref/dli_02_0190.html @@ -1,7 +1,7 @@ -

    Querying an Enhanced Datasource Connection List

    -

    Function

    This API is used to query the list of created enhanced datasource connections.

    +

    Listing Enhanced Datasource Connections

    +

    Function

    This API is used to list the created enhanced datasource connections.

    URI

    • URI format

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

    • Parameter description @@ -129,7 +129,7 @@
    - @@ -189,7 +189,7 @@ - diff --git a/docs/dli/api-ref/dli_02_0193.html b/docs/dli/api-ref/dli_02_0193.html index 46d1caad..3faf1244 100644 --- a/docs/dli/api-ref/dli_02_0193.html +++ b/docs/dli/api-ref/dli_02_0193.html @@ -18,16 +18,6 @@
  • Querying Connectivity Test Details of a Specified Address
    • -
  • Creating a Scheduled CU Change
    -
    • -
  • Viewing a Scheduled CU Change
    -
    • -
  • Deleting Scheduled CU Changes in Batches
    -
    • -
  • Deleting a Scheduled CU Change
    -
    • -
  • Modifying a Scheduled CU Change
    -
    • diff --git a/docs/dli/api-ref/dli_02_0194.html b/docs/dli/api-ref/dli_02_0194.html index 8167027b..02dab232 100644 --- a/docs/dli/api-ref/dli_02_0194.html +++ b/docs/dli/api-ref/dli_02_0194.html @@ -36,9 +36,9 @@ - - @@ -46,9 +46,9 @@ - - @@ -57,9 +57,9 @@ - - - - - - - - @@ -98,9 +98,9 @@ - - @@ -108,9 +108,9 @@ - - @@ -119,18 +119,18 @@ - - - - @@ -141,9 +141,9 @@ - - @@ -151,22 +151,22 @@ - - - - @@ -227,6 +227,17 @@ "labels": ["multi_az=2"] } +

    Creating a queue in a specified elastic resource pool

    +
    {
+    "queue_name": "queue2",
+    "description": "test_esp",
+    "cu_count": 16,
+    "resource_mode": 1,
+    "enterprise_project_id": "0",
+    "queue_type": "general",
+    "labels": ["multi_az=2"],
+    "elastic_resource_pool_name": "elastic_pool_0622_10"
+}

    Example Response

    {
   "is_success": true,
   "message": "",
@@ -235,25 +246,25 @@

    Status Codes

    Table 5 describes the status code.

    -
    Table 5 Response parameters

    Parameter

    Type

    +

    Type

    Description

    is_success

    +

    is_success

    Boolean

    +

    Boolean

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

    message

    +

    message

    String

    +

    String

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

    connection_id

    +

    connection_id

    String

    +

    String

    Connection ID. Identifies the UUID of a datasource connection.

    No

    Array of Objects

    +

    Array of objects

    For details about how to create a datasource connection for each queue, see Table 3.

    No

    Array of Objects

    +

    Array of objects

    User-defined host information. For details, see hosts parameter description.

    No

    Array of Objects

    +

    Array of objects

    Datasource connection information list. For details, see Table 4.

    No

    Array of Objects

    +

    Array of objects

    For details about how to create a datasource connection for each queue, see Table 5.

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    Yes

    String

    +

    String

    Name of a newly created resource queue. The name can contain only digits, letters, and underscores (_), but cannot contain only digits or start with an underscore (_). Length range: 1 to 128 characters.

    +

    Name of a newly created resource queue. The name can contain only digits, letters, and underscores (_), but cannot contain only digits or start with an underscore (_). Length range: 1 to 128 characters.

    NOTE:

    The queue name is case-insensitive. The uppercase letters will be automatically converted to lowercase letters.

    No

    String

    +

    String

    Queue type. The options are as follows:

    +

    Queue type. The options are as follows:

    • sql: Queues used to run SQL jobs
    • general: Queues used to run Flink and Spark Jar jobs.
    NOTE:

    If the type is not specified, the default value sql is used.

    @@ -69,27 +69,27 @@

    No

    String

    +

    String

    Description of a queue.

    +

    Description of a queue.

    cu_count

    Yes

    Integer

    +

    Integer

    Minimum number of CUs that are bound to a queue. Currently, the value can only be 16, 64, or 256.

    +

    Minimum number of CUs that are bound to a queue. Currently, the value can only be 16, 64, or 256.

    enterprise_project_id

    No

    String

    +

    String

    Enterprise project ID. The value 0 indicates the default enterprise project.

    +

    Enterprise project ID. The value 0 indicates the default enterprise project.

    NOTE:

    Users who have enabled Enterprise Management can set this parameter to bind a specified project.

    No

    String

    +

    String

    CPU architecture of compute resources.

    +

    CPU architecture of compute resources.

    • x86_64

    No

    Integer

    +

    Integer

    Queue resource mode. The options are as follows:

    +

    Queue resource mode. The options are as follows:

    0: shared resource mode

    1: dedicated resource mode

    No

    Array of Strings

    +

    Array of Strings

    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.

    +

    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

    No

    Array of Objects

    +

    Array of objects

    Queue tags for identifying cloud resources. A tag consists of a key and tag value. For details, see Table 3.

    +

    Queue tags for identifying cloud resources. A tag consists of a key and tag value. For details, see Table 3.

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    Yes

    String

    +

    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.

    +
    Tag key.
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    Yes

    String

    +

    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.

    +
    Tag value.
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

    +
    Table 5 Status codes

    Status Code

    +
    - - - - - - - diff --git a/docs/dli/api-ref/dli_02_0201.html b/docs/dli/api-ref/dli_02_0201.html index f146d54d..b7eb0ad9 100644 --- a/docs/dli/api-ref/dli_02_0201.html +++ b/docs/dli/api-ref/dli_02_0201.html @@ -7,7 +7,7 @@
    • Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities.
    • Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

    Policy-based authorization is useful if you want to allow or deny the access to an API.

    -

    An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user needs to create buckets using an API, the user must have been granted permissions that allow the dli:queue:create_queue action.

    +

    An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user needs to create buckets using an API, the user must have been granted permissions that allow the dli:queue:create_queue action.

    Supported Actions

    VBS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

    • Permissions: Allow or deny operations on specified resources under specific conditions.
    • APIs: RESTful APIs that can be called in a custom policy.
    • Actions: added to a custom policy to control permissions for specific operations.
    • Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.
    • IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Project.

    @@ -15,1138 +15,898 @@

    DLI supports the following actions that can be defined in custom policies:

    -
    Table 5 Status codes

    Status Code

    Description

    +

    Description

    200

    +

    200

    The job is created successfully.

    +

    The job is created successfully.

    400

    +

    400

    Request error.

    +

    Request error.

    500

    +

    500

    Internal service error.

    +

    Internal service error.
    Table 1 Actions

    Permission

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/dli/api-ref/dli_02_0223.html b/docs/dli/api-ref/dli_02_0223.html index 3cab90c3..9a0dfbd1 100644 --- a/docs/dli/api-ref/dli_02_0223.html +++ b/docs/dli/api-ref/dli_02_0223.html @@ -1,11 +1,9 @@ -

    APIs Related to Flink Jobs

    +

    Flink Job-related APIs

    Table 1 Actions

    Permission

    API

    +

    API

    Actions

    +

    Actions

    Dependent Permission

    -

    IAM Project

    +

    IAM Project

    (Project)

    Enterprise Project

    +

    Enterprise Project

    (Enterprise Project)

    Creating a Queue

    +

    Creating a queue

    POST /v1.0/{project_id}/queues

    +

    POST /v1.0/{project_id}/queues

    dli:queue:createQueue

    +

    dli:queue:createQueue

    -

    +

    √

    √

    -

    √

    +

    √

    Deleting a Queue

    -

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

    +

    Deleting a queue

    dli:queue:dropQueue

    +

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

    -

    +

    dli:queue:dropQueue

    √

    +

    √

    √

    +

    √

    Submitting a Job

    +

    Submitting a job

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

    +

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

    dli:queue:submitJob

    +

    dli:queue:submitJob

    -

    +

    √

    √

    -

    ×

    +

    ×

    Canceling a job

    -

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

    +

    Canceling a job

    dli:queue:cancelJob

    +

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

    -

    +

    dli:queue:cancelJob

    √

    +

    √

    ×

    +

    ×

    Viewing Queue Permissions of Other Users

    +

    Viewing queue permissions of other users

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

    +

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

    dli:queue:showPrivileges

    +

    dli:queue:showPrivileges

    -

    +

    √

    √

    -

    ×

    +

    ×

    Restarting a queue

    -

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

    +

    Restarting a queue

    dli:queue:restart

    +

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

    -

    +

    dli:queue:restart

    √

    +

    √

    ×

    +

    ×

    Scaling out/in a queue

    +

    Scaling out/in a queue

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

    +

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

    dli:queue:scaleQueue

    +

    dli:queue:scaleQueue

    -

    +

    √

    √

    -

    ×

    +

    ×

    Granting elastic resource pool permissions

    -

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

    +

    Granting elastic resource pool permissions

    dli:elasticresourcepool:grantPrivilege

    +

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

    -

    +

    dli:elasticresourcepool:grantPrivilege

    √

    +

    √

    ×

    +

    ×

    Revoking elastic resource pool permissions

    +

    Revoking elastic resource pool permissions

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

    +

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

    dli:elasticresourcepool:revokePrivilege

    +

    dli:elasticresourcepool:revokePrivilege

    -

    +

    √

    √

    -

    ×

    +

    ×

    Creating a Database

    -

    POST /v1.0/{project_id}/databases

    +

    Creating a database

    dli:database:createDatabase

    +

    POST /v1.0/{project_id}/databases

    -

    +

    dli:database:createDatabase

    √

    +

    √

    ×

    +

    ×

    Deleting a Database

    +

    Deleting a database

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

    +

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

    dli:database:dropDatabase

    +

    dli:database:dropDatabase

    -

    +

    √

    √

    -

    ×

    +

    ×

    Modifying database configuration

    -

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

    +

    Modifying database configuration

    dli:database:alterDatabaseProperties

    +

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

    -

    +

    dli:database:alterDatabaseProperties

    √

    +

    √

    ×

    +

    ×

    Explaining the SQL Statement as an Execution Plan

    +

    Explaining the SQL statement as an execution plan

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

    +

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

    dli:database:explain

    +

    dli:database:explain

    -

    +

    √

    √

    -

    ×

    +

    ×

    Creating a Table

    -

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

    +

    Creating a table

    dli:database:createTable

    +

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

    -

    +

    dli:database:createTable

    √

    +

    √

    ×

    +

    ×

    Creating a View

    +

    Creating a view

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

    +

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

    dli:database:createView

    +

    dli:database:createView

    -

    +

    √

    √

    -

    ×

    +

    ×

    Creating a Function

    -

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

    +

    Creating a function

    dli:database:createFunction

    +

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

    -

    +

    dli:database:createFunction

    √

    +

    √

    ×

    +

    ×

    Describing a Function

    +

    Describing a function

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

    +

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

    dli:database:describeFunction

    +

    dli:database:describeFunction

    -

    +

    √

    √

    -

    ×

    +

    ×

    Deleting a Function

    -

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

    +

    Deleting a function

    dli:database:dropFunction

    +

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

    -

    +

    dli:database:dropFunction

    √

    +

    √

    ×

    +

    ×

    Displaying a Function

    -

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

    -

    dli:database:showFunctions

    -

    -

    -

    √

    -

    ×

    -

    Creating a role

    -

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

    -

    dli:database:createRole

    -

    -

    -

    √

    -

    ×

    -

    Deleting a role

    -

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

    -

    dli:database:dropRole

    -

    -

    -

    √

    -

    ×

    -

    Displaying a Role

    -

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

    -

    dli:database:showRoles

    -

    -

    -

    √

    -

    ×

    -

    Displaying All Roles

    -

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

    -

    dli:database:showAllRoles

    -

    -

    -

    √

    -

    ×

    -

    Binding a Role

    -

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

    -

    dli:database:grantRole

    -

    -

    -

    √

    -

    ×

    -

    Unbinding the Role

    -

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

    +

    Displaying a function

    dli:database:revokeRole

    +

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

    -

    +

    dli:database:showFunctions

    √

    +

    √

    ×

    +

    ×

    Displaying the Binding Relationships Between All Roles and Users

    +

    Creating a role

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

    +

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

    dli:database:showUsers

    +

    dli:database:createRole

    -

    +

    √

    √

    -

    ×

    +

    ×

    Viewing Database Permissions of Other Users

    -

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

    +

    Deleting a role

    dli:database:showPrivileges

    +

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

    -

    +

    dli:database:dropRole

    √

    +

    √

    ×

    +

    ×

    Displaying database

    +

    Displaying a role

    GET /v1.0/{project_id}/databases

    +

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

    dli:database:display_database

    +

    dli:database:showRoles

    -

    +

    √

    √

    -

    ×

    +

    ×

    Displaying all databases

    -

    GET /v1.0/{project_id}/databases

    +

    Displaying all roles

    dli:database:displayAllDatabases

    +

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

    -

    +

    dli:database:showAllRoles

    √

    +

    √

    ×

    +

    ×

    Displaying all tables

    +

    Binding a role

    GET /v1.0/{project_id}/databases

    +

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

    dli:database:displayAllTables

    +

    dli:database:grantRole

    -

    +

    √

    √

    -

    ×

    +

    ×

    Granting database permissions to a specified user

    -

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

    +

    Unbinding a role

    dli:database:grantPrivilege

    +

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

    -

    +

    dli:database:revokeRole

    √

    +

    √

    ×

    +

    ×

    Removing database permissions of a specified user

    +

    Displaying the binding relationships between all roles and users

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

    +

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

    dli:database:revokePrivilege

    +

    dli:database:showUsers

    -

    +

    √

    √

    -

    ×

    +

    ×

    Deleting a Table

    -

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

    +

    Viewing database permissions of other users

    dli:table:dropTable

    +

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

    -

    +

    dli:database:showPrivileges

    √

    +

    √

    ×

    +

    ×

    Displaying Table Structure

    +

    Displaying a database

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

    +

    GET /v1.0/{project_id}/databases

    dli:table:describeTable

    +

    dli:database:displayDatabase

    -

    +

    √

    √

    -

    ×

    +

    ×

    Querying a Table

    -

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

    +

    Displaying all databases

    dli:table:select

    +

    GET /v1.0/{project_id}/databases

    -

    +

    dli:database:displayAllDatabases

    √

    +

    √

    ×

    +

    ×

    Displaying table configuration

    +

    Displaying all tables

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

    +

    GET /v1.0/{project_id}/databases

    dli:table:showTableProperties

    +

    dli:database:displayAllTables

    -

    +

    √

    √

    -

    ×

    +

    ×

    Displaying the Table Creation Statement

    -

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

    +

    Granting database permissions to a specified user

    dli:table:showCreateTable

    +

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

    -

    +

    dli:database:grantPrivilege

    √

    +

    √

    ×

    +

    ×

    Displaying All Partitions

    +

    Removing database permissions of a specified user

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

    +

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

    dli:table:showPartitions

    +

    dli:database:revokePrivilege

    -

    +

    √

    √

    -

    ×

    +

    ×

    Setting Table Configuration

    -

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

    +

    Deleting a table

    dli:table:alterTableSetProperties

    +

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

    -

    +

    dli:table:dropTable

    √

    +

    √

    ×

    +

    ×

    Adding a Column

    +

    Displaying the table structure

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

    +

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

    dli:table:alterTableAddColumns

    +

    dli:table:describeTable

    -

    +

    √

    √

    -

    ×

    +

    ×

    Adding Partitions to the Partitioned Table

    -

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

    +

    Querying a table

    dli:table:alterTableAddPartition

    +

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

    -

    +

    dli:table:select

    √

    +

    √

    ×

    +

    ×

    Renaming a Table Partition

    +

    Displaying table configuration

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

    +

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

    dli:table:alterTableRenamePartition

    +

    dli:table:showTableProperties

    -

    +

    √

    √

    -

    ×

    +

    ×

    Deleting Partitions from a Partitioned Table

    -

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

    +

    Displaying the table creation statement

    dli:table:alterTableDropPartition

    +

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

    -

    +

    dli:table:showCreateTable

    √

    +

    √

    ×

    +

    ×

    Restoring Table Partitions

    +

    Displaying all partitions

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

    +

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

    dli:table:alterTableRecoverPartition

    +

    dli:table:showPartitions

    -

    +

    √

    √

    -

    ×

    +

    ×

    Renaming a Table

    -

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

    +

    Setting table configuration

    dli:table:alterTableRename

    +

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

    -

    +

    dli:table:alterTableSetProperties

    √

    +

    √

    ×

    +

    ×

    Setting the Partition Path

    +

    Adding a column

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

    +

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

    dli:table:alterTableSetLocation

    +

    dli:table:alterTableAddColumns

    -

    +

    √

    √

    -

    ×

    +

    ×

    Inserting data into a table

    -

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

    +

    Adding partitions to a partitioned table

    dli:table:insertIntoTable

    +

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

    -

    +

    dli:table:alterTableAddPartition

    √

    +

    √

    ×

    +

    ×

    Rewriting table data

    +

    Renaming a table partition

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

    +

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

    dli:table:insertOverwriteTable

    +

    dli:table:alterTableRenamePartition

    -

    +

    √

    √

    -

    ×

    +

    ×

    Viewing Table Permissions of Other Users

    -

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

    +

    Deleting partitions from a partitioned table

    dli:table:showPrivileges

    +

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

    -

    +

    dli:table:alterTableDropPartition

    √

    +

    √

    ×

    +

    ×

    Clearing a table

    +

    Restoring a table partition

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

    +

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

    dli:table:truncateTable

    +

    dli:table:alterTableRecoverPartition

    -

    +

    √

    √

    -

    ×

    +

    ×

    Updating a table

    -

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

    +

    Renaming a table

    dli:table:update

    +

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

    -

    +

    dli:table:alterTableRename

    √

    +

    √

    ×

    +

    ×

    Deleting data in a table

    +

    Setting the partition path

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

    +

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

    dli:table:delete

    +

    dli:table:alterTableSetLocation

    -

    +

    √

    √

    -

    ×

    +

    ×

    Modifying column information

    -

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

    +

    Inserting table data

    dli:table:alterTableChangeColumn

    +

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

    -

    +

    dli:table:insertIntoTable

    √

    +

    √

    ×

    +

    ×

    Deleting a column

    +

    Rewriting table data

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

    +

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

    dli:table:alterTableDropColumns

    +

    dli:table:insertOverwriteTable

    -

    +

    √

    √

    -

    ×

    +

    ×

    Displaying data segments

    -

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

    +

    Viewing table permissions of other users

    dli:table:showSegments

    +

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

    -

    +

    dli:table:showPrivileges

    √

    +

    √

    ×

    +

    ×

    Merging data segments

    -

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

    +

    Clearing a table

    dli:table:compaction

    +

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

    -

    +

    dli:table:truncateTable

    √

    +

    √

    ×

    +

    ×

    Modifying a View

    +

    Updating a table

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

    +

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

    dli:table:alterView

    +

    dli:table:update

    -

    +

    √

    √

    -

    ×

    +

    ×

    Displaying the table structure

    -

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

    +

    Deleting table data

    dli:table:describeTable

    +

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

    -

    +

    dli:table:delete

    √

    +

    √

    ×

    +

    ×

    Granting data table permissions to a specified user

    +

    Modifying column information

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

    +

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

    dli:table:grantPrivilege

    +

    dli:table:alterTableChangeColumn

    -

    +

    √

    √

    -

    ×

    +

    ×

    Removing data table permissions of a specified user

    -

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

    +

    Deleting a column

    dli:table:revokePrivilege

    +

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

    -

    +

    dli:table:alterTableDropColumns

    √

    +

    √

    ×

    +

    ×

    Viewing the security authentication information permission list of other users

    +

    Displaying data segments

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

    +

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

    dli:datasourceauth:showPrivileges

    +

    dli:table:showSegments

    -

    +

    √

    √

    -

    ×

    +

    ×

    Using security authentication information

    -

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

    +

    Merging data segments

    dli:datasourceauth:useAuth

    +

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

    -

    +

    dli:table:compaction

    √

    +

    √

    ×

    +

    ×

    Deleting security authentication information

    +

    Modifying a view

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

    +

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

    dli:datasourceauth:dropAuth

    +

    dli:table:alterView

    -

    +

    √

    √

    -

    ×

    +

    ×

    Updating security authentication information

    -

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

    +

    Displaying the table structure

    dli:datasourceauth:updateAuth

    +

    POST /v1.0/{project_id}/jobs/submit-job, executing corresponding SQL statements

    -

    +

    dli:table:describeTable

    √

    +

    √

    ×

    +

    ×

    Granting security authentication permissions to a specified user

    +

    Granting data table permissions to a specified user

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

    +

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

    dli:datasourceauth:grantPrivilege

    +

    dli:table:grantPrivilege

    -

    +

    √

    √

    -

    ×

    +

    ×

    Removing security authentication permissions of a specified user

    -

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

    +

    Removing data table permissions of a specified user

    dli:datasourceauth:revokePrivilege

    +

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

    -

    +

    dli:table:revokePrivilege

    √

    +

    √

    ×

    +

    ×

    Querying job details

    +

    Viewing the security authentication information permission list of other users

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

    +

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

    dli:jobs:get

    +

    dli:datasourceauth:showPrivileges

    -

    +

    √

    √

    -

    ×

    +

    ×

    Querying a job list

    -

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

    +

    Using security authentication information

    dli:jobs:listAll

    +

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

    -

    +

    dli:datasourceauth:useAuth

    √

    +

    √

    ×

    +

    ×

    Creating a job

    +

    Deleting security authentication information

    POST /v1.0/:x_project_id/streaming/sql-jobs

    +

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

    dli:jobs:create

    +

    dli:datasourceauth:dropAuth

    -

    +

    √

    √

    -

    ×

    +

    ×

    Updating a job

    -

    PUT /v1.0/:x_project_id/streaming/sql-jobs/:job_id

    +

    Updating security authentication information

    dli:jobs:update

    +

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

    -

    +

    dli:datasourceauth:updateAuth

    √

    +

    √

    ×

    +

    ×

    Deleting a job

    -

    POST /v1.0/:x_project_id/streaming/jobs/delete

    +

    Granting security authentication permissions to a specified user

    dli:jobs:delete

    +

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

    -

    +

    dli:datasourceauth:grantPrivilege

    √

    +

    √

    ×

    +

    ×

    Starting a job

    +

    Removing security authentication permissions of a specified user

    POST /v1.0/:x_project_id/streaming/jobs/run

    +

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

    dli:jobs:start

    +

    dli:datasourceauth:revokePrivilege

    -

    +

    √

    √

    -

    ×

    +

    ×

    Stopping a job

    -

    POST /v1.0/:x_project_id/streaming/jobs/stop

    +

    Granting job permissions to a specified user

    dli:jobs:stop

    +

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

    -

    +

    dli:jobs:grantPrivilege

    √

    +

    √

    ×

    +

    ×

    Exporting a job

    +

    Removing job permissions of a specified user

    POST /v1.0/:x_project_id/streaming/jobs/export

    +

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

    dli:jobs:export

    +

    dli:jobs:revokePrivilege

    -

    +

    √

    √

    -

    ×

    +

    ×

    Granting job permissions to a specified user

    -

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

    +

    Querying a Column

    dli:jobs:grantPrivilege

    +

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

    -

    +

    dli:column:select

    √

    +

    √

    ×

    +

    ×

    Removing job permissions of a specified user

    +

    Granting permissions to a specified user queue

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

    +

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

    dli:jobs:revokePrivilege

    +

    dli:column:grantPrivilege

    -

    +

    √

    √

    -

    ×

    +

    ×

    Querying a Column

    -

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

    +

    Removing permissions of a specified user queue

    dli:column:select

    +

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

    -

    +

    dli:column:revokePrivilege

    √

    +

    √

    ×

    +

    ×

    Granting permissions to a specified user queue

    +

    Listing Flink jobs

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

    +

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

    dli:column:grantPrivilege

    +

    dli:jobs:listAll

    -

    +

    √

    √

    -

    ×

    +

    ×

    Removing permissions of a specified user queue

    -

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

    +

    Querying Flink job details

    dli:column:revokePrivilege

    +

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

    -

    +

    dli:jobs:get

    √

    +

    √

    ×

    +

    ×

    Querying the Flink Job List

    +

    Creating a Flink SQL job

    GET /v1.0/:x_project_id/jobs

    +

    POST /v1.0/{project_id}/streaming/sql-jobs

    dli:jobs:listAll

    +

    dli:jobs:create

    -

    +

    √

    √

    -

    ×

    +

    ×

    Querying Flink Job Details

    -

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

    +

    Creating a Flink Jar job

    dli:jobs:get

    +

    POST /v1.0/{project_id}/streaming/flink-jobs

    -

    +

    dli:jobs:create

    √

    +

    √

    ×

    +

    ×

    Creating a Flink Job

    +

    Updating a Flink SQL job

    POST /v1.0/:x_project_id/sql_job

    +

    PUT /v1.0/{project_id}/streaming/sql-jobs/{job_id}

    dli:jobs:create

    +

    dli:jobs:update

    -

    +

    √

    √

    -

    ×

    +

    ×

    Updating a Flink Job

    -

    PATCH /v1.0/:x_project_id/sql_job

    +

    Updating a Flink Jar job

    dli:jobs:update

    +

    PUT /v1.0/{project_id}/streaming/flink-jobs/{job_id}

    -

    +

    dli:jobs:update

    √

    +

    √

    ×

    +

    ×

    Deleting a Flink Job

    +

    Deleting a Flink job

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

    +

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

    dli:jobs:delete

    +

    dli:jobs:delete

    -

    +

    √

    √

    -

    ×

    +

    ×

    Starting a Flink Job

    -

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

    +

    Running Flink jobs in batches

    dli:jobs:start

    +

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

    -

    +

    dli:jobs:start

    √

    +

    √

    ×

    +

    ×

    Stopping a Flink Job

    -

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

    +

    Stopping a Flink job

    dli:jobs:stop

    +

    POST /v1.0/{project_id}/streaming/jobs/stopob_id/stop

    -

    +

    dli:jobs:stop

    √

    +

    √

    ×

    +

    ×
    Table 2 Request parameters

    Parameter

    +
    - - - - - @@ -125,7 +127,7 @@ diff --git a/docs/dli/api-ref/dli_02_0228.html b/docs/dli/api-ref/dli_02_0228.html index cf7f2b07..1299bb85 100644 --- a/docs/dli/api-ref/dli_02_0228.html +++ b/docs/dli/api-ref/dli_02_0228.html @@ -30,270 +30,271 @@

    Request

    -
    Table 2 Request parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    obs_buckets

    +

    obs_buckets

    Yes

    +

    Yes

    Array of Strings

    +

    Array of Strings

    List of OBS buckets.
    Table 2 Request parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -316,7 +317,9 @@ - @@ -327,7 +330,9 @@ - @@ -341,9 +346,9 @@ - - @@ -351,27 +356,27 @@ - - - - - - @@ -478,7 +483,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0229.html b/docs/dli/api-ref/dli_02_0229.html index fe721c81..095680e1 100644 --- a/docs/dli/api-ref/dli_02_0229.html +++ b/docs/dli/api-ref/dli_02_0229.html @@ -7,30 +7,30 @@
  • Parameter description
    • Table 2 Request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    Yes

    +

    Yes

    String

    +

    String

    Name of the job. The value can contain 1 to 57 characters.

    +

    Name of the job. The value can contain 1 to 57 characters.

    desc

    +

    desc

    No

    +

    No

    String

    +

    String

    Job description. Length range: 0 to 512 characters.

    +

    Job description. Length range: 0 to 512 characters.

    template_id

    +

    template_id

    No

    +

    No

    Integer

    +

    Integer

    Template ID.

    +

    Template ID.

    If both template_id and sql_body are specified, sql_body is used. If template_id is specified but sql_body is not, fill sql_body with the template_id value.

    queue_name

    +

    queue_name

    No

    +

    No

    String

    +

    String

    Name of a queue. The value can contain 0 to 128 characters.

    +

    Name of a queue. The value can contain 0 to 128 characters.

    sql_body

    +

    sql_body

    No

    +

    No

    String

    +

    String

    Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1,024 x 1,024 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

    +

    run_mode

    No

    +

    No

    String

    +

    String

    Job running mode. The options are as follows:

    +

    Job running mode. The options are as follows:

    • shared_cluster: indicates that the job is running on a shared cluster.
    • exclusive_cluster: indicates that the job is running on an exclusive cluster.
    • edge_node: indicates that the job is running on an edge node.

    The default value is shared_cluster.

    cu_number

    +

    cu_number

    No

    +

    No

    Integer

    +

    Integer

    Number of CUs selected for a job. The default value is 2.

    -

    Sum of the number of compute units and job manager CUs of DLI. CU is also the billing unit of DLI. One CU equals one vCPU and 4 GB. The value is the number of CUs required for job running and cannot exceed the number of CUs in the bound queue. For details about how to set the number of CUs of JobManager, see manager_cu_number.

    +

    Number of CUs selected for a job. The default value is 2.

    +

    Sum of the number of compute units and job manager CUs of DLI. CU is also the billing unit of DLI. One CU equals one vCPU and 4 GB of memory. The value is the number of CUs required for job running and cannot exceed the number of CUs in the bound queue. For details about how to set the number of CUs of JobManager, see manager_cu_number.

    parallel_number

    +

    parallel_number

    No

    +

    No

    Integer

    +

    Integer

    Number of parallel jobs set by a user. The default value is 1.

    +

    Number of parallel jobs set by a user. The default value is 1.

    Number of Flink SQL jobs that run at the same time. Properly increasing the number of parallel threads improves the overall computing capability of the job. However, the switchover overhead caused by the increase of threads must be considered. This value cannot be greater than four times the compute units (number of CUs minus the number of JobManager CUs).

    For details about how to set the number of JobManager CUs, see manager_cu_number.

    checkpoint_enabled

    +

    checkpoint_enabled

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to enable the automatic job snapshot function.

    +

    Whether to enable the automatic job snapshot function.

    • true: indicates to enable the automatic job snapshot function.
    • false: indicates to disable the automatic job snapshot function.
    • Default value: false

    checkpoint_mode

    +

    checkpoint_mode

    No

    +

    No

    Integer

    +

    Integer

    Snapshot mode. There are two options:

    +

    Snapshot mode. There are two options:

    • 1: ExactlyOnce, indicates that data is processed only once.
    • 2: AtLeastOnce, indicates that data is processed at least once.

    The default value is 1.

    checkpoint_interval

    +

    checkpoint_interval

    No

    +

    No

    Integer

    +

    Integer

    Snapshot interval. The unit is second. The default value is 10.

    +

    Snapshot interval. The unit is second. The default value is 10.

    obs_bucket

    +

    obs_bucket

    No

    +

    No

    String

    +

    String

    OBS path where users are authorized to save the snapshot. This parameter is valid only when checkpoint_enabled is set to true.

    -

    OBS path where users are authorized to save the snapshot. This parameter is valid only when log_enabled is set to true.

    +

    OBS bucket where users are authorized to save the snapshot. This parameter is valid only when checkpoint_enabled is set to true.

    +

    OBS bucket where users are authorized to save the snapshot. This parameter is valid only when log_enabled is set to true.

    log_enabled

    +

    log_enabled

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.

    +

    Whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.

    smn_topic

    +

    smn_topic

    No

    +

    No

    String

    +

    String

    SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.

    +

    SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.

    restart_when_exception

    +

    restart_when_exception

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.

    +

    Whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.

    idle_state_retention

    +

    idle_state_retention

    No

    +

    No

    Integer

    +

    Integer

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

    +

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

    job_type

    +

    job_type

    No

    +

    No

    String

    +

    String

    Job type. This parameter can be set to flink_sql_job.

    - +

    Job type. The options include flink_sql_job and flink_opensource_sql_job.

    +

    The default value is flink_opensource_sql_job.

    +
    • If run_mode is set to exclusive_cluster, job_type must be set to flink_sql_job or flink_opensource_sql_job.
    • If run_mode is set to shared_cluster, job_type must be set to flink_sql_job.

    dirty_data_strategy

    +

    dirty_data_strategy

    No

    +

    No

    String

    +

    String

    Dirty data policy of a job.

    +

    Dirty data policy of a job.

    • 2:obsDir: Save. obsDir specifies the path for storing dirty data.
    • 1: Trigger a job exception
    • 0: Ignore

    The default value is 0.

    udf_jar_url

    +

    udf_jar_url

    No

    +

    No

    String

    +

    String

    Name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.

    +

    Name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.

    manager_cu_number

    +

    manager_cu_number

    No

    +

    No

    Integer

    +

    Integer

    Number of CUs in the JobManager selected for a job. The default value is 1.

    +

    Number of CUs in the JobManager selected for a job. The default value is 1.

    tm_cus

    +

    tm_cus

    No

    +

    No

    Integer

    +

    Integer

    Number of CUs for each TaskManager. The default value is 1.

    +

    Number of CUs for each TaskManager. The default value is 1.

    tm_slot_num

    +

    tm_slot_num

    No

    +

    No

    Integer

    +

    Integer

    Number of slots in each TaskManager. The default value is (parallel_number*tm_cus)/(cu_number-manager_cu_number).

    +

    Number of slots in each TaskManager. The default value is (parallel_number*tm_cus)/(cu_number-manager_cu_number).

    resume_checkpoint

    +

    resume_checkpoint

    No

    +

    No

    Boolean

    +

    Boolean

    Whether the abnormal restart is recovered from the checkpoint.

    +

    Whether the abnormal restart is recovered from the checkpoint.

    resume_max_num

    +

    resume_max_num

    No

    +

    No

    Integer

    +

    Integer

    Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is -1, indicating that the number of times is unlimited.

    +

    Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is -1, indicating that the number of times is unlimited.

    tags

    +

    tags

    No

    +

    No

    Array of Objects

    +

    Array of objects

    Label of a Flink SQL job. For details, see Table 3.

    +

    Label of a Flink SQL job. For details, see Table 3.

    runtime_config

    +

    runtime_config

    No

    +

    No

    String

    +

    String

    Customizes optimization parameters when a Flink job is running.

    +

    Customizes optimization parameters when a Flink job is running.

    flink_version

    +

    flink_version

    No

    +

    No

    String

    +

    String

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

    +

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

    String

    Tag key.

    +

    Tag key

    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the key cannot start or end with a space or start with _sys_.

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

    String

    Tag key.

    +

    Tag value

    +
    NOTE:

    A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

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

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    No

    Boolean

    +

    String

    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.

    message

    No

    String

    +

    String

    Message content.

    +

    Message content.

    job

    No

    Object

    +

    Object

    Information about the job status. For details, see Table 5.

    +

    Information about the job status. For details, see Table 5.
    - - - - - - - - - @@ -39,9 +39,9 @@

    Request

    -
    Table 1 URI parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    +

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    job_id

    Yes

    +

    Yes

    Long

    +

    Long

    Job ID. Refer to Creating a SQL Job to obtain the value.

    +

    Job ID. Refer to Creating a SQL Job to obtain the value.
    Table 2 Request parameters

    Parameter

    +
    - @@ -49,45 +49,45 @@ - - - - - - - - - - @@ -96,27 +96,27 @@

    The default value is shared_cluster.

    - - - - - - @@ -124,9 +124,9 @@
    • true: indicates to enable the automatic job snapshot function.
    • false: indicates to disable the automatic job snapshot function.
    • Default value: false
    - - @@ -135,73 +135,73 @@

    The default value is 1.

    - - - - - - - - - - - - - - - - - @@ -210,72 +210,72 @@

    The default value is 0.

    - - - - - - - - - - - - - - - - @@ -283,18 +283,18 @@ 
    {"operator_list":[{"id":"0a448493b4782967b150582570326227","rate_factor":0.55},{"id":"6d2677a0ecc3fd8df0b72ec675edf8f4","rate_factor":1},{"id":"ea632d67b7d595e5b851708ae9ad79d6","rate_factor":0.55},{"id":"bc764cd8ddf7a0cff126f51c16239658","output_rate":2000}]}
    - - - - @@ -308,46 +308,46 @@

    Response

    Table 2 Request parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    name

    +

    name

    No

    +

    No

    String

    Name of a job. Length range: 0 to 57 characters.

    desc

    +

    desc

    No

    +

    No

    String

    Job description. Length range: 0 to 512 characters.

    queue_name

    +

    queue_name

    No

    +

    No

    String

    Name of a queue. The value can contain 0 to 128 characters.

    sql_body

    +

    sql_body

    No

    +

    No

    String

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

    run_mode

    +

    run_mode

    No

    +

    No

    String

    cu_number

    +

    cu_number

    No

    +

    No

    Integer

    Number of CUs selected for a job. The default value is 2.

    parallel_number

    +

    parallel_number

    No

    +

    No

    Integer

    Number of parallel jobs set by a user. The default value is 1.

    checkpoint_enabled

    +

    checkpoint_enabled

    No

    +

    No

    Boolean

    checkpoint_mode

    +

    checkpoint_mode

    No

    +

    No

    Integer

    checkpoint_interval

    +

    checkpoint_interval

    No

    +

    No

    Integer

    Snapshot interval. The unit is second. The default value is 10.

    obs_bucket

    +

    obs_bucket

    No

    +

    No

    String

    OBS path where users are authorized to save the snapshot. This parameter is valid only when checkpoint_enabled is set to true.

    -

    OBS path where users are authorized to save the snapshot. This parameter is valid only when log_enabled is set to true.

    +

    OBS bucket where users are authorized to save the snapshot. This parameter is valid only when checkpoint_enabled is set to true.

    +

    OBS bucket where users are authorized to save the snapshot. This parameter is valid only when log_enabled is set to true.

    log_enabled

    +

    log_enabled

    No

    +

    No

    Boolean

    Whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.

    smn_topic

    +

    smn_topic

    No

    +

    No

    String

    SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.

    restart_when_exception

    +

    restart_when_exception

    No

    +

    No

    Boolean

    Whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.

    idle_state_retention

    +

    idle_state_retention

    No

    +

    No

    Integer

    Expiration time, in seconds. The default value is 3600.

    edge_group_ids

    +

    edge_group_ids

    No

    +

    No

    Array of Strings

    List of edge computing group IDs. Use commas (,) to separate multiple IDs.

    dirty_data_strategy

    +

    dirty_data_strategy

    No

    +

    No

    String

    udf_jar_url

    +

    udf_jar_url

    No

    +

    No

    String

    Name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.

    manager_cu_number

    +

    manager_cu_number

    No

    +

    No

    Integer

    Number of CUs in the JobManager selected for a job. The default value is 1.

    tm_cus

    +

    tm_cus

    No

    +

    No

    Integer

    Number of CUs for each TaskManager. The default value is 1.

    tm_slot_num

    +

    tm_slot_num

    No

    +

    No

    Integer

    Number of slots in each TaskManager. The default value is (parallel_number*tm_cus)/(cu_number-manager_cu_number).

    operator_config

    +

    operator_config

    No

    +

    No

    String

    Degree of parallelism (DOP) of an operator.

    resume_checkpoint

    +

    resume_checkpoint

    No

    +

    No

    Boolean

    Whether the abnormal restart is recovered from the checkpoint.

    resume_max_num

    +

    resume_max_num

    No

    +

    No

    Integer

    Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is -1, indicating that the number of times is unlimited.

    static_estimator_config

    +

    static_estimator_config

    No

    +

    No

    String

    runtime_config

    +

    runtime_config

    No

    +

    No

    String

    Customizes optimization parameters when a Flink job is running.

    flink_version

    +

    flink_version

    No

    +

    No

    String

    - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    is_success

    No

    +

    No

    Boolean

    +

    String

    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.

    message

    No

    +

    No

    String

    +

    String

    Message content.

    +

    Message content.

    job

    No

    +

    No

    Object

    +

    Object

    Information about job update. For details, see Table 4.

    +

    Information about job update. For details, see Table 4.
    -
    Table 4 job parameters

    Parameter

    +
    @@ -430,7 +430,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0230.html b/docs/dli/api-ref/dli_02_0230.html index a1eedd62..1d9f805f 100644 --- a/docs/dli/api-ref/dli_02_0230.html +++ b/docs/dli/api-ref/dli_02_0230.html @@ -30,217 +30,217 @@

    Request

    -
    Table 4 job parameter

    Parameter

    Mandatory
    Table 2 Parameter description

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -249,9 +249,9 @@
    Table 2 Parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    Yes

    +

    Yes

    String

    +

    String

    Name of the job. The value can contain 1 to 57 characters.

    +

    Name of the job. The value can contain 1 to 57 characters.

    desc

    +

    desc

    No

    +

    No

    String

    +

    String

    Job description. Length range: 0 to 512 characters.

    +

    Job description. Length range: 0 to 512 characters.

    queue_name

    +

    queue_name

    No

    +

    No

    String

    +

    String

    Name of a queue. The value can contain 0 to 128 characters.

    +

    Name of a queue. The value can contain 0 to 128 characters.

    cu_number

    +

    cu_number

    No

    +

    No

    Integer

    +

    Integer

    Number of CUs selected for a job.

    +

    Number of CUs selected for a job.

    manager_cu_number

    +

    manager_cu_number

    No

    +

    No

    Integer

    +

    Integer

    Number of CUs on the management node selected by the user for a job, which corresponds to the number of Flink job managers. The default value is 1.

    +

    Number of CUs on the management node selected by the user for a job, which corresponds to the number of Flink job managers. The default value is 1.

    parallel_number

    +

    parallel_number

    No

    +

    No

    Integer

    +

    Integer

    Number of parallel operations selected for a job.

    +

    Number of parallel operations selected for a job.

    log_enabled

    +

    log_enabled

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to enable the job log function.

    +

    Whether to enable the job log function.

    • true: indicates to enable the job log function.
    • false: indicates to disable the job log function.
    • Default value: false

    obs_bucket

    +

    obs_bucket

    No

    +

    No

    String

    +

    String

    OBS bucket where users are authorized to save logs when log_enabled is set to true.

    +

    OBS bucket where users are authorized to save logs when log_enabled is set to true.

    smn_topic

    +

    smn_topic

    No

    +

    No

    String

    +

    String

    SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.

    +

    SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.

    main_class

    +

    main_class

    No

    +

    No

    String

    +

    String

    Job entry class.

    +

    Job entry class.

    entrypoint_args

    +

    entrypoint_args

    No

    +

    No

    String

    +

    String

    Job entry parameter. Multiple parameters are separated by spaces.

    +

    Job entry parameter. Multiple parameters are separated by spaces.

    restart_when_exception

    +

    restart_when_exception

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to enable the function of restart upon exceptions. The default value is false.

    +

    Whether to enable the function of restart upon exceptions. The default value is false.

    entrypoint

    +

    entrypoint

    No

    +

    No

    String

    +

    String

    Name of the package that has been uploaded to the DLI resource management system. This parameter is used to customize the JAR file where the job main class is located.

    +

    Name of the package that has been uploaded to the DLI resource management system. This parameter is used to customize the JAR file where the job main class is located.

    dependency_jars

    +

    dependency_jars

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Name of the package that has been uploaded to the DLI resource management system. This parameter is used to customize other dependency packages.

    +

    Name of the package that has been uploaded to the DLI resource management system. This parameter is used to customize other dependency packages.

    Example: myGroup/test.jar,myGroup/test1.jar.

    dependency_files

    +

    dependency_files

    No

    +

    No

    Array of Strings

    +

    Array of Strings

    Name of the resource package that has been uploaded to the DLI resource management system. This parameter is used to customize dependency files.

    +

    Name of the resource package that has been uploaded to the DLI resource management system. This parameter is used to customize dependency files.

    Example: myGroup/test.cvs,myGroup/test1.csv.

    You can add the following content to the application to access the corresponding dependency file: In the command, fileName indicates the name of the file to be accessed, and ClassName indicates the name of the class that needs to access the file.

    ClassName.class.getClassLoader().getResource("userData/fileName")

    tm_cus

    +

    tm_cus

    No

    +

    No

    Integer

    +

    Integer

    Number of CUs for each TaskManager. The default value is 1.

    +

    Number of CUs for each TaskManager. The default value is 1.

    tm_slot_num

    +

    tm_slot_num

    No

    +

    No

    Integer

    +

    Integer

    Number of slots in each TaskManager. The default value is (parallel_number*tm_cus)/(cu_number-manager_cu_number).

    +

    Number of slots in each TaskManager. The default value is (parallel_number*tm_cus)/(cu_number-manager_cu_number).

    resume_checkpoint

    +

    resume_checkpoint

    No

    +

    No

    Boolean

    +

    Boolean

    Whether the abnormal restart is recovered from the checkpoint.

    +

    Whether the abnormal restart is recovered from the checkpoint.

    resume_max_num

    +

    resume_max_num

    No

    +

    No

    Integer

    +

    Integer

    Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is -1, indicating that the number of times is unlimited.

    +

    Maximum number of retry times upon exceptions. The unit is times/hour. Value range: -1 or greater than 0. The default value is -1, indicating that the number of times is unlimited.

    checkpoint_path

    +

    checkpoint_path

    No

    +

    No

    String

    +

    String

    Storage address of the checkpoint in the JAR file of the user. The path must be unique.

    +

    Storage address of the checkpoint in the JAR file of the user. The path must be unique.

    tags

    +

    tags

    No

    +

    No

    Array of Objects

    +

    Array of objects

    Label of a Flink JAR job. For details, see Table 3.

    +

    Label of a Flink JAR job. For details, see Table 3.

    runtime_config

    +

    runtime_config

    No

    +

    No

    String

    +

    String

    Customizes optimization parameters when a Flink job is running.

    +

    Customizes optimization parameters when a Flink job is running.
    - - @@ -259,20 +259,26 @@ - - - - @@ -294,7 +300,7 @@ - @@ -426,7 +432,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0231.html b/docs/dli/api-ref/dli_02_0231.html index 2873835d..bff75d36 100644 --- a/docs/dli/api-ref/dli_02_0231.html +++ b/docs/dli/api-ref/dli_02_0231.html @@ -100,7 +100,7 @@ - - - @@ -377,7 +377,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0233.html b/docs/dli/api-ref/dli_02_0233.html index 5889860c..97a8e988 100644 --- a/docs/dli/api-ref/dli_02_0233.html +++ b/docs/dli/api-ref/dli_02_0233.html @@ -172,7 +172,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0234.html b/docs/dli/api-ref/dli_02_0234.html index 8426846c..63f18e8d 100644 --- a/docs/dli/api-ref/dli_02_0234.html +++ b/docs/dli/api-ref/dli_02_0234.html @@ -1,7 +1,7 @@ -

    Querying the Job List

    -

    Function

    This API is used to query the list of the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can also query jobs in specific status, for example, in running status or other. By default, all jobs are queried.

    +

    Listing Jobs

    +

    Function

    This API is used to list the current user's jobs. You can set the job ID as the ID and query jobs whose IDs are greater than or less than the ID. You can also query jobs in specific status, for example, in running status or other. By default, all jobs are queried.

    URI

    • URI format

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

    • Parameter description @@ -28,109 +28,109 @@
    Table 3 tags parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    key

    Yes

    +

    Yes

    String

    +

    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.

    +
    +
    NOTE:

    A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

    +

    value

    Yes

    +

    Yes

    String

    +

    String

    Tag key.

    +
    NOTE:

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

    +

    No

    Boolean

    +

    String

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

    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

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

    String

    OBS path where users are authorized to save logs when log_enabled is set to true.

    +

    OBS bucket where users are authorized to save logs when log_enabled is set to true.

    smn_topic

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

    No

    Boolean

    +

    String

    Whether the request is successfully executed. Value true indicates that the request is successfully executed.
    -
    Table 2 query parameter description

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -155,7 +155,7 @@ - @@ -205,7 +205,7 @@ - @@ -214,214 +214,250 @@
    Table 2 query parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    job_type

    +

    job_type

    No

    +

    No

    String

    +

    String

    Job type.

    +

    Job type.

    • flink_sql_job: Flink SQL job
    • flink_jar_job: User-defined Flink job

    status

    +

    status

    No

    +

    No

    String

    +

    String

    Job status code.

    +

    Job status code.

    Available job statuses are as follows:

    • job_init: The job is in the draft status.
    • job_submitting: The job is being submitted.
    • job_submit_fail: The job fails to be submitted.
    • job_running: The job is running. (After the job is submitted, a normal result is returned.)
    • job_running_exception (The job stops running due to an exception.)
    • job_downloading: The job is being downloaded.
    • job_idle: The job is idle.
    • job_canceling: The job is being stopped.
    • job_cancel_success: The job has been stopped.
    • job_cancel_fail: The job fails to be stopped.
    • job_savepointing: The savepoint is being created.
    • job_finish: The job is completed.

    queue_name

    +

    queue_name

    No

    +

    No

    String

    +

    String

    Name of a queue.

    +

    Name of a queue.

    order

    +

    order

    No

    +

    No

    String

    +

    String

    Sorting style of the query results.

    +

    Sorting style of the query results.

    • asc: by time in ascending order
    • desc: by time in descending order

    The default value is desc.

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

    Number of returned data records. The default value is 10 and the maximum value is 100.

    +

    Number of returned data records. The default value is 10 and the maximum value is 100.

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Name of the job. Length range: 0 to 57 characters.

    +

    Name of the job. Length range: 0 to 57 characters.

    offset

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Job offset.

    +

    Job offset.

    show_detail

    +

    show_detail

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to return job details. The default value is false. If this parameter is set to true, the job details are returned. For details, see Querying Job Details.

    +

    Whether to return job details. The default value is false. If this parameter is set to true, the job details are returned. For details, see Querying Job Details.

    user_name

    +

    user_name

    No

    +

    No

    String

    +

    String

    Username, which can be used as a filter.

    +

    Username, which can be used as a filter.

    tags

    +

    tags

    No

    +

    No

    String

    +

    String

    Specifies a label for filtering.

    +

    Specifies a label for filtering.

    No

    Boolean

    +

    String

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

    No

    Array of Objects

    +

    Array of objects

    Information about a job. For details, see Table 5.

    -
    - - @@ -55,27 +55,27 @@ - - - - - - @@ -84,187 +84,250 @@
    Table 5 Jobs parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + @@ -636,6 +672,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Jobs parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    job_id

    +

    job_id

    No

    +

    No

    Long

    +

    Long

    Job ID.

    +

    Job ID.

    name

    +

    name

    No

    +

    No

    String

    +

    String

    Name of the job. Length range: 0 to 57 characters.

    +

    Name of the job. Length range: 0 to 57 characters.

    desc

    +

    desc

    No

    +

    No

    String

    +

    String

    Job description. Length range: 0 to 512 characters.

    +

    Job description. Length range: 0 to 512 characters.

    user_name

    +

    user_name

    No

    +

    No

    String

    +

    String

    Username. This parameter is valid only when show_detail is set to false.

    +

    Username. This parameter is valid only when show_detail is set to false.

    job_type

    +

    job_type

    No

    +

    No

    String

    +

    String

    Job type.

    +

    Job type.

    • flink_sql_job: Flink SQL job
    • flink_jar_job: User-defined Flink job

    status

    +

    status

    No

    +

    No

    String

    +

    String

    Job status.

    +

    Job status.

    status_desc

    +

    status_desc

    No

    +

    No

    String

    +

    String

    Description of job status.

    +

    Description of job status.

    create_time

    +

    create_time

    No

    +

    No

    Long

    +

    Long

    Time when a job is created.

    +

    Time when a job is created.

    start_time

    +

    start_time

    No

    +

    No

    Long

    +

    Long

    Time when a job is started. The value 0 indicates that the process is not started.

    +

    Time when a job is started. The value 0 indicates that the process is not started.

    duration

    +

    duration

    No

    +

    No

    Long

    +

    Long

    Running duration of a job. Unit: ms. This parameter is valid only when show_detail is set to false.

    +

    Running duration of a job. Unit: ms. This parameter is valid only when show_detail is set to false.

    root_id

    +

    root_id

    No

    +

    No

    Long

    +

    Long

    Parent job ID. This parameter is valid only when show_detail is set to false.

    +

    Parent job ID. This parameter is valid only when show_detail is set to false.

    graph_editor_enabled

    +

    graph_editor_enabled

    No

    +

    No

    Boolean

    +

    Boolean

    Whether the flow diagram can be edited. Value true indicates that the flow diagram can be edited, and false indicates that the flow diagram cannot be edited.

    +

    Whether the flow diagram can be edited. Value true indicates that the flow diagram can be edited, and false indicates that the flow diagram cannot be edited.

    has_savepoint

    +

    has_savepoint

    No

    +

    No

    Boolean

    +

    Boolean

    Whether a job has a savepoint. Value true indicates that the job has a savepoint, and false indicates that the job does not have a savepoint.

    +

    Whether a job has a savepoint. Value true indicates that the job has a savepoint, and false indicates that the job does not have a savepoint.

    user_id

    +

    user_id

    No

    +

    No

    String

    +

    String

    ID of the user who creates the job. This parameter is valid only when show_detail is set to true.

    +

    ID of the user who creates the job. This parameter is valid only when show_detail is set to true.

    project_id

    +

    project_id

    No

    +

    No

    String

    +

    String

    ID of the project to which a job belongs. This parameter is valid only when show_detail is set to true.

    +

    ID of the project to which a job belongs. This parameter is valid only when show_detail is set to true.

    sql_body

    +

    sql_body

    No

    +

    No

    String

    +

    String

    Stream SQL statement. This parameter is valid only when show_detail is set to false.

    +

    Stream SQL statement. This parameter is valid only when show_detail is set to false.

    run_mode

    +

    run_mode

    No

    +

    No

    String

    +

    String

    Job running mode. The options are as follows: The value can be shared_cluster, exclusive_cluster, or edge_node. This parameter is valid only when show_detail is set to true.

    +

    Job running mode. The options are as follows: The value can be shared_cluster, exclusive_cluster, or edge_node. This parameter is valid only when show_detail is set to true.

    • shared_cluster: indicates that the job is running on a shared cluster.
    • exclusive_cluster: indicates that the job is running on an exclusive cluster.
    • edge_node: indicates that the job is running on an edge node.

    job_config

    +

    job_config

    No

    +

    No

    Object

    +

    Object

    Job configuration. This parameter is valid only when show_detail is set to false. For details, see Table 6.

    +

    Job configuration. This parameter is valid only when show_detail is set to false. For details, see Table 6.

    main_class

    +

    main_class

    No

    +

    No

    String

    +

    String

    Main class of a JAR package. This parameter is valid only when show_detail is set to false.

    +

    Main class of a JAR package. This parameter is valid only when show_detail is set to false.

    entrypoint_args

    +

    entrypoint_args

    No

    +

    No

    String

    +

    String

    Job running parameter of the JAR file. Multiple parameters are separated by spaces. This parameter is valid only when show_detail is set to true.

    +

    Job running parameter of the JAR file. Multiple parameters are separated by spaces. This parameter is valid only when show_detail is set to true.

    execution_graph

    +

    execution_graph

    No

    +

    No

    String

    +

    String

    Job execution plan. This parameter is valid only when show_detail is set to false.

    +

    Job execution plan. This parameter is valid only when show_detail is set to false.

    update_time

    +

    update_time

    No

    +

    No

    Long

    +

    Long

    Time when a job is updated. This parameter is valid only when show_detail is set to false.

    +

    Time when a job is updated. This parameter is valid only when show_detail is set to false.

    +

    queue_name

    +

    No

    +

    String

    +

    Queue name

    +

    edge_group_ids

    +

    No

    +

    Array of Strings

    +

    List of edge computing group IDs. Use commas (,) to separate multiple IDs.

    +

    restart_times

    +

    No

    +

    Integer

    +

    Number of restart times

    +

    savepoint_path

    +

    No

    +

    String

    +

    Path for storing manually generated checkpoints

    Whether to restore data from the latest checkpoint when the system automatically restarts upon an exception. The default value is false.

    runtime_config

    +

    No

    +

    String

    +

    Customizes optimization parameters when a Flink job is running.

    +

    graph_editor_enabled

    +

    No

    +

    Boolean

    +

    Whether to enable flow diagram editing. The default value is false.

    +

    graph_editor_data

    +

    No

    +

    String

    +

    Edited stream graph data. The default value is null.

    +

    resume_max_num

    +

    No

    +

    Integer

    +

    Maximum retry attempts. –1 indicates there is no upper limit.

    +

    checkpoint_path

    +

    No

    +

    String

    +

    Path for saving the checkpoint.

    +

    config_url

    +

    No

    +

    String

    +

    OBS path of the config package uploaded by the user.

    +

    tm_cus

    +

    No

    +

    int

    +

    Number of CUs per TaskManager node.

    +

    tm_slot_num

    +

    No

    +

    int

    +

    Number of slots per TaskManager node.

    +

    image

    +

    No

    +

    String

    +

    Custom image. The format is Organization name/Image name:Image version.

    +

    This parameter is valid only when feature is set to custom. You can use this parameter with the feature parameter to specify a user-defined Flink image for job running.

    +

    feature

    +

    No

    +

    String

    +

    User-defined job feature. Type of the Flink image used by a job.

    +
    • basic: indicates that the basic Flink image provided by DLI is used.
    • custom: indicates that the user-defined Flink image is used.
    +

    flink_version

    +

    No

    +

    String

    +

    Flink version. This parameter is valid only when feature is set to basic. You can use this parameter with the feature parameter to specify the version of the DLI basic Flink image used for job running.

    +

    operator_config

    +

    No

    +

    String

    +

    Operator's parallelism degree. The operator ID and degree of parallelism are displayed in JSON format.

    +

    static_estimator_config

    +

    No

    +

    String

    +

    Estimation of static flow diagram resources.

    +

    real_cu_number

    +

    No

    +

    Integer

    +

    Number of actually used CUs. The default value is 0, indicating that the value of cu_number is used.

    +
    @@ -693,7 +857,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0235.html b/docs/dli/api-ref/dli_02_0235.html index ab395581..84cd403c 100644 --- a/docs/dli/api-ref/dli_02_0235.html +++ b/docs/dli/api-ref/dli_02_0235.html @@ -45,9 +45,9 @@

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    No

    Boolean

    +

    String

    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.

    message

    No

    String

    +

    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.

    job_detail

    No

    Object

    +

    Object

    Job details. For details, see Table 3.

    +

    Job details. For details, see Table 3.
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -569,6 +632,15 @@ + + + + +
    Table 3 job_detail parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    job_id

    No

    +

    No

    Long

    +

    Long

    Job ID.

    +

    Job ID.

    name

    No

    +

    No

    String

    +

    String

    Name of the job. Length range: 0 to 57 characters.

    +

    Name of the job. Length range: 0 to 57 characters.

    desc

    No

    +

    No

    String

    +

    String

    Job description. Length range: 0 to 512 characters.

    +

    Job description. Length range: 0 to 512 characters.

    job_type

    No

    +

    No

    String

    +

    String

    Job type.

    +

    Job type.

    • flink_sql_job: Flink SQL job
    • flink_jar_job: User-defined Flink job

    status

    No

    +

    No

    String

    +

    String

    Job status.

    +

    Job status.

    Available job statuses are as follows:

    • job_init: The job is in the draft status.
    • job_submitting: The job is being submitted.
    • job_submit_fail: The job fails to be submitted.
    • job_running: The job is running. (After the job is submitted, a normal result is returned.)
    • job_running_exception (The job stops running due to an exception.)
    • job_downloading: The job is being downloaded.
    • job_idle: The job is idle.
    • job_canceling: The job is being stopped.
    • job_cancel_success: The job has been stopped.
    • job_cancel_fail: The job fails to be stopped.
    • job_savepointing: The savepoint is being created.
    • job_finish: The job is completed.

    status_desc

    No

    +

    No

    String

    +

    String

    Description of job status.

    +

    Description of job status.

    create_time

    No

    +

    No

    Long

    +

    Long

    Time when a job is created.

    +

    Time when a job is created.

    start_time

    No

    +

    No

    Long

    +

    Long

    Time when a job is started.

    +

    Time when a job is started.

    user_id

    No

    +

    No

    String

    +

    String

    ID of the user who creates the job.

    +

    ID of the user who creates the job.

    queue_name

    No

    +

    No

    String

    +

    String

    Name of a queue. Length range: 1 to 128 characters.

    +

    Name of a queue. Length range: 1 to 128 characters.

    project_id

    No

    +

    No

    String

    +

    String

    ID of the project to which a job belongs.

    +

    ID of the project to which a job belongs.

    sql_body

    No

    +

    No

    String

    +

    String

    Stream SQL statement.

    +

    Stream SQL statement.

    savepoint_path

    No

    +

    No

    String

    +

    String

    Path for storing manually generated checkpoints.

    +

    Path for storing manually generated checkpoints.

    run_mode

    No

    +

    No

    String

    +

    String

    Job running mode. The options are as follows:

    +

    Job running mode. The options are as follows:

    • shared_cluster: indicates that the job is running on a shared cluster.
    • exclusive_cluster: indicates that the job is running on an exclusive cluster.
    • edge_node: indicates that the job is running on an edge node.

    job_config

    No

    +

    No

    Object

    +

    Object

    Job configurations. Refer to Table 4 for details.

    +

    Job configurations. Refer to Table 4 for details.

    main_class

    No

    +

    No

    String

    +

    String

    Main class of a JAR package, for example, org.apache.spark.examples.streaming.JavaQueueStream.

    +

    Main class of a JAR package, for example, org.apache.spark.examples.streaming.JavaQueueStream.

    entrypoint_args

    No

    +

    No

    String

    +

    String

    Running parameter of a JAR package job. Multiple parameters are separated by spaces.

    +

    Running parameter of a JAR package job. Multiple parameters are separated by spaces.

    execution_graph

    No

    +

    No

    String

    +

    String

    Job execution plan.

    +

    Job execution plan.

    update_time

    No

    +

    No

    Long

    +

    Long

    Time when a job is updated.

    +

    Time when a job is updated.

    +

    user_name

    +

    No

    +

    String

    +

    Username. This parameter is valid only when show_detail is set to false.

    +

    duration

    +

    No

    +

    Long

    +

    Running duration of a job. Unit: ms. This parameter is valid only when show_detail is set to false.

    +

    root_id

    +

    No

    +

    Long

    +

    Parent job ID. This parameter is valid only when show_detail is set to false.

    +

    graph_editor_enabled

    +

    No

    +

    Boolean

    +

    Whether the stream graph of a job can be edited. Value true indicates that the flow diagram can be edited, and false indicates that the flow diagram cannot be edited.

    +

    has_savepoint

    +

    No

    +

    Boolean

    +

    Whether savepointing is enabled for the job. Value true indicates that the job has a savepoint, and false indicates that the job does not have a savepoint.

    +

    edge_group_ids

    +

    No

    +

    Array of Strings

    +

    List of edge computing group IDs. Use commas (,) to separate multiple IDs.

    +

    restart_times

    +

    No

    +

    Integer

    +

    Number of restart times

    Customizes optimization parameters when a Flink job is running.

    real_cu_number

    +

    No

    +

    Integer

    +

    Number of actually used CUs. The default value is 0, indicating that the value of cu_number is used.

    +
    @@ -658,7 +730,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0236.html b/docs/dli/api-ref/dli_02_0236.html index 25821dee..21c6337d 100644 --- a/docs/dli/api-ref/dli_02_0236.html +++ b/docs/dli/api-ref/dli_02_0236.html @@ -201,7 +201,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0238.html b/docs/dli/api-ref/dli_02_0238.html new file mode 100644 index 00000000..7a76b664 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0238.html @@ -0,0 +1,309 @@ + + +

    Querying Job Monitoring Information (Discarded)

    +

    Function

    This API is used to query job monitoring information. You can query monitoring information about multiple jobs at the same time.

    +

    This API has been discarded and is not recommended.

    +
    +
    +

    URI

    • URI format

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

      +
    • Parameter description +
      + + + + + + + + + + + +
      Table 1 URI parameter

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

      +
      +
      +
    +
    +

    Request

    +
    + + + + + + + + + + + +
    Table 2 Request parameter

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    job_ids

    +

    Yes

    +

    Array of Long

    +

    List of job IDs.

    +
    +
    +
    +

    Response

    +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    is_success

    +

    No

    +

    Boolean

    +

    Indicates whether the request is successful.

    +

    message

    +

    No

    +

    String

    +

    Message content.

    +

    metrics

    +

    No

    +

    Object

    +

    Information about a job list. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 4 payload parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    jobs

    +

    No

    +

    Array of objects

    +

    Monitoring information about all jobs. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 5 jobs parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    job_id

    +

    No

    +

    Long

    +

    Job ID.

    +

    metrics

    +

    No

    +

    Object

    +

    All input and output monitoring information about a job. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6 metrics parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    sources

    +

    No

    +

    Array of objects

    +

    All source streams. For details, see Table 7.

    +

    sinks

    +

    No

    +

    Array of objects

    +

    All sink streams. For details, see Table 7.

    +

    total_read_rate

    +

    No

    +

    Double

    +

    Total read rate.

    +

    total_write_rate

    +

    No

    +

    Double

    +

    Total write rate.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 7 source/sinks parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    String

    +

    Name of the source or sink stream.

    +

    records

    +

    No

    +

    Long

    +

    Total number of records.

    +

    corrupted_records

    +

    No

    +

    Long

    +

    Number of dirty data records.

    +
    +
    +
    +

    Example

    • Example request
      {
+    "job_ids": [298765, 298766]
+}
      +
    • Example response
      {
+    "is_success": true,
+    "message": "Message content",
+    "metrics": {
+        "jobs": [
+            {
+                "job_id": 0,
+                "metrics": {
+                    "sources": [
+                        {
+                            "name": "Source: KafKa_6070_KAFKA_SOURCE",
+                            "records": 0,
+                            "corrupted_records": 0
+                        }
+                    ],
+                    "sinks": [
+                        {
+                            "name": "Source: KafKa_6070_KAFKA_SOURCE",
+                            "records": 0,
+                            "corrupted_records": 0
+                        }
+                    ],
+                    "total_read_rate": 100,
+                    "total_write_rate": 100
+                }
+            }
+        ]
+    }
+}
      +
    +
    +

    Status Codes

    +
    + + + + + + + + + + +
    Table 8 Status codes

    Status Code

    +

    Description

    +

    200

    +

    The query of job monitoring information succeeds.

    +

    400

    +

    The input parameter is invalid.

    +
    +
    +
    +

    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 1d3d6262..bed0025b 100644 --- a/docs/dli/api-ref/dli_02_0241.html +++ b/docs/dli/api-ref/dli_02_0241.html @@ -155,7 +155,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0242.html b/docs/dli/api-ref/dli_02_0242.html index a93374df..9ffb329e 100644 --- a/docs/dli/api-ref/dli_02_0242.html +++ b/docs/dli/api-ref/dli_02_0242.html @@ -109,7 +109,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0243.html b/docs/dli/api-ref/dli_02_0243.html index 946a2e51..44bdc95f 100644 --- a/docs/dli/api-ref/dli_02_0243.html +++ b/docs/dli/api-ref/dli_02_0243.html @@ -123,7 +123,7 @@
    -
    Parent topic: APIs Related to Flink Jobs
    +
    Parent topic: Flink Job-related APIs
    diff --git a/docs/dli/api-ref/dli_02_0245.html b/docs/dli/api-ref/dli_02_0245.html index 3d66601b..bd64a8ee 100644 --- a/docs/dli/api-ref/dli_02_0245.html +++ b/docs/dli/api-ref/dli_02_0245.html @@ -5,23 +5,23 @@

    URI

    • URI format

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

    • Parameter description -
      Table 1 URI parameter

      Parameter

      +
      - - - - - - - @@ -30,59 +30,59 @@

      Request

      -
      Table 1 URI parameter

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

      +

      Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
      Table 2 Request parameters

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - @@ -91,9 +91,9 @@
      Table 2 Request parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      name

      +

      name

      Yes

      +

      Yes

      String

      +

      String

      Template name. The value can contain 1 to 64 characters.

      +

      Template name. The value can contain 1 to 64 characters.

      desc

      +

      desc

      No

      +

      No

      String

      +

      String

      Template description. Length range: 0 to 512 characters.

      +

      Template description. Length range: 0 to 512 characters.

      sql_body

      +

      sql_body

      No

      +

      No

      String

      +

      String

      Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 0 to 2,048 characters.

      +

      Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 0 to 2,048 characters.

      tags

      +

      tags

      No

      +

      No

      Array of Objects

      +

      Array of objects

      Label of a Flink job template. For details, see Table 3.

      +

      Label of a Flink job template. For details, see Table 3.

      job_type

      +

      job_type

      No

      +

      No

      String

      +

      String

      Flink job template type.

      +

      Flink job template type.

      - - @@ -101,20 +101,26 @@ - - - - @@ -122,100 +128,100 @@

      Response

      -
      Table 3 tags parameter

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      key

      Yes

      +

      Yes

      String

      +

      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.

      +
      +
      NOTE:

      A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the value cannot start or end with a space or start with _sys_.

      +

      value

      Yes

      +

      Yes

      String

      +

      String

      Tag key.

      +
      NOTE:

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

      +
      Table 4 Response parameters

      Parameter

      +
      - - - - - - - - - - - - - - -
      Table 4 Response parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      is_success

      +

      is_success

      No

      +

      No

      Boolean

      +

      Boolean

      Indicates whether the request is successful.

      +

      Indicates whether the request is successful.

      message

      +

      message

      No

      +

      No

      String

      +

      String

      Message content.

      +

      Message content.

      template

      +

      template

      No

      +

      No

      Object

      +

      Object

      Information about job update. For details, see Table 5.

      +

      Information about job update. For details, see Table 5.
      -
      Table 5 template parameters

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - @@ -226,7 +232,8 @@ 
      {
     "name": "simple_stream_sql",
     "desc": "Example of quick start",
-    "sql_body": "select * from source_table"
+    "sql_body": "select * from source_table",
+    "job_type": "flink_sql_job"
 }

      Example Response

      {
@@ -237,7 +244,7 @@
         "name": "IoT_example",
        "desc": "Example of quick start",
         "create_time": 1516952710040,
-        "job_type": "flink_sql_job"
+        "job_type": "flink_opensource_sql_job"
     }
 }
      diff --git a/docs/dli/api-ref/dli_02_0250.html b/docs/dli/api-ref/dli_02_0250.html index 913fedaf..89bb6740 100644 --- a/docs/dli/api-ref/dli_02_0250.html +++ b/docs/dli/api-ref/dli_02_0250.html @@ -1,7 +1,9 @@ -

      Obtaining the Partition List

      -

      Function

      This API is used to obtain the partition list.

      +

      Listing Partitions (Discarded)

      +

      Function

      This API is used to list partitions.

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

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

      • Parameter description @@ -135,9 +137,9 @@
      Table 5 template parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      template_id

      +

      template_id

      No

      +

      No

      Long

      +

      Long

      Template ID.

      +

      Template ID.

      name

      +

      name

      No

      +

      No

      String

      +

      String

      Template name.

      +

      Template name.

      desc

      +

      desc

      No

      +

      No

      String

      +

      String

      Template description.

      +

      Template description.

      create_time

      +

      create_time

      No

      +

      No

      Long

      +

      Long

      Time when the template is created.

      +

      Time when the template is created.

      job_type

      +

      job_type

      No

      +

      No

      String

      +

      String

      Job template type

      +

      Job template type
      - - @@ -145,18 +147,18 @@ - - - - @@ -339,7 +341,7 @@
      -
      Parent topic: Table-related APIs
      +
      Parent topic: Table-related APIs (Discarded)
      diff --git a/docs/dli/api-ref/dli_02_0252.html b/docs/dli/api-ref/dli_02_0252.html index d8833c3a..c57b6dee 100644 --- a/docs/dli/api-ref/dli_02_0252.html +++ b/docs/dli/api-ref/dli_02_0252.html @@ -82,66 +82,66 @@

      Response

      Table 4 partitions parameter description

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      total_count

      Yes

      +

      Yes

      Long

      +

      Long

      Total number of partitions.

      partition_infos

      Yes

      +

      Yes

      Array of Objects

      +

      Array of objects

      List of partitions. For details, see Table 5.
      - - - - - - - - - - - - - - - - - - - - - @@ -152,37 +152,46 @@ - - - + + + + + - - - - - - diff --git a/docs/dli/api-ref/dli_02_0253.html b/docs/dli/api-ref/dli_02_0253.html index 19b0b154..fe50326f 100644 --- a/docs/dli/api-ref/dli_02_0253.html +++ b/docs/dli/api-ref/dli_02_0253.html @@ -1,7 +1,9 @@ -

      Changing the Owner of a Group or Resource Package

      +

      Changing the Owner of a Group or Resource Package (Discarded)

      Function

      This API is used to change the owner of a program package.

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

        PUT /v2.0/{project_id}/resources/owner

      • Parameter description @@ -161,7 +163,7 @@
      diff --git a/docs/dli/api-ref/dli_02_0254.html b/docs/dli/api-ref/dli_02_0254.html index 484b114b..347bddf3 100644 --- a/docs/dli/api-ref/dli_02_0254.html +++ b/docs/dli/api-ref/dli_02_0254.html @@ -155,7 +155,7 @@
      -
      Parent topic: APIs Related to Flink Jobs
      +
      Parent topic: Flink Job-related APIs
      diff --git a/docs/dli/api-ref/dli_02_0255.html b/docs/dli/api-ref/dli_02_0255.html index de070694..c835fcd7 100644 --- a/docs/dli/api-ref/dli_02_0255.html +++ b/docs/dli/api-ref/dli_02_0255.html @@ -192,7 +192,7 @@
      -
      Parent topic: APIs Related to Flink Jobs
      +
      Parent topic: Flink Job-related APIs
      diff --git a/docs/dli/api-ref/dli_02_0258.html b/docs/dli/api-ref/dli_02_0258.html index 75ffd163..2c0b1440 100644 --- a/docs/dli/api-ref/dli_02_0258.html +++ b/docs/dli/api-ref/dli_02_0258.html @@ -5,7 +5,7 @@

      URI

      • URI format

        POST /v1.0/{project_id}/variables

      • Parameter description -
      Table 3 Response parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      is_success

      Yes

      +

      Yes

      Boolean

      +

      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.

      message

      Yes

      +

      Yes

      String

      +

      String

      Indicates the system prompt. If execution succeeds, this parameter may be left blank.

      +

      Indicates the system prompt. If execution succeeds, this parameter may be left blank.

      object_name

      Yes

      +

      No

      String

      +

      String

      Object name.

      +

      Object name.

      object_type

      Yes

      +

      No

      String

      +

      String

      Object type.

      +

      Object type.

      privileges

      No

      +

      No

      Array of Object

      +

      Array of Object

      Permission information. For details, see Table 4.

      +

      Permission information. For details, see Table 4.

      count

      No

      +

      No

      Integer

      +

      Integer

      Total number of permissions.

      +

      Total number of permissions.

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      is_admin

      +

      object

      +

      No

      +

      String

      +

      Data object whose permissions are to be granted, which corresponds to the object in the permission assignment API.

      +

      is_admin

      No

      Boolean

      +

      Boolean

      Whether the database user is an administrator.

      +

      Whether the database user is an administrator.

      user_name

      No

      String

      +

      String

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

      +

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

      privileges

      No

      Array of Strings

      +

      Array of Strings

      Permission of the user on the database.

      +

      Permission of the user on the database.
      Table 1 URI parameters

      Parameter

      +
      diff --git a/docs/dli/api-ref/dli_02_0291.html b/docs/dli/api-ref/dli_02_0291.html index f142f158..7b71bde1 100644 --- a/docs/dli/api-ref/dli_02_0291.html +++ b/docs/dli/api-ref/dli_02_0291.html @@ -1,7 +1,9 @@ -

      Creating a Scheduled CU Change

      +

      Creating a Scheduled CU Change (Discarded)

      Function

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

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

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

      • Parameter description @@ -228,7 +230,7 @@
      diff --git a/docs/dli/api-ref/dli_02_0292.html b/docs/dli/api-ref/dli_02_0292.html index 3ad5a89c..6ef6de82 100644 --- a/docs/dli/api-ref/dli_02_0292.html +++ b/docs/dli/api-ref/dli_02_0292.html @@ -1,7 +1,9 @@ -

      Viewing a Scheduled CU Change

      +

      Viewing a Scheduled CU Change (Discarded)

      Function

      This API is used to query the scheduled CU changes and list the changes of a specified queue.

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

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

      • Parameter description @@ -73,7 +75,7 @@
      - @@ -276,7 +278,7 @@ diff --git a/docs/dli/api-ref/dli_02_0293.html b/docs/dli/api-ref/dli_02_0293.html index c24efb05..4d6f85c1 100644 --- a/docs/dli/api-ref/dli_02_0293.html +++ b/docs/dli/api-ref/dli_02_0293.html @@ -1,7 +1,9 @@ -

      Deleting Scheduled CU Changes in Batches

      +

      Deleting Scheduled CU Changes in Batches (Discarded)

      Function

      This API is used to delete scheduled CU changes in batches.

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

        POST /v1/{project_id}/queues/{queue_name}/plans/batch-delete

      • Parameter description @@ -55,7 +57,7 @@
      - @@ -152,7 +154,7 @@ diff --git a/docs/dli/api-ref/dli_02_0294.html b/docs/dli/api-ref/dli_02_0294.html index 547376c8..9aad98b7 100644 --- a/docs/dli/api-ref/dli_02_0294.html +++ b/docs/dli/api-ref/dli_02_0294.html @@ -1,7 +1,9 @@ -

      Deleting a Scheduled CU Change

      +

      Deleting a Scheduled CU Change (Discarded)

      Function

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

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

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

      • Parameter description @@ -39,7 +41,7 @@
      - @@ -136,7 +138,7 @@ diff --git a/docs/dli/api-ref/dli_02_0295.html b/docs/dli/api-ref/dli_02_0295.html index 63a29b1f..75dab490 100644 --- a/docs/dli/api-ref/dli_02_0295.html +++ b/docs/dli/api-ref/dli_02_0295.html @@ -1,7 +1,9 @@ -

      Modifying a Scheduled CU Change

      +

      Modifying a Scheduled CU Change (Discarded)

      Function

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

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

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

      • Parameter description @@ -39,7 +41,7 @@
      - @@ -251,7 +253,7 @@ diff --git a/docs/dli/api-ref/dli_02_0296.html b/docs/dli/api-ref/dli_02_0296.html index cc8915bf..8126bce0 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: SQL Job related APIs
      +
      Parent topic: SQL Job-related APIs
      diff --git a/docs/dli/api-ref/dli_02_0297.html b/docs/dli/api-ref/dli_02_0297.html index 201a5aa5..33654afc 100644 --- a/docs/dli/api-ref/dli_02_0297.html +++ b/docs/dli/api-ref/dli_02_0297.html @@ -1,17 +1,18 @@ - -

      Agency-related APIs

      - -

      +

      Agency-related APIs (Discarded)

      +

      - diff --git a/docs/dli/api-ref/dli_02_0298.html b/docs/dli/api-ref/dli_02_0298.html index b5b1987a..be948a2b 100644 --- a/docs/dli/api-ref/dli_02_0298.html +++ b/docs/dli/api-ref/dli_02_0298.html @@ -1,11 +1,13 @@ -

      Obtaining DLI Agency Information

      +

      Obtaining DLI Agency Information (Discarded)

      Function

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

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

        GET /v2/{project_id}/agency

      • Parameter description -
      Table 1 URI parameter

      Parameter

      Mandatory

      No

      Array of Objects

      +

      Array of objects

      Scheduled scaling plan information. For details, see Table 3.

      Array of Long

      Scaling policy IDs of the queues you want to delete. For details, see Viewing a Scheduled CU Change. Example: "plan_ids": [8,10]

      +

      Scaling policy IDs of the queues you want to delete. For details, see Viewing a Scheduled CU Change (Discarded). Example: "plan_ids": [8,10]

      Long

      ID of scheduled CU change to be deleted. For details about how to obtain the IDs, see Viewing a Scheduled CU Change.

      +

      ID of scheduled CU change to be deleted. For details about how to obtain the IDs, see Viewing a Scheduled CU Change (Discarded).

      String

      ID of scheduled CU change to be modified. Use commas (,) to separate multiple IDs. For details about how to obtain the IDs, see Viewing a Scheduled CU Change.

      +

      ID of scheduled CU change to be modified. Use commas (,) to separate multiple IDs. For details about how to obtain the IDs, see Viewing a Scheduled CU Change (Discarded).
      Table 1 URI parameters

      Parameter

      +
      @@ -161,7 +163,7 @@ diff --git a/docs/dli/api-ref/dli_02_0299.html b/docs/dli/api-ref/dli_02_0299.html index 5579d148..73c778de 100644 --- a/docs/dli/api-ref/dli_02_0299.html +++ b/docs/dli/api-ref/dli_02_0299.html @@ -1,11 +1,13 @@ -

      Creating a DLI Agency

      +

      Creating a DLI Agency (Discarded)

      Function

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

      +

      This API has been discarded and is not recommended.

      +

      URI

      • URI format

        POST /v2/{project_id}/agency

      • Parameter description -
      Table 1 URI parameter

      Parameter

      Mandatory
      Table 1 URI parameters

      Parameter

      +
      @@ -132,7 +134,7 @@ diff --git a/docs/dli/api-ref/dli_02_0300.html b/docs/dli/api-ref/dli_02_0300.html new file mode 100644 index 00000000..ac7d3dca --- /dev/null +++ b/docs/dli/api-ref/dli_02_0300.html @@ -0,0 +1,29 @@ + + + +

      Out-of-Date APIs

      + +

      +
      + + + diff --git a/docs/dli/api-ref/dli_02_0308.html b/docs/dli/api-ref/dli_02_0308.html index 48f6916c..3690cf5b 100644 --- a/docs/dli/api-ref/dli_02_0308.html +++ b/docs/dli/api-ref/dli_02_0308.html @@ -5,10 +5,10 @@

      Constraints

      • It takes 6 to 10 minutes to start a job using a new queue for the first time.
      -

      Involved APIs

      +

      Involved APIs

      Procedure

      1. Create a SQL queue. For details, see Creating a Queue.
      2. Create a database.
        • API

          URI format: POST /v1.0/{project_id}/databases

          - +
        • Request example
          • Description: Creates a database named db1 in the project whose ID is 48cc2c48765f481480c7db940d6409d1.
          • Example URL: POST https://{endpoint}/v1.0/48cc2c48765f481480c7db940d6409d1/databases
          • Body:
            {
      "database_name": "db1",
      "description": "this is for test"
@@ -20,7 +20,7 @@
 }
        • Create a table.
          • API

            URI format: POST /v1.0/{project_id}/databases/{database_name}/tables

            - +
          • Request example
            • Description: In the project whose ID is 48cc2c48765f481480c7db940d6409d1, create a table named tb1 in the db1 database.
            • Example URL: POST https://{endpoint}/v1.0/48cc2c48765f481480c7db940d6409d1/databases/db1/tables
            • Body:
              {
   "table_name": "tb1",
   "data_location": "OBS",
@@ -54,8 +54,8 @@
   "message": ""
 }
            -
          • (Optional) If the table to be created does not contain data, use the Importing Data API to import data to the table.
          • (Optional) After data is imported, you can use the Querying Job Details API to check whether the imported data is correct.
          • Submit a query job.
            • API

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

              - +
            • (Optional) If the table to be created does not contain data, use the Importing Data (Discarded) API to import data to the table.
            • (Optional) After data is imported, you can use the Querying Job Details API to check whether the imported data is correct.
            • Submit a query job.
              • API

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

                +
              • Request example
                • Description: Submit a SQL job in the project whose ID is 48cc2c48765f481480c7db940d6409d1 and query data in the tb1 table in the database db1.
                • Example URL: POST https://{endpoint}/v1.0/48cc2c48765f481480c7db940d6409d1/jobs/submit-job
                • Body:
                  {
     "currentdb": "db1",
     "sql": "select * from tb1 limit 10",
diff --git a/docs/dli/api-ref/dli_02_0309.html b/docs/dli/api-ref/dli_02_0309.html
index d88246b3..275408a5 100644
--- a/docs/dli/api-ref/dli_02_0309.html
+++ b/docs/dli/api-ref/dli_02_0309.html
@@ -5,10 +5,10 @@

      Constraints

      • It takes 6 to 10 minutes to start a job using a new queue for the first time.
      -

      Involved APIs

      +

      Involved APIs

      Procedure

      1. Create a common queue. For details, see Creating a Queue.
      2. Upload a package group.
        • API

          URI format: POST /v2.0/{project_id}/resources

          - +
        • Request example
          • Description: Upload resources in the GATK group to the project whose ID is 48cc2c48765f481480c7db940d6409d1.
          • Example URL: POST https://{endpoint}/v2.0/48cc2c48765f481480c7db940d6409d1/resources
          • Body:
            {
     "paths": [
         "https://test.obs.xxx.com/txr_test/jars/spark-sdv-app.jar"
@@ -57,7 +57,7 @@
 }
        • View resource packages in a group.
          • API

            URI format: GET /v2.0/{project_id}/resources/{resource_name}

            - +
          • Request example
            • Description: Query the resource package named luxor-router-1.1.1.jar in the GATK group under the project whose ID is 48cc2c48765f481480c7db940d6409d1.
            • Example URL: GET https://{endpoint}/v2.0/48cc2c48765f481480c7db940d6409d1/resources/luxor-router-1.1.1.jar?group=gatk
            • Body:
              {}
          • Example response
            {
@@ -118,7 +118,7 @@
 }
        • Query batch job logs.
          • API

            URI format: GET /v2.0/{project_id}/batches/{batch_id}/log

            - +
          • Request example
            • Description: Query the background logs of the batch processing job 0a324461-d9d9-45da-a52a-3b3c7a3d809e in the 48cc2c48765f481480c7db940d6409d1 project.
            • Example URL: GET https://{endpoint}/v2.0/48cc2c48765f481480c7db940d6409d1/batches/0a324461-d9d9-45da-a52a-3b3c7a3d809e/log
            • Body:
              {}
          • Example response
            {
diff --git a/docs/dli/api-ref/dli_02_0310.html b/docs/dli/api-ref/dli_02_0310.html
index 6b8ac4c1..a9103df8 100644
--- a/docs/dli/api-ref/dli_02_0310.html
+++ b/docs/dli/api-ref/dli_02_0310.html
@@ -5,10 +5,10 @@

      Constraints

      • It takes 6 to 10 minutes to start a job using a new queue for the first time.
      -

      Involved APIs

      +

      Involved APIs

      Procedure

      1. Create a queue for general use. For details, see Creating a Queue. In the request, set resource_mode to 1 to create a dedicated queue.
      2. Upload the resource package of the user-defined Flink job. For details, see 2.
      3. Query resource packages in a group. For details, see 3.
      4. Create a custom flink job.
        • API

          URI format: POST /v1.0/{project_id}/streaming/flink-jobs

          - +
        • Request example
          • Description: Create a user-defined Flink job in the project whose ID is 48cc2c48765f481480c7db940d6409d1.
          • Example URL: POST https://{endpoint}/v1.0/48cc2c48765f481480c7db940d6409d1/streaming/flink-jobs
          • Body:
            {
     "name": "test",
     "desc": "job for test",
diff --git a/docs/dli/api-ref/dli_02_0311.html b/docs/dli/api-ref/dli_02_0311.html
index 5e391a8c..11df59a8 100644
--- a/docs/dli/api-ref/dli_02_0311.html
+++ b/docs/dli/api-ref/dli_02_0311.html
@@ -33,7 +33,7 @@
 }
        • (Optional) If no queue is bound when you create an enhanced datasource connection, you can use the Binding a Queue API to bind a queue.
        • Verify that the enhanced datasource connection is created successfully.
          • API

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

            - +
          • Request example
            • Description: Query an enhanced datasource connection whose ID is 2a620c33-5609-40c9-affd-2b6453071b0f in project 48cc2c48765f481480c7db940d6409d1.
            • Example URL: GET https://{endpoint}/v2.0/48cc2c48765f481480c7db940d6409d1/datasource/enhanced-connections/2a620c33-5609-40c9-affd-2b6453071b0f
            • Body:
              {}
          • Example response
            {
diff --git a/docs/dli/api-ref/dli_02_0312.html b/docs/dli/api-ref/dli_02_0312.html
index 087210e8..b6007b63 100644
--- a/docs/dli/api-ref/dli_02_0312.html
+++ b/docs/dli/api-ref/dli_02_0312.html
@@ -39,32 +39,32 @@
      Table 1 URI parameter

      Parameter

      Mandatory
      -
      Table 2 query parameter description

      Parameter

      +
      - - - - - - - - - @@ -94,7 +94,7 @@ - - @@ -147,7 +147,7 @@ - @@ -156,7 +156,7 @@ - @@ -222,7 +222,7 @@
      -
      Parent topic: SQL Job related APIs
      +
      Parent topic: SQL Job-related APIs
      diff --git a/docs/dli/api-ref/dli_02_0316.html b/docs/dli/api-ref/dli_02_0316.html index 82a92138..afe1d67e 100644 --- a/docs/dli/api-ref/dli_02_0316.html +++ b/docs/dli/api-ref/dli_02_0316.html @@ -30,115 +30,124 @@

      Request

      -
      Table 2 query parameter description

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      page-size

      No

      +

      No

      Long

      +

      Long

      Number of result rows. The value ranges from 1 to 1000. The default rate limit is 1000.

      +

      Number of result rows. The value ranges from 1 to 1000. The default rate limit is 1000.

      queue-name

      No

      +

      No

      String

      +

      String

      Name of the execution queue for obtaining job results. If this parameter is not specified, the default system queue is used.

      +

      Name of the execution queue for obtaining job results. If this parameter is not specified, the default system queue is used.

      Boolean

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

      message

      @@ -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

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

      No

      long

      +

      Long

      Amount of data scanned during job execution.

      No

      Array of Objects

      +

      Array of Map

      Name and type of the job result column.

      No

      Array of Strings

      +

      Array of objects

      Job results set.
      Table 2 Request parameters

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + @@ -245,7 +254,7 @@
      -
      Parent topic: APIs Related to Flink Jobs
      +
      Parent topic: Flink Job-related APIs
      diff --git a/docs/dli/api-ref/dli_02_0325.html b/docs/dli/api-ref/dli_02_0325.html new file mode 100644 index 00000000..4e897d68 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0325.html @@ -0,0 +1,26 @@ + + +

      APIs Related to Elastic Resource Pools

      +

      +
      + + diff --git a/docs/dli/api-ref/dli_02_0326.html b/docs/dli/api-ref/dli_02_0326.html new file mode 100644 index 00000000..d954b80c --- /dev/null +++ b/docs/dli/api-ref/dli_02_0326.html @@ -0,0 +1,250 @@ + + +

      Creating an Elastic Resource Pool

      +

      Function

      This API is used to create elastic resource pools.

      +
      +

      URI

      • URI format

        POST /v3/{project_id}/elastic-resource-pools

        +
      • Parameter description +
      Table 2 Request parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      sql_body

      +

      sql_body

      Yes

      +

      Yes

      String

      +

      String

      SQL

      +

      SQL

      cu_number

      +

      cu_number

      No

      +

      No

      Integer

      +

      Integer

      Total number of CUs.

      +

      Total number of CUs.

      manager_cu_number

      +

      manager_cu_number

      No

      +

      No

      Integer

      +

      Integer

      Number of CUs of the management unit.

      +

      Number of CUs of the management unit.

      parallel_number

      +

      parallel_number

      No

      +

      No

      Integer

      +

      Integer

      Maximum degree of parallelism.

      +

      Maximum degree of parallelism.

      tm_cus

      +

      tm_cus

      No

      +

      No

      Integer

      +

      Integer

      Number of CUs in a taskManager.

      +

      Number of CUs in a taskManager.

      tm_slot_num

      +

      tm_slot_num

      No

      +

      No

      Integer

      +

      Integer

      Number of slots in a taskManager.

      +

      Number of slots in a taskManager.

      operator_config

      +

      operator_config

      No

      +

      No

      String

      +

      String

      Operator configurations.

      +

      Operator configurations.

      static_estimator

      +

      static_estimator

      No

      +

      No

      Boolean

      +

      Boolean

      Whether to estimate static resources.

      +

      Whether to estimate static resources.

      job_type

      +

      job_type

      No

      +

      No

      String

      +

      String

      Job types.

      +

      Job types.

      Only flink_opensource_sql_job job is supported.

      graph_type

      +

      graph_type

      No

      +

      No

      String

      +

      String

      Stream graph type. Currently, the following two types of stream graphs are supported:

      +

      Stream graph type. Currently, the following two types of stream graphs are supported:

      • simple_graph: Simplified stream graph
      • job_graph: Static stream graph

      static_estimator_config

      +

      static_estimator_config

      No

      +

      No

      String

      +

      String

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

      +

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

      +

      flink_version

      +

      No

      +

      String

      +

      Flink version. Currently, only 1.10 and 1.12 are supported.
      + + + + + + + + + + + +
      Table 1 URI parameter

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

      +
      +
      + + +

      Request

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 2 Request parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      elastic_resource_pool_name

      +

      Yes

      +

      String

      +

      Name of a new elastic resource pool. Only digits, letters, and underscores (_) are allowed, but the value cannot contain only digits or start with an underscore (_). The value can contain 1 to 128 characters.

      +
      NOTE:

      If the name contains uppercase letters, the system automatically converts them to lowercase letters.

      +
      +

      description

      +

      No

      +

      String

      +

      Description. The value can contain a maximum of 256 characters.

      +

      cidr_in_vpc

      +

      No

      +

      String

      +

      VPC CIDR associated with the virtual cluster. If it is not specified, the default value 172.16.0.0/12 is used.

      +

      max_cu

      +

      Yes

      +

      Integer

      +

      Maximum number of CUs. The value of this parameter must be greater than or equal to the sum of maximum CUs allowed for any queue in the resource pool, and greater than min_cu. The minimum value is 64.

      +

      min_cu

      +

      Yes

      +

      Integer

      +

      Minimum number of CUs. The value of this parameter must be greater than or equal to the sum of the minimum CUs allowed for each queue in the resource pool. The minimum value is 64.

      +

      charging_mode

      +

      No

      +

      Integer

      +

      Billing mode. The default value is 1, which indicates the pay-per-use billing mode.

      +

      enterprise_project_id

      +

      No

      +

      String

      +

      Enterprise ID. If this parameter is left blank, the default value 0 is used.

      +

      tags

      +

      No

      +

      Array of objects

      +

      Queue tags for identifying cloud resources. A tag consists of a key and a value. For details, see Table 3.

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      key

      +

      Yes

      +

      String

      +

      Tag key

      +
      NOTE:

      A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed, but the key cannot start or end with a space or start with _sys_.

      +

      +
      +

      value

      +

      Yes

      +

      String

      +

      Tag value

      +
      NOTE:

      A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. The value cannot start or end with a space.

      +
      +
      +
      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 4 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

      Message content, for example, Success to get tsdb list.

      +

      elastic_resource_pool_name

      +

      No

      +

      String

      +

      Elastic resource pool name, for example, elastic_pool_0623_02".

      +
      +
      +
      +

      Example Request

      Create an elastic resource pool with maximum CUs of 684 and minimum CUs of 684.

      +
      {
+  "elastic_resource_pool_name" : "elastic_pool_0623_02",
+  "description" : "test",
+  "cidr_in_vpc" : "172.16.0.0/14",
+  "charging_mode" : "1",
+  "max_cu" : 684,
+  "min_cu" : 684
+}
      +
      +

      Example Response

      {
+  "is_success" : true,
+  "message" : "Success to get tsdb list",
+  "elastic_resource_pool_name" : "elastic_pool_0623_02"
+}
      +
      +

      Status Codes

      +
      + + + + + + + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +

      400

      +

      Incorrect parameters. For example, creating an existing elastic resource pool.

      +

      403

      +

      Forbidden

      +
      +
      +
      +

      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_0327.html b/docs/dli/api-ref/dli_02_0327.html new file mode 100644 index 00000000..33c24c97 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0327.html @@ -0,0 +1,409 @@ + + +

      Querying All Elastic Resource Pools

      +

      Function

      This API is used to query all elastic resource pools.

      +
      +

      URI

      • URI format

        GET /v3/{project_id}/elastic-resource-pools

        +
      • Parameter description +
        + + + + + + + + + + + +
        Table 1 URI parameter

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        project_id

        +

        Yes

        +

        String

        +

        Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Table 2 query parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        limit

        +

        No

        +

        Integer

        +

        Page size. The default value is 100.

        +

        name

        +

        No

        +

        String

        +

        Fuzzy match based on the elastic resource pool name.

        +

        offset

        +

        No

        +

        Integer

        +

        Offset. The default value is 0.

        +

        status

        +

        No

        +

        String

        +

        Status of the elastic resource pool. Possible values are as follows:

        +
        • AVAILABLE
        • SCALING
        • CREATING
        • FAILED
        +

        tags

        +

        No

        +

        String

        +

        Query results are filtered by tag.

        +
        +
        +
      +
      +

      Request

      None

      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 3 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

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

      +

      count

      +

      No

      +

      Long

      +

      Total number of records.

      +

      elastic_resource_pools

      +

      No

      +

      Array of objects

      +

      Elastic resource pool information. For details, see Table 4.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 4 elastic_resource_pools parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      owner

      +

      No

      +

      String

      +

      Account used to create an elastic resource pool.

      +

      elastic_resource_pool_name

      +

      No

      +

      String

      +

      Elastic resource pool name.

      +

      description

      +

      No

      +

      String

      +

      Elastic resource pool description information.

      +

      max_cu

      +

      No

      +

      Integer

      +

      Maximum number of CUs.

      +

      min_cu

      +

      No

      +

      Integer

      +

      Minimum number of CUs.

      +

      actual_cu

      +

      No

      +

      Integer

      +

      Actual number of CUs.

      +

      cidr_in_vpc

      +

      No

      +

      String

      +

      Subnet information of the elastic resource pool.

      +

      create_time

      +

      No

      +

      Long

      +

      Time when the elastic resource pool is created.

      +

      update_time

      +

      No

      +

      Long

      +

      Time when the elastic resource pool is updated.

      +

      current_cu

      +

      No

      +

      Integer

      +

      Number of current CUs.

      +

      status

      +

      No

      +

      String

      +

      Status of the elastic resource pool. Possible values are as follows:

      +
      • AVAILABLE
      • SCALING
      • CREATING
      • FAILED
      +

      resource_id

      +

      No

      +

      String

      +

      Resource ID of the elastic resource pool.

      +

      fail_reason

      +

      No

      +

      String

      +

      Cause of the elastic resource pool creation failure.

      +

      enterprise_project_id

      +

      No

      +

      String

      +

      Enterprise project ID.

      +

      prepay_cu

      +

      No

      +

      Integer

      +

      Number of prepaid CUs.

      +

      charging_mode

      +

      No

      +

      Integer

      +

      Billing mode.

      +

      queues

      +

      No

      +

      Array of Strings

      +

      Information about the queue the elastic resource pool belongs to.

      +

      manager

      +

      No

      +

      String

      +

      Type of the elastic resource pool.

      +

      label

      +

      No

      +

      Map<string, string>

      +

      Label used to identify the elastic resource pool. Currently, only the developer label is supported. The value is "label": {"billing_spec_code":"developer"}.

      +

      id

      +

      No

      +

      Long

      +

      ID of the elastic resource pool

      +
      +
      +
      +

      Example Request

      None

      +
      +

      Example Response

      {
+  "is_success": true,
+  "message": "",
+  "count": 2,
+  "elastic_resource_pools": [
+    {
+      "owner": "ei_dlics_d00352221",
+      "id": 1026,
+      "elastic_resource_pool_name": "elastic_pool_0622_10",
+      "description": "",
+      "max_cu": 0,
+      "min_cu": 0,
+      "actual_cu": 0,
+      "cidr_in_vpc": "172.16.0.0/12",
+      "create_time": 1624366266826,
+      "current_cu": 64,
+      "status": "AVAILABLE",
+      "resource_id": "ecc98d89-3fd1-4dec-b572-aa6e2ef82391",
+      "fail_reason": "",
+      "enterprise_project_id": "0",
+      "prepay_cu": 0,
+      "charging_mode": 1
+    },
+    {
+      "owner": "ei_dlics_d00352221",
+      "id": 1002,
+      "elastic_resource_pool_name": "elastic_pool_0622_0",
+      "description": "test",
+      "max_cu": 684,
+      "min_cu": 0,
+      "actual_cu": 0,
+      "cidr_in_vpc": "172.16.0.0/12",
+      "create_time": 1624353878084,
+      "status": "AVAILABLE",
+      "resource_id": "ecc98d89-3fd1-4dec-b572-aa6e2ef82391",
+      "fail_reason": "",
+      "enterprise_project_id": "0",
+      "prepay_cu": 0,
+      "charging_mode": 1
+    }
+  ]
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      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_0328.html b/docs/dli/api-ref/dli_02_0328.html new file mode 100644 index 00000000..2b5a9b85 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0328.html @@ -0,0 +1,107 @@ + + +

      Deleting an Elastic Resource Pool

      +

      Function

      This API is used to delete an elastic resource pool.

      +
      +

      URI

      • URI format

        DELETE /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}

        +
      • Parameter description +
        + + + + + + + + + + + + + + + + +
        Table 1 URI parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        elastic_resource_pool_name

        +

        Yes

        +

        String

        +

        Elastic resource pool name.

        +

        project_id

        +

        Yes

        +

        String

        +

        Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

        +
        +
        +
      +
      +

      Request

      None

      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + +
      Table 2 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

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

      +
      +
      +
      +

      Example Request

      None

      +
      +

      Example Response

      {
+  "is_success" : true,
+  "message" : ""
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      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_0329.html b/docs/dli/api-ref/dli_02_0329.html new file mode 100644 index 00000000..e1855ff9 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0329.html @@ -0,0 +1,152 @@ + + +

      Modifying Elastic Resource Pool Information

      +

      Function

      This API is used to modify elastic resource pool information.

      +
      +

      URI

      • URI format

        PUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}

        +
      • Parameter description +
        + + + + + + + + + + + + + + + + +
        Table 1 URI parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        elastic_resource_pool_name

        +

        Yes

        +

        String

        +

        Elastic resource pool name.

        +

        project_id

        +

        Yes

        +

        String

        +

        Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

        +
        +
        +
      +
      +

      Request

      +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 2 Request parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      description

      +

      No

      +

      String

      +

      Description. The value can contain a maximum of 256 characters.

      +

      max_cu

      +

      No

      +

      Integer

      +

      Maximum CUs allowed for an elastic resource pool.

      +

      min_cu

      +

      No

      +

      Integer

      +

      Maximum CUs allowed for an elastic resource pool.

      +
      +
      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + +
      Table 3 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

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

      +
      +
      +
      +

      Example Request

      Modify the description, maximum CUs, and minimum CUs of the elastic resource pool. After the modification, the minimum CUs is 78 and the maximum CUs is 990.

      +
      {
+  "description" : "test_update",
+  "min_cu" : 78,
+  "max_cu" : 990
+}
      +
      +

      Example Response

      {
+  "is_success" : true,
+  "message" : ""
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      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_0330.html b/docs/dli/api-ref/dli_02_0330.html new file mode 100644 index 00000000..79e35968 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0330.html @@ -0,0 +1,333 @@ + + +

      Querying All Queues in an Elastic Resource Pool

      +

      Function

      This API is used to query all queues in an elastic resource pool.

      +
      +

      URI

      • URI format

        GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues

        +
      • Parameter description +
        + + + + + + + + + + + + + + + + +
        Table 1 URI parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        elastic_resource_pool_name

        +

        Yes

        +

        String

        +

        Elastic resource pool name.

        +

        project_id

        +

        Yes

        +

        String

        +

        Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + + + +
        Table 2 query parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        limit

        +

        No

        +

        Integer

        +

        Page size. The default value is 100.

        +

        offset

        +

        No

        +

        Integer

        +

        Offset. The default value is 0.

        +

        queue_name

        +

        No

        +

        String

        +

        You can filter data by queue name.

        +
        +
        +
      +
      +

      Request

      None

      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 3 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

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

      +

      queues

      +

      No

      +

      Array of objects

      +

      Resource weight of all queues in the elastic resource pool. For details about the parameters, see Table 4.

      +

      count

      +

      No

      +

      Long

      +

      Number of queues bound to the elastic resource pool.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 4 queues

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      queue_name

      +

      No

      +

      String

      +

      Queue name.

      +

      enterprise_project_id

      +

      No

      +

      String

      +

      Enterprise project ID.

      +

      queue_type

      +

      No

      +

      String

      +

      Queue type.

      +

      queue_scaling_policies

      +

      No

      +

      Array of objects

      +

      Scaling policy. For details about the parameters, see priority_infos.

      +

      owner

      +

      No

      +

      String

      +

      Queue owner.

      +

      create_time

      +

      No

      +

      Long

      +

      Time when a queue is created.

      +

      engine

      +

      No

      +

      String

      +

      Queue engine type.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 5 queue_scaling_policies

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      priority

      +

      No

      +

      Integer

      +

      The policy priority ranges from 1 to 100. The value 100 indicates the highest priority.

      +

      impact_start_time

      +

      No

      +

      String

      +

      Time when a policy takes effect.

      +

      impact_stop_time

      +

      No

      +

      String

      +

      Time when a policy expires.

      +

      min_cu

      +

      No

      +

      Integer

      +

      Minimum number of CUs.

      +

      max_cu

      +

      No

      +

      Integer

      +

      Maximum number of CUs.

      +
      +
      +
      +

      Example Request

      None

      +
      +

      Example Response

      {
+  "is_success": true,
+  "message": "",
+  "count": 1,
+  "queues": [
+    {
+      "queue_name": "lhm_sql",
+      "enterprise_project_id": "0",
+      "queue_type": "sql",
+      "queue_scaling_policies": [
+        {
+          "priority": 50,
+          "impact_start_time": "00:00",
+          "impact_stop_time": "24:00",
+          "min_cu": 16,
+          "max_cu": 16
+        },
+        {
+          "priority": 100,
+          "impact_start_time": "00:00",
+          "impact_stop_time": "12:00",
+          "min_cu": 32,
+          "max_cu": 64
+        },
+        {
+          "priority": 50,
+          "impact_start_time": "12:00",
+          "impact_stop_time": "24:00",
+          "min_cu": 16,
+          "max_cu": 32
+        }
+      ]
+    }
+  ]
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      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_0331.html b/docs/dli/api-ref/dli_02_0331.html new file mode 100644 index 00000000..17af3ef4 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0331.html @@ -0,0 +1,132 @@ + + +

      Associating a Queue with an Elastic Resource Pool

      +

      Function

      This API is used to associate a queue with an elastic resource pool.

      +
      +

      URI

      • URI format

        POST /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues

        +
      • Parameter description +
        + + + + + + + + + + + + + + + + +
        Table 1 URI parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        elastic_resource_pool_name

        +

        Yes

        +

        String

        +

        Elastic resource pool name.

        +

        project_id

        +

        Yes

        +

        String

        +

        Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

        +
        +
        +
      +
      +

      Request

      +
      + + + + + + + + + + + +
      Table 2 Request parameter

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      queue_name

      +

      Yes

      +

      String

      +

      Queue name.

      +
      +
      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + +
      Table 3 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

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

      +
      +
      +
      +

      Example Request

      Associate the lhm_sql queue with the elastic resource pool.

      +
      {
+  "queue_name" : "lhm_sql"
+}
      +
      +

      Example Response

      {
+  "is_success" : true,
+  "message" : ""
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      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_0332.html b/docs/dli/api-ref/dli_02_0332.html new file mode 100644 index 00000000..36bdf21e --- /dev/null +++ b/docs/dli/api-ref/dli_02_0332.html @@ -0,0 +1,212 @@ + + +

      Modifying the Scaling Policy of a Queue Associated with an Elastic Resource Pool

      +

      Function

      This API is used to modify the scaling policy of a queue associated with an elastic resource pool.

      +
      +

      URI

      • URI format

        PUT /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/queues/{queue_name}

        +
      • Parameter description +
        + + + + + + + + + + + + + + + + + + + + + +
        Table 1 URI parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        elastic_resource_pool_name

        +

        Yes

        +

        String

        +

        Elastic resource pool name.

        +

        project_id

        +

        Yes

        +

        String

        +

        Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

        +

        queue_name

        +

        Yes

        +

        String

        +

        Name of a bound queue.

        +
        +
        +
      +
      +

      Request

      +
      + + + + + + + + + + + +
      Table 2 Request parameter

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      queue_scaling_policies

      +

      Yes

      +

      Array of objects

      +

      Scaling policy of a queue in an elastic resource pool. A policy contains the period, priority, and CU range. There must be a default scaling policy (period [00:00, 24:00]) for each queue. For details about the parameters, see Table 3.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 3 queue_scaling_policies

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      impact_start_time

      +

      Yes

      +

      String

      +

      Time when a policy takes effect.

      +

      impact_stop_time

      +

      Yes

      +

      String

      +

      Time when a policy expires.

      +

      priority

      +

      Yes

      +

      Integer

      +

      Priority.

      +

      min_cu

      +

      Yes

      +

      Integer

      +

      Minimum number of CUs.

      +

      max_cu

      +

      Yes

      +

      Integer

      +

      Maximum number of CUs.

      +
      +
      +
      +

      Response

      +
      + + + + + + + + + + + + + + + + +
      Table 4 Response parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      is_success

      +

      No

      +

      Boolean

      +

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

      +

      message

      +

      No

      +

      String

      +

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

      +
      +
      +
      +

      Example Request

      Modify the scaling policy of a queue associated with an elastic resource pool.

      +
      {
+  "queue_scaling_policies" : [ {
+    "priority" : 100,
+    "impact_start_time" : "10:00",
+    "impact_stop_time" : "22:00",
+    "min_cu":"64",
+    "max_cu":"752"
+  }, {
+    "priority" : 50,
+    "impact_start_time" : "22:00",
+    "impact_stop_time" : "10:00",
+    "min_cu":"64",
+    "max_cu":"752"
+  } ]
+}
      +
      +

      Example Response

      {
+  "is_success" : true,
+  "message" : ""
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      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_0333.html b/docs/dli/api-ref/dli_02_0333.html new file mode 100644 index 00000000..9251c1e8 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0333.html @@ -0,0 +1,18 @@ + + +

      APIs Related to Flink Jobs (Discarded)

      +

      +
      + + diff --git a/docs/dli/api-ref/dli_02_0336.html b/docs/dli/api-ref/dli_02_0336.html new file mode 100644 index 00000000..74f71383 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0336.html @@ -0,0 +1,245 @@ + + +

      Viewing Scaling History of an Elastic Resource Pool

      +

      Function

      This API is used to view scaling history of an elastic resource pool.

      +
      +

      URI

      GET /v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/scale-records

      + +
      + + + + + + + + + + + + + + + + +
      Table 1 URI parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

      Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

      +

      elastic_resource_pool_name

      +

      Yes

      +

      String

      +

      Elastic resource pool name

      +

      The value can contain 1 to 128 characters.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 2 query parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      start_time

      +

      No

      +

      Long

      +

      Start time of the historical scaling records you want to query. The time must be 30 days earlier than the current time and earlier than the end_time. The value is a UNIX timestamp in milliseconds.

      +
      • If start_time is left empty, data generated in the recent seven days before end_time will be queried. The end_time cannot be later than 30 days after the current time.
      • If both start_time and end_time are left empty, data generated in the recent 15 days before the current time will be queried.
      +

      end_time

      +

      No

      +

      Long

      +

      End time of the historical scaling records. The value cannot be earlier than the start_time or later than the current time. The value is a UNIX timestamp in milliseconds.

      +
      • If end_time is left empty, data generated since the start_time will be queried.
      • If both start_time and end_time are left empty, data generated in the recent 15 days before the current time will be queried.
      +

      status

      +

      No

      +

      String

      +

      Scaling status

      +

      Enumerated values:

      +
      • success
      • fail
      +

      offset

      +

      No

      +

      Integer

      +

      Offset

      +

      Minimum value: 0

      +

      limit

      +

      No

      +

      Integer

      +

      Number of records displayed on a page

      +

      Minimum value: 0

      +

      Maximum value: 100

      +
      +
      +
      +

      Request

      None

      +
      +

      Response

      +
      + + + + + + + + + + + + + +
      Table 3 Response body parameters

      Parameter

      +

      Type

      +

      Description

      +

      count

      +

      Integer

      +

      Number of elements in the array

      +

      items

      +

      Array of arrays

      +

      Data returned in the array For details, see Table 4.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 4 items parameters

      Parameter

      +

      Type

      +

      Description

      +

      max_cu

      +

      Integer

      +

      Maximum number of CUs

      +

      min_cu

      +

      Integer

      +

      Minimum number of CUs

      +

      current_cu

      +

      Integer

      +

      Scaled number of CUs

      +

      origin_cu

      +

      Integer

      +

      Original number of CUs

      +

      target_cu

      +

      Integer

      +

      Target number of CUs

      +

      record_time

      +

      Long

      +

      Operation completion time

      +

      status

      +

      String

      +

      Scaling status, which can be success or failure

      +

      fail_reason

      +

      String

      +

      Failure cause

      +
      +
      +
      +

      Example Request

      GET https://{endpoint}/v3/{project_id}/elastic-resource-pools/{elastic_resource_pool_name}/scale-records?start_time=1650784624000&end_time=1652625304002&status=&limit=20&offset=1
      +
      +

      Example Response

      The following is an example for a successful query:

      +
      { 
+  "count" : 1, 
+  "items" : [ { 
+    "max_cu" : 64, 
+    "min_cu" : 16, 
+    "current_cu" : 16, 
+    "target_cu" : 16, 
+    "origin_cu" : 16, 
+    "record_time" : 1650784624000, 
+    "status" : "fail", 
+    "fail_reason" : "Internal error, please contact technical support." 
+  } ] 
+}
      +
      +

      Status Codes

      +
      + + + + + + + +

      Status Code

      +

      Description

      +

      200

      +

      OK

      +
      +
      +
      +

      Error Codes

      For details, see Error Codes.

      +
      +
      + + diff --git a/docs/dli/api-ref/dli_02_0356.html b/docs/dli/api-ref/dli_02_0356.html index 3b5e52cb..67e70db9 100644 --- a/docs/dli/api-ref/dli_02_0356.html +++ b/docs/dli/api-ref/dli_02_0356.html @@ -1,19 +1,18 @@ - -

      Resource-related APIs

      - -

      +

      Resource-related APIs (Discarded)

      +

      - diff --git a/docs/dli/api-ref/dli_02_0359.html b/docs/dli/api-ref/dli_02_0359.html new file mode 100644 index 00000000..01f7e05b --- /dev/null +++ b/docs/dli/api-ref/dli_02_0359.html @@ -0,0 +1,16 @@ + + +

      APIs Related to Spark Batch Processing (Discarded)

      +

      +
      + + diff --git a/docs/dli/api-ref/dli_02_0360.html b/docs/dli/api-ref/dli_02_0360.html new file mode 100644 index 00000000..222ac1a1 --- /dev/null +++ b/docs/dli/api-ref/dli_02_0360.html @@ -0,0 +1,18 @@ + + +

      SQL Job-related APIs (Discarded)

      +

      +
      + + diff --git a/docs/dli/api-ref/dli_02_0361.html b/docs/dli/api-ref/dli_02_0361.html new file mode 100644 index 00000000..db5bdfed --- /dev/null +++ b/docs/dli/api-ref/dli_02_0361.html @@ -0,0 +1,24 @@ + + +

      Queue-related APIs (Discarded)

      +

      +
      + +