vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dataartsstudio/api-ref/CLASS.TXT.json
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2024-03-01 11:46:15 +00:00

1163 lines
46 KiB
JSON
Raw Blame History

[
{
"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":"Before You Start",
"uri":"dataartsstudio_02_0001.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"Welcome to DataArts Studio. DataArts Studio is a one-stop operations platform that provides data lifecycle management and intelligent data management for enterprises' dig",
"product_code":"dataartsstudio",
"title":"Overview",
"uri":"dataartsstudio_02_0002.html",
"doc_type":"api",
"p_code":"1",
"code":"2"
},
{
"desc":"DataArts Studio supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details on API calling, see Calling APIs.",
"product_code":"dataartsstudio",
"title":"API Calling",
"uri":"dataartsstudio_02_0003.html",
"doc_type":"api",
"p_code":"1",
"code":"3"
},
{
"desc":"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",
"product_code":"dataartsstudio",
"title":"Concepts",
"uri":"dataartsstudio_02_0006.html",
"doc_type":"api",
"p_code":"1",
"code":"4"
},
{
"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":"endpoint.html",
"doc_type":"api",
"p_code":"1",
"code":"5"
},
{
"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":"projectid_accountid.html",
"doc_type":"api",
"p_code":"1",
"code":"6"
},
{
"desc":"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",
"product_code":"dataartsstudio",
"title":"DataArts Studio Instance ID and Workspace ID",
"uri":"dataartsstudio_02_0350.html",
"doc_type":"api",
"p_code":"1",
"code":"7"
},
{
"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":"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.",
"product_code":"dataartsstudio",
"title":"API Overview",
"uri":"dataartsstudio_02_0007.html",
"doc_type":"api",
"p_code":"",
"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.",
"product_code":"dataartsstudio",
"title":"Calling APIs",
"uri":"dataartsstudio_02_0008.html",
"doc_type":"api",
"p_code":"",
"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":"making_request.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Authentication",
"uri":"dataartsstudio_02_0010.html",
"doc_type":"api",
"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 ",
"product_code":"dataartsstudio",
"title":"Response",
"uri":"dataartsstudio_02_0011.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Application Cases",
"uri":"dataartsstudio_02_0012.html",
"doc_type":"api",
"p_code":"",
"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":"Example of Using DataArts Migration APIs",
"uri":"dataartsstudio_02_0013.html",
"doc_type":"api",
"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 DataArts Factory APIs",
"uri":"dataartsstudio_02_0015.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"DataArts Migration APIs",
"uri":"dataartsstudio_02_0016.html",
"doc_type":"api",
"p_code":"",
"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_8.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Stopping a Cluster",
"uri":"StopCluster.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_6.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_6.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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_0.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Public Data Structures",
"uri":"dataartsstudio_02_0260.html",
"doc_type":"api",
"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":"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 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":"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.",
"product_code":"dataartsstudio",
"title":"Link to HDFS",
"uri":"dataartsstudio_02_0266.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Link to HBase",
"uri":"dataartsstudio_02_0267.html",
"doc_type":"api",
"p_code":"42",
"code":"46"
},
{
"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":"42",
"code":"47"
},
{
"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":"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",
"product_code":"dataartsstudio",
"title":"Link to an FTP or SFTP Server",
"uri":"dataartsstudio_02_0270.html",
"doc_type":"api",
"p_code":"42",
"code":"49"
},
{
"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":"42",
"code":"50"
},
{
"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",
"uri":"dataartsstudio_02_0272.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Link to Kafka",
"uri":"dataartsstudio_02_0274.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Link to Elasticsearch/Cloud Search Service",
"uri":"dataartsstudio_02_0276.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Link to DLI",
"uri":"dataartsstudio_02_0277.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Link to DMS Kafka",
"uri":"dataartsstudio_02_0280.html",
"doc_type":"api",
"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":"source_job_parameters.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From a Relational Database",
"uri":"dataartsstudio_02_0282.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From Object Storage",
"uri":"dataartsstudio_02_0283.html",
"doc_type":"api",
"p_code":"56",
"code":"58"
},
{
"desc":"HDFS job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.inputDirectoryYesStringPath for storing data to be extracted. For example, /data_dir.fromJobC",
"product_code":"dataartsstudio",
"title":"From HDFS",
"uri":"dataartsstudio_02_0284.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From Hive",
"uri":"dataartsstudio_02_0285.html",
"doc_type":"api",
"p_code":"56",
"code":"60"
},
{
"desc":"HBase/CloudTable job parameter descriptionParameterMandatoryTypeDescriptionfromJobConfig.tableYesStringName of the table from which data is extracted. For example, cdm.fr",
"product_code":"dataartsstudio",
"title":"From HBase/CloudTable",
"uri":"dataartsstudio_02_0286.html",
"doc_type":"api",
"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",
"uri":"dataartsstudio_02_0287.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From HTTP/HTTPS",
"uri":"dataartsstudio_02_0288.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From MongoDB/DDS",
"uri":"dataartsstudio_02_0289.html",
"doc_type":"api",
"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",
"uri":"dataartsstudio_02_0290.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From DIS",
"uri":"dataartsstudio_02_0291.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From Kafka",
"uri":"dataartsstudio_02_0292.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"From Elasticsearch/Cloud Search Service",
"uri":"dataartsstudio_02_0293.html",
"doc_type":"api",
"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":"destination_job_parameters.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To a Relational Database",
"uri":"dataartsstudio_02_0296.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To OBS",
"uri":"dataartsstudio_02_0297.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To HDFS",
"uri":"dataartsstudio_02_0298.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To Hive",
"uri":"dataartsstudio_02_0299.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To HBase/CloudTable",
"uri":"dataartsstudio_02_0300.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To DDS",
"uri":"dataartsstudio_02_0302.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To Elasticsearch/Cloud Search Service",
"uri":"dataartsstudio_02_0304.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To DLI",
"uri":"dataartsstudio_02_0305.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"To DIS",
"uri":"dataartsstudio_02_0306.html",
"doc_type":"api",
"p_code":"69",
"code":"78"
},
{
"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":"job_parameter.html",
"doc_type":"api",
"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_0048.html",
"doc_type":"api",
"p_code":"",
"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.",
"product_code":"dataartsstudio",
"title":"Script Development APIs",
"uri":"dataartsstudio_02_0056.html",
"doc_type":"api",
"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 ",
"product_code":"dataartsstudio",
"title":"Deleting a Script",
"uri":"dataartsstudio_02_0057.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Executing a Script",
"uri":"dataartsstudio_02_0058.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Stopping Executing a Script Instance",
"uri":"dataartsstudio_02_0059.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Resource Management APIs",
"uri":"dataartsstudio_02_0060.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Deleting a Resource",
"uri":"dataartsstudio_02_0061.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Job Development APIs",
"uri":"dataartsstudio_02_0062.html",
"doc_type":"api",
"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"
},
{
"desc":"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",
"product_code":"dataartsstudio",
"title":"Viewing a Job File",
"uri":"dataartsstudio_02_0063.html",
"doc_type":"api",
"p_code":"96",
"code":"101"
},
{
"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":"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",
"product_code":"dataartsstudio",
"title":"Batch Exporting Jobs",
"uri":"dataartsstudio_02_0089.html",
"doc_type":"api",
"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 /",
"product_code":"dataartsstudio",
"title":"Importing a Job",
"uri":"dataartsstudio_02_0090.html",
"doc_type":"api",
"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 /",
"product_code":"dataartsstudio",
"title":"Executing a Job Immediately",
"uri":"dataartsstudio_02_0091.html",
"doc_type":"api",
"p_code":"96",
"code":"105"
},
{
"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":"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",
"product_code":"dataartsstudio",
"title":"Viewing Running Status of a Real-Time Job",
"uri":"dataartsstudio_02_0093.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Viewing a Job Instance List",
"uri":"dataartsstudio_02_0094.html",
"doc_type":"api",
"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",
"product_code":"dataartsstudio",
"title":"Viewing Job Instance Details",
"uri":"dataartsstudio_02_0095.html",
"doc_type":"api",
"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 System Task Details",
"uri":"dataartsstudio_02_0096.html",
"doc_type":"api",
"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":"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":"Exporting Connections (to Be Taken Offline)",
"uri":"dataartsstudio_02_0055.html",
"doc_type":"api",
"p_code":"115",
"code":"121"
},
{
"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":"Importing Connections (to Be Taken Offline)",
"uri":"dataartsstudio_02_0106.html",
"doc_type":"api",
"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.",
"product_code":"dataartsstudio",
"title":"Appendix",
"uri":"dataartsstudio_02_0309.html",
"doc_type":"api",
"p_code":"",
"code":"123"
},
{
"desc":"Table 1 describes common request headers.Table 2 describes common response headers.",
"product_code":"dataartsstudio",
"title":"Common Message Headers",
"uri":"dataartsstudio_02_0318.html",
"doc_type":"api",
"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:",
"product_code":"dataartsstudio",
"title":"Parsing a Stream in a Response Message",
"uri":"dataartsstudio_02_0317.html",
"doc_type":"api",
"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":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"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"
}
]
View Git Blame Copy Permalink