ListClusterConfigs

更新时间:
复制 MD 格式

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

ClusterId

integer

Yes

The ID of the cluster generated by DataWorks.

1234

ProjectId

integer

Yes

The ID of the DataWorks workspace.

5678

ConfigType

string

Yes

The configuration type of the cluster. Valid values:

  • SPARK_CONF: SPARK parameters.

SPARK_CONF

Response elements

Element

Type

Description

Example

object

The returned data.

ClusterConfigs

array

A list of configurations of cluster modules.

ClusterConfig

The configuration information of a cluster on a module.

RequestId

string

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

0000-ABCD-E****

Success

boolean

Indicates whether the request was successful. Valid values:

  • true

  • false

true

ErrorCode

string

The error code.

101011005

ErrorMessage

string

The error message.

Invalid.Cluster.ClusterNotFound

HttpStatusCode

integer

The HTTP status code.

200

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.