From 6a7720e26673e5c9b98cc0b762daad71c075ad60 Mon Sep 17 00:00:00 2001 From: "Xiong, Chen Xiao" Date: Fri, 4 Jul 2025 09:10:27 +0000 Subject: [PATCH] DataArts API 20240831 version Reviewed-by: Pruthi, Vineet Co-authored-by: Xiong, Chen Xiao Co-committed-by: Xiong, Chen Xiao --- docs/dataartsstudio/api-ref/CLASS.TXT.json | 46 +++++++++---------- .../api-ref/dataartsstudio_02_0094.html | 4 +- .../api-ref/dataartsstudio_02_0262.html | 13 ------ .../api-ref/dataartsstudio_02_0266.html | 4 +- .../api-ref/dataartsstudio_02_0267.html | 4 +- .../api-ref/dataartsstudio_02_0269.html | 2 +- .../api-ref/dataartsstudio_02_0288.html | 2 +- .../api-ref/dataartsstudio_02_0297.html | 10 ++++ .../api-ref/dataartsstudio_02_0298.html | 10 ++++ .../api-ref/dataartsstudio_02_0311.html | 13 +----- 10 files changed, 52 insertions(+), 56 deletions(-) diff --git a/docs/dataartsstudio/api-ref/CLASS.TXT.json b/docs/dataartsstudio/api-ref/CLASS.TXT.json index 88f82e57d..45f95716b 100644 --- a/docs/dataartsstudio/api-ref/CLASS.TXT.json +++ b/docs/dataartsstudio/api-ref/CLASS.TXT.json @@ -154,7 +154,7 @@ }, { "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", + "product_code":"cdm", "title":"Cluster Management", "uri":"topic_300000000_8.html", "doc_type":"api", @@ -163,7 +163,7 @@ }, { "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", + "product_code":"cdm", "title":"Querying Cluster Details", "uri":"ShowClusterDetail_0.html", "doc_type":"api", @@ -172,7 +172,7 @@ }, { "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", + "product_code":"cdm", "title":"Deleting a Cluster", "uri":"DeleteCluster_0.html", "doc_type":"api", @@ -181,7 +181,7 @@ }, { "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", + "product_code":"cdm", "title":"Restarting a Cluster", "uri":"RestartCluster_0.html", "doc_type":"api", @@ -190,7 +190,7 @@ }, { "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", + "product_code":"cdm", "title":"Starting a Cluster", "uri":"StartCluster_0.html", "doc_type":"api", @@ -199,7 +199,7 @@ }, { "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", + "product_code":"cdm", "title":"Stopping a Cluster", "uri":"StopCluster.html", "doc_type":"api", @@ -208,7 +208,7 @@ }, { "desc":"This API is used to create a cluster.POST /v1.1/{project_id}/clustersStatus code: 202Status code: 202AcceptedSee Error Codes.", - "product_code":"dataartsstudio", + "product_code":"cdm", "title":"Creating a Cluster", "uri":"CreateCluster_0.html", "doc_type":"api", @@ -217,7 +217,7 @@ }, { "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", + "product_code":"cdm", "title":"Querying the Cluster List", "uri":"ListClusters_0.html", "doc_type":"api", @@ -226,7 +226,7 @@ }, { "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", + "product_code":"cdm", "title":"Job Management", "uri":"topic_300000001_6.html", "doc_type":"api", @@ -235,7 +235,7 @@ }, { "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", + "product_code":"cdm", "title":"Querying a Job", "uri":"ShowJobs_0.html", "doc_type":"api", @@ -244,7 +244,7 @@ }, { "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", + "product_code":"cdm", "title":"Deleting a Job", "uri":"DeleteJob_0.html", "doc_type":"api", @@ -253,7 +253,7 @@ }, { "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", + "product_code":"cdm", "title":"Modifying a Job", "uri":"UpdateJob_0.html", "doc_type":"api", @@ -262,7 +262,7 @@ }, { "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", + "product_code":"cdm", "title":"Creating and Executing a Job in a Random Cluster", "uri":"CreateAndStartRandomClusterJob_0.html", "doc_type":"api", @@ -271,7 +271,7 @@ }, { "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", + "product_code":"cdm", "title":"Stopping a Job", "uri":"StopJob_0.html", "doc_type":"api", @@ -280,7 +280,7 @@ }, { "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", + "product_code":"cdm", "title":"Creating a Job in a Specified Cluster", "uri":"CreateJob_0.html", "doc_type":"api", @@ -289,7 +289,7 @@ }, { "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", + "product_code":"cdm", "title":"Starting a Job", "uri":"StartJob_0.html", "doc_type":"api", @@ -298,7 +298,7 @@ }, { "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", + "product_code":"cdm", "title":"Querying Job Status", "uri":"ShowJobStatus_0.html", "doc_type":"api", @@ -307,7 +307,7 @@ }, { "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", + "product_code":"cdm", "title":"Querying Job Execution History", "uri":"ShowSubmissions_0.html", "doc_type":"api", @@ -316,7 +316,7 @@ }, { "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", + "product_code":"cdm", "title":"Link Management", "uri":"topic_300000002_6.html", "doc_type":"api", @@ -325,7 +325,7 @@ }, { "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", + "product_code":"cdm", "title":"Creating a Link", "uri":"CreateLink_0.html", "doc_type":"api", @@ -334,7 +334,7 @@ }, { "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", + "product_code":"cdm", "title":"Querying a Link", "uri":"ShowLink_0.html", "doc_type":"api", @@ -343,7 +343,7 @@ }, { "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", + "product_code":"cdm", "title":"Deleting a Link", "uri":"DeleteLink_0.html", "doc_type":"api", @@ -352,7 +352,7 @@ }, { "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", + "product_code":"cdm", "title":"Modifying a Link", "uri":"UpdateLink_0.html", "doc_type":"api", diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0094.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0094.html index ebe4eb06a..75948b078 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0094.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0094.html @@ -189,7 +189,7 @@

No

-

String

+

Long

Job ID

@@ -301,7 +301,7 @@

No

-

String

+

int

Job instance version

diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0262.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0262.html index fec9cb90e..8fb4e27ea 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0262.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0262.html @@ -35,10 +35,6 @@ "name": "linkConfig.password", "value": "Add password here" }, - { - "name": "linkConfig.useAgent", - "value": "false" - }, { "name": "linkConfig.fetchSize", "value": "100000" @@ -151,15 +147,6 @@

Password

-

linkConfig.useAgent

- -

Yes

- -

Boolean

- -

Whether to obtain data from the data source through an agent

- -

linkConfig.fetchSize

No

diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0266.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0266.html index 2571be448..b818bf4f9 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0266.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0266.html @@ -144,7 +144,7 @@

String

-

Account principal required for Kerveros authentication. You can contact the administrator to obtain the account. Before using the cluster configuration, you must set this parameter in cluster configuration management.

+

Account principal required for Kerveros authentication. You can contact the administrator to obtain the account. Before using the cluster configuration, you must set this parameter in cluster configuration management.

linkConfig.keytab

@@ -163,7 +163,7 @@

Enumeration

Running mode of the HDFS link. The options are as follows:
  • EMBEDDED: The link instance runs with CDM. This mode delivers better performance.
  • STANDALONE: The link instance runs in an independent process. If CDM needs to connect to multiple Hadoop data sources (MRS, Hadoop, or CloudTable) with both Kerberos and Simple authentication methods, STANDALONE is used.

    If STANDALONE is selected, CDM can migrate data between HDFSs of multiple MRS clusters.

    -
  • Agent: The link instance runs on an agent.

    If Agent is not used, and the CDM cluster connects to two or more clusters with Kerberos authentication enabled and the same realm, only one cluster can be connected in EMBEDDED mode, and the other clusters must be in STANDALONE mode.

    +

    If a CDM cluster connects to two or more clusters with Kerberos authentication enabled and the same realm, only one cluster can be connected in EMBEDDED mode, and the other clusters must be connected in STANDALONE mode.

diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0267.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0267.html index 0f87e3ef0..368276a54 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0267.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0267.html @@ -158,7 +158,7 @@

String

-

Account principal required for Kerveros authentication. You can contact the administrator to obtain the account.

+

Account principal required for Kerveros authentication. You can contact the administrator to obtain the account.

linkConfig.keytab

@@ -186,7 +186,7 @@

Enumeration

This parameter is used only when the HBase version is HBase_2_X. Possible values are:
  • EMBEDDED: The link instance runs with CDM. This mode delivers better performance.
  • STANDALONE: The link instance runs in an independent process. If CDM needs to connect to multiple Hadoop data sources (MRS, Hadoop, or CloudTable) with both Kerberos and Simple authentication methods, STANDALONE is used.

    If STANDALONE is selected, CDM can migrate data between HDFSs of multiple MRS clusters.

    -
  • Agent: The link instance runs on an agent.

    If Agent is not used, and the CDM cluster connects to two or more clusters with Kerberos authentication enabled and the same realm, only one cluster can be connected in EMBEDDED mode, and the other clusters must be in STANDALONE mode.

    +

    If a CDM cluster connects to two or more clusters with Kerberos authentication enabled and the same realm, only one cluster can be connected in EMBEDDED mode, and the other clusters must be connected in STANDALONE mode.

diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0269.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0269.html index 04e40a44b..d14e3050c 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0269.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0269.html @@ -148,7 +148,7 @@

Enumeration

This parameter is used only when the Hive version is HIVE_3_X. Possible values are:

-
  • EMBEDDED: The link instance runs with CDM. This mode delivers better performance.
  • STANDALONE: The link instance runs in an independent process. If CDM needs to connect to multiple Hadoop data sources (MRS, Hadoop, or CloudTable) with both Kerberos and Simple authentication modes, select STANDALONE or configure different agents.

    Note: The STANDALONE mode is used to solve the version conflict problem. If the connector versions of the source and destination ends of the same link are different, a JAR file conflict occurs. In this case, you need to place the source or destination end in the STANDALONE process to prevent the migration failure caused by the conflict.

    +
    • EMBEDDED: The link instance runs with CDM. This mode delivers better performance.
    • STANDALONE: The link instance runs in an independent process. If you want to connect CDM to multiple Hadoop data sources (MRS, Hadoop, or CloudTable), and both KERBEROS and SIMPLE authentication modes are available, you must select STANDALONE for this parameter.

      Note: The STANDALONE mode is used to solve the version conflict problem. If the connector versions of the source and destination ends of the same link are different, a JAR file conflict occurs. In this case, you need to place the source or destination end in the STANDALONE process to prevent the migration failure caused by the conflict.

    diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0288.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0288.html index 7cdd62ae3..8e0dbe865 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0288.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0288.html @@ -67,7 +67,7 @@

    Enumeration

    -
    Compression format of the source files. The options are as follows:
    • NONE: Files in all formats are transferred.
    • GZIP: Files in gzip format are transferred.
    • ZIP: Files in Zip format are transferred.
    • TAR.GZ: Files in TAR.GZ format are transferred.
    +
    Compression format of the source files. The options are as follows:
    • NONE: Files in all formats are transferred.
    • GZIP: Files in gzip format are transferred.
    • ZIP: Files in Zip format are transferred.
    • TAR.GZ: Files in TAR.GZ format are transferred.
    diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0297.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0297.html index 2aa4b5e5a..6fbd11069 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0297.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0297.html @@ -284,6 +284,16 @@

    This parameter is available only when toJobConfig.outputFormat is CSV_FILE. When a table is migrated to a CSV file, CDM does not migrate the heading line of the table by default. If this parameter is set to Yes, CDM writes the heading line of the table to the file.

    +

    toJobConfig.filePrefix

    + +

    No

    + +

    String

    + +

    Custom file name prefix. It can be any custom name or a combination of the table name macro, time macro, and version macro. Example: ${tableName}_${dateformat(yyyy-MM-dd HH:mm:ss, -1, DAY)}_${version}.

    +

    The file name must comply with the OBS file path naming rules.

    + +
    diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0298.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0298.html index e2272762b..045419f2a 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0298.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0298.html @@ -152,6 +152,16 @@

    Remember the initialization vector configured here because the initialization vector used for decryption must be the same as that configured here. If the encryption and decryption keys are inconsistent, the system does not report an exception, but the decrypted data is incorrect.

    +

    toJobConfig.filePrefix

    + +

    No

    + +

    String

    + +

    Custom file name prefix, which can be a time macro, for example, test_${dateformat(yyyyMMdd, -1, DAY)}.

    +

    The file name must comply with the HDFS file path naming rules.

    + + diff --git a/docs/dataartsstudio/api-ref/dataartsstudio_02_0311.html b/docs/dataartsstudio/api-ref/dataartsstudio_02_0311.html index a506c342b..d93dfc18f 100644 --- a/docs/dataartsstudio/api-ref/dataartsstudio_02_0311.html +++ b/docs/dataartsstudio/api-ref/dataartsstudio_02_0311.html @@ -129,17 +129,6 @@

    Contact customer service or technical support.

    -

    Cdm.0013

    - -

    400

    - -

    Agent connection failure.

    - -

    The agent fails to be connected.

    - -

    It is possible that the network is disconnected, or no security group or firewall rule is configured to allow access. If the fault persists, contact technical support.

    - -

    Cdm.0014

    400

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

    Failed to create data to be submitted.

    -

    Contact customer service or technical support.

    +

    Contact customer service or technical support.

    Cdm.0032