Help Center/ DataArts Studio/ SDK Reference/ DataArts DataService SDK Reference/ Common Error Codes and Messages for SDK Invocation
Updated on 2024-06-12 GMT+08:00

Common Error Codes and Messages for SDK Invocation

Table 1 Error codes and messages

Error Code

Error Message

Error Cause

Solution

DLM.0

null

The API is successfully called.

No action is required.

APIG.0101

The API does not exist or has not been published in the environment

  1. The API has not been published.
  2. The URL is incorrect.
  1. Publish the API.
  2. Ensure that the request URL is correct.

APIG.0106

Orchestration error: Invalid header parameter: x-Authorization, required

x-Authorization is not added to the SDK.

See Step 3 in "Preparations for Using the SDK".

APIG.0106

Orchestration error: Invalid ___ parameter: ___, required

A specified parameter is not transferred.

Transfer the parameter during invocation.

APIG.0201

Backend timeout

API Gateway does not receive a response within 50 seconds after sending a request.

Check the DataArts DataService access log. If the access log contains data (the data is slightly delayed), the data source extraction time is too long. In this case, optimize the data extraction SQL logic.

If the access log does not contain data, check whether the DataArts DataService Exclusive cluster is running.

APIG.0303

Incorrect app authentication information: app not found

The application does not exist.

Check whether the request key and secret are correct.

APIG.0304

The app is not authorized to access the API

The application does not have the permission to access the current API.

  1. Ensure that the application has been authorized to access the API.
  2. Check whether the request key and secret are correct.

APIG.0308

The throttling threshold has been reached: policy domain over ratelimit, limit:1000, time:1 day

The number of domain name requests has reached the upper limit, which is 1,000 per day.

  1. Suggestion: Bind a domain name to the API group in API Gateway.
  2. Workaround: Change another group. Domain names are grouped. Each group has an upper limit.

DLM.4018

Api is not exist

The API does not exist.

For APIs released before the version on June 30, 2020:

Check whether the value of x-api-id is correct. (The value is the ID of the API to be accessed and can be obtained from the API provider.)

For APIs released after the version on June 30, 2020:

  1. Ensure that the request URL is correct.
  2. If the API is just published by DataArts DataService Exclusive, wait for a while. There is a short delay before the API is delivered to the cluster.

Other APIs (data synchronization exception):

  1. Disable or suspend the API, and then resume or publish the API.
  2. Restart the cluster. (Restart nodes one by one to avoid impact on services.)

DLM.4094

Call api failed.

The API fails to be called.

  1. Ensure that the SQL statement used to call the API is correct and can be executed properly. (For details about the SQL statement, see the access log. The SQL statement is visible only to the API caller.)
  2. The CDM agent is abnormal. For details about the error cause, see the returned DLG error message.
  3. The API call times out. If the DWS database is used, you are advised to use the custom pagination mode.
  4. The API call times out. Optimize the query statement to ensure that it can be executed in the database in a short time.

DLM.4211

Token invalid

Token verification fails.

  1. Check whether the token is correct.
  2. Check whether the tenant to which the token belongs has been authorized or is in the allowlist.

DLM.4312

Missing parameters: ___

A specified parameter is missing.

Transfer the parameter during invocation.

400

App does not have permission to access API.

The application does not have the permission to access the current API.

  1. Ensure that the application has been authorized to access the API.
  2. Check whether the request key and secret are correct.
  3. Ensure that the authorization relationship between the API and application is still valid.

401

Authorization not found.

Authorization information is not found.

  1. Application authentication: Step 3 in "Preparations for Using the SDK"
  2. IAM authentication for an API in DataArts DataService Exclusive published to the gateway: An API using the IAM authentication method cannot directly access the cluster through token authentication.

401

Authorization format incorrect.

The authorization format is incorrect.

You are advised to use the SDK to generate a signature.

401

Signing key not found.

The signature key is not found.

Check whether the request key and secret are correct.

401

Signed header ___ not found.

The signature header is not found.

Ensure that the header parameter used for signature is uploaded during the SDK invocation.

401

Header x-sdk-date not found.

The x-sdk-date header is not found.

This parameter is automatically generated when the SDK is signed. If the SDK is invoked in other ways, upload the parameter when invoking the signed SDK.

401

Signature expired.

The signature has expired.

  1. The signature has a validity period. If the signature has expired, generate a new one.
  2. Check whether the local time is the same as the actual time.
  3. If the local time is correct, contact related personnel to check whether the time of the cluster nodes is normal.

401

Verify authorization failed.

Signature verification fails.

Ensure that all signature parameters have been uploaded and are the same as those used during the signature, including but not limited to url, path, header, query, and body.

Supplementary information:

1. If a third-party gateway is connected, the request address is different from the address displayed by DataArts DataService. In this case, you need to add the x-forwarded-host parameter to the request header and set its value to the request address used for signature.

2. If the get request is used, do not define the body.

DLG.0902

Fail to call the agent. For details about No matching constant for [-1], see the CDM logs.

The CDM agent cannot be called.

  1. The SQL statement duration is too long.
  2. CDM resources are insufficient.

1. Check the SQL statement execution duration. If the duration is too long, optimize the SQL statement. (If the default pagination mode is used, you are advised to change it to the custom pagination mode.)

2. If the SQL statement execution duration is short and no other service is running, restart CDM.

DAYU.1088

Failed to process the request sent by the agent.

CDM does not respond.

  1. Restart CDM.
  2. This issue may be caused by CDM upgrade. Buy another CDM cluster.