All Products
Search
Document Center

:ListClusterConfigs

Last Updated:Sep 04, 2025

Queries the configurations of submodules in a workspace. You can query information about SPARK parameters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdlongYes

The ID of the cluster generated by DataWorks.

1234
ProjectIdlongYes

The ID of the DataWorks workspace.

5678
ConfigTypestringYes

The configuration type of the cluster. Valid values:

  • SPARK_CONF: SPARK parameters.
SPARK_CONF

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

ClusterConfigsarray

A list of configurations of cluster modules.

ClusterConfigsClusterConfig

The configuration information of a cluster on a module.

RequestIdstring

The request ID. You can locate logs and troubleshoot issues based on the ID.

0000-ABCD-E****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

101011005
ErrorMessagestring

The error message.

Invalid.Cluster.ClusterNotFound
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{ "ClusterConfigs": [ { "ModuleName": "ide", "ConfigValue": { "spark.driver.memory": "1g" }, "EnableOverwrite": false } ], "RequestId": "0000-ABCD-E****", "Success": true, "ErrorCode": 101011005, "ErrorMessage": "Invalid.Cluster.ClusterNotFound", "HttpStatusCode": 200 }

Error codes

For a list of error codes, visit the Service error codes.