ListClusterConfigs - 列出集群的配置信息

列出集群在某个工作空间下分模块的配置信息,目前支持列出 SPARK 参数。

接口说明

本接口当前处于试用阶段。需要体验的用户可以提出申请,管理员加入试用名单后即可调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClusterIdlong

DataWorks 生成的集群 ID。

1234
ProjectIdlong

DataWorks 工作空间的 ID。

5678
ConfigTypestring

集群配置的类型,支持的类型如下:

  • SPARK_CONF(SPARK 参数)
SPARK_CONF

返回参数

名称类型描述示例值
object

返回结构。

ClusterConfigsarray

集群分模块的配置信息列表。

ClusterConfigsClusterConfig

集群在某个模块的配置信息。

RequestIdstring

请求的 ID。用于定位日志,排查问题。

0000-ABCD-E****
Successboolean

请求是否成功:

  • true(成功)
  • false(失败)
true
ErrorCodestring

错误码。

101011005
ErrorMessagestring

错误信息。

Invalid.Cluster.ClusterNotFound
HttpStatusCodeinteger

HTTP 状态码。

200

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。