From 14a6d65e8cac72a6651088f051115dc1cbc48495 Mon Sep 17 00:00:00 2001 From: "Xiong, Chen Xiao" Date: Fri, 1 Mar 2024 11:46:15 +0000 Subject: [PATCH] DataArts API 20240130 version Reviewed-by: Pruthi, Vineet Co-authored-by: Xiong, Chen Xiao Co-committed-by: Xiong, Chen Xiao --- docs/dataartsstudio/api-ref/ALL_META.TXT.json | 2573 ++++++++++++----- docs/dataartsstudio/api-ref/CLASS.TXT.json | 1027 +++---- ... => CreateAndStartRandomClusterJob_0.html} | 48 +- .../dataartsstudio/api-ref/CreateCluster.html | 655 ----- .../api-ref/CreateCluster_0.html | 655 +++++ docs/dataartsstudio/api-ref/CreateJob.html | 803 ----- docs/dataartsstudio/api-ref/CreateJob_0.html | 818 ++++++ .../{CreateLink.html => CreateLink_0.html} | 78 +- ...eleteCluster.html => DeleteCluster_0.html} | 14 +- .../{DeleteJob.html => DeleteJob_0.html} | 12 +- .../{DeleteLink.html => DeleteLink_0.html} | 12 +- docs/dataartsstudio/api-ref/ErrorCode.html | 4 +- ...{ListClusters.html => ListClusters_0.html} | 62 +- ...tartCluster.html => RestartCluster_0.html} | 18 +- ...erDetail.html => ShowClusterDetail_0.html} | 68 +- ...howJobStatus.html => ShowJobStatus_0.html} | 24 +- .../{ShowJobs.html => ShowJobs_0.html} | 36 +- .../{ShowLink.html => ShowLink_0.html} | 64 +- ...ubmissions.html => ShowSubmissions_0.html} | 24 +- ...{StartCluster.html => StartCluster_0.html} | 14 +- .../{StartJob.html => StartJob_0.html} | 16 +- docs/dataartsstudio/api-ref/StopCluster.html | 158 +- .../api-ref/{StopJob.html => StopJob_0.html} | 16 +- .../{UpdateJob.html => UpdateJob_0.html} | 44 +- .../{UpdateLink.html => UpdateLink_0.html} | 79 +- .../api-ref/dataartsstudio_02_0001.html | 6 +- .../api-ref/dataartsstudio_02_0002.html | 4 +- .../api-ref/dataartsstudio_02_0004.html | 13 - .../api-ref/dataartsstudio_02_0005.html | 3 +- .../api-ref/dataartsstudio_02_0006.html | 13 +- .../api-ref/dataartsstudio_02_0007.html | 198 +- .../api-ref/dataartsstudio_02_0008.html | 2 +- .../api-ref/dataartsstudio_02_0009.html | 247 -- .../api-ref/dataartsstudio_02_0010.html | 21 +- .../api-ref/dataartsstudio_02_0011.html | 13 +- .../api-ref/dataartsstudio_02_0012.html | 4 +- .../api-ref/dataartsstudio_02_0013.html | 268 +- .../api-ref/dataartsstudio_02_0015.html | 4 +- .../api-ref/dataartsstudio_02_0016.html | 6 +- ..._0127.html => dataartsstudio_02_0048.html} | 10 +- .../api-ref/dataartsstudio_02_0049.html | 18 +- .../api-ref/dataartsstudio_02_0050.html | 439 +-- .../api-ref/dataartsstudio_02_0051.html | 144 +- .../api-ref/dataartsstudio_02_0052.html | 100 +- .../api-ref/dataartsstudio_02_0053.html | 108 +- .../api-ref/dataartsstudio_02_0054.html | 62 +- .../api-ref/dataartsstudio_02_0055.html | 52 +- .../api-ref/dataartsstudio_02_0056.html | 12 +- .../api-ref/dataartsstudio_02_0057.html | 74 +- .../api-ref/dataartsstudio_02_0058.html | 35 +- .../api-ref/dataartsstudio_02_0059.html | 14 +- .../api-ref/dataartsstudio_02_0060.html | 10 +- .../api-ref/dataartsstudio_02_0061.html | 16 +- .../api-ref/dataartsstudio_02_0062.html | 30 +- .../api-ref/dataartsstudio_02_0063.html | 16 +- .../api-ref/dataartsstudio_02_0064.html | 14 +- .../api-ref/dataartsstudio_02_0065.html | 70 +- .../api-ref/dataartsstudio_02_0066.html | 15 +- .../api-ref/dataartsstudio_02_0067.html | 19 +- .../api-ref/dataartsstudio_02_0082.html | 127 - .../api-ref/dataartsstudio_02_0083.html | 63 - .../api-ref/dataartsstudio_02_0084.html | 1302 ++++++--- .../api-ref/dataartsstudio_02_0085.html | 2058 ++++++++++++- .../api-ref/dataartsstudio_02_0086.html | 85 +- .../api-ref/dataartsstudio_02_0087.html | 1960 ++++++++++++- .../api-ref/dataartsstudio_02_0088.html | 56 +- .../api-ref/dataartsstudio_02_0089.html | 18 +- .../api-ref/dataartsstudio_02_0090.html | 91 +- .../api-ref/dataartsstudio_02_0091.html | 78 +- .../api-ref/dataartsstudio_02_0092.html | 70 +- .../api-ref/dataartsstudio_02_0093.html | 32 +- .../api-ref/dataartsstudio_02_0094.html | 113 +- .../api-ref/dataartsstudio_02_0095.html | 46 +- .../api-ref/dataartsstudio_02_0096.html | 96 +- .../api-ref/dataartsstudio_02_0097.html | 98 +- .../api-ref/dataartsstudio_02_0098.html | 74 +- .../api-ref/dataartsstudio_02_0099.html | 33 +- .../api-ref/dataartsstudio_02_0100.html | 48 +- .../api-ref/dataartsstudio_02_0101.html | 19 +- .../api-ref/dataartsstudio_02_0102.html | 25 +- .../api-ref/dataartsstudio_02_0103.html | 58 +- .../api-ref/dataartsstudio_02_0104.html | 22 +- .../api-ref/dataartsstudio_02_0105.html | 46 +- .../api-ref/dataartsstudio_02_0106.html | 119 +- .../api-ref/dataartsstudio_02_0260.html | 8 +- .../api-ref/dataartsstudio_02_0262.html | 8 +- .../api-ref/dataartsstudio_02_0263.html | 15 +- .../api-ref/dataartsstudio_02_0266.html | 6 +- .../api-ref/dataartsstudio_02_0267.html | 6 +- .../api-ref/dataartsstudio_02_0268.html | 15 +- .../api-ref/dataartsstudio_02_0269.html | 11 +- .../api-ref/dataartsstudio_02_0270.html | 2 +- .../api-ref/dataartsstudio_02_0271.html | 4 +- .../api-ref/dataartsstudio_02_0272.html | 6 +- .../api-ref/dataartsstudio_02_0274.html | 2 +- .../api-ref/dataartsstudio_02_0276.html | 2 +- .../api-ref/dataartsstudio_02_0277.html | 2 +- .../api-ref/dataartsstudio_02_0278.html | 108 - .../api-ref/dataartsstudio_02_0280.html | 2 +- .../api-ref/dataartsstudio_02_0282.html | 12 +- .../api-ref/dataartsstudio_02_0283.html | 231 +- .../api-ref/dataartsstudio_02_0284.html | 210 +- .../api-ref/dataartsstudio_02_0285.html | 2 +- .../api-ref/dataartsstudio_02_0286.html | 4 +- .../api-ref/dataartsstudio_02_0287.html | 244 +- .../api-ref/dataartsstudio_02_0288.html | 32 +- .../api-ref/dataartsstudio_02_0289.html | 2 +- .../api-ref/dataartsstudio_02_0290.html | 4 +- .../api-ref/dataartsstudio_02_0291.html | 2 +- .../api-ref/dataartsstudio_02_0292.html | 2 +- .../api-ref/dataartsstudio_02_0293.html | 2 +- .../api-ref/dataartsstudio_02_0294.html | 105 - .../api-ref/dataartsstudio_02_0296.html | 4 +- .../api-ref/dataartsstudio_02_0297.html | 46 +- .../api-ref/dataartsstudio_02_0298.html | 8 +- .../api-ref/dataartsstudio_02_0299.html | 2 +- .../api-ref/dataartsstudio_02_0300.html | 4 +- .../api-ref/dataartsstudio_02_0301.html | 183 -- .../api-ref/dataartsstudio_02_0302.html | 2 +- .../api-ref/dataartsstudio_02_0303.html | 183 -- .../api-ref/dataartsstudio_02_0304.html | 2 +- .../api-ref/dataartsstudio_02_0305.html | 2 +- .../api-ref/dataartsstudio_02_0306.html | 2 +- .../api-ref/dataartsstudio_02_0307.html | 87 - .../api-ref/dataartsstudio_02_0308.html | 231 -- .../api-ref/dataartsstudio_02_0309.html | 4 +- .../api-ref/dataartsstudio_02_0311.html | 40 +- .../api-ref/dataartsstudio_02_0313.html | 373 ++- .../api-ref/dataartsstudio_02_0314.html | 42 - .../api-ref/dataartsstudio_02_0316.html | 15 - .../api-ref/dataartsstudio_02_0318.html | 103 +- .../api-ref/dataartsstudio_02_0330.html | 32 - .../api-ref/dataartsstudio_02_0350.html | 12 +- ...5.html => destination_job_parameters.html} | 8 +- .../api-ref/en-us_image_0000001321929240.gif | Bin 29752 -> 0 bytes .../api-ref/en-us_image_0000001322088924.png | Bin 96274 -> 0 bytes .../api-ref/en-us_image_0000001373088745.png | Bin 16641 -> 0 bytes .../api-ref/en-us_image_0000001373289273.png | Bin 22462 -> 0 bytes .../api-ref/en-us_image_0000001373289293.png | Bin 22462 -> 0 bytes ...1.png => en-us_image_0000001668210950.png} | Bin ...9.png => en-us_image_0000001668278494.png} | Bin ...5.png => en-us_image_0000001716158249.png} | Bin ...8.png => en-us_image_0000001716290189.png} | Bin .../api-ref/en-us_image_0000001828945753.png | Bin 0 -> 40761 bytes docs/dataartsstudio/api-ref/endpoint.html | 13 + .../dataartsstudio/api-ref/job_parameter.html | 231 ++ ...tudio_02_0261.html => link_parameter.html} | 6 +- .../api-ref/making_request.html | 248 ++ .../api-ref/projectid_accountid.html | 40 + .../public_sys-resources/imageclose.gif | Bin 0 -> 1238 bytes .../public_sys-resources/imageclosehover.gif | Bin 0 -> 1172 bytes .../api-ref/public_sys-resources/imagemax.gif | Bin 0 -> 1267 bytes .../public_sys-resources/imagemaxhover.gif | Bin 0 -> 1199 bytes .../public_sys-resources/macFFBgHack.png | Bin 0 -> 1014 bytes ...2_0281.html => source_job_parameters.html} | 8 +- .../api-ref/topic_300000000_3.html | 28 - .../api-ref/topic_300000000_8.html | 28 + .../api-ref/topic_300000001_2.html | 32 - .../api-ref/topic_300000001_6.html | 32 + .../api-ref/topic_300000002_2.html | 22 - .../api-ref/topic_300000002_6.html | 22 + 161 files changed, 12075 insertions(+), 7188 deletions(-) rename docs/dataartsstudio/api-ref/{CreateAndStartRandomClusterJob.html => CreateAndStartRandomClusterJob_0.html} (89%) delete mode 100644 docs/dataartsstudio/api-ref/CreateCluster.html create mode 100644 docs/dataartsstudio/api-ref/CreateCluster_0.html delete mode 100644 docs/dataartsstudio/api-ref/CreateJob.html create mode 100644 docs/dataartsstudio/api-ref/CreateJob_0.html rename docs/dataartsstudio/api-ref/{CreateLink.html => CreateLink_0.html} (80%) rename docs/dataartsstudio/api-ref/{DeleteCluster.html => DeleteCluster_0.html} (85%) rename docs/dataartsstudio/api-ref/{DeleteJob.html => DeleteJob_0.html} (86%) rename docs/dataartsstudio/api-ref/{DeleteLink.html => DeleteLink_0.html} (87%) rename docs/dataartsstudio/api-ref/{ListClusters.html => ListClusters_0.html} (83%) rename docs/dataartsstudio/api-ref/{RestartCluster.html => RestartCluster_0.html} (86%) rename docs/dataartsstudio/api-ref/{ShowClusterDetail.html => ShowClusterDetail_0.html} (84%) rename docs/dataartsstudio/api-ref/{ShowJobStatus.html => ShowJobStatus_0.html} (87%) rename docs/dataartsstudio/api-ref/{ShowJobs.html => ShowJobs_0.html} (89%) rename docs/dataartsstudio/api-ref/{ShowLink.html => ShowLink_0.html} (79%) rename docs/dataartsstudio/api-ref/{ShowSubmissions.html => ShowSubmissions_0.html} (88%) rename docs/dataartsstudio/api-ref/{StartCluster.html => StartCluster_0.html} (84%) rename docs/dataartsstudio/api-ref/{StartJob.html => StartJob_0.html} (88%) rename docs/dataartsstudio/api-ref/{StopJob.html => StopJob_0.html} (79%) rename docs/dataartsstudio/api-ref/{UpdateJob.html => UpdateJob_0.html} (88%) rename docs/dataartsstudio/api-ref/{UpdateLink.html => UpdateLink_0.html} (80%) delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0004.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0009.html rename docs/dataartsstudio/api-ref/{dataartsstudio_02_0127.html => dataartsstudio_02_0048.html} (56%) delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0082.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0083.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0278.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0294.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0301.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0303.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0307.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0308.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0314.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0316.html delete mode 100644 docs/dataartsstudio/api-ref/dataartsstudio_02_0330.html rename docs/dataartsstudio/api-ref/{dataartsstudio_02_0295.html => destination_job_parameters.html} (73%) delete mode 100644 docs/dataartsstudio/api-ref/en-us_image_0000001321929240.gif delete mode 100644 docs/dataartsstudio/api-ref/en-us_image_0000001322088924.png delete mode 100644 docs/dataartsstudio/api-ref/en-us_image_0000001373088745.png delete mode 100644 docs/dataartsstudio/api-ref/en-us_image_0000001373289273.png delete mode 100644 docs/dataartsstudio/api-ref/en-us_image_0000001373289293.png rename docs/dataartsstudio/api-ref/{en-us_image_0000001373408961.png => en-us_image_0000001668210950.png} (100%) rename docs/dataartsstudio/api-ref/{en-us_image_0000001373408969.png => en-us_image_0000001668278494.png} (100%) rename docs/dataartsstudio/api-ref/{en-us_image_0000001373088765.png => en-us_image_0000001716158249.png} (100%) rename docs/dataartsstudio/api-ref/{en-us_image_0000001322248848.png => en-us_image_0000001716290189.png} (100%) create mode 100644 docs/dataartsstudio/api-ref/en-us_image_0000001828945753.png create mode 100644 docs/dataartsstudio/api-ref/endpoint.html create mode 100644 docs/dataartsstudio/api-ref/job_parameter.html rename docs/dataartsstudio/api-ref/{dataartsstudio_02_0261.html => link_parameter.html} (86%) create mode 100644 docs/dataartsstudio/api-ref/making_request.html create mode 100644 docs/dataartsstudio/api-ref/projectid_accountid.html create mode 100644 docs/dataartsstudio/api-ref/public_sys-resources/imageclose.gif create mode 100644 docs/dataartsstudio/api-ref/public_sys-resources/imageclosehover.gif create mode 100644 docs/dataartsstudio/api-ref/public_sys-resources/imagemax.gif create mode 100644 docs/dataartsstudio/api-ref/public_sys-resources/imagemaxhover.gif create mode 100644 docs/dataartsstudio/api-ref/public_sys-resources/macFFBgHack.png rename docs/dataartsstudio/api-ref/{dataartsstudio_02_0281.html => source_job_parameters.html} (81%) delete mode 100644 docs/dataartsstudio/api-ref/topic_300000000_3.html create mode 100644 docs/dataartsstudio/api-ref/topic_300000000_8.html delete mode 100644 docs/dataartsstudio/api-ref/topic_300000001_2.html create mode 100644 docs/dataartsstudio/api-ref/topic_300000001_6.html delete mode 100644 docs/dataartsstudio/api-ref/topic_300000002_2.html create mode 100644 docs/dataartsstudio/api-ref/topic_300000002_6.html diff --git a/docs/dataartsstudio/api-ref/ALL_META.TXT.json b/docs/dataartsstudio/api-ref/ALL_META.TXT.json index 7f28f483..1d481d01 100644 --- a/docs/dataartsstudio/api-ref/ALL_META.TXT.json +++ b/docs/dataartsstudio/api-ref/ALL_META.TXT.json @@ -1,1382 +1,2665 @@ [ + { + "dockw":"API Reference" + }, { "uri":"dataartsstudio_02_0001.html", - "product_code":"dgc", + "node_id":"dataartsstudio_02_0001.xml", + "product_code":"dataartsstudio", "code":"1", "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":"Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Before You Start", "githuburl":"" }, { "uri":"dataartsstudio_02_0002.html", - "product_code":"dgc", + "node_id":"dataartsstudio_02_0002.xml", + "product_code":"dataartsstudio", "code":"2", "des":"Welcome to DataArts Studio. DataArts Studio is a one-stop operations platform that provides data lifecycle management and intelligent data management for enterprises' dig", "doc_type":"api", "kw":"Overview,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Overview", "githuburl":"" }, { "uri":"dataartsstudio_02_0003.html", - "product_code":"dgc", + "node_id":"dataartsstudio_02_0003.xml", + "product_code":"dataartsstudio", "code":"3", "des":"DataArts Studio supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details on API calling, see Calling APIs.", "doc_type":"api", "kw":"API Calling,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"API Calling", "githuburl":"" }, { "uri":"dataartsstudio_02_0006.html", - "product_code":"dgc", + "node_id":"dataartsstudio_02_0006.xml", + "product_code":"dataartsstudio", "code":"4", "des":"DomainA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user p", "doc_type":"api", "kw":"Concepts,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Concepts", "githuburl":"" }, { - "uri":"dataartsstudio_02_0004.html", - "product_code":"dgc", + "uri":"endpoint.html", + "node_id":"endpoint.xml", + "product_code":"dataartsstudio", "code":"5", "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions.You can obtain endpoints from Regions and Endpoints.", "doc_type":"api", "kw":"Endpoints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Endpoints", "githuburl":"" }, { - "uri":"dataartsstudio_02_0314.html", - "product_code":"", + "uri":"projectid_accountid.html", + "node_id":"projectid_accountid.xml", + "product_code":"dataartsstudio", "code":"6", - "des":"You can obtain the project ID and account ID by performing the following steps:Register with and log in to the management console.Hover the cursor on the username in the ", - "doc_type":"", + "des":"A project is a group of tenant resources, and an account ID corresponds to the current account. The IAM ID corresponds to the current user. You can view the project IDs, ", + "doc_type":"api", "kw":"Project ID and Account ID,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Project ID and Account ID", "githuburl":"" }, { "uri":"dataartsstudio_02_0350.html", - "product_code":"", + "node_id":"dataartsstudio_02_0350.xml", + "product_code":"dataartsstudio", "code":"7", "des":"To obtain a DataArts Studio instance ID and workspace ID, perform the following steps:On the DataArts Studio console, locate a workspace and click any module, such as Man", - "doc_type":"", + "doc_type":"api", "kw":"DataArts Studio Instance ID and Workspace ID,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"DataArts Studio Instance ID and Workspace ID", "githuburl":"" }, - { - "uri":"dataartsstudio_02_0316.html", - "product_code":"", - "code":"8", - "des":"A job ID (jobid) is required for some URLs when an API is called. To obtain a job ID, perform the following operations:Log in to the DataArts Studio console. Locate an in", - "doc_type":"", - "kw":"Data Development Job ID,Before You Start,API Reference", - "title":"Data Development Job ID", - "githuburl":"" - }, { "uri":"dataartsstudio_02_0005.html", - "product_code":"dgc", - "code":"9", - "des":"The restrictions on DataArts Catalog APIs are as follows:CDM jobs carry large volumes of data, which increases the database load. You are advised to periodically delete u", + "node_id":"dataartsstudio_02_0005.xml", + "product_code":"dataartsstudio", + "code":"8", + "des":"An IAM user can pass the authentication and access DataArts Studio through an API or SDK only if Programmatic access is selected for Access Type during the creation of th", "doc_type":"api", "kw":"Constraints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Constraints", "githuburl":"" }, { "uri":"dataartsstudio_02_0007.html", - "product_code":"dgc", - "code":"10", + "node_id":"dataartsstudio_02_0007.xml", + "product_code":"dataartsstudio", + "code":"9", "des":"DataArts Studio provides self-developed APIs that comply with RESTful API design specifications. You can call those APIs to perform operations on DataArts Studio.", "doc_type":"api", "kw":"API Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"API Overview", "githuburl":"" }, { "uri":"dataartsstudio_02_0008.html", - "product_code":"dgc", - "code":"11", + "node_id":"dataartsstudio_02_0008.xml", + "product_code":"dataartsstudio", + "code":"10", "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":"Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Calling APIs", "githuburl":"" }, { - "uri":"dataartsstudio_02_0009.html", - "product_code":"dgc", - "code":"12", + "uri":"making_request.html", + "node_id":"making_request.xml", + "product_code":"dataartsstudio", + "code":"11", "des":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token ca", "doc_type":"api", "kw":"Making an API Request,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Making an API Request", "githuburl":"" }, { "uri":"dataartsstudio_02_0010.html", - "product_code":"dgc", - "code":"13", + "node_id":"dataartsstudio_02_0010.xml", + "product_code":"dataartsstudio", + "code":"12", "des":"Requests for calling an API can be authenticated using either of the following methods:Token-based authentication: Requests are authenticated using a token.AK/SK-based au", "doc_type":"api", "kw":"Authentication,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Authentication", "githuburl":"" }, { "uri":"dataartsstudio_02_0011.html", - "product_code":"dgc", - "code":"14", + "node_id":"dataartsstudio_02_0011.xml", + "product_code":"dataartsstudio", + "code":"13", "des":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", "doc_type":"api", "kw":"Response,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Response", "githuburl":"" }, { "uri":"dataartsstudio_02_0012.html", - "product_code":"dgc", - "code":"15", + "node_id":"dataartsstudio_02_0012.xml", + "product_code":"dataartsstudio", + "code":"14", "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":"Application Cases", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Application Cases", "githuburl":"" }, { "uri":"dataartsstudio_02_0013.html", - "product_code":"dgc", - "code":"16", + "node_id":"dataartsstudio_02_0013.xml", + "product_code":"dataartsstudio", + "code":"15", "des":"This section describes how to use cURL to call CDM APIs to migrate data from a local MySQL database to DWS in the cloud.Obtaining a TokenCall the API to obtain the user t", "doc_type":"api", - "kw":"Application Example,Application Cases,API Reference", - "title":"Application Example", + "kw":"Example of Using DataArts Migration APIs,Application Cases,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"Example of Using DataArts Migration APIs", "githuburl":"" }, { "uri":"dataartsstudio_02_0015.html", - "product_code":"dgc", - "code":"17", + "node_id":"dataartsstudio_02_0015.xml", + "product_code":"dataartsstudio", + "code":"16", "des":"DataArts Studio helps enterprises quickly build an end-to-end intelligent data system that covers the entire process from data ingestion to data analytics. The system can", "doc_type":"api", - "kw":"Example of Using Data Development APIs,Application Cases,API Reference", - "title":"Example of Using Data Development APIs", + "kw":"Example of Using DataArts Factory APIs,Application Cases,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"Example of Using DataArts Factory APIs", "githuburl":"" }, { "uri":"dataartsstudio_02_0016.html", - "product_code":"dgc", - "code":"18", + "node_id":"dataartsstudio_02_0016.xml", + "product_code":"dataartsstudio", + "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":"DataArts Migration APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"DataArts Migration APIs", "githuburl":"" }, { - "uri":"topic_300000000_3.html", + "uri":"topic_300000000_8.html", + "node_id":"topic_300000000_8.xml", "product_code":"cdm", - "code":"19", + "code":"18", "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":"Cluster Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Cluster Management", "githuburl":"" }, { - "uri":"ShowClusterDetail.html", + "uri":"ShowClusterDetail_0.html", + "node_id":"showclusterdetail_0.xml", "product_code":"cdm", - "code":"20", + "code":"19", "des":"This API is used to query cluster details.GET /v1.1/{project_id}/clusters/{cluster_id}Status code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Querying Cluster Details,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Querying Cluster Details", "githuburl":"" }, { - "uri":"DeleteCluster.html", + "uri":"DeleteCluster_0.html", + "node_id":"deletecluster_0.xml", "product_code":"cdm", - "code":"21", + "code":"20", "des":"This API is used to delete a cluster.DELETE /v1.1/{project_id}/clusters/{cluster_id}Status code: 202Status code: 202AcceptedSee Error Codes.", "doc_type":"api", "kw":"Deleting a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Deleting a Cluster", "githuburl":"" }, { - "uri":"RestartCluster.html", + "uri":"RestartCluster_0.html", + "node_id":"restartcluster_0.xml", "product_code":"cdm", - "code":"22", + "code":"21", "des":"This API is used to restart a cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/actionStatus code: 200Restarting a ClusterStatus code: 200okSee Error Codes.", "doc_type":"api", "kw":"Restarting a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Restarting a Cluster", "githuburl":"" }, { - "uri":"StartCluster.html", + "uri":"StartCluster_0.html", + "node_id":"startcluster_0.xml", "product_code":"cdm", - "code":"23", + "code":"22", "des":"This API is used to start a cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/actionStatus code: 200Starting a ClusterStatus code: 200okSee Error Codes.", "doc_type":"api", "kw":"Starting a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Starting a Cluster", "githuburl":"" }, { "uri":"StopCluster.html", + "node_id":"stopcluster.xml", "product_code":"cdm", - "code":"24", + "code":"23", "des":"This API is used to stop a cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/actionStatus code: 200Stopping a ClusterStatus code: 200okSee Error Codes.", "doc_type":"api", "kw":"Stopping a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Stopping a Cluster", "githuburl":"" }, { - "uri":"CreateCluster.html", + "uri":"CreateCluster_0.html", + "node_id":"createcluster_0.xml", "product_code":"cdm", - "code":"25", + "code":"24", "des":"This API is used to create a cluster.POST /v1.1/{project_id}/clustersStatus code: 202Status code: 202AcceptedSee Error Codes.", "doc_type":"api", "kw":"Creating a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Creating a Cluster", "githuburl":"" }, { - "uri":"ListClusters.html", + "uri":"ListClusters_0.html", + "node_id":"listclusters_0.xml", "product_code":"cdm", - "code":"26", + "code":"25", "des":"This API is used to query the cluster list.GET /v1.1/{project_id}/clustersStatus code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Querying the Cluster List,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Querying the Cluster List", "githuburl":"" }, { - "uri":"topic_300000001_2.html", + "uri":"topic_300000001_6.html", + "node_id":"topic_300000001_6.xml", "product_code":"cdm", - "code":"27", + "code":"26", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Job Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Job Management", "githuburl":"" }, { - "uri":"ShowJobs.html", + "uri":"ShowJobs_0.html", + "node_id":"showjobs_0.xml", "product_code":"cdm", - "code":"28", + "code":"27", "des":"This API is used to query jobs.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}Status code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Querying a Job,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Querying a Job", "githuburl":"" }, { - "uri":"DeleteJob.html", + "uri":"DeleteJob_0.html", + "node_id":"deletejob_0.xml", "product_code":"cdm", - "code":"29", + "code":"28", "des":"This API is used to delete a job.DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}Status code: 500Status code: 500An internal service error occurred. For", "doc_type":"api", "kw":"Deleting a Job,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Deleting a Job", "githuburl":"" }, { - "uri":"UpdateJob.html", + "uri":"UpdateJob_0.html", + "node_id":"updatejob_0.xml", "product_code":"cdm", - "code":"30", + "code":"29", "des":"This API is used to modify a job.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}Status code: 200Status code: 400Status code: 200okStatus code: 400Error co", "doc_type":"api", "kw":"Modifying a Job,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Modifying a Job", "githuburl":"" }, { - "uri":"CreateAndStartRandomClusterJob.html", + "uri":"CreateAndStartRandomClusterJob_0.html", + "node_id":"createandstartrandomclusterjob_0.xml", "product_code":"cdm", - "code":"31", + "code":"30", "des":"This API is used to create and execute a job in a random cluster.POST /v1.1/{project_id}/clusters/jobStatus code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Creating and Executing a Job in a Random Cluster,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Creating and Executing a Job in a Random Cluster", "githuburl":"" }, { - "uri":"StopJob.html", + "uri":"StopJob_0.html", + "node_id":"stopjob_0.xml", "product_code":"cdm", - "code":"32", + "code":"31", "des":"This API is used to stop a job.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/stopStatus code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Stopping a Job,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Stopping a Job", "githuburl":"" }, { - "uri":"CreateJob.html", + "uri":"CreateJob_0.html", + "node_id":"createjob_0.xml", "product_code":"cdm", - "code":"33", + "code":"32", "des":"This API is used to create a job in a specified cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/jobStatus code: 200Status code: 400Status code: 200okStatus code", "doc_type":"api", "kw":"Creating a Job in a Specified Cluster,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Creating a Job in a Specified Cluster", "githuburl":"" }, { - "uri":"StartJob.html", + "uri":"StartJob_0.html", + "node_id":"startjob_0.xml", "product_code":"cdm", - "code":"34", + "code":"33", "des":"This API is used to start a job.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/startStatus code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Starting a Job,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Starting a Job", "githuburl":"" }, { - "uri":"ShowJobStatus.html", + "uri":"ShowJobStatus_0.html", + "node_id":"showjobstatus_0.xml", "product_code":"cdm", - "code":"35", + "code":"34", "des":"This API is used to query the job status.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/statusStatus code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Querying Job Status,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Querying Job Status", "githuburl":"" }, { - "uri":"ShowSubmissions.html", + "uri":"ShowSubmissions_0.html", + "node_id":"showsubmissions_0.xml", "product_code":"cdm", - "code":"36", + "code":"35", "des":"This API is used to query the job execution history.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissionsStatus code: 200Status code: 200okSee Error Codes.", "doc_type":"api", "kw":"Querying Job Execution History,Job Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Querying Job Execution History", "githuburl":"" }, { - "uri":"topic_300000002_2.html", + "uri":"topic_300000002_6.html", + "node_id":"topic_300000002_6.xml", "product_code":"cdm", - "code":"37", + "code":"36", "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":"Link Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Link Management", "githuburl":"" }, { - "uri":"CreateLink.html", + "uri":"CreateLink_0.html", + "node_id":"createlink_0.xml", "product_code":"cdm", - "code":"38", + "code":"37", "des":"This API is used to create a link.POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/linkStatus code: 200Status code: 400Status code: 500Status code: 200OKStatus code: 400", "doc_type":"api", "kw":"Creating a Link,Link Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Creating a Link", "githuburl":"" }, { - "uri":"ShowLink.html", + "uri":"ShowLink_0.html", + "node_id":"showlink_0.xml", "product_code":"cdm", - "code":"39", + "code":"38", "des":"This API is used to query a link.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}Status code: 200Status code: 200OKSee Error Codes.", "doc_type":"api", "kw":"Querying a Link,Link Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Querying a Link", "githuburl":"" }, { - "uri":"DeleteLink.html", + "uri":"DeleteLink_0.html", + "node_id":"deletelink_0.xml", "product_code":"cdm", - "code":"40", + "code":"39", "des":"This API is used to delete a link.DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}Status code: 500Status code: 500An internal service error occurred. ", "doc_type":"api", "kw":"Deleting a Link,Link Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Deleting a Link", "githuburl":"" }, { - "uri":"UpdateLink.html", + "uri":"UpdateLink_0.html", + "node_id":"updatelink_0.xml", "product_code":"cdm", - "code":"41", + "code":"40", "des":"This API is used to modify a link.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}Status code: 200Status code: 500Status code: 200OKStatus code: 500An in", "doc_type":"api", "kw":"Modifying a Link,Link Management,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "prodname":"cdm" + } + ], "title":"Modifying a Link", "githuburl":"" }, { "uri":"dataartsstudio_02_0260.html", - "product_code":"dgc", - "code":"42", + "node_id":"dataartsstudio_02_0260.xml", + "product_code":"dataartsstudio", + "code":"41", "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 Data Structures", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Public Data Structures", "githuburl":"" }, { - "uri":"dataartsstudio_02_0261.html", - "product_code":"dgc", - "code":"43", + "uri":"link_parameter.html", + "node_id":"link_parameter.xml", + "product_code":"dataartsstudio", + "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":"Link Parameter Description", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link Parameter Description", "githuburl":"" }, { "uri":"dataartsstudio_02_0262.html", - "product_code":"dgc", - "code":"44", - "des":"By creating a JDBC link, you can extract data from or load data to the following relational databases:Data Warehouse ServiceRDS for MySQLRDS for PostgreSQLRDS for SQL Ser", + "node_id":"dataartsstudio_02_0262.xml", + "product_code":"dataartsstudio", + "code":"43", + "des":"By creating a JDBC link, you can extract data from or load data to the following relational databases:RDS for PostgreSQLRDS for SQL ServerPostgreSQLMicrosoft SQL ServerRD", "doc_type":"api", "kw":"Link to a Relational Database,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to a Relational Database", "githuburl":"" }, { "uri":"dataartsstudio_02_0263.html", - "product_code":"dgc", - "code":"45", - "des":"By creating an OBS link, you can extract files from or load files to OBS. Files in CSV, JSON, and binary format are supported.", + "node_id":"dataartsstudio_02_0263.xml", + "product_code":"dataartsstudio", + "code":"44", + "des":"By creating an OBS link, you can extract files from or load files to OBS. Files in CSV, JSON, and binary format are supported.The following is the message body of a sampl", "doc_type":"api", "kw":"Link to OBS,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to OBS", "githuburl":"" }, { "uri":"dataartsstudio_02_0266.html", - "product_code":"dgc", - "code":"46", + "node_id":"dataartsstudio_02_0266.xml", + "product_code":"dataartsstudio", + "code":"45", "des":"By creating an HDFS link, you can extract files from or load files to MRS, FusionInsight HD, or Apache Hadoop. Files in CSV, Parquet, and binary formats are supported.", "doc_type":"api", "kw":"Link to HDFS,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to HDFS", "githuburl":"" }, { "uri":"dataartsstudio_02_0267.html", - "product_code":"dgc", - "code":"47", + "node_id":"dataartsstudio_02_0267.xml", + "product_code":"dataartsstudio", + "code":"46", "des":"By creating an HBase link, you can extract data from or load data to HBase of MRS, FusionInsight HD, and Apache Hadoop.", "doc_type":"api", "kw":"Link to HBase,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to HBase", "githuburl":"" }, { "uri":"dataartsstudio_02_0268.html", - "product_code":"dgc", - "code":"48", - "des":"By creating a CloudTable link, you can extract data from or load data to CloudTable.", + "node_id":"dataartsstudio_02_0268.xml", + "product_code":"dataartsstudio", + "code":"47", + "des":"By creating a CloudTable link, you can extract data from or load data to CloudTable.The following is the message body of a sample link. You are advised to store the AK an", "doc_type":"api", "kw":"Link to CloudTable,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to CloudTable", "githuburl":"" }, { "uri":"dataartsstudio_02_0269.html", - "product_code":"dgc", - "code":"49", - "des":"By creating a Hive link, you can extract data from or load data to Hive of MRS.", + "node_id":"dataartsstudio_02_0269.xml", + "product_code":"dataartsstudio", + "code":"48", + "des":"By creating a Hive link, you can extract data from or load data to Hive of MRS.The following is the message body of a sample link. You are advised to store the AK and SK ", "doc_type":"api", "kw":"Link to Hive,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to Hive", "githuburl":"" }, { "uri":"dataartsstudio_02_0270.html", - "product_code":"dgc", - "code":"50", + "node_id":"dataartsstudio_02_0270.xml", + "product_code":"dataartsstudio", + "code":"49", "des":"By creating an FTP or SFTP link, you are able to extract files from or load files to the FTP or SFTP server. Files in CSV, JSON, and binary format are supported.Parameter", "doc_type":"api", "kw":"Link to an FTP or SFTP Server,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to an FTP or SFTP Server", "githuburl":"" }, { "uri":"dataartsstudio_02_0271.html", - "product_code":"dgc", - "code":"51", - "des":"By creating a MongoDB link, you can extract data from or load data to MongoDB.", + "node_id":"dataartsstudio_02_0271.xml", + "product_code":"dataartsstudio", + "code":"50", + "des":"By creating a Link to MongoDB, you can extract data from or load data to MongoDB.", "doc_type":"api", "kw":"Link to MongoDB,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to MongoDB", "githuburl":"" }, { "uri":"dataartsstudio_02_0272.html", - "product_code":"dgc", - "code":"52", - "des":"By creating a Redis link, you can extract data from or load data to the Redis server. By creating a DCS link, you can load data to Data Cache Service (DCS), but not extra", + "node_id":"dataartsstudio_02_0272.xml", + "product_code":"dataartsstudio", + "code":"51", + "des":"By creating a Redis link, you can extract data from or load data to the Redis server.", "doc_type":"api", - "kw":"Link to Redis/DCS (to Be Brought Offline),Link Parameter Description,API Reference", - "title":"Link to Redis/DCS (to Be Brought Offline)", + "kw":"Link to Redis,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"Link to Redis", "githuburl":"" }, { "uri":"dataartsstudio_02_0274.html", - "product_code":"dgc", - "code":"53", + "node_id":"dataartsstudio_02_0274.xml", + "product_code":"dataartsstudio", + "code":"52", "des":"By creating a Kafka link, you are able to access open source Kafka and migrate data from Kafka to other data sources as required. Currently, only data export from Kafka i", "doc_type":"api", "kw":"Link to Kafka,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to Kafka", "githuburl":"" }, { "uri":"dataartsstudio_02_0276.html", - "product_code":"dgc", - "code":"54", + "node_id":"dataartsstudio_02_0276.xml", + "product_code":"dataartsstudio", + "code":"53", "des":"By creating an Elasticsearch link, you can extract data from or load data to the Elasticsearch server or Cloud Search Service.", "doc_type":"api", "kw":"Link to Elasticsearch/Cloud Search Service,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to Elasticsearch/Cloud Search Service", "githuburl":"" }, { "uri":"dataartsstudio_02_0277.html", - "product_code":"dgc", - "code":"55", + "node_id":"dataartsstudio_02_0277.xml", + "product_code":"dataartsstudio", + "code":"54", "des":"By creating a DLI link, you can import data to DLI. Currently, you cannot export data from DLI using CDM.", "doc_type":"api", "kw":"Link to DLI,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to DLI", "githuburl":"" }, - { - "uri":"dataartsstudio_02_0278.html", - "product_code":"dgc", - "code":"56", - "des":"By creating an OpenTSDB link, you can extract data from and load data to CloudTable OpenTSDB.", - "doc_type":"api", - "kw":"Link to CloudTable OpenTSDB,Link Parameter Description,API Reference", - "title":"Link to CloudTable OpenTSDB", - "githuburl":"" - }, { "uri":"dataartsstudio_02_0280.html", - "product_code":"dgc", - "code":"57", + "node_id":"dataartsstudio_02_0280.xml", + "product_code":"dataartsstudio", + "code":"55", "des":"By creating a DMS Kafka link, you can connect to Kafka Basic or Kafka Platinum on DMS. Currently, you can only export data from DMS Kafka to Cloud Search Service.", "doc_type":"api", "kw":"Link to DMS Kafka,Link Parameter Description,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Link to DMS Kafka", "githuburl":"" }, { - "uri":"dataartsstudio_02_0281.html", - "product_code":"dgc", - "code":"58", + "uri":"source_job_parameters.html", + "node_id":"source_job_parameters.xml", + "product_code":"dataartsstudio", + "code":"56", "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":"Source Job Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Source Job Parameters", "githuburl":"" }, { "uri":"dataartsstudio_02_0282.html", - "product_code":"dgc", - "code":"59", + "node_id":"dataartsstudio_02_0282.xml", + "product_code":"dataartsstudio", + "code":"57", "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":"From a Relational Database,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From a Relational Database", "githuburl":"" }, { "uri":"dataartsstudio_02_0283.html", - "product_code":"dgc", - "code":"60", + "node_id":"dataartsstudio_02_0283.xml", + "product_code":"dataartsstudio", + "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":"From Object Storage,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From Object Storage", "githuburl":"" }, { "uri":"dataartsstudio_02_0284.html", - "product_code":"dgc", - "code":"61", + "node_id":"dataartsstudio_02_0284.xml", + "product_code":"dataartsstudio", + "code":"59", "des":"HDFS job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.inputDirectoryYesStringPath for storing data to be extracted. For example, /data_dir.fromJobC", "doc_type":"api", "kw":"From HDFS,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From HDFS", "githuburl":"" }, { "uri":"dataartsstudio_02_0285.html", - "product_code":"dgc", - "code":"62", + "node_id":"dataartsstudio_02_0285.xml", + "product_code":"dataartsstudio", + "code":"60", "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":"From Hive,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From Hive", "githuburl":"" }, { "uri":"dataartsstudio_02_0286.html", - "product_code":"dgc", - "code":"63", + "node_id":"dataartsstudio_02_0286.xml", + "product_code":"dataartsstudio", + "code":"61", "des":"HBase/CloudTable job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.tableYesStringName of the table from which data is extracted. For example, cdm.fr", "doc_type":"api", "kw":"From HBase/CloudTable,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From HBase/CloudTable", "githuburl":"" }, { "uri":"dataartsstudio_02_0287.html", - "product_code":"dgc", - "code":"64", + "node_id":"dataartsstudio_02_0287.xml", + "product_code":"dataartsstudio", + "code":"62", "des":"Source link job parameters of FTP and SFTP are the same. Table 1 describes the parameters.Source link job parameters of file systemsParameterMandatoryTypeDescriptionfromJ", "doc_type":"api", - "kw":"From FTP/SFTP/NAS (to Be Brought Offline)/SFS (to Be Brought Offline),Source Job Parameters,API Refe", - "title":"From FTP/SFTP/NAS (to Be Brought Offline)/SFS (to Be Brought Offline)", + "kw":"From FTP/SFTP,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"From FTP/SFTP", "githuburl":"" }, { "uri":"dataartsstudio_02_0288.html", - "product_code":"dgc", - "code":"65", + "node_id":"dataartsstudio_02_0288.xml", + "product_code":"dataartsstudio", + "code":"63", "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":"From HTTP/HTTPS,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From HTTP/HTTPS", "githuburl":"" }, { "uri":"dataartsstudio_02_0289.html", - "product_code":"dgc", - "code":"66", + "node_id":"dataartsstudio_02_0289.xml", + "product_code":"dataartsstudio", + "code":"64", "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":"From MongoDB/DDS,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From MongoDB/DDS", "githuburl":"" }, { "uri":"dataartsstudio_02_0290.html", - "product_code":"dgc", - "code":"67", + "node_id":"dataartsstudio_02_0290.xml", + "product_code":"dataartsstudio", + "code":"65", "des":"Redis job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.isBatchMigrationNoBooleanWhether to migrate all data in the databasefromJobConfig.keyPrefixY", "doc_type":"api", - "kw":"From Redis/DCS (to Be Brought Offline),Source Job Parameters,API Reference", - "title":"From Redis/DCS (to Be Brought Offline)", + "kw":"From Redis,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"From Redis", "githuburl":"" }, { "uri":"dataartsstudio_02_0291.html", - "product_code":"dgc", - "code":"68", + "node_id":"dataartsstudio_02_0291.xml", + "product_code":"dataartsstudio", + "code":"66", "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":"From DIS,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From DIS", "githuburl":"" }, { "uri":"dataartsstudio_02_0292.html", - "product_code":"dgc", - "code":"69", + "node_id":"dataartsstudio_02_0292.xml", + "product_code":"dataartsstudio", + "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":"From Kafka,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From Kafka", "githuburl":"" }, { "uri":"dataartsstudio_02_0293.html", - "product_code":"dgc", - "code":"70", + "node_id":"dataartsstudio_02_0293.xml", + "product_code":"dataartsstudio", + "code":"68", "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":"From Elasticsearch/Cloud Search Service,Source Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"From Elasticsearch/Cloud Search Service", "githuburl":"" }, { - "uri":"dataartsstudio_02_0294.html", - "product_code":"dgc", - "code":"71", - "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":"From OpenTSDB,Source Job Parameters,API Reference", - "title":"From OpenTSDB", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0295.html", - "product_code":"dgc", - "code":"72", + "uri":"destination_job_parameters.html", + "node_id":"destination_job_parameters.xml", + "product_code":"dataartsstudio", + "code":"69", "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":"Destination Job Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Destination Job Parameters", "githuburl":"" }, { "uri":"dataartsstudio_02_0296.html", - "product_code":"dgc", - "code":"73", + "node_id":"dataartsstudio_02_0296.xml", + "product_code":"dataartsstudio", + "code":"70", "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":"To a Relational Database,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To a Relational Database", "githuburl":"" }, { "uri":"dataartsstudio_02_0297.html", - "product_code":"dgc", - "code":"74", + "node_id":"dataartsstudio_02_0297.xml", + "product_code":"dataartsstudio", + "code":"71", "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":"To OBS,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To OBS", "githuburl":"" }, { "uri":"dataartsstudio_02_0298.html", - "product_code":"dgc", - "code":"75", + "node_id":"dataartsstudio_02_0298.xml", + "product_code":"dataartsstudio", + "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":"To HDFS,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To HDFS", "githuburl":"" }, { "uri":"dataartsstudio_02_0299.html", - "product_code":"dgc", - "code":"76", + "node_id":"dataartsstudio_02_0299.xml", + "product_code":"dataartsstudio", + "code":"73", "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":"To Hive,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To Hive", "githuburl":"" }, { "uri":"dataartsstudio_02_0300.html", - "product_code":"dgc", - "code":"77", + "node_id":"dataartsstudio_02_0300.xml", + "product_code":"dataartsstudio", + "code":"74", "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":"To HBase/CloudTable,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To HBase/CloudTable", "githuburl":"" }, - { - "uri":"dataartsstudio_02_0301.html", - "product_code":"dgc", - "code":"78", - "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":"To FTP/SFTP/NAS (to Be Brought Offline)/SFS (to Be Brought Offline),Destination Job Parameters,API R", - "title":"To FTP/SFTP/NAS (to Be Brought Offline)/SFS (to Be Brought Offline)", - "githuburl":"" - }, { "uri":"dataartsstudio_02_0302.html", - "product_code":"dgc", - "code":"79", + "node_id":"dataartsstudio_02_0302.xml", + "product_code":"dataartsstudio", + "code":"75", "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":"To DDS,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To DDS", "githuburl":"" }, - { - "uri":"dataartsstudio_02_0303.html", - "product_code":"dgc", - "code":"80", - "des":"Parameter descriptionParameterMandatoryTypeDescriptiontoJobConfig.isBatchMigrationNoBooleanWhether to migrate all data in the databasetoJobConfig.shouldClearDatabaseNoBoo", - "doc_type":"api", - "kw":"To DCS,Destination Job Parameters,API Reference", - "title":"To DCS", - "githuburl":"" - }, { "uri":"dataartsstudio_02_0304.html", - "product_code":"dgc", - "code":"81", + "node_id":"dataartsstudio_02_0304.xml", + "product_code":"dataartsstudio", + "code":"76", "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":"To Elasticsearch/Cloud Search Service,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To Elasticsearch/Cloud Search Service", "githuburl":"" }, { "uri":"dataartsstudio_02_0305.html", - "product_code":"dgc", - "code":"82", + "node_id":"dataartsstudio_02_0305.xml", + "product_code":"dataartsstudio", + "code":"77", "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":"To DLI,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To DLI", "githuburl":"" }, { "uri":"dataartsstudio_02_0306.html", - "product_code":"dgc", - "code":"83", + "node_id":"dataartsstudio_02_0306.xml", + "product_code":"dataartsstudio", + "code":"78", "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":"To DIS,Destination Job Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"To DIS", "githuburl":"" }, { - "uri":"dataartsstudio_02_0307.html", - "product_code":"dgc", - "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":"To OpenTSDB,Destination Job Parameters,API Reference", - "title":"To OpenTSDB", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0308.html", - "product_code":"dgc", - "code":"85", - "des":"When Creating a Job in a Specified Cluster or Creating and Executing a Job in a Random Cluster, the driver-config-values parameter specifies the job configuration, which ", + "uri":"job_parameter.html", + "node_id":"job_parameter.xml", + "product_code":"dataartsstudio", + "code":"79", + "des":"When you create a job in a specified cluster by following the instructions in Creating a Job in a Specified Cluster or create and execute a job in a random cluster by fol", "doc_type":"api", "kw":"Job Parameter Description,Public Data Structures,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Job Parameter Description", "githuburl":"" }, { - "uri":"dataartsstudio_02_0127.html", - "product_code":"dgc", - "code":"86", + "uri":"dataartsstudio_02_0048.html", + "node_id":"dataartsstudio_02_0048.xml", + "product_code":"dataartsstudio", + "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":"DataArts Factory APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"DataArts Factory APIs", "githuburl":"" }, - { - "uri":"dataartsstudio_02_0049.html", - "product_code":"dgc", - "code":"87", - "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":"Connection Management APIs", - "title":"Connection Management APIs", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0050.html", - "product_code":"dgc", - "code":"88", - "des":"This API is used to create a connection. The supported connection types include DWS, DLI, Spark SQL, RDS, CloudTable, and Hive.URI formatPOST /v1/{project_id}/connections", - "doc_type":"api", - "kw":"Creating a Connection,Connection Management APIs,API Reference", - "title":"Creating a Connection", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0051.html", - "product_code":"dgc", - "code":"89", - "des":"This API is used to query a connection list.URI formatGET /v1/{project_id}/connections?offset={offset}&limit={limit}&connectionName={connectionName}GET /v1/{project_id}/c", - "doc_type":"api", - "kw":"Querying a Connection List,Connection Management APIs,API Reference", - "title":"Querying a Connection List", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0052.html", - "product_code":"dgc", - "code":"90", - "des":"This API is used to query configuration details of a specific connection.URI formatGET /v1/{project_id}/connections/{connection_name}GET /v1/{project_id}/connections/{con", - "doc_type":"api", - "kw":"Viewing Connection Details,Connection Management APIs,API Reference", - "title":"Viewing Connection Details", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0053.html", - "product_code":"dgc", - "code":"91", - "des":"This API is used to edit a connection.URI formatPUT /v1/{project_id}/connections/{connection_name}?ischeck=truePUT /v1/{project_id}/connections/{connection_name}?ischeck=", - "doc_type":"api", - "kw":"Editing a Connection,Connection Management APIs,API Reference", - "title":"Editing a Connection", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0054.html", - "product_code":"dgc", - "code":"92", - "des":"This API is used to delete a connection.URI formatDELETE /v1/{project_id}/connections/{connection_name}DELETE /v1/{project_id}/connections/{connection_name}Parameter desc", - "doc_type":"api", - "kw":"Deleting a Connection,Connection Management APIs,API Reference", - "title":"Deleting a Connection", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0055.html", - "product_code":"dgc", - "code":"93", - "des":"This API is used to export all connection information that is compressed in ZIP format.URI formatPOST /v1/{project_id}/connections/exportPOST /v1/{project_id}/connections", - "doc_type":"api", - "kw":"Exporting a Connection,Connection Management APIs,API Reference", - "title":"Exporting a Connection", - "githuburl":"" - }, { "uri":"dataartsstudio_02_0056.html", - "product_code":"dgc", - "code":"94", + "node_id":"dataartsstudio_02_0056.xml", + "product_code":"dataartsstudio", + "code":"81", "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":"Script Development APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Script Development APIs", "githuburl":"" }, - { - "uri":"dataartsstudio_02_0057.html", - "product_code":"dgc", - "code":"95", - "des":"This API is used to delete a specific script.URI formatDELETE /v1/{project_id}/scripts/{script_name}DELETE /v1/{project_id}/scripts/{script_name}Parameter descriptionURI ", - "doc_type":"api", - "kw":"Deleting a Script,Script Development APIs,API Reference", - "title":"Deleting a Script", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0058.html", - "product_code":"dgc", - "code":"96", - "des":"This API is used to execute a specific script, which can be a DWS SQL, DLI SQL, RDS SQL, Flink SQL, Hive SQL, Presto SQL, or Spark SQL script. A script instance is genera", - "doc_type":"api", - "kw":"Executing a Script,Script Development APIs,API Reference", - "title":"Executing a Script", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0059.html", - "product_code":"dgc", - "code":"97", - "des":"This API is used to stop executing a script instance.URI formatPOST /v1/{project_id}/scripts/{script_name}/instances/{instance_id}/stopPOST /v1/{project_id}/scripts/{scri", - "doc_type":"api", - "kw":"Stopping Executing a Script Instance,Script Development APIs,API Reference", - "title":"Stopping Executing a Script Instance", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0060.html", - "product_code":"dgc", - "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":"Resource Management APIs", - "title":"Resource Management APIs", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0061.html", - "product_code":"dgc", - "code":"99", - "des":"This API is used to delete a resource.URI formatDELETE /v1/{project_id}/resources/{resource_id}DELETE /v1/{project_id}/resources/{resource_id}Parameter descriptionURI par", - "doc_type":"api", - "kw":"Deleting a Resource,Resource Management APIs,API Reference", - "title":"Deleting a Resource", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0062.html", - "product_code":"dgc", - "code":"100", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Job Development APIs", - "title":"Job Development APIs", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0063.html", - "product_code":"dgc", - "code":"101", - "des":"This API is used to check whether there are jobs and scripts in the job file to be imported from OBS to DLF.URI formatPOST /v1/{project_id}/jobs/check-filePOST /v1/{proje", - "doc_type":"api", - "kw":"Viewing a Job File,Job Development APIs,API Reference", - "title":"Viewing a Job File", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0064.html", - "product_code":"dgc", - "code":"102", - "des":"This API is used to stop a job.URI formatPOST /v1/{project_id}/jobs/{job_name}/stopPOST /v1/{project_id}/jobs/{job_name}/stopParameter descriptionURI parametersParamete", - "doc_type":"api", - "kw":"Stopping a Job,Job Development APIs,API Reference", - "title":"Stopping a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0065.html", - "product_code":"dgc", - "code":"103", - "des":"This API is used to delete a job.URI formatDELETE /v1/{project_id}/jobs/{job_name}DELETE /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterManda", - "doc_type":"api", - "kw":"Deleting a Job,Job Development APIs,API Reference", - "title":"Deleting a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0066.html", - "product_code":"dgc", - "code":"104", - "des":"This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.URI formatPOST /v1/{project_id}/jobs/{job_name}/insta", - "doc_type":"api", - "kw":"Stopping a Job Instance,Job Development APIs,API Reference", - "title":"Stopping a Job Instance", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0067.html", - "product_code":"dgc", - "code":"105", - "des":"This API is used to restart a specific job instance. A job instance can be restarted only when it is in the successful, failed, or canceled state.URI formatPOST /v1/{proj", - "doc_type":"api", - "kw":"Restarting a Job Instance,Job Development APIs,API Reference", - "title":"Restarting a Job Instance", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0082.html", - "product_code":"dgc", - "code":"106", - "des":"Table 1 describes common request headers.Table 2 describes common response headers.", - "doc_type":"api", - "kw":"Data Structure,DataArts Factory APIs,API Reference", - "title":"Data Structure", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0083.html", - "product_code":"dgc", - "code":"107", - "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 to Be Taken Offline", - "title":"APIs to Be Taken Offline", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0084.html", - "product_code":"dgc", - "code":"108", - "des":"This API is used to create a job. A job consists of one or more nodes, such as Hive SQL and CDM Job nodes. DLF supports two types of jobs: batch jobs and real-time jobs.U", - "doc_type":"api", - "kw":"Creating a Job,APIs to Be Taken Offline,API Reference", - "title":"Creating a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0085.html", - "product_code":"dgc", - "code":"109", - "des":"This API is used to edit a job.URI formatPUT /v1/{project_id}/jobs/{job_name}PUT /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterMandatoryType", - "doc_type":"api", - "kw":"Editing a Job,APIs to Be Taken Offline,API Reference", - "title":"Editing a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0086.html", - "product_code":"dgc", - "code":"110", - "des":"This API is used to query a list of batch or real-time jobs. A maximum of 1000 jobs can be returned for each query.URI formatGET /v1/{project_id}/jobs?jobType={jobType}&o", - "doc_type":"api", - "kw":"Viewing a Job List,APIs to Be Taken Offline,API Reference", - "title":"Viewing a Job List", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0087.html", - "product_code":"dgc", - "code":"111", - "des":"This API is used to view job details.URI formatGET /v1/{project_id}/jobs/{name}GET /v1/{project_id}/jobs/{name}Parameter descriptionURI parameterParameterMandatoryTypeDes", - "doc_type":"api", - "kw":"Viewing Job Details,APIs to Be Taken Offline,API Reference", - "title":"Viewing Job Details", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0088.html", - "product_code":"dgc", - "code":"112", - "des":"This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/{name}/exportPOST /v1/{p", - "doc_type":"api", - "kw":"Exporting a Job,APIs to Be Taken Offline,API Reference", - "title":"Exporting a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0089.html", - "product_code":"dgc", - "code":"113", - "des":"This API is used to batch export jobs, including job dependency scripts and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/batch-exportPOST /v1/{project_id}/job", - "doc_type":"api", - "kw":"Batch Exporting Jobs,APIs to Be Taken Offline,API Reference", - "title":"Batch Exporting Jobs", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0090.html", - "product_code":"dgc", - "code":"114", - "des":"This API is used to import one or more job files from OBS to DLF.Before using this API, store job files in OBS buckets.URI formatPOST /v1/{project_id}/jobs/importPOST /", - "doc_type":"api", - "kw":"Importing a Job,APIs to Be Taken Offline,API Reference", - "title":"Importing a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0091.html", - "product_code":"dgc", - "code":"115", - "des":"This API is used to execute a job immediately and check whether the job can be executed successfully.URI formatPOST /v1/{project_id}/jobs/{job_name}/run-immediatePOST /", - "doc_type":"api", - "kw":"Executing a Job Immediately,APIs to Be Taken Offline,API Reference", - "title":"Executing a Job Immediately", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0092.html", - "product_code":"dgc", - "code":"116", - "des":"This API is used to start a job.URI formatPOST /v1/{project_id}/jobs/{name}/startPOST /v1/{project_id}/jobs/{name}/startParameter descriptionURI parametersParameterMand", - "doc_type":"api", - "kw":"Starting a Job,APIs to Be Taken Offline,API Reference", - "title":"Starting a Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0093.html", - "product_code":"dgc", - "code":"117", - "des":"This API is used to view running status of a real-time job.URI formatGET /v1/{project_id}/jobs/{job_name}/statusGET /v1/{project_id}/jobs/{job_name}/statusParameter descr", - "doc_type":"api", - "kw":"Viewing Running Status of a Real-Time Job,APIs to Be Taken Offline,API Reference", - "title":"Viewing Running Status of a Real-Time Job", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0094.html", - "product_code":"dgc", - "code":"118", - "des":"This API is used to view a job instance list.A job instance is generated each time you run a batch job for which periodic scheduling or event-based scheduling is configur", - "doc_type":"api", - "kw":"Viewing a Job Instance List,APIs to Be Taken Offline,API Reference", - "title":"Viewing a Job Instance List", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0095.html", - "product_code":"dgc", - "code":"119", - "des":"This API is used to view job instance details, including the execution information about each node in a job instance.URI formatGET /v1/{project_id}/jobs/{job_name}/instan", - "doc_type":"api", - "kw":"Viewing Job Instance Details,APIs to Be Taken Offline,API Reference", - "title":"Viewing Job Instance Details", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0096.html", - "product_code":"dgc", - "code":"120", - "des":"This API is used to query details about asynchronous tasks.URI formatGET /v1/{project_id}/system-tasks/{task_id}GET /v1/{project_id}/system-tasks/{task_id}Parameter descr", - "doc_type":"api", - "kw":"Querying a System Task,APIs to Be Taken Offline,API Reference", - "title":"Querying a System Task", - "githuburl":"" - }, { "uri":"dataartsstudio_02_0097.html", - "product_code":"dgc", - "code":"121", - "des":"This API is used to create a script. Currently, the following script types are supported: DLI SQL, Flink SQL, RDS SQL, Spark SQL, Hive SQL, DWS SQL, Shell, and Presto.URI", + "node_id":"dataartsstudio_02_0097.xml", + "product_code":"dataartsstudio", + "code":"82", + "des":"This API is used to create a script. Currently, the following script types are supported: DLI SQL, Flink SQL, RDS SQL, Spark SQL, Hive SQL, DWS SQL, Shell, Presto SQL, Cl", "doc_type":"api", - "kw":"Creating a Script,APIs to Be Taken Offline,API Reference", + "kw":"Creating a Script,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Creating a Script", "githuburl":"" }, { "uri":"dataartsstudio_02_0098.html", - "product_code":"dgc", - "code":"122", + "node_id":"dataartsstudio_02_0098.xml", + "product_code":"dataartsstudio", + "code":"83", "des":"This API is used to modify the configuration items or script contents of a script.When modifying a script, specify the name of the script to be modified.The script name a", "doc_type":"api", - "kw":"Modifying a Script,APIs to Be Taken Offline,API Reference", + "kw":"Modifying a Script,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Modifying a Script", "githuburl":"" }, { "uri":"dataartsstudio_02_0099.html", - "product_code":"dgc", - "code":"123", - "des":"This API is used to query a script, including the script type and script content.URI formatGET /v1/{project_id}/script/{script_name}GET /v1/{project_id}/script/{script_na", + "node_id":"dataartsstudio_02_0099.xml", + "product_code":"dataartsstudio", + "code":"84", + "des":"This API is used to query a script, including the script type and script content.URI formatGET /v1/{project_id}/scripts/{script_name}GET /v1/{project_id}/scripts/{script_", "doc_type":"api", - "kw":"Querying a Script,APIs to Be Taken Offline,API Reference", + "kw":"Querying a Script,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Querying a Script", "githuburl":"" }, { "uri":"dataartsstudio_02_0100.html", - "product_code":"dgc", - "code":"124", + "node_id":"dataartsstudio_02_0100.xml", + "product_code":"dataartsstudio", + "code":"85", "des":"This API is used to query the script list. A maximum of 1000 scripts can be returned for each query.URI formatGET /v1/{project_id}/scripts?offset={offset}&limit={limit}&s", "doc_type":"api", - "kw":"Querying a Script List,APIs to Be Taken Offline,API Reference", + "kw":"Querying a Script List,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Querying a Script List", "githuburl":"" }, { "uri":"dataartsstudio_02_0101.html", - "product_code":"dgc", - "code":"125", + "node_id":"dataartsstudio_02_0101.xml", + "product_code":"dataartsstudio", + "code":"86", "des":"This API is used to obtain the execution status and result of a script instance.During the query, specify the script name and script instance ID.URI formatGET /v1/{projec", "doc_type":"api", - "kw":"Querying the Execution Result of a Script Instance,APIs to Be Taken Offline,API Reference", + "kw":"Querying the Execution Result of a Script Instance,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Querying the Execution Result of a Script Instance", "githuburl":"" }, + { + "uri":"dataartsstudio_02_0057.html", + "node_id":"dataartsstudio_02_0057.xml", + "product_code":"dataartsstudio", + "code":"87", + "des":"This API is used to delete a specific script.URI formatDELETE /v1/{project_id}/scripts/{script_name}DELETE /v1/{project_id}/scripts/{script_name}Parameter descriptionURI ", + "doc_type":"api", + "kw":"Deleting a Script,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Deleting a Script", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0058.html", + "node_id":"dataartsstudio_02_0058.xml", + "product_code":"dataartsstudio", + "code":"88", + "des":"This API is used to execute a specific script, which can be a DWS SQL, DLI SQL, RDS SQL, Flink SQL, Hive SQL, Presto SQL, or Spark SQL script. A script instance is genera", + "doc_type":"api", + "kw":"Executing a Script,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Executing a Script", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0059.html", + "node_id":"dataartsstudio_02_0059.xml", + "product_code":"dataartsstudio", + "code":"89", + "des":"This API is used to stop executing a script instance.URI formatPOST /v1/{project_id}/scripts/{script_name}/instances/{instance_id}/stopPOST /v1/{project_id}/scripts/{scri", + "doc_type":"api", + "kw":"Stopping Executing a Script Instance,Script Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Stopping Executing a Script Instance", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0060.html", + "node_id":"dataartsstudio_02_0060.xml", + "product_code":"dataartsstudio", + "code":"90", + "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 Management APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"Resource Management APIs", + "githuburl":"" + }, { "uri":"dataartsstudio_02_0102.html", - "product_code":"dgc", - "code":"126", + "node_id":"dataartsstudio_02_0102.xml", + "product_code":"dataartsstudio", + "code":"91", "des":"This API is used to create a resource. Types of nodes, including DLI Spark, MRS Spark, and MRS MapReduce, can reference files such as JAR and properties through resources", "doc_type":"api", - "kw":"Creating a Resource,APIs to Be Taken Offline,API Reference", + "kw":"Creating a Resource,Resource Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Creating a Resource", "githuburl":"" }, { "uri":"dataartsstudio_02_0103.html", - "product_code":"dgc", - "code":"127", + "node_id":"dataartsstudio_02_0103.xml", + "product_code":"dataartsstudio", + "code":"92", "des":"This API is used to modify a specific resource. When modifying the resource, specify the resource ID.The resource type and directory cannot be modified.URI formatPUT /v1/", "doc_type":"api", - "kw":"Modifying a Resource,APIs to Be Taken Offline,API Reference", + "kw":"Modifying a Resource,Resource Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Modifying a Resource", "githuburl":"" }, { "uri":"dataartsstudio_02_0104.html", - "product_code":"dgc", - "code":"128", + "node_id":"dataartsstudio_02_0104.xml", + "product_code":"dataartsstudio", + "code":"93", "des":"This API is used to query resource details. A resource contains various files such as JAR, ZIP, and properties files. A created resource can be used in job nodes such as ", "doc_type":"api", - "kw":"Querying a Resource,APIs to Be Taken Offline,API Reference", + "kw":"Querying a Resource,Resource Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Querying a Resource", "githuburl":"" }, + { + "uri":"dataartsstudio_02_0061.html", + "node_id":"dataartsstudio_02_0061.xml", + "product_code":"dataartsstudio", + "code":"94", + "des":"This API is used to delete a resource.URI formatDELETE /v1/{project_id}/resources/{resource_id}DELETE /v1/{project_id}/resources/{resource_id}Parameter descriptionURI par", + "doc_type":"api", + "kw":"Deleting a Resource,Resource Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Deleting a Resource", + "githuburl":"" + }, { "uri":"dataartsstudio_02_0105.html", - "product_code":"dgc", - "code":"129", + "node_id":"dataartsstudio_02_0105.xml", + "product_code":"dataartsstudio", + "code":"95", "des":"This API is used to query a resource list. During the query, you can specify the page number and the maximum number of records on each page.URI formatGET /v1/{project_id}", "doc_type":"api", - "kw":"Querying a Resource List,APIs to Be Taken Offline,API Reference", + "kw":"Querying a Resource List,Resource Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], "title":"Querying a Resource List", "githuburl":"" }, { - "uri":"dataartsstudio_02_0106.html", - "product_code":"dgc", - "code":"130", - "des":"This API is used to import one or more connection files from OBS to the Data Development module. Before using this API, store connection files in OBS buckets.URI formatPO", + "uri":"dataartsstudio_02_0062.html", + "node_id":"dataartsstudio_02_0062.xml", + "product_code":"dataartsstudio", + "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":"Importing a Connection,APIs to Be Taken Offline,API Reference", - "title":"Importing a Connection", + "kw":"Job Development APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"Job Development APIs", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0084.html", + "node_id":"dataartsstudio_02_0084.xml", + "product_code":"dataartsstudio", + "code":"97", + "des":"This API is used to create a job. A job consists of one or more nodes, such as Hive SQL and CDM Job nodes. DLF supports two types of jobs: batch jobs and real-time jobs.U", + "doc_type":"api", + "kw":"Creating a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Creating a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0085.html", + "node_id":"dataartsstudio_02_0085.xml", + "product_code":"dataartsstudio", + "code":"98", + "des":"This API is used to edit a job.URI formatPUT /v1/{project_id}/jobs/{job_name}PUT /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterMandatoryType", + "doc_type":"api", + "kw":"Editing a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Editing a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0086.html", + "node_id":"dataartsstudio_02_0086.xml", + "product_code":"dataartsstudio", + "code":"99", + "des":"This API is used to query a list of batch or real-time jobs. A maximum of 100 jobs can be returned for each query.URI formatGET /v1/{project_id}/jobs?jobType={jobType}&of", + "doc_type":"api", + "kw":"Viewing a Job List,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Viewing a Job List", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0087.html", + "node_id":"dataartsstudio_02_0087.xml", + "product_code":"dataartsstudio", + "code":"100", + "des":"This API is used to view job details.URI formatGET /v1/{project_id}/jobs/{name}GET /v1/{project_id}/jobs/{name}Parameter descriptionParameterMandatoryTypeDescriptionproje", + "doc_type":"api", + "kw":"Viewing Job Details,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Viewing Job Details", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0063.html", + "node_id":"dataartsstudio_02_0063.xml", + "product_code":"dataartsstudio", + "code":"101", + "des":"This API is used to check whether there are jobs and scripts in the job file to be imported from OBS to DLF.URI formatPOST /v1/{project_id}/jobs/check-filePOST /v1/{proje", + "doc_type":"api", + "kw":"Viewing a Job File,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Viewing a Job File", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0088.html", + "node_id":"dataartsstudio_02_0088.xml", + "product_code":"dataartsstudio", + "code":"102", + "des":"This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/{job_name}/exportPOST /v", + "doc_type":"api", + "kw":"Exporting a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Exporting a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0089.html", + "node_id":"dataartsstudio_02_0089.xml", + "product_code":"dataartsstudio", + "code":"103", + "des":"This API is used to batch export jobs, including job dependency scripts and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/batch-exportPOST /v1/{project_id}/job", + "doc_type":"api", + "kw":"Batch Exporting Jobs,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Batch Exporting Jobs", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0090.html", + "node_id":"dataartsstudio_02_0090.xml", + "product_code":"dataartsstudio", + "code":"104", + "des":"This API is used to import one or more job files from OBS to DLF.Before using this API, store job files in OBS buckets.URI formatPOST /v1/{project_id}/jobs/importPOST /", + "doc_type":"api", + "kw":"Importing a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Importing a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0091.html", + "node_id":"dataartsstudio_02_0091.xml", + "product_code":"dataartsstudio", + "code":"105", + "des":"This API is used to execute a job immediately and check whether the job can be executed successfully.URI formatPOST /v1/{project_id}/jobs/{job_name}/run-immediatePOST /", + "doc_type":"api", + "kw":"Executing a Job Immediately,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Executing a Job Immediately", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0092.html", + "node_id":"dataartsstudio_02_0092.xml", + "product_code":"dataartsstudio", + "code":"106", + "des":"This API is used to start a job.URI formatPOST /v1/{project_id}/jobs/{job_name}/startPOST /v1/{project_id}/jobs/{job_name}/startParameter descriptionURI parametersParam", + "doc_type":"api", + "kw":"Starting a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Starting a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0064.html", + "node_id":"dataartsstudio_02_0064.xml", + "product_code":"dataartsstudio", + "code":"107", + "des":"This API is used to stop a job.URI formatPOST /v1/{project_id}/jobs/{job_name}/stopPOST /v1/{project_id}/jobs/{job_name}/stopParameter descriptionURI parametersParamete", + "doc_type":"api", + "kw":"Stopping a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Stopping a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0065.html", + "node_id":"dataartsstudio_02_0065.xml", + "product_code":"dataartsstudio", + "code":"108", + "des":"This API is used to delete a job.URI formatDELETE /v1/{project_id}/jobs/{job_name}DELETE /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterManda", + "doc_type":"api", + "kw":"Deleting a Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Deleting a Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0066.html", + "node_id":"dataartsstudio_02_0066.xml", + "product_code":"dataartsstudio", + "code":"109", + "des":"This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.URI formatPOST /v1/{project_id}/jobs/{job_name}/insta", + "doc_type":"api", + "kw":"Stopping a Job Instance,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Stopping a Job Instance", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0067.html", + "node_id":"dataartsstudio_02_0067.xml", + "product_code":"dataartsstudio", + "code":"110", + "des":"This API is used to retry a specific job instance. A job instance can be retried only when it is in the successful, failed, or canceled state.URI formatPOST /v1/{project_", + "doc_type":"api", + "kw":"Retrying a Job Instance,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Retrying a Job Instance", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0093.html", + "node_id":"dataartsstudio_02_0093.xml", + "product_code":"dataartsstudio", + "code":"111", + "des":"This API is used to view running status of a real-time job.URI formatGET /v1/{project_id}/jobs/{job_name}/statusGET /v1/{project_id}/jobs/{job_name}/statusParameter descr", + "doc_type":"api", + "kw":"Viewing Running Status of a Real-Time Job,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Viewing Running Status of a Real-Time Job", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0094.html", + "node_id":"dataartsstudio_02_0094.xml", + "product_code":"dataartsstudio", + "code":"112", + "des":"This API is used to view a job instance list.A job instance is generated each time you run a batch job for which periodic scheduling or event-based scheduling is configur", + "doc_type":"api", + "kw":"Viewing a Job Instance List,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Viewing a Job Instance List", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0095.html", + "node_id":"dataartsstudio_02_0095.xml", + "product_code":"dataartsstudio", + "code":"113", + "des":"This API is used to view job instance details, including the execution information about each node in a job instance.URI formatGET /v1/{project_id}/jobs/{job_name}/instan", + "doc_type":"api", + "kw":"Viewing Job Instance Details,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Viewing Job Instance Details", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0096.html", + "node_id":"dataartsstudio_02_0096.xml", + "product_code":"dataartsstudio", + "code":"114", + "des":"This API is used to query details about asynchronous tasks.URI formatGET /v1/{project_id}/system-tasks/{task_id}GET /v1/{project_id}/system-tasks/{task_id}Parameter descr", + "doc_type":"api", + "kw":"Querying System Task Details,Job Development APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Querying System Task Details", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0049.html", + "node_id":"dataartsstudio_02_0049.xml", + "product_code":"dataartsstudio", + "code":"115", + "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":"Connection Management APIs (To Be Taken Offline)", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Connection Management APIs (To Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0050.html", + "node_id":"dataartsstudio_02_0050.xml", + "product_code":"dataartsstudio", + "code":"116", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to create a connection. The supported co", + "doc_type":"api", + "kw":"Creating a Connection (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),API Ref", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Creating a Connection (to Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0051.html", + "node_id":"dataartsstudio_02_0051.xml", + "product_code":"dataartsstudio", + "code":"117", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to query a connection list.URI formatGET", + "doc_type":"api", + "kw":"Querying a Connection List (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),AP", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Querying a Connection List (to Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0052.html", + "node_id":"dataartsstudio_02_0052.xml", + "product_code":"dataartsstudio", + "code":"118", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to query details of a connection.URI for", + "doc_type":"api", + "kw":"Querying Connection Details (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),A", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Querying Connection Details (to Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0053.html", + "node_id":"dataartsstudio_02_0053.xml", + "product_code":"dataartsstudio", + "code":"119", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to edit a connection.URI formatPUT /v1/{", + "doc_type":"api", + "kw":"Editing a Connection (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),API Refe", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Editing a Connection (to Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0054.html", + "node_id":"dataartsstudio_02_0054.xml", + "product_code":"dataartsstudio", + "code":"120", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to delete a connection.URI formatDELETE ", + "doc_type":"api", + "kw":"Deleting a Connection (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),API Ref", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Deleting a Connection (to Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0055.html", + "node_id":"dataartsstudio_02_0055.xml", + "product_code":"dataartsstudio", + "code":"121", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to export all connection information tha", + "doc_type":"api", + "kw":"Exporting Connections (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),API Ref", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Exporting Connections (to Be Taken Offline)", + "githuburl":"" + }, + { + "uri":"dataartsstudio_02_0106.html", + "node_id":"dataartsstudio_02_0106.xml", + "product_code":"dataartsstudio", + "code":"122", + "des":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to import one or more connection files f", + "doc_type":"api", + "kw":"Importing Connections (to Be Taken Offline),Connection Management APIs (To Be Taken Offline),API Ref", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"Importing Connections (to Be Taken Offline)", "githuburl":"" }, { "uri":"dataartsstudio_02_0309.html", - "product_code":"dgc", - "code":"131", + "node_id":"dataartsstudio_02_0309.xml", + "product_code":"dataartsstudio", + "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":"Appendix", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Appendix", "githuburl":"" }, { "uri":"dataartsstudio_02_0318.html", - "product_code":"dgc", - "code":"132", + "node_id":"dataartsstudio_02_0318.xml", + "product_code":"dataartsstudio", + "code":"124", "des":"Table 1 describes common request headers.Table 2 describes common response headers.", "doc_type":"api", "kw":"Common Message Headers,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Common Message Headers", "githuburl":"" }, + { + "uri":"dataartsstudio_02_0317.html", + "node_id":"dataartsstudio_02_0317.xml", + "product_code":"dataartsstudio", + "code":"125", + "des":"The response messages of the job export API and connection export API are streams that need to be converted to files. For details, see the following sample code:", + "doc_type":"api", + "kw":"Parsing a Stream in a Response Message,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"Parsing a Stream in a Response Message", + "githuburl":"" + }, { "uri":"dataartsstudio_02_0310.html", - "product_code":"dgc", - "code":"133", + "node_id":"dataartsstudio_02_0310.xml", + "product_code":"dataartsstudio", + "code":"126", "des":"A status code consists of three digits. The first digit defines the class of a response. There are five values for the first digit:1xx: indication information, indicating", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"ErrorCode.html", - "product_code":"", - "code":"134", + "node_id":"errorcode.xml", + "product_code":"dataartsstudio", + "code":"127", "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":"", + "doc_type":"api", "kw":"Error Codes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], "title":"Error Codes", "githuburl":"" }, { "uri":"dataartsstudio_02_0311.html", - "product_code":"dgc", - "code":"135", + "node_id":"dataartsstudio_02_0311.xml", + "product_code":"dataartsstudio", + "code":"128", "des":"If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status co", "doc_type":"api", - "kw":"CDM Error Codes,Error Codes,API Reference", - "title":"CDM Error Codes", + "kw":"DataArts Migration Error Codes,Error Codes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "IsBot":"yes", + "opensource":"true" + } + ], + "title":"DataArts Migration Error Codes", "githuburl":"" }, { "uri":"dataartsstudio_02_0313.html", - "product_code":"dgc", - "code":"136", + "node_id":"dataartsstudio_02_0313.xml", + "product_code":"dataartsstudio", + "code":"129", "des":"The error response is in the following format:{\"error_code\":\"DLF.0100\",\"error_msg\":\"The job not found\"}Table 1 describes the error codes.", "doc_type":"api", - "kw":"DLF Error Codes,Error Codes,API Reference", - "title":"DLF Error Codes", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0317.html", - "product_code":"dgc", - "code":"137", - "des":"The response messages of the job export API and connection export API are streams that need to be converted to files. For details, see the following sample code:", - "doc_type":"api", - "kw":"Parsing a Stream in a Response Message,Appendix,API Reference", - "title":"Parsing a Stream in a Response Message", - "githuburl":"" - }, - { - "uri":"dataartsstudio_02_0330.html", - "product_code":"", - "code":"138", - "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":"", - "kw":"Change History,API Reference", - "title":"Change History", + "kw":"DataArts Factory Error Codes,Error Codes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"dataartsstudio", + "IsMulti":"no", + "opensource":"true", + "IsBot":"yes" + } + ], + "title":"DataArts Factory Error Codes", "githuburl":"" } ] \ No newline at end of file diff --git a/docs/dataartsstudio/api-ref/CLASS.TXT.json b/docs/dataartsstudio/api-ref/CLASS.TXT.json index 172ceb84..88f82e57 100644 --- a/docs/dataartsstudio/api-ref/CLASS.TXT.json +++ b/docs/dataartsstudio/api-ref/CLASS.TXT.json @@ -39,16 +39,16 @@ "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions.You can obtain endpoints from Regions and Endpoints.", "product_code":"dataartsstudio", "title":"Endpoints", - "uri":"dataartsstudio_02_0004.html", + "uri":"endpoint.html", "doc_type":"api", "p_code":"1", "code":"5" }, { - "desc":"You can obtain the project ID and account ID by performing the following steps:Register with and log in to the management console.Hover the cursor on the username in the ", + "desc":"A project is a group of tenant resources, and an account ID corresponds to the current account. The IAM ID corresponds to the current user. You can view the project IDs, ", "product_code":"dataartsstudio", "title":"Project ID and Account ID", - "uri":"dataartsstudio_02_0314.html", + "uri":"projectid_accountid.html", "doc_type":"api", "p_code":"1", "code":"6" @@ -63,22 +63,13 @@ "code":"7" }, { - "desc":"A job ID (jobid) is required for some URLs when an API is called. To obtain a job ID, perform the following operations:Log in to the DataArts Studio console. Locate an in", - "product_code":"dataartsstudio", - "title":"Data Development Job ID", - "uri":"dataartsstudio_02_0316.html", - "doc_type":"api", - "p_code":"1", - "code":"8" - }, - { - "desc":"The restrictions on DataArts Catalog APIs are as follows:CDM jobs carry large volumes of data, which increases the database load. You are advised to periodically delete u", + "desc":"An IAM user can pass the authentication and access DataArts Studio through an API or SDK only if Programmatic access is selected for Access Type during the creation of th", "product_code":"dataartsstudio", "title":"Constraints", "uri":"dataartsstudio_02_0005.html", "doc_type":"api", "p_code":"1", - "code":"9" + "code":"8" }, { "desc":"DataArts Studio provides self-developed APIs that comply with RESTful API design specifications. You can call those APIs to perform operations on DataArts Studio.", @@ -87,7 +78,7 @@ "uri":"dataartsstudio_02_0007.html", "doc_type":"api", "p_code":"", - "code":"10" + "code":"9" }, { "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.", @@ -96,16 +87,16 @@ "uri":"dataartsstudio_02_0008.html", "doc_type":"api", "p_code":"", - "code":"11" + "code":"10" }, { "desc":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token ca", "product_code":"dataartsstudio", "title":"Making an API Request", - "uri":"dataartsstudio_02_0009.html", + "uri":"making_request.html", "doc_type":"api", - "p_code":"11", - "code":"12" + "p_code":"10", + "code":"11" }, { "desc":"Requests for calling an API can be authenticated using either of the following methods:Token-based authentication: Requests are authenticated using a token.AK/SK-based au", @@ -113,8 +104,8 @@ "title":"Authentication", "uri":"dataartsstudio_02_0010.html", "doc_type":"api", - "p_code":"11", - "code":"13" + "p_code":"10", + "code":"12" }, { "desc":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ", @@ -122,8 +113,8 @@ "title":"Response", "uri":"dataartsstudio_02_0011.html", "doc_type":"api", - "p_code":"11", - "code":"14" + "p_code":"10", + "code":"13" }, { "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.", @@ -132,25 +123,25 @@ "uri":"dataartsstudio_02_0012.html", "doc_type":"api", "p_code":"", - "code":"15" + "code":"14" }, { "desc":"This section describes how to use cURL to call CDM APIs to migrate data from a local MySQL database to DWS in the cloud.Obtaining a TokenCall the API to obtain the user t", "product_code":"dataartsstudio", - "title":"Application Example", + "title":"Example of Using DataArts Migration APIs", "uri":"dataartsstudio_02_0013.html", "doc_type":"api", - "p_code":"15", - "code":"16" + "p_code":"14", + "code":"15" }, { "desc":"DataArts Studio helps enterprises quickly build an end-to-end intelligent data system that covers the entire process from data ingestion to data analytics. The system can", "product_code":"dataartsstudio", - "title":"Example of Using Data Development APIs", + "title":"Example of Using DataArts Factory APIs", "uri":"dataartsstudio_02_0015.html", "doc_type":"api", - "p_code":"15", - "code":"17" + "p_code":"14", + "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.", @@ -159,52 +150,52 @@ "uri":"dataartsstudio_02_0016.html", "doc_type":"api", "p_code":"", - "code":"18" + "code":"17" }, { "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":"dataartsstudio", "title":"Cluster Management", - "uri":"topic_300000000_3.html", + "uri":"topic_300000000_8.html", "doc_type":"api", - "p_code":"18", - "code":"19" + "p_code":"17", + "code":"18" }, { "desc":"This API is used to query cluster details.GET /v1.1/{project_id}/clusters/{cluster_id}Status code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Querying Cluster Details", - "uri":"ShowClusterDetail.html", + "uri":"ShowClusterDetail_0.html", "doc_type":"api", - "p_code":"19", - "code":"20" + "p_code":"18", + "code":"19" }, { "desc":"This API is used to delete a cluster.DELETE /v1.1/{project_id}/clusters/{cluster_id}Status code: 202Status code: 202AcceptedSee Error Codes.", "product_code":"dataartsstudio", "title":"Deleting a Cluster", - "uri":"DeleteCluster.html", + "uri":"DeleteCluster_0.html", "doc_type":"api", - "p_code":"19", - "code":"21" + "p_code":"18", + "code":"20" }, { "desc":"This API is used to restart a cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/actionStatus code: 200Restarting a ClusterStatus code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Restarting a Cluster", - "uri":"RestartCluster.html", + "uri":"RestartCluster_0.html", "doc_type":"api", - "p_code":"19", - "code":"22" + "p_code":"18", + "code":"21" }, { "desc":"This API is used to start a cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/actionStatus code: 200Starting a ClusterStatus code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Starting a Cluster", - "uri":"StartCluster.html", + "uri":"StartCluster_0.html", "doc_type":"api", - "p_code":"19", - "code":"23" + "p_code":"18", + "code":"22" }, { "desc":"This API is used to stop a cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/actionStatus code: 200Stopping a ClusterStatus code: 200okSee Error Codes.", @@ -212,161 +203,161 @@ "title":"Stopping a Cluster", "uri":"StopCluster.html", "doc_type":"api", - "p_code":"19", - "code":"24" + "p_code":"18", + "code":"23" }, { "desc":"This API is used to create a cluster.POST /v1.1/{project_id}/clustersStatus code: 202Status code: 202AcceptedSee Error Codes.", "product_code":"dataartsstudio", "title":"Creating a Cluster", - "uri":"CreateCluster.html", + "uri":"CreateCluster_0.html", "doc_type":"api", - "p_code":"19", - "code":"25" + "p_code":"18", + "code":"24" }, { "desc":"This API is used to query the cluster list.GET /v1.1/{project_id}/clustersStatus code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Querying the Cluster List", - "uri":"ListClusters.html", + "uri":"ListClusters_0.html", "doc_type":"api", - "p_code":"19", - "code":"26" + "p_code":"18", + "code":"25" }, { "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":"dataartsstudio", "title":"Job Management", - "uri":"topic_300000001_2.html", + "uri":"topic_300000001_6.html", "doc_type":"api", - "p_code":"18", - "code":"27" + "p_code":"17", + "code":"26" }, { "desc":"This API is used to query jobs.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}Status code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Querying a Job", - "uri":"ShowJobs.html", + "uri":"ShowJobs_0.html", "doc_type":"api", - "p_code":"27", - "code":"28" + "p_code":"26", + "code":"27" }, { "desc":"This API is used to delete a job.DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}Status code: 500Status code: 500An internal service error occurred. For", "product_code":"dataartsstudio", "title":"Deleting a Job", - "uri":"DeleteJob.html", + "uri":"DeleteJob_0.html", "doc_type":"api", - "p_code":"27", - "code":"29" + "p_code":"26", + "code":"28" }, { "desc":"This API is used to modify a job.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}Status code: 200Status code: 400Status code: 200okStatus code: 400Error co", "product_code":"dataartsstudio", "title":"Modifying a Job", - "uri":"UpdateJob.html", + "uri":"UpdateJob_0.html", "doc_type":"api", - "p_code":"27", - "code":"30" + "p_code":"26", + "code":"29" }, { "desc":"This API is used to create and execute a job in a random cluster.POST /v1.1/{project_id}/clusters/jobStatus code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Creating and Executing a Job in a Random Cluster", - "uri":"CreateAndStartRandomClusterJob.html", + "uri":"CreateAndStartRandomClusterJob_0.html", "doc_type":"api", - "p_code":"27", - "code":"31" + "p_code":"26", + "code":"30" }, { "desc":"This API is used to stop a job.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/stopStatus code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Stopping a Job", - "uri":"StopJob.html", + "uri":"StopJob_0.html", "doc_type":"api", - "p_code":"27", - "code":"32" + "p_code":"26", + "code":"31" }, { "desc":"This API is used to create a job in a specified cluster.POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/jobStatus code: 200Status code: 400Status code: 200okStatus code", "product_code":"dataartsstudio", "title":"Creating a Job in a Specified Cluster", - "uri":"CreateJob.html", + "uri":"CreateJob_0.html", "doc_type":"api", - "p_code":"27", - "code":"33" + "p_code":"26", + "code":"32" }, { "desc":"This API is used to start a job.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/startStatus code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Starting a Job", - "uri":"StartJob.html", + "uri":"StartJob_0.html", "doc_type":"api", - "p_code":"27", - "code":"34" + "p_code":"26", + "code":"33" }, { "desc":"This API is used to query the job status.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/statusStatus code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Querying Job Status", - "uri":"ShowJobStatus.html", + "uri":"ShowJobStatus_0.html", "doc_type":"api", - "p_code":"27", - "code":"35" + "p_code":"26", + "code":"34" }, { "desc":"This API is used to query the job execution history.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissionsStatus code: 200Status code: 200okSee Error Codes.", "product_code":"dataartsstudio", "title":"Querying Job Execution History", - "uri":"ShowSubmissions.html", + "uri":"ShowSubmissions_0.html", "doc_type":"api", - "p_code":"27", - "code":"36" + "p_code":"26", + "code":"35" }, { "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":"dataartsstudio", "title":"Link Management", - "uri":"topic_300000002_2.html", + "uri":"topic_300000002_6.html", "doc_type":"api", - "p_code":"18", - "code":"37" + "p_code":"17", + "code":"36" }, { "desc":"This API is used to create a link.POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/linkStatus code: 200Status code: 400Status code: 500Status code: 200OKStatus code: 400", "product_code":"dataartsstudio", "title":"Creating a Link", - "uri":"CreateLink.html", + "uri":"CreateLink_0.html", "doc_type":"api", - "p_code":"37", - "code":"38" + "p_code":"36", + "code":"37" }, { "desc":"This API is used to query a link.GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}Status code: 200Status code: 200OKSee Error Codes.", "product_code":"dataartsstudio", "title":"Querying a Link", - "uri":"ShowLink.html", + "uri":"ShowLink_0.html", "doc_type":"api", - "p_code":"37", - "code":"39" + "p_code":"36", + "code":"38" }, { "desc":"This API is used to delete a link.DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}Status code: 500Status code: 500An internal service error occurred. ", "product_code":"dataartsstudio", "title":"Deleting a Link", - "uri":"DeleteLink.html", + "uri":"DeleteLink_0.html", "doc_type":"api", - "p_code":"37", - "code":"40" + "p_code":"36", + "code":"39" }, { "desc":"This API is used to modify a link.PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}Status code: 200Status code: 500Status code: 200OKStatus code: 500An in", "product_code":"dataartsstudio", "title":"Modifying a Link", - "uri":"UpdateLink.html", + "uri":"UpdateLink_0.html", "doc_type":"api", - "p_code":"37", - "code":"41" + "p_code":"36", + "code":"40" }, { "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.", @@ -374,35 +365,35 @@ "title":"Public Data Structures", "uri":"dataartsstudio_02_0260.html", "doc_type":"api", - "p_code":"18", - "code":"42" + "p_code":"17", + "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":"dataartsstudio", "title":"Link Parameter Description", - "uri":"dataartsstudio_02_0261.html", + "uri":"link_parameter.html", + "doc_type":"api", + "p_code":"41", + "code":"42" + }, + { + "desc":"By creating a JDBC link, you can extract data from or load data to the following relational databases:RDS for PostgreSQLRDS for SQL ServerPostgreSQLMicrosoft SQL ServerRD", + "product_code":"dataartsstudio", + "title":"Link to a Relational Database", + "uri":"dataartsstudio_02_0262.html", "doc_type":"api", "p_code":"42", "code":"43" }, { - "desc":"By creating a JDBC link, you can extract data from or load data to the following relational databases:Data Warehouse ServiceRDS for MySQLRDS for PostgreSQLRDS for SQL Ser", - "product_code":"dataartsstudio", - "title":"Link to a Relational Database", - "uri":"dataartsstudio_02_0262.html", - "doc_type":"api", - "p_code":"43", - "code":"44" - }, - { - "desc":"By creating an OBS link, you can extract files from or load files to OBS. Files in CSV, JSON, and binary format are supported.", + "desc":"By creating an OBS link, you can extract files from or load files to OBS. Files in CSV, JSON, and binary format are supported.The following is the message body of a sampl", "product_code":"dataartsstudio", "title":"Link to OBS", "uri":"dataartsstudio_02_0263.html", "doc_type":"api", - "p_code":"43", - "code":"45" + "p_code":"42", + "code":"44" }, { "desc":"By creating an HDFS link, you can extract files from or load files to MRS, FusionInsight HD, or Apache Hadoop. Files in CSV, Parquet, and binary formats are supported.", @@ -410,8 +401,8 @@ "title":"Link to HDFS", "uri":"dataartsstudio_02_0266.html", "doc_type":"api", - "p_code":"43", - "code":"46" + "p_code":"42", + "code":"45" }, { "desc":"By creating an HBase link, you can extract data from or load data to HBase of MRS, FusionInsight HD, and Apache Hadoop.", @@ -419,26 +410,26 @@ "title":"Link to HBase", "uri":"dataartsstudio_02_0267.html", "doc_type":"api", - "p_code":"43", - "code":"47" + "p_code":"42", + "code":"46" }, { - "desc":"By creating a CloudTable link, you can extract data from or load data to CloudTable.", + "desc":"By creating a CloudTable link, you can extract data from or load data to CloudTable.The following is the message body of a sample link. You are advised to store the AK an", "product_code":"dataartsstudio", "title":"Link to CloudTable", "uri":"dataartsstudio_02_0268.html", "doc_type":"api", - "p_code":"43", - "code":"48" + "p_code":"42", + "code":"47" }, { - "desc":"By creating a Hive link, you can extract data from or load data to Hive of MRS.", + "desc":"By creating a Hive link, you can extract data from or load data to Hive of MRS.The following is the message body of a sample link. You are advised to store the AK and SK ", "product_code":"dataartsstudio", "title":"Link to Hive", "uri":"dataartsstudio_02_0269.html", "doc_type":"api", - "p_code":"43", - "code":"49" + "p_code":"42", + "code":"48" }, { "desc":"By creating an FTP or SFTP link, you are able to extract files from or load files to the FTP or SFTP server. Files in CSV, JSON, and binary format are supported.Parameter", @@ -446,26 +437,26 @@ "title":"Link to an FTP or SFTP Server", "uri":"dataartsstudio_02_0270.html", "doc_type":"api", - "p_code":"43", - "code":"50" + "p_code":"42", + "code":"49" }, { - "desc":"By creating a MongoDB link, you can extract data from or load data to MongoDB.", + "desc":"By creating a Link to MongoDB, you can extract data from or load data to MongoDB.", "product_code":"dataartsstudio", "title":"Link to MongoDB", "uri":"dataartsstudio_02_0271.html", "doc_type":"api", - "p_code":"43", - "code":"51" + "p_code":"42", + "code":"50" }, { - "desc":"By creating a Redis link, you can extract data from or load data to the Redis server. By creating a DCS link, you can load data to Data Cache Service (DCS), but not extra", + "desc":"By creating a Redis link, you can extract data from or load data to the Redis server.", "product_code":"dataartsstudio", - "title":"Link to Redis/DCS (to Be Brought Offline)", + "title":"Link to Redis", "uri":"dataartsstudio_02_0272.html", "doc_type":"api", - "p_code":"43", - "code":"52" + "p_code":"42", + "code":"51" }, { "desc":"By creating a Kafka link, you are able to access open source Kafka and migrate data from Kafka to other data sources as required. Currently, only data export from Kafka i", @@ -473,8 +464,8 @@ "title":"Link to Kafka", "uri":"dataartsstudio_02_0274.html", "doc_type":"api", - "p_code":"43", - "code":"53" + "p_code":"42", + "code":"52" }, { "desc":"By creating an Elasticsearch link, you can extract data from or load data to the Elasticsearch server or Cloud Search Service.", @@ -482,8 +473,8 @@ "title":"Link to Elasticsearch/Cloud Search Service", "uri":"dataartsstudio_02_0276.html", "doc_type":"api", - "p_code":"43", - "code":"54" + "p_code":"42", + "code":"53" }, { "desc":"By creating a DLI link, you can import data to DLI. Currently, you cannot export data from DLI using CDM.", @@ -491,17 +482,8 @@ "title":"Link to DLI", "uri":"dataartsstudio_02_0277.html", "doc_type":"api", - "p_code":"43", - "code":"55" - }, - { - "desc":"By creating an OpenTSDB link, you can extract data from and load data to CloudTable OpenTSDB.", - "product_code":"dataartsstudio", - "title":"Link to CloudTable OpenTSDB", - "uri":"dataartsstudio_02_0278.html", - "doc_type":"api", - "p_code":"43", - "code":"56" + "p_code":"42", + "code":"54" }, { "desc":"By creating a DMS Kafka link, you can connect to Kafka Basic or Kafka Platinum on DMS. Currently, you can only export data from DMS Kafka to Cloud Search Service.", @@ -509,17 +491,17 @@ "title":"Link to DMS Kafka", "uri":"dataartsstudio_02_0280.html", "doc_type":"api", - "p_code":"43", - "code":"57" + "p_code":"42", + "code":"55" }, { "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":"dataartsstudio", "title":"Source Job Parameters", - "uri":"dataartsstudio_02_0281.html", + "uri":"source_job_parameters.html", "doc_type":"api", - "p_code":"42", - "code":"58" + "p_code":"41", + "code":"56" }, { "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.", @@ -527,8 +509,8 @@ "title":"From a Relational Database", "uri":"dataartsstudio_02_0282.html", "doc_type":"api", - "p_code":"58", - "code":"59" + "p_code":"56", + "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.", @@ -536,8 +518,8 @@ "title":"From Object Storage", "uri":"dataartsstudio_02_0283.html", "doc_type":"api", - "p_code":"58", - "code":"60" + "p_code":"56", + "code":"58" }, { "desc":"HDFS job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.inputDirectoryYesStringPath for storing data to be extracted. For example, /data_dir.fromJobC", @@ -545,8 +527,8 @@ "title":"From HDFS", "uri":"dataartsstudio_02_0284.html", "doc_type":"api", - "p_code":"58", - "code":"61" + "p_code":"56", + "code":"59" }, { "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.", @@ -554,8 +536,8 @@ "title":"From Hive", "uri":"dataartsstudio_02_0285.html", "doc_type":"api", - "p_code":"58", - "code":"62" + "p_code":"56", + "code":"60" }, { "desc":"HBase/CloudTable job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.tableYesStringName of the table from which data is extracted. For example, cdm.fr", @@ -563,17 +545,17 @@ "title":"From HBase/CloudTable", "uri":"dataartsstudio_02_0286.html", "doc_type":"api", - "p_code":"58", - "code":"63" + "p_code":"56", + "code":"61" }, { "desc":"Source link job parameters of FTP and SFTP are the same. Table 1 describes the parameters.Source link job parameters of file systemsParameterMandatoryTypeDescriptionfromJ", "product_code":"dataartsstudio", - "title":"From FTP/SFTP/NAS (to Be Brought Offline)/SFS (to Be Brought Offline)", + "title":"From FTP/SFTP", "uri":"dataartsstudio_02_0287.html", "doc_type":"api", - "p_code":"58", - "code":"64" + "p_code":"56", + "code":"62" }, { "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.", @@ -581,8 +563,8 @@ "title":"From HTTP/HTTPS", "uri":"dataartsstudio_02_0288.html", "doc_type":"api", - "p_code":"58", - "code":"65" + "p_code":"56", + "code":"63" }, { "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.", @@ -590,17 +572,17 @@ "title":"From MongoDB/DDS", "uri":"dataartsstudio_02_0289.html", "doc_type":"api", - "p_code":"58", - "code":"66" + "p_code":"56", + "code":"64" }, { "desc":"Redis job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.isBatchMigrationNoBooleanWhether to migrate all data in the databasefromJobConfig.keyPrefixY", "product_code":"dataartsstudio", - "title":"From Redis/DCS (to Be Brought Offline)", + "title":"From Redis", "uri":"dataartsstudio_02_0290.html", "doc_type":"api", - "p_code":"58", - "code":"67" + "p_code":"56", + "code":"65" }, { "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.", @@ -608,8 +590,8 @@ "title":"From DIS", "uri":"dataartsstudio_02_0291.html", "doc_type":"api", - "p_code":"58", - "code":"68" + "p_code":"56", + "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.", @@ -617,8 +599,8 @@ "title":"From Kafka", "uri":"dataartsstudio_02_0292.html", "doc_type":"api", - "p_code":"58", - "code":"69" + "p_code":"56", + "code":"67" }, { "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.", @@ -626,26 +608,17 @@ "title":"From Elasticsearch/Cloud Search Service", "uri":"dataartsstudio_02_0293.html", "doc_type":"api", - "p_code":"58", - "code":"70" - }, - { - "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":"dataartsstudio", - "title":"From OpenTSDB", - "uri":"dataartsstudio_02_0294.html", - "doc_type":"api", - "p_code":"58", - "code":"71" + "p_code":"56", + "code":"68" }, { "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":"dataartsstudio", "title":"Destination Job Parameters", - "uri":"dataartsstudio_02_0295.html", + "uri":"destination_job_parameters.html", "doc_type":"api", - "p_code":"42", - "code":"72" + "p_code":"41", + "code":"69" }, { "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.", @@ -653,8 +626,8 @@ "title":"To a Relational Database", "uri":"dataartsstudio_02_0296.html", "doc_type":"api", - "p_code":"72", - "code":"73" + "p_code":"69", + "code":"70" }, { "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.", @@ -662,8 +635,8 @@ "title":"To OBS", "uri":"dataartsstudio_02_0297.html", "doc_type":"api", - "p_code":"72", - "code":"74" + "p_code":"69", + "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.", @@ -671,8 +644,8 @@ "title":"To HDFS", "uri":"dataartsstudio_02_0298.html", "doc_type":"api", - "p_code":"72", - "code":"75" + "p_code":"69", + "code":"72" }, { "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.", @@ -680,8 +653,8 @@ "title":"To Hive", "uri":"dataartsstudio_02_0299.html", "doc_type":"api", - "p_code":"72", - "code":"76" + "p_code":"69", + "code":"73" }, { "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.", @@ -689,17 +662,8 @@ "title":"To HBase/CloudTable", "uri":"dataartsstudio_02_0300.html", "doc_type":"api", - "p_code":"72", - "code":"77" - }, - { - "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":"dataartsstudio", - "title":"To FTP/SFTP/NAS (to Be Brought Offline)/SFS (to Be Brought Offline)", - "uri":"dataartsstudio_02_0301.html", - "doc_type":"api", - "p_code":"72", - "code":"78" + "p_code":"69", + "code":"74" }, { "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.", @@ -707,17 +671,8 @@ "title":"To DDS", "uri":"dataartsstudio_02_0302.html", "doc_type":"api", - "p_code":"72", - "code":"79" - }, - { - "desc":"Parameter descriptionParameterMandatoryTypeDescriptiontoJobConfig.isBatchMigrationNoBooleanWhether to migrate all data in the databasetoJobConfig.shouldClearDatabaseNoBoo", - "product_code":"dataartsstudio", - "title":"To DCS", - "uri":"dataartsstudio_02_0303.html", - "doc_type":"api", - "p_code":"72", - "code":"80" + "p_code":"69", + "code":"75" }, { "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.", @@ -725,8 +680,8 @@ "title":"To Elasticsearch/Cloud Search Service", "uri":"dataartsstudio_02_0304.html", "doc_type":"api", - "p_code":"72", - "code":"81" + "p_code":"69", + "code":"76" }, { "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.", @@ -734,8 +689,8 @@ "title":"To DLI", "uri":"dataartsstudio_02_0305.html", "doc_type":"api", - "p_code":"72", - "code":"82" + "p_code":"69", + "code":"77" }, { "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.", @@ -743,98 +698,26 @@ "title":"To DIS", "uri":"dataartsstudio_02_0306.html", "doc_type":"api", - "p_code":"72", - "code":"83" + "p_code":"69", + "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":"dataartsstudio", - "title":"To OpenTSDB", - "uri":"dataartsstudio_02_0307.html", - "doc_type":"api", - "p_code":"72", - "code":"84" - }, - { - "desc":"When Creating a Job in a Specified Cluster or Creating and Executing a Job in a Random Cluster, the driver-config-values parameter specifies the job configuration, which ", + "desc":"When you create a job in a specified cluster by following the instructions in Creating a Job in a Specified Cluster or create and execute a job in a random cluster by fol", "product_code":"dataartsstudio", "title":"Job Parameter Description", - "uri":"dataartsstudio_02_0308.html", + "uri":"job_parameter.html", "doc_type":"api", - "p_code":"42", - "code":"85" + "p_code":"41", + "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":"dataartsstudio", "title":"DataArts Factory APIs", - "uri":"dataartsstudio_02_0127.html", + "uri":"dataartsstudio_02_0048.html", "doc_type":"api", "p_code":"", - "code":"86" - }, - { - "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":"dataartsstudio", - "title":"Connection Management APIs", - "uri":"dataartsstudio_02_0049.html", - "doc_type":"api", - "p_code":"86", - "code":"87" - }, - { - "desc":"This API is used to create a connection. The supported connection types include DWS, DLI, Spark SQL, RDS, CloudTable, and Hive.URI formatPOST /v1/{project_id}/connections", - "product_code":"dataartsstudio", - "title":"Creating a Connection", - "uri":"dataartsstudio_02_0050.html", - "doc_type":"api", - "p_code":"87", - "code":"88" - }, - { - "desc":"This API is used to query a connection list.URI formatGET /v1/{project_id}/connections?offset={offset}&limit={limit}&connectionName={connectionName}GET /v1/{project_id}/c", - "product_code":"dataartsstudio", - "title":"Querying a Connection List", - "uri":"dataartsstudio_02_0051.html", - "doc_type":"api", - "p_code":"87", - "code":"89" - }, - { - "desc":"This API is used to query configuration details of a specific connection.URI formatGET /v1/{project_id}/connections/{connection_name}GET /v1/{project_id}/connections/{con", - "product_code":"dataartsstudio", - "title":"Viewing Connection Details", - "uri":"dataartsstudio_02_0052.html", - "doc_type":"api", - "p_code":"87", - "code":"90" - }, - { - "desc":"This API is used to edit a connection.URI formatPUT /v1/{project_id}/connections/{connection_name}?ischeck=truePUT /v1/{project_id}/connections/{connection_name}?ischeck=", - "product_code":"dataartsstudio", - "title":"Editing a Connection", - "uri":"dataartsstudio_02_0053.html", - "doc_type":"api", - "p_code":"87", - "code":"91" - }, - { - "desc":"This API is used to delete a connection.URI formatDELETE /v1/{project_id}/connections/{connection_name}DELETE /v1/{project_id}/connections/{connection_name}Parameter desc", - "product_code":"dataartsstudio", - "title":"Deleting a Connection", - "uri":"dataartsstudio_02_0054.html", - "doc_type":"api", - "p_code":"87", - "code":"92" - }, - { - "desc":"This API is used to export all connection information that is compressed in ZIP format.URI formatPOST /v1/{project_id}/connections/exportPOST /v1/{project_id}/connections", - "product_code":"dataartsstudio", - "title":"Exporting a Connection", - "uri":"dataartsstudio_02_0055.html", - "doc_type":"api", - "p_code":"87", - "code":"93" + "code":"80" }, { "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.", @@ -842,8 +725,53 @@ "title":"Script Development APIs", "uri":"dataartsstudio_02_0056.html", "doc_type":"api", - "p_code":"86", - "code":"94" + "p_code":"80", + "code":"81" + }, + { + "desc":"This API is used to create a script. Currently, the following script types are supported: DLI SQL, Flink SQL, RDS SQL, Spark SQL, Hive SQL, DWS SQL, Shell, Presto SQL, Cl", + "product_code":"dataartsstudio", + "title":"Creating a Script", + "uri":"dataartsstudio_02_0097.html", + "doc_type":"api", + "p_code":"81", + "code":"82" + }, + { + "desc":"This API is used to modify the configuration items or script contents of a script.When modifying a script, specify the name of the script to be modified.The script name a", + "product_code":"dataartsstudio", + "title":"Modifying a Script", + "uri":"dataartsstudio_02_0098.html", + "doc_type":"api", + "p_code":"81", + "code":"83" + }, + { + "desc":"This API is used to query a script, including the script type and script content.URI formatGET /v1/{project_id}/scripts/{script_name}GET /v1/{project_id}/scripts/{script_", + "product_code":"dataartsstudio", + "title":"Querying a Script", + "uri":"dataartsstudio_02_0099.html", + "doc_type":"api", + "p_code":"81", + "code":"84" + }, + { + "desc":"This API is used to query the script list. A maximum of 1000 scripts can be returned for each query.URI formatGET /v1/{project_id}/scripts?offset={offset}&limit={limit}&s", + "product_code":"dataartsstudio", + "title":"Querying a Script List", + "uri":"dataartsstudio_02_0100.html", + "doc_type":"api", + "p_code":"81", + "code":"85" + }, + { + "desc":"This API is used to obtain the execution status and result of a script instance.During the query, specify the script name and script instance ID.URI formatGET /v1/{projec", + "product_code":"dataartsstudio", + "title":"Querying the Execution Result of a Script Instance", + "uri":"dataartsstudio_02_0101.html", + "doc_type":"api", + "p_code":"81", + "code":"86" }, { "desc":"This API is used to delete a specific script.URI formatDELETE /v1/{project_id}/scripts/{script_name}DELETE /v1/{project_id}/scripts/{script_name}Parameter descriptionURI ", @@ -851,8 +779,8 @@ "title":"Deleting a Script", "uri":"dataartsstudio_02_0057.html", "doc_type":"api", - "p_code":"94", - "code":"95" + "p_code":"81", + "code":"87" }, { "desc":"This API is used to execute a specific script, which can be a DWS SQL, DLI SQL, RDS SQL, Flink SQL, Hive SQL, Presto SQL, or Spark SQL script. A script instance is genera", @@ -860,8 +788,8 @@ "title":"Executing a Script", "uri":"dataartsstudio_02_0058.html", "doc_type":"api", - "p_code":"94", - "code":"96" + "p_code":"81", + "code":"88" }, { "desc":"This API is used to stop executing a script instance.URI formatPOST /v1/{project_id}/scripts/{script_name}/instances/{instance_id}/stopPOST /v1/{project_id}/scripts/{scri", @@ -869,8 +797,8 @@ "title":"Stopping Executing a Script Instance", "uri":"dataartsstudio_02_0059.html", "doc_type":"api", - "p_code":"94", - "code":"97" + "p_code":"81", + "code":"89" }, { "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.", @@ -878,8 +806,35 @@ "title":"Resource Management APIs", "uri":"dataartsstudio_02_0060.html", "doc_type":"api", - "p_code":"86", - "code":"98" + "p_code":"80", + "code":"90" + }, + { + "desc":"This API is used to create a resource. Types of nodes, including DLI Spark, MRS Spark, and MRS MapReduce, can reference files such as JAR and properties through resources", + "product_code":"dataartsstudio", + "title":"Creating a Resource", + "uri":"dataartsstudio_02_0102.html", + "doc_type":"api", + "p_code":"90", + "code":"91" + }, + { + "desc":"This API is used to modify a specific resource. When modifying the resource, specify the resource ID.The resource type and directory cannot be modified.URI formatPUT /v1/", + "product_code":"dataartsstudio", + "title":"Modifying a Resource", + "uri":"dataartsstudio_02_0103.html", + "doc_type":"api", + "p_code":"90", + "code":"92" + }, + { + "desc":"This API is used to query resource details. A resource contains various files such as JAR, ZIP, and properties files. A created resource can be used in job nodes such as ", + "product_code":"dataartsstudio", + "title":"Querying a Resource", + "uri":"dataartsstudio_02_0104.html", + "doc_type":"api", + "p_code":"90", + "code":"93" }, { "desc":"This API is used to delete a resource.URI formatDELETE /v1/{project_id}/resources/{resource_id}DELETE /v1/{project_id}/resources/{resource_id}Parameter descriptionURI par", @@ -887,8 +842,17 @@ "title":"Deleting a Resource", "uri":"dataartsstudio_02_0061.html", "doc_type":"api", - "p_code":"98", - "code":"99" + "p_code":"90", + "code":"94" + }, + { + "desc":"This API is used to query a resource list. During the query, you can specify the page number and the maximum number of records on each page.URI formatGET /v1/{project_id}", + "product_code":"dataartsstudio", + "title":"Querying a Resource List", + "uri":"dataartsstudio_02_0105.html", + "doc_type":"api", + "p_code":"90", + "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.", @@ -896,7 +860,43 @@ "title":"Job Development APIs", "uri":"dataartsstudio_02_0062.html", "doc_type":"api", - "p_code":"86", + "p_code":"80", + "code":"96" + }, + { + "desc":"This API is used to create a job. A job consists of one or more nodes, such as Hive SQL and CDM Job nodes. DLF supports two types of jobs: batch jobs and real-time jobs.U", + "product_code":"dataartsstudio", + "title":"Creating a Job", + "uri":"dataartsstudio_02_0084.html", + "doc_type":"api", + "p_code":"96", + "code":"97" + }, + { + "desc":"This API is used to edit a job.URI formatPUT /v1/{project_id}/jobs/{job_name}PUT /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterMandatoryType", + "product_code":"dataartsstudio", + "title":"Editing a Job", + "uri":"dataartsstudio_02_0085.html", + "doc_type":"api", + "p_code":"96", + "code":"98" + }, + { + "desc":"This API is used to query a list of batch or real-time jobs. A maximum of 100 jobs can be returned for each query.URI formatGET /v1/{project_id}/jobs?jobType={jobType}&of", + "product_code":"dataartsstudio", + "title":"Viewing a Job List", + "uri":"dataartsstudio_02_0086.html", + "doc_type":"api", + "p_code":"96", + "code":"99" + }, + { + "desc":"This API is used to view job details.URI formatGET /v1/{project_id}/jobs/{name}GET /v1/{project_id}/jobs/{name}Parameter descriptionParameterMandatoryTypeDescriptionproje", + "product_code":"dataartsstudio", + "title":"Viewing Job Details", + "uri":"dataartsstudio_02_0087.html", + "doc_type":"api", + "p_code":"96", "code":"100" }, { @@ -905,107 +905,17 @@ "title":"Viewing a Job File", "uri":"dataartsstudio_02_0063.html", "doc_type":"api", - "p_code":"100", + "p_code":"96", "code":"101" }, { - "desc":"This API is used to stop a job.URI formatPOST /v1/{project_id}/jobs/{job_name}/stopPOST /v1/{project_id}/jobs/{job_name}/stopParameter descriptionURI parametersParamete", - "product_code":"dataartsstudio", - "title":"Stopping a Job", - "uri":"dataartsstudio_02_0064.html", - "doc_type":"api", - "p_code":"100", - "code":"102" - }, - { - "desc":"This API is used to delete a job.URI formatDELETE /v1/{project_id}/jobs/{job_name}DELETE /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterManda", - "product_code":"dataartsstudio", - "title":"Deleting a Job", - "uri":"dataartsstudio_02_0065.html", - "doc_type":"api", - "p_code":"100", - "code":"103" - }, - { - "desc":"This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.URI formatPOST /v1/{project_id}/jobs/{job_name}/insta", - "product_code":"dataartsstudio", - "title":"Stopping a Job Instance", - "uri":"dataartsstudio_02_0066.html", - "doc_type":"api", - "p_code":"100", - "code":"104" - }, - { - "desc":"This API is used to restart a specific job instance. A job instance can be restarted only when it is in the successful, failed, or canceled state.URI formatPOST /v1/{proj", - "product_code":"dataartsstudio", - "title":"Restarting a Job Instance", - "uri":"dataartsstudio_02_0067.html", - "doc_type":"api", - "p_code":"100", - "code":"105" - }, - { - "desc":"Table 1 describes common request headers.Table 2 describes common response headers.", - "product_code":"dataartsstudio", - "title":"Data Structure", - "uri":"dataartsstudio_02_0082.html", - "doc_type":"api", - "p_code":"86", - "code":"106" - }, - { - "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":"dataartsstudio", - "title":"APIs to Be Taken Offline", - "uri":"dataartsstudio_02_0083.html", - "doc_type":"api", - "p_code":"86", - "code":"107" - }, - { - "desc":"This API is used to create a job. A job consists of one or more nodes, such as Hive SQL and CDM Job nodes. DLF supports two types of jobs: batch jobs and real-time jobs.U", - "product_code":"dataartsstudio", - "title":"Creating a Job", - "uri":"dataartsstudio_02_0084.html", - "doc_type":"api", - "p_code":"107", - "code":"108" - }, - { - "desc":"This API is used to edit a job.URI formatPUT /v1/{project_id}/jobs/{job_name}PUT /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterMandatoryType", - "product_code":"dataartsstudio", - "title":"Editing a Job", - "uri":"dataartsstudio_02_0085.html", - "doc_type":"api", - "p_code":"107", - "code":"109" - }, - { - "desc":"This API is used to query a list of batch or real-time jobs. A maximum of 1000 jobs can be returned for each query.URI formatGET /v1/{project_id}/jobs?jobType={jobType}&o", - "product_code":"dataartsstudio", - "title":"Viewing a Job List", - "uri":"dataartsstudio_02_0086.html", - "doc_type":"api", - "p_code":"107", - "code":"110" - }, - { - "desc":"This API is used to view job details.URI formatGET /v1/{project_id}/jobs/{name}GET /v1/{project_id}/jobs/{name}Parameter descriptionURI parameterParameterMandatoryTypeDes", - "product_code":"dataartsstudio", - "title":"Viewing Job Details", - "uri":"dataartsstudio_02_0087.html", - "doc_type":"api", - "p_code":"107", - "code":"111" - }, - { - "desc":"This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/{name}/exportPOST /v1/{p", + "desc":"This API is used to export a job, including job definitions, job dependency scripts, and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/{job_name}/exportPOST /v", "product_code":"dataartsstudio", "title":"Exporting a Job", "uri":"dataartsstudio_02_0088.html", "doc_type":"api", - "p_code":"107", - "code":"112" + "p_code":"96", + "code":"102" }, { "desc":"This API is used to batch export jobs, including job dependency scripts and CDM job definitions.URI formatPOST /v1/{project_id}/jobs/batch-exportPOST /v1/{project_id}/job", @@ -1013,8 +923,8 @@ "title":"Batch Exporting Jobs", "uri":"dataartsstudio_02_0089.html", "doc_type":"api", - "p_code":"107", - "code":"113" + "p_code":"96", + "code":"103" }, { "desc":"This API is used to import one or more job files from OBS to DLF.Before using this API, store job files in OBS buckets.URI formatPOST /v1/{project_id}/jobs/importPOST /", @@ -1022,8 +932,8 @@ "title":"Importing a Job", "uri":"dataartsstudio_02_0090.html", "doc_type":"api", - "p_code":"107", - "code":"114" + "p_code":"96", + "code":"104" }, { "desc":"This API is used to execute a job immediately and check whether the job can be executed successfully.URI formatPOST /v1/{project_id}/jobs/{job_name}/run-immediatePOST /", @@ -1031,17 +941,53 @@ "title":"Executing a Job Immediately", "uri":"dataartsstudio_02_0091.html", "doc_type":"api", - "p_code":"107", - "code":"115" + "p_code":"96", + "code":"105" }, { - "desc":"This API is used to start a job.URI formatPOST /v1/{project_id}/jobs/{name}/startPOST /v1/{project_id}/jobs/{name}/startParameter descriptionURI parametersParameterMand", + "desc":"This API is used to start a job.URI formatPOST /v1/{project_id}/jobs/{job_name}/startPOST /v1/{project_id}/jobs/{job_name}/startParameter descriptionURI parametersParam", "product_code":"dataartsstudio", "title":"Starting a Job", "uri":"dataartsstudio_02_0092.html", "doc_type":"api", - "p_code":"107", - "code":"116" + "p_code":"96", + "code":"106" + }, + { + "desc":"This API is used to stop a job.URI formatPOST /v1/{project_id}/jobs/{job_name}/stopPOST /v1/{project_id}/jobs/{job_name}/stopParameter descriptionURI parametersParamete", + "product_code":"dataartsstudio", + "title":"Stopping a Job", + "uri":"dataartsstudio_02_0064.html", + "doc_type":"api", + "p_code":"96", + "code":"107" + }, + { + "desc":"This API is used to delete a job.URI formatDELETE /v1/{project_id}/jobs/{job_name}DELETE /v1/{project_id}/jobs/{job_name}Parameter descriptionURI parametersParameterManda", + "product_code":"dataartsstudio", + "title":"Deleting a Job", + "uri":"dataartsstudio_02_0065.html", + "doc_type":"api", + "p_code":"96", + "code":"108" + }, + { + "desc":"This API is used to stop a specific job instance. A job instance can be stopped only when it is in the running state.URI formatPOST /v1/{project_id}/jobs/{job_name}/insta", + "product_code":"dataartsstudio", + "title":"Stopping a Job Instance", + "uri":"dataartsstudio_02_0066.html", + "doc_type":"api", + "p_code":"96", + "code":"109" + }, + { + "desc":"This API is used to retry a specific job instance. A job instance can be retried only when it is in the successful, failed, or canceled state.URI formatPOST /v1/{project_", + "product_code":"dataartsstudio", + "title":"Retrying a Job Instance", + "uri":"dataartsstudio_02_0067.html", + "doc_type":"api", + "p_code":"96", + "code":"110" }, { "desc":"This API is used to view running status of a real-time job.URI formatGET /v1/{project_id}/jobs/{job_name}/statusGET /v1/{project_id}/jobs/{job_name}/statusParameter descr", @@ -1049,8 +995,8 @@ "title":"Viewing Running Status of a Real-Time Job", "uri":"dataartsstudio_02_0093.html", "doc_type":"api", - "p_code":"107", - "code":"117" + "p_code":"96", + "code":"111" }, { "desc":"This API is used to view a job instance list.A job instance is generated each time you run a batch job for which periodic scheduling or event-based scheduling is configur", @@ -1058,8 +1004,8 @@ "title":"Viewing a Job Instance List", "uri":"dataartsstudio_02_0094.html", "doc_type":"api", - "p_code":"107", - "code":"118" + "p_code":"96", + "code":"112" }, { "desc":"This API is used to view job instance details, including the execution information about each node in a job instance.URI formatGET /v1/{project_id}/jobs/{job_name}/instan", @@ -1067,107 +1013,89 @@ "title":"Viewing Job Instance Details", "uri":"dataartsstudio_02_0095.html", "doc_type":"api", - "p_code":"107", - "code":"119" + "p_code":"96", + "code":"113" }, { "desc":"This API is used to query details about asynchronous tasks.URI formatGET /v1/{project_id}/system-tasks/{task_id}GET /v1/{project_id}/system-tasks/{task_id}Parameter descr", "product_code":"dataartsstudio", - "title":"Querying a System Task", + "title":"Querying System Task Details", "uri":"dataartsstudio_02_0096.html", "doc_type":"api", - "p_code":"107", + "p_code":"96", + "code":"114" + }, + { + "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":"dataartsstudio", + "title":"Connection Management APIs (To Be Taken Offline)", + "uri":"dataartsstudio_02_0049.html", + "doc_type":"api", + "p_code":"80", + "code":"115" + }, + { + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to create a connection. The supported co", + "product_code":"dataartsstudio", + "title":"Creating a Connection (to Be Taken Offline)", + "uri":"dataartsstudio_02_0050.html", + "doc_type":"api", + "p_code":"115", + "code":"116" + }, + { + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to query a connection list.URI formatGET", + "product_code":"dataartsstudio", + "title":"Querying a Connection List (to Be Taken Offline)", + "uri":"dataartsstudio_02_0051.html", + "doc_type":"api", + "p_code":"115", + "code":"117" + }, + { + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to query details of a connection.URI for", + "product_code":"dataartsstudio", + "title":"Querying Connection Details (to Be Taken Offline)", + "uri":"dataartsstudio_02_0052.html", + "doc_type":"api", + "p_code":"115", + "code":"118" + }, + { + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to edit a connection.URI formatPUT /v1/{", + "product_code":"dataartsstudio", + "title":"Editing a Connection (to Be Taken Offline)", + "uri":"dataartsstudio_02_0053.html", + "doc_type":"api", + "p_code":"115", + "code":"119" + }, + { + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to delete a connection.URI formatDELETE ", + "product_code":"dataartsstudio", + "title":"Deleting a Connection (to Be Taken Offline)", + "uri":"dataartsstudio_02_0054.html", + "doc_type":"api", + "p_code":"115", "code":"120" }, { - "desc":"This API is used to create a script. Currently, the following script types are supported: DLI SQL, Flink SQL, RDS SQL, Spark SQL, Hive SQL, DWS SQL, Shell, and Presto.URI", + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to export all connection information tha", "product_code":"dataartsstudio", - "title":"Creating a Script", - "uri":"dataartsstudio_02_0097.html", + "title":"Exporting Connections (to Be Taken Offline)", + "uri":"dataartsstudio_02_0055.html", "doc_type":"api", - "p_code":"107", + "p_code":"115", "code":"121" }, { - "desc":"This API is used to modify the configuration items or script contents of a script.When modifying a script, specify the name of the script to be modified.The script name a", + "desc":"The connection management capability is provided by Management Center. APIs of Management Center are recommended.This API is used to import one or more connection files f", "product_code":"dataartsstudio", - "title":"Modifying a Script", - "uri":"dataartsstudio_02_0098.html", - "doc_type":"api", - "p_code":"107", - "code":"122" - }, - { - "desc":"This API is used to query a script, including the script type and script content.URI formatGET /v1/{project_id}/script/{script_name}GET /v1/{project_id}/script/{script_na", - "product_code":"dataartsstudio", - "title":"Querying a Script", - "uri":"dataartsstudio_02_0099.html", - "doc_type":"api", - "p_code":"107", - "code":"123" - }, - { - "desc":"This API is used to query the script list. A maximum of 1000 scripts can be returned for each query.URI formatGET /v1/{project_id}/scripts?offset={offset}&limit={limit}&s", - "product_code":"dataartsstudio", - "title":"Querying a Script List", - "uri":"dataartsstudio_02_0100.html", - "doc_type":"api", - "p_code":"107", - "code":"124" - }, - { - "desc":"This API is used to obtain the execution status and result of a script instance.During the query, specify the script name and script instance ID.URI formatGET /v1/{projec", - "product_code":"dataartsstudio", - "title":"Querying the Execution Result of a Script Instance", - "uri":"dataartsstudio_02_0101.html", - "doc_type":"api", - "p_code":"107", - "code":"125" - }, - { - "desc":"This API is used to create a resource. Types of nodes, including DLI Spark, MRS Spark, and MRS MapReduce, can reference files such as JAR and properties through resources", - "product_code":"dataartsstudio", - "title":"Creating a Resource", - "uri":"dataartsstudio_02_0102.html", - "doc_type":"api", - "p_code":"107", - "code":"126" - }, - { - "desc":"This API is used to modify a specific resource. When modifying the resource, specify the resource ID.The resource type and directory cannot be modified.URI formatPUT /v1/", - "product_code":"dataartsstudio", - "title":"Modifying a Resource", - "uri":"dataartsstudio_02_0103.html", - "doc_type":"api", - "p_code":"107", - "code":"127" - }, - { - "desc":"This API is used to query resource details. A resource contains various files such as JAR, ZIP, and properties files. A created resource can be used in job nodes such as ", - "product_code":"dataartsstudio", - "title":"Querying a Resource", - "uri":"dataartsstudio_02_0104.html", - "doc_type":"api", - "p_code":"107", - "code":"128" - }, - { - "desc":"This API is used to query a resource list. During the query, you can specify the page number and the maximum number of records on each page.URI formatGET /v1/{project_id}", - "product_code":"dataartsstudio", - "title":"Querying a Resource List", - "uri":"dataartsstudio_02_0105.html", - "doc_type":"api", - "p_code":"107", - "code":"129" - }, - { - "desc":"This API is used to import one or more connection files from OBS to the Data Development module. Before using this API, store connection files in OBS buckets.URI formatPO", - "product_code":"dataartsstudio", - "title":"Importing a Connection", + "title":"Importing Connections (to Be Taken Offline)", "uri":"dataartsstudio_02_0106.html", "doc_type":"api", - "p_code":"107", - "code":"130" + "p_code":"115", + "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.", @@ -1176,7 +1104,7 @@ "uri":"dataartsstudio_02_0309.html", "doc_type":"api", "p_code":"", - "code":"131" + "code":"123" }, { "desc":"Table 1 describes common request headers.Table 2 describes common response headers.", @@ -1184,44 +1112,8 @@ "title":"Common Message Headers", "uri":"dataartsstudio_02_0318.html", "doc_type":"api", - "p_code":"131", - "code":"132" - }, - { - "desc":"A status code consists of three digits. The first digit defines the class of a response. There are five values for the first digit:1xx: indication information, indicating", - "product_code":"dataartsstudio", - "title":"Status Codes", - "uri":"dataartsstudio_02_0310.html", - "doc_type":"api", - "p_code":"131", - "code":"133" - }, - { - "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":"dataartsstudio", - "title":"Error Codes", - "uri":"ErrorCode.html", - "doc_type":"api", - "p_code":"131", - "code":"134" - }, - { - "desc":"If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status co", - "product_code":"dataartsstudio", - "title":"CDM Error Codes", - "uri":"dataartsstudio_02_0311.html", - "doc_type":"api", - "p_code":"134", - "code":"135" - }, - { - "desc":"The error response is in the following format:{\"error_code\":\"DLF.0100\",\"error_msg\":\"The job not found\"}Table 1 describes the error codes.", - "product_code":"dataartsstudio", - "title":"DLF Error Codes", - "uri":"dataartsstudio_02_0313.html", - "doc_type":"api", - "p_code":"134", - "code":"136" + "p_code":"123", + "code":"124" }, { "desc":"The response messages of the job export API and connection export API are streams that need to be converted to files. For details, see the following sample code:", @@ -1229,16 +1121,43 @@ "title":"Parsing a Stream in a Response Message", "uri":"dataartsstudio_02_0317.html", "doc_type":"api", - "p_code":"131", - "code":"137" + "p_code":"123", + "code":"125" + }, + { + "desc":"A status code consists of three digits. The first digit defines the class of a response. There are five values for the first digit:1xx: indication information, indicating", + "product_code":"dataartsstudio", + "title":"Status Codes", + "uri":"dataartsstudio_02_0310.html", + "doc_type":"api", + "p_code":"123", + "code":"126" }, { "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":"dataartsstudio", - "title":"Change History", - "uri":"dataartsstudio_02_0330.html", + "title":"Error Codes", + "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"", - "code":"138" + "p_code":"123", + "code":"127" + }, + { + "desc":"If an error occurs in API calling, no result is returned. Identify the error cause based on the error codes of each API. If an error occurs in API calling, HTTP status co", + "product_code":"dataartsstudio", + "title":"DataArts Migration Error Codes", + "uri":"dataartsstudio_02_0311.html", + "doc_type":"api", + "p_code":"127", + "code":"128" + }, + { + "desc":"The error response is in the following format:{\"error_code\":\"DLF.0100\",\"error_msg\":\"The job not found\"}Table 1 describes the error codes.", + "product_code":"dataartsstudio", + "title":"DataArts Factory Error Codes", + "uri":"dataartsstudio_02_0313.html", + "doc_type":"api", + "p_code":"127", + "code":"129" } ] \ No newline at end of file diff --git a/docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob.html b/docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob_0.html similarity index 89% rename from docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob.html rename to docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob_0.html index 9115eb74..e97f28a7 100644 --- a/docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob.html +++ b/docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob_0.html @@ -1,9 +1,9 @@ - +

Creating and Executing a Job in a Random Cluster

Function

This API is used to create and execute a job in a random cluster.

-

URI

POST /v1.1/{project_id}/clusters/job

+

URI

POST /v1.1/{project_id}/clusters/job

@@ -29,7 +29,7 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Table 2 Request header parameters

Parameter

+
@@ -61,7 +61,7 @@
Table 2 Request header parameters

Parameter

Mandatory

-
Table 3 Request body parameters

Parameter

+
@@ -75,7 +75,7 @@ - @@ -93,7 +93,7 @@
Table 3 Request body parameters

Parameter

Mandatory

Yes

Array of Job objects

+

Array of Job objects

Job list. For details, see the descriptions of jobs parameters.

-
Table 4 Job

Parameter

+
@@ -134,7 +134,7 @@ - @@ -152,7 +152,7 @@ - @@ -161,7 +161,7 @@ - @@ -439,7 +439,7 @@
Table 4 Job

Parameter

Mandatory

Yes

ConfigValues object

+

ConfigValues object

Destination link parameter configuration

Yes

ConfigValues object

+

ConfigValues object

Job parameter configuration

Yes

ConfigValues object

+

ConfigValues object

Source link parameter configuration

-
Table 5 ConfigValues

Parameter

+
@@ -453,7 +453,7 @@ - @@ -462,7 +462,7 @@ - @@ -471,7 +471,7 @@
Table 5 ConfigValues

Parameter

Mandatory

Yes

Array of configs objects

+

Array of configs objects

The data structures of source link parameters, destination link parameters, and job parameters are the same. However, the inputs parameter varies. For details, see the descriptions of configs parameters.

No

extended-configs object

+

extended-configs object

Extended configuration. For details, see the descriptions of extended-configs parameters.

-
Table 6 configs

Parameter

+
@@ -485,7 +485,7 @@ - @@ -521,7 +521,7 @@
Table 6 configs

Parameter

Mandatory

Yes

Array of Input objects

+

Array of Input objects

Input parameter list. Each element in the list is in name,value format. For details, see the descriptions of inputs parameters. In the from-config-values data structure, the value of this parameter varies with the source link type. For details, see section "Source Job Parameters" in the Cloud Data Migration User Guide. In the to-cofig-values data structure, the value of this parameter varies with the destination link type. For details, see section "Destination Job Parameters" in the Cloud Data Migration User Guide. For details about the inputs parameter in the driver-config-values data structure, see the job parameter descriptions.

-
Table 7 Input

Parameter

+
@@ -562,7 +562,7 @@
Table 7 Input

Parameter

Mandatory

-
Table 8 extended-configs

Parameter

+
@@ -596,7 +596,7 @@

Response Parameters

Status code: 200

-
Table 8 extended-configs

Parameter

Mandatory

Table 9 Response body parameters

Parameter

+
@@ -606,7 +606,7 @@ - @@ -615,7 +615,7 @@
Table 9 Response body parameters

Parameter

Type

submissions

Array of StartJobSubmission objects

+

Array of StartJobSubmission objects

Job running information. For details, see the descriptions of submission parameters.

-
Table 10 StartJobSubmission

Parameter

+
@@ -839,24 +839,24 @@ "submissions" : [ { "isIncrementing" : false, "job-name" : "obs2obs-03", - "submisson-id" : 13, + "submission-id" : 13, "isStopingIncrement" : "", "last-update-date" : 1635909057030, "is-execute-auto" : false, "delete_rows" : 0, "write_rows" : 0, - "last-update-user" : "mwx5316849", "isDeleteJob" : false, "creation-user" : "mwx5316849", "progress" : 0, "creation-date" : 1635909057030, "update_rows" : 0, - "status" : "PENDING" + "status" : "PENDING", + "execute-date" : 1635909057030 } ] }

Status Codes

-
Table 10 StartJobSubmission

Parameter

Type

Status Code

+
@@ -876,7 +876,7 @@
diff --git a/docs/dataartsstudio/api-ref/CreateCluster.html b/docs/dataartsstudio/api-ref/CreateCluster.html deleted file mode 100644 index d7ef3b5c..00000000 --- a/docs/dataartsstudio/api-ref/CreateCluster.html +++ /dev/null @@ -1,655 +0,0 @@ - - -

Creating a Cluster

-

Function

This API is used to create a cluster.

-
-

URI

POST /v1.1/{project_id}/clusters

- -

Status Code

Description

- - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID

-
-
- -

Request Parameters

-
- - - - - - - - - - - - - - - - -
Table 2 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

-

X-Language

-

Yes

-

String

-

Request language

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

cluster

-

Yes

-

cluster object

-

Cluster object. For details, see the descriptions of cluster parameters.

-

auto_remind

-

No

-

Boolean

-

Whether to enable message notification. If you enable this function, you can configure a maximum of five mobile numbers or email addresses. You will be notified of table/file migration job failures and EIP exceptions by SMS message or email.

-

phone_num

-

No

-

String

-

Mobile number for receiving notifications

-

email

-

No

-

String

-

Email address for receiving notifications

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 cluster

Parameter

-

Mandatory

-

Type

-

Description

-

scheduleBootTime

-

No

-

String

-

Time for scheduled startup of a CDM cluster. The CDM cluster starts at this time every day.

-

isScheduleBootOff

-

No

-

Boolean

-

Whether to enable scheduled startup/shutdown. The scheduled startup/shutdown and auto shutdown functions cannot be enabled at the same time.

-

instances

-

No

-

Array of instance objects

-

Node list. For details, see the descriptions of instances parameters.

-

datastore

-

No

-

Datastore object

-

Cluster information. For details, see the descriptions of datastore parameters.

-

extended_properties

-

No

-

ExtendedProperties object

-

Extended attribute. For details, see parameters in the extended_properties field.

-

scheduleOffTime

-

No

-

String

-

Time for scheduled shutdown of a CDM cluster. The CDM cluster shuts down directly at this time every day without waiting for unfinished jobs to complete.

-

vpcId

-

No

-

String

-

VPC ID, which is used for configuring a network for the cluster.

-

name

-

No

-

String

-

Cluster name

-

sys_tags

-

No

-

Array of sys_tags objects

-

Enterprise project information. For details, see the descriptions of sys_tags parameters.

-

isAutoOff

-

No

-

Boolean

-

Whether to enable auto shutdown. The auto shutdown and scheduled startup/shutdown functions cannot be enabled at the same time. When auto shutdown is enabled, if no job is running in the cluster and no scheduled job is available, a cluster will be automatically shut down 15 minutes after it starts running, which reduces costs for you.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 instance

Parameter

-

Mandatory

-

Type

-

Description

-

availability_zone

-

Yes

-

String

-

AZ where a cluster is located

-

nics

-

Yes

-

Array of nics objects

-

NIC list. A maximum of two NICs are supported. For details, see the descriptions of nics parameters.

-

flavorRef

-

Yes

-

String

-

Instance flavor

-
  • a79fd5ae-1833-448a-88e8-3ea2b913e1f6: cdm.small with 2 vCPUs and 4 GB memory applicable to Proof of Concept (PoC) verification and development and tests
  • fb8fe666-6734-4b11-bc6c-43d11db3c745: cdm.medium with 4 vCPUs and 8 GB memory applicable to the migration of a single database table with fewer than 10 million pieces of data
  • 5ddb1071-c5d7-40e0-a874-8a032e81a697: cdm.large with 8 vCPUs and 16 GB memory applicable to the migration of a single database table with 10 million or more pieces of data
  • 6ddb1072-c5d7-40e0-a874-8a032e81a698: cdm.xlarge with 16 vCPUs and 32 GB memory applicable to the migration of terabytes of data requiring 10GE bandwidth
-

type

-

Yes

-

String

-

Node type. Currently, only cdm is available.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 6 nics

Parameter

-

Mandatory

-

Type

-

Description

-

securityGroupId

-

Yes

-

String

-

Security group ID

-

net-id

-

Yes

-

String

-

Subnet ID

-
-
- -
- - - - - - - - - - - - - - - - -
Table 7 Datastore

Parameter

-

Mandatory

-

Type

-

Description

-

type

-

No

-

String

-

Type. Generally, the value is cdm.

-

version

-

No

-

String

-

Cluster version

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 8 ExtendedProperties

Parameter

-

Mandatory

-

Type

-

Description

-

workSpaceId

-

No

-

String

-

Workspace ID

-

resourceId

-

No

-

String

-

Resource ID

-

trial

-

No

-

String

-

Whether the cluster is a trial cluster

-
-
- -
- - - - - - - - - - - - - - - - -
Table 9 sys_tags

Parameter

-

Mandatory

-

Type

-

Description

-

value

-

Yes

-

String

-

Enterprise project ID

-

key

-

Yes

-

String

-

The value is fixed at _sys_enterprise_project_id.

-
-
-
-

Response Parameters

Status code: 202

- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

Cluster name

-

id

-

String

-

Cluster ID

-

task

-

Task object

-

Task information

-

datastore

-

Datastore object

-

Cluster information

-

instances

-

Array of ClusterInstance objects

-

Cluster node information

-
-
- -
- - - - - - - - - - - - - -
Table 11 Task

Parameter

-

Type

-

Description

-

id

-

String

-

Task ID

-

name

-

String

-

Task name

-
-
- -
- - - - - - - - - - - - - -
Table 12 Datastore

Parameter

-

Type

-

Description

-

type

-

String

-

Type. Generally, the value is cdm.

-

version

-

String

-

Cluster version

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 13 ClusterInstance

Parameter

-

Type

-

Description

-

id

-

String

-

Node VM ID

-

name

-

String

-

Name of the VM on the node

-

type

-

String

-

Node type. Currently, only cdm is available.

-

shard_id

-

String

-

Shard ID

-
-
-
-

Example Requests

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters
-
-{
-  "cluster" : {
-    "scheduleBootTime" : "",
-    "isScheduleBootOff" : false,
-    "instances" : [ {
-      "availability_zone" : "eu-de",
-      "nics" : [ {
-        "securityGroupId" : "c37852d2-2d12-41cb-af47-65c80e995c80",
-        "net-id" : "2d120298-6130-44d4-a438-454912fff901"
-      } ],
-      "flavorRef" : "5ddb1071-c5d7-40e0-a874-8a032e81a697",
-      "type" : "cdm"
-    } ],
-    "datastore" : {
-      "type" : "cdm",
-      "version" : "1.8.10"
-    },
-    "scheduleOffTime" : "",
-    "vpcId" : "67c06084-2212-4242-bcd4-d2144c2385a9",
-    "name" : "cdm-ab82",
-    "sys_tags" : [ {
-      "value" : "1ce45885-4033-40d2-bdde-d4dbaceb387d",
-      "key" : "_sys_enterprise_project_id"
-    } ],
-    "isAutoOff" : false
-  },
-  "auto_remind" : false,
-  "phone_num" : "",
-  "email" : ""
-}
-
-

Example Responses

Status code: 202

-

Accepted

-
{
-  "id" : "befc862c-9286-46a0-a1d6-300d98b63aad",
-  "name" : "cdm-4ef213",
-  "task" : {
-    "id" : "2c9080047f1b1185017f1ef6ad0500ac",
-    "name" : "rdsCreateBackupJob"
-  },
-  "datastore" : {
-    "type" : "cdm",
-    "version" : "2.9.1.100"
-  },
-  "instances" : [ {
-    "id" : "b2672e7d-2faf-423f-96bb-0664cd743cfd",
-    "name" : "cdm-4ef213-cdm-dn-1-1",
-    "type" : "cdm",
-    "shard_id" : "dn-1"
-  } ]
-}
-
-

Status Codes

-
- - - - - - - - - - - - - - - - - - - - - - - - - -

Status Code

-

Description

-

202

-

Accepted

-

400

-

Request error.

-

401

-

Authentication failed.

-

403

-

You do not have required permissions to perform this operation.

-

404

-

The requested resource was not found.

-

500

-

Internal service error.

-

503

-

Service unavailable.

-
-
-
-

Error Codes

See Error Codes.

-
- -
- -
- diff --git a/docs/dataartsstudio/api-ref/CreateCluster_0.html b/docs/dataartsstudio/api-ref/CreateCluster_0.html new file mode 100644 index 00000000..86462a5a --- /dev/null +++ b/docs/dataartsstudio/api-ref/CreateCluster_0.html @@ -0,0 +1,655 @@ + + +

Creating a Cluster

+

Function

This API is used to create a cluster.

+
+

URI

POST /v1.1/{project_id}/clusters

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+

X-Language

+

Yes

+

String

+

Request language

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

cluster

+

Yes

+

cluster object

+

Cluster object. For details, see the descriptions of cluster parameters.

+

auto_remind

+

No

+

Boolean

+

Whether to enable message notification. If you enable this function, you can configure a maximum of five mobile numbers or email addresses. You will be notified of table/file migration job failures and EIP exceptions by SMS message or email.

+

phone_num

+

No

+

String

+

Mobile number for receiving notifications

+

email

+

No

+

String

+

Email address for receiving notifications

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 cluster

Parameter

+

Mandatory

+

Type

+

Description

+

scheduleBootTime

+

No

+

String

+

Time for scheduled startup of a CDM cluster. The CDM cluster starts at this time every day.

+

isScheduleBootOff

+

No

+

Boolean

+

Whether to enable scheduled startup/shutdown. The scheduled startup/shutdown and auto shutdown functions cannot be enabled at the same time.

+

instances

+

No

+

Array of instance objects

+

Node list. For details, see the descriptions of instances parameters.

+

datastore

+

No

+

Datastore object

+

Cluster information. For details, see the descriptions of datastore parameters.

+

extended_properties

+

No

+

ExtendedProperties object

+

Extended attribute. For details, see parameters in the extended_properties field.

+

scheduleOffTime

+

No

+

String

+

Time for scheduled shutdown of a CDM cluster. The CDM cluster shuts down directly at this time every day without waiting for unfinished jobs to complete.

+

vpcId

+

No

+

String

+

VPC ID, which is used for configuring a network for the cluster.

+

name

+

No

+

String

+

Cluster name

+

sys_tags

+

No

+

Array of sys_tags objects

+

Enterprise project information. For details, see the descriptions of sys_tags parameters.

+

isAutoOff

+

No

+

Boolean

+

Whether to enable auto shutdown. The auto shutdown and scheduled startup/shutdown functions cannot be enabled at the same time. When auto shutdown is enabled, if no job is running in the cluster and no scheduled job is available, a cluster will be automatically shut down 15 minutes after it starts running, which reduces costs for you.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 instance

Parameter

+

Mandatory

+

Type

+

Description

+

availability_zone

+

Yes

+

String

+

AZ where a cluster is located.

+

nics

+

Yes

+

Array of nics objects

+

NIC list. A maximum of two NICs are supported. For details, see the descriptions of nics parameters.

+

flavorRef

+

Yes

+

String

+

Instance flavor

+
  • a79fd5ae-1833-448a-88e8-3ea2b913e1f6: cdm.small with 2 vCPUs and 4 GB memory applicable to Proof of Concept (PoC) verification and development and tests
  • fb8fe666-6734-4b11-bc6c-43d11db3c745: cdm.medium with 4 vCPUs and 8 GB memory applicable to the migration of a single database table with fewer than 10 million pieces of data
  • 5ddb1071-c5d7-40e0-a874-8a032e81a697: cdm.large with 8 vCPUs and 16 GB memory applicable to the migration of a single database table with 10 million or more pieces of data
  • 6ddb1072-c5d7-40e0-a874-8a032e81a698: cdm.xlarge with 16 vCPUs and 32 GB memory applicable to the migration of terabytes of data requiring 10GE bandwidth
+

type

+

Yes

+

String

+

Node type. Currently, only cdm is available.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 nics

Parameter

+

Mandatory

+

Type

+

Description

+

securityGroupId

+

Yes

+

String

+

Security group ID

+

net-id

+

Yes

+

String

+

Subnet ID

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 Datastore

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Type. Generally, the value is cdm.

+

version

+

No

+

String

+

Cluster version

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 8 ExtendedProperties

Parameter

+

Mandatory

+

Type

+

Description

+

workSpaceId

+

No

+

String

+

Workspace ID

+

resourceId

+

No

+

String

+

Resource ID

+

trial

+

No

+

String

+

Whether the cluster is a trial cluster

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 9 sys_tags

Parameter

+

Mandatory

+

Type

+

Description

+

value

+

Yes

+

String

+

Enterprise project ID

+

key

+

Yes

+

String

+

The value is fixed at _sys_enterprise_project_id.

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Cluster name

+

id

+

String

+

Cluster ID

+

task

+

Task object

+

Task information

+

datastore

+

Datastore object

+

Cluster information

+

instances

+

Array of ClusterInstance objects

+

Cluster node information

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 Task

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID

+

name

+

String

+

Task name

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 Datastore

Parameter

+

Type

+

Description

+

type

+

String

+

Type. Generally, the value is cdm.

+

version

+

String

+

Cluster version

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 13 ClusterInstance

Parameter

+

Type

+

Description

+

id

+

String

+

Node VM ID

+

name

+

String

+

Name of the VM on the node

+

type

+

String

+

Node type. Currently, only cdm is available.

+

shard_id

+

String

+

Shard ID

+
+
+
+

Example Requests

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters
+
+{
+  "cluster" : {
+    "scheduleBootTime" : "",
+    "isScheduleBootOff" : false,
+    "instances" : [ {
+      "availability_zone" : "xx-xxxxx-xx",
+      "nics" : [ {
+        "securityGroupId" : "c37852d2-2d12-41cb-af47-65c80e995c80",
+        "net-id" : "2d120298-6130-44d4-a438-454912fff901"
+      } ],
+      "flavorRef" : "5ddb1071-c5d7-40e0-a874-8a032e81a697",
+      "type" : "cdm"
+    } ],
+    "datastore" : {
+      "type" : "cdm",
+      "version" : "1.8.10"
+    },
+    "scheduleOffTime" : "",
+    "vpcId" : "67c06084-2212-4242-bcd4-d2144c2385a9",
+    "name" : "cdm-ab82",
+    "sys_tags" : [ {
+      "value" : "1ce45885-4033-40d2-bdde-d4dbaceb387d",
+      "key" : "_sys_enterprise_project_id"
+    } ],
+    "isAutoOff" : false
+  },
+  "auto_remind" : false,
+  "phone_num" : "",
+  "email" : ""
+}
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "id" : "befc862c-9286-46a0-a1d6-300d98b63aad",
+  "name" : "cdm-4ef213",
+  "task" : {
+    "id" : "2c9080047f1b1185017f1ef6ad0500ac",
+    "name" : "rdsCreateBackupJob"
+  },
+  "datastore" : {
+    "type" : "cdm",
+    "version" : "2.9.1.100"
+  },
+  "instances" : [ {
+    "id" : "b2672e7d-2faf-423f-96bb-0664cd743cfd",
+    "name" : "cdm-4ef213-cdm-dn-1-1",
+    "type" : "cdm",
+    "shard_id" : "dn-1"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

202

+

Accepted

+

400

+

Request error.

+

401

+

Authentication failed.

+

403

+

You do not have required permissions to perform this operation.

+

404

+

The requested resource was not found.

+

500

+

Internal service error.

+

503

+

Service unavailable.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dataartsstudio/api-ref/CreateJob.html b/docs/dataartsstudio/api-ref/CreateJob.html deleted file mode 100644 index 68297bb6..00000000 --- a/docs/dataartsstudio/api-ref/CreateJob.html +++ /dev/null @@ -1,803 +0,0 @@ - - -

Creating a Job in a Specified Cluster

-

Function

This API is used to create a job in a specified cluster.

-
-

URI

POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/job

- -
- - - - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID

-

cluster_id

-

Yes

-

String

-

Cluster ID

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Auth-Token

-

Yes

-

String

-

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

-
-
- -
- - - - - - - - - - - -
Table 3 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

jobs

-

Yes

-

Array of Job objects

-

Job list. For details, see the descriptions of jobs parameters.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Job

Parameter

-

Mandatory

-

Type

-

Description

-

job_type

-

No

-

String

-

Job type

-
  • NORMAL_JOB: table/file migration
  • BATCH_JOB: entire DB migration
  • SCENARIO_JOB: scenario migration
-

Enumeration values:

-
  • NORMAL_JOB
  • BATCH_JOB
  • SCENARIO_JOB
-

from-connector-name

-

Yes

-

String

-

Source link type

-

to-config-values

-

Yes

-

ConfigValues object

-

Destination link parameter configuration

-

to-link-name

-

Yes

-

String

-

Destination link name

-

driver-config-values

-

Yes

-

ConfigValues object

-

Job parameter configuration

-

from-config-values

-

Yes

-

ConfigValues object

-

Source link parameter configuration

-

to-connector-name

-

No

-

String

-

Destination link type

-

name

-

No

-

String

-

Job name, which contains 1 to 240 characters

-

Minimum: 1

-

Maximum: 240

-

from-link-name

-

No

-

String

-

Source link name

-

creation-user

-

No

-

String

-

User who created the job

-

creation-date

-

No

-

Long

-

Time when the job was created, accurate to millisecond

-

update-date

-

No

-

Long

-

Time when the job was last updated, accurate to millisecond

-

is_incre_job

-

No

-

Boolean

-

Incremental or not

-

flag

-

No

-

Integer

-

Flag

-

files_read

-

No

-

Integer

-

Number of read files

-

update-user

-

No

-

String

-

User who last updated the job

-

external_id

-

No

-

String

-

External ID

-

type

-

No

-

String

-

Task type

-

execute_start_date

-

No

-

Long

-

Execution start date

-

delete_rows

-

No

-

Integer

-

Number of deleted rows

-

enabled

-

No

-

Boolean

-

Whether to activate the link

-

bytes_written

-

No

-

Long

-

Number of written bytes

-

id

-

No

-

Integer

-

Job ID

-

is_use_sql

-

No

-

Boolean

-

Whether to use SQL statements

-

update_rows

-

No

-

Integer

-

Number of updated rows

-

group_name

-

No

-

String

-

Group name

-

bytes_read

-

No

-

Long

-

Number of read bytes

-

execute_update_date

-

No

-

Long

-

Execution update date

-

write_rows

-

No

-

Integer

-

Number of written rows

-

rows_written

-

No

-

Integer

-

Number of written rows

-

rows_read

-

No

-

Long

-

Number of rows that are read

-

files_written

-

No

-

Integer

-

Number of written files

-

is_incrementing

-

No

-

Boolean

-

Incremental or not

-

execute_create_date

-

No

-

Long

-

Execution creation date

-

status

-

No

-

String

-

Job execution status

-
  • BOOTING: The job is starting.
  • RUNNING: The job is running.
  • SUCCEEDED: The job was successfully executed.
  • FAILED: The job execution failed.
  • NEW: The job was not executed.
-
-
- -
- - - - - - - - - - - - - - - - -
Table 5 ConfigValues

Parameter

-

Mandatory

-

Type

-

Description

-

configs

-

Yes

-

Array of configs objects

-

The data structures of source link parameters, destination link parameters, and job parameters are the same. However, the inputs parameter varies. For details, see the descriptions of configs parameters.

-

extended-configs

-

No

-

extended-configs object

-

Extended configuration. For details, see the descriptions of extended-configs parameters.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 6 configs

Parameter

-

Mandatory

-

Type

-

Description

-

inputs

-

Yes

-

Array of Input objects

-

Input parameter list. Each element in the list is in name,value format. For details, see the descriptions of inputs parameters. In the from-config-values data structure, the value of this parameter varies with the source link type. For details, see section "Source Job Parameters" in the Cloud Data Migration User Guide. In the to-cofig-values data structure, the value of this parameter varies with the destination link type. For details, see section "Destination Job Parameters" in the Cloud Data Migration User Guide. For details about the inputs parameter in the driver-config-values data structure, see the job parameter descriptions.

-

name

-

Yes

-

String

-

Configuration name. The value is fromJobConfig for a source job, toJobConfig for a destination job, and linkConfig for a link.

-

id

-

No

-

Integer

-

Configuration ID

-

type

-

No

-

String

-

Configuration type

-
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 7 Input

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

Yes

-

String

-

Parameter name

-

value

-

Yes

-

String

-

Parameter value

-

type

-

No

-

String

-

Value type

-
-
- -
- - - - - - - - - - - - - - - - -
Table 8 extended-configs

Parameter

-

Mandatory

-

Type

-

Description

-

name

-

No

-

String

-

Name

-

value

-

No

-

String

-

Value

-
-
-
-

Response Parameters

Status code: 200

- -
- - - - - - - - - - - - - -
Table 9 Response body parameters

Parameter

-

Type

-

Description

-

name

-

String

-

Job name

-

validation-result

-

Array of JobValidationResult objects

-

Check result

-
  • If the modification fails, the failure cause is returned.
  • If the modification is successful, an empty list is returned.
-
-
- -
- - - - - - - - - - - - - -
Table 10 JobValidationResult

Parameter

-

Type

-

Description

-

message

-

String

-

Error message

-

status

-

String

-

ERROR,WARNING

-

Enumeration values:

-
  • ERROR
  • WARNING
-
-
-

Status code: 400

- -
- - - - - - - - - - - - - - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

code

-

String

-

Return code

-

errCode

-

String

-

Error code

-

message

-

String

-

Error message

-

externalMessage

-

String

-

Additional information

-
-
-
-

Example Requests

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/job
-
-{
-  "jobs" : [ {
-    "job_type" : "NORMAL_JOB",
-    "from-connector-name" : "elasticsearch-connector",
-    "to-config-values" : {
-      "configs" : [ {
-        "inputs" : [ {
-          "name" : "toJobConfig.streamName",
-          "value" : "dis-lkGm"
-        }, {
-          "name" : "toJobConfig.separator",
-          "value" : "|"
-        }, {
-          "name" : "toJobConfig.columnList",
-          "value" : "1&2&3"
-        } ],
-        "name" : "toJobConfig"
-      } ]
-    },
-    "to-link-name" : "dis",
-    "driver-config-values" : {
-      "configs" : [ {
-        "inputs" : [ {
-          "name" : "throttlingConfig.numExtractors",
-          "value" : "1"
-        }, {
-          "name" : "throttlingConfig.submitToCluster",
-          "value" : "false"
-        }, {
-          "name" : "throttlingConfig.numLoaders",
-          "value" : "1"
-        }, {
-          "name" : "throttlingConfig.recordDirtyData",
-          "value" : "false"
-        } ],
-        "name" : "throttlingConfig"
-      }, {
-        "inputs" : { },
-        "name" : "jarConfig"
-      }, {
-        "inputs" : [ {
-          "name" : "schedulerConfig.isSchedulerJob",
-          "value" : "false"
-        }, {
-          "name" : "schedulerConfig.disposableType",
-          "value" : "NONE"
-        } ],
-        "name" : "schedulerConfig"
-      }, {
-        "inputs" : { },
-        "name" : "transformConfig"
-      }, {
-        "inputs" : [ {
-          "name" : "retryJobConfig.retryJobType",
-          "value" : "NONE"
-        } ],
-        "name" : "retryJobConfig"
-      } ]
-    },
-    "from-config-values" : {
-      "configs" : [ {
-        "inputs" : [ {
-          "name" : "fromJobConfig.index",
-          "value" : "52est"
-        }, {
-          "name" : "fromJobConfig.type",
-          "value" : "est_array"
-        }, {
-          "name" : "fromJobConfig.columnList",
-          "value" : "array_f1_int:long&array_f2_text:string&array_f3_object:nested"
-        }, {
-          "name" : "fromJobConfig.splitNestedField",
-          "value" : "false"
-        } ],
-        "name" : "fromJobConfig"
-      } ]
-    },
-    "to-connector-name" : "dis-connector",
-    "name" : "es_css",
-    "from-link-name" : "css"
-  } ]
-}
-
-

Example Responses

Status code: 200

-

ok

-
{
-  "name" : "mysql2hive"
-}
-

Status code: 400

-

Request error

-
{
-  "code" : "Cdm.0104",
-  "errCode" : "Cdm.0104",
-  "message" : "Job name already exist or created by other.",
-  "externalMessage" : "Job name already exist or created by other."
-}
-
-

Status Codes

-
- - - - - - - - - - -

Status Code

-

Description

-

200

-

ok

-

400

-

Request error

-
-
-
-

Error Codes

See Error Codes.

-
-
-
- -
- diff --git a/docs/dataartsstudio/api-ref/CreateJob_0.html b/docs/dataartsstudio/api-ref/CreateJob_0.html new file mode 100644 index 00000000..2e38d260 --- /dev/null +++ b/docs/dataartsstudio/api-ref/CreateJob_0.html @@ -0,0 +1,818 @@ + + +

Creating a Job in a Specified Cluster

+

Function

This API is used to create a job in a specified cluster.

+
+

URI

POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/job

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

cluster_id

+

Yes

+

String

+

Cluster ID

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

jobs

+

Yes

+

Array of Job objects

+

Job list. For details, see the descriptions of jobs parameters.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Job

Parameter

+

Mandatory

+

Type

+

Description

+

job_type

+

No

+

String

+

Job type

+
  • NORMAL_JOB: table/file migration

    +
  • BATCH_JOB: entire DB migration

    +
  • SCENARIO_JOB: scenario migration

    +
+

Enumeration values:

+
  • NORMAL_JOB

    +
  • BATCH_JOB

    +
  • SCENARIO_JOB

    +
+

from-connector-name

+

Yes

+

String

+

Source link type

+

to-config-values

+

Yes

+

ConfigValues object

+

Destination link parameter configuration

+

to-link-name

+

Yes

+

String

+

Destination link name

+

driver-config-values

+

Yes

+

ConfigValues object

+

Job parameter configuration

+

from-config-values

+

Yes

+

ConfigValues object

+

Source link parameter configuration

+

to-connector-name

+

No

+

String

+

Destination link type

+

name

+

No

+

String

+

Job name, which contains 1 to 240 characters

+

Minimum: 1

+

Maximum: 240

+

from-link-name

+

No

+

String

+

Source link name

+

creation-user

+

No

+

String

+

User who created the job

+

creation-date

+

No

+

Long

+

Time when the job was created, accurate to millisecond

+

update-date

+

No

+

Long

+

Time when the job was last updated, accurate to millisecond

+

is_incre_job

+

No

+

Boolean

+

Incremental or not

+

flag

+

No

+

Integer

+

Flag

+

files_read

+

No

+

Integer

+

Number of read files

+

update-user

+

No

+

String

+

User who last updated the job

+

external_id

+

No

+

String

+

External ID

+

type

+

No

+

String

+

Task type

+

execute_start_date

+

No

+

Long

+

Execution start date

+

delete_rows

+

No

+

Integer

+

Number of deleted rows

+

enabled

+

No

+

Boolean

+

Whether to activate the link

+

bytes_written

+

No

+

Long

+

Number of written bytes

+

id

+

No

+

Integer

+

Job ID

+

is_use_sql

+

No

+

Boolean

+

Whether to use SQL statements

+

update_rows

+

No

+

Integer

+

Number of updated rows

+

group_name

+

No

+

String

+

Group name

+

bytes_read

+

No

+

Long

+

Number of read bytes

+

execute_update_date

+

No

+

Long

+

Execution update date

+

write_rows

+

No

+

Integer

+

Number of written rows

+

rows_written

+

No

+

Integer

+

Number of written rows

+

rows_read

+

No

+

Long

+

Number of rows that are read

+

files_written

+

No

+

Integer

+

Number of written files

+

is_incrementing

+

No

+

Boolean

+

Incremental or not

+

execute_create_date

+

No

+

Long

+

Execution creation date

+

status

+

No

+

String

+

Job execution status

+
  • BOOTING: The job is starting.

    +
  • RUNNING: The job is running.

    +
  • SUCCEEDED: The job was successfully executed.

    +
  • FAILED: The job execution failed.

    +
  • NEW: The job was not executed.

    +
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 ConfigValues

Parameter

+

Mandatory

+

Type

+

Description

+

configs

+

Yes

+

Array of configs objects

+

The data structures of source link parameters, destination link parameters, and job parameters are the same. However, the inputs parameter varies. For details, see the descriptions of configs parameters.

+

extended-configs

+

No

+

extended-configs object

+

Extended configuration. For details, see the descriptions of extended-configs parameters.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 configs

Parameter

+

Mandatory

+

Type

+

Description

+

inputs

+

Yes

+

Array of Input objects

+

Input parameter list. Each element in the list is in name,value format. For details, see the descriptions of inputs parameters. In the from-config-values data structure, the value of this parameter varies with the source link type. For details, see section "Source Job Parameters" in the Cloud Data Migration User Guide. In the to-cofig-values data structure, the value of this parameter varies with the destination link type. For details, see section "Destination Job Parameters" in the Cloud Data Migration User Guide. For details about the inputs parameter in the driver-config-values data structure, see the job parameter descriptions.

+

name

+

Yes

+

String

+

Configuration name. The value is fromJobConfig for a source job, toJobConfig for a destination job, and linkConfig for a link.

+

id

+

No

+

Integer

+

Configuration ID

+

type

+

No

+

String

+

Configuration type

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 Input

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Parameter name

+

value

+

Yes

+

String

+

Parameter value

+

type

+

No

+

String

+

Value type

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 extended-configs

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Name

+

value

+

No

+

String

+

Value

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

name

+

String

+

Job name

+

validation-result

+

Array of JobValidationResult objects

+

Check result

+
  • If the modification fails, the failure cause is returned.

    +
  • If the modification is successful, an empty list is returned.

    +
+
+
+ +
+ + + + + + + + + + + + + +
Table 10 JobValidationResult

Parameter

+

Type

+

Description

+

message

+

String

+

Error message

+

status

+

String

+

ERROR,WARNING

+

Enumeration values:

+
  • ERROR

    +
  • WARNING

    +
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

code

+

String

+

Return code

+

errCode

+

String

+

Error code

+

message

+

String

+

Error message

+

externalMessage

+

String

+

Additional information

+
+
+
+

Example Requests

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/job
+
+{
+  "jobs" : [ {
+    "job_type" : "NORMAL_JOB",
+    "from-connector-name" : "elasticsearch-connector",
+    "to-config-values" : {
+      "configs" : [ {
+        "inputs" : [ {
+          "name" : "toJobConfig.streamName",
+          "value" : "dis-lkGm"
+        }, {
+          "name" : "toJobConfig.separator",
+          "value" : "|"
+        }, {
+          "name" : "toJobConfig.columnList",
+          "value" : "1&2&3"
+        } ],
+        "name" : "toJobConfig"
+      } ]
+    },
+    "to-link-name" : "dis",
+    "driver-config-values" : {
+      "configs" : [ {
+        "inputs" : [ {
+          "name" : "throttlingConfig.numExtractors",
+          "value" : "1"
+        }, {
+          "name" : "throttlingConfig.submitToCluster",
+          "value" : "false"
+        }, {
+          "name" : "throttlingConfig.numLoaders",
+          "value" : "1"
+        }, {
+          "name" : "throttlingConfig.recordDirtyData",
+          "value" : "false"
+        } ],
+        "name" : "throttlingConfig"
+      }, {
+        "inputs" : { },
+        "name" : "jarConfig"
+      }, {
+        "inputs" : [ {
+          "name" : "schedulerConfig.isSchedulerJob",
+          "value" : "false"
+        }, {
+          "name" : "schedulerConfig.disposableType",
+          "value" : "NONE"
+        } ],
+        "name" : "schedulerConfig"
+      }, {
+        "inputs" : { },
+        "name" : "transformConfig"
+      }, {
+        "inputs" : [ {
+          "name" : "retryJobConfig.retryJobType",
+          "value" : "NONE"
+        } ],
+        "name" : "retryJobConfig"
+      } ]
+    },
+    "from-config-values" : {
+      "configs" : [ {
+        "inputs" : [ {
+          "name" : "fromJobConfig.index",
+          "value" : "52est"
+        }, {
+          "name" : "fromJobConfig.type",
+          "value" : "est_array"
+        }, {
+          "name" : "fromJobConfig.columnList",
+          "value" : "array_f1_int:long&array_f2_text:string&array_f3_object:nested"
+        }, {
+          "name" : "fromJobConfig.splitNestedField",
+          "value" : "false"
+        } ],
+        "name" : "fromJobConfig"
+      } ]
+    },
+    "to-connector-name" : "dis-connector",
+    "name" : "es_css",
+    "from-link-name" : "css"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

ok

+
{
+  "name" : "mysql2hive"
+}
+

Status code: 400

+

Request error

+
{
+  "code" : "Cdm.0104",
+  "errCode" : "Cdm.0104",
+  "message" : "Job name already exist or created by other.",
+  "ternalMessage" : "Job name already exist or created by other."
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

ok

+

400

+

Request error

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/dataartsstudio/api-ref/CreateLink.html b/docs/dataartsstudio/api-ref/CreateLink_0.html similarity index 80% rename from docs/dataartsstudio/api-ref/CreateLink.html rename to docs/dataartsstudio/api-ref/CreateLink_0.html index efd7f3dd..08274ae1 100644 --- a/docs/dataartsstudio/api-ref/CreateLink.html +++ b/docs/dataartsstudio/api-ref/CreateLink_0.html @@ -1,9 +1,9 @@ - +

Creating a Link

Function

This API is used to create a link.

-

URI

POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/link

+