Help Center/ Data Warehouse Service/ API Reference/ API Description/ Parameter Configurations/ Querying Cluster Parameter Configurations
Updated on 2025-08-06 GMT+08:00
View PDF

Querying Cluster Parameter Configurations

Function

This API is used to query the parameter template associated with a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/configurations/{configuration_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

configuration_id

Yes

String

Definition

Parameter template ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

configurations

Array of ConfigurationParameter objects

Definition

Parameter configurations used by the cluster.

Range

N/A
Table 3 ConfigurationParameter

Parameter

Type

Description

name

String

Definition

Parameter name.

Range

N/A

values

Array of ConfigurationParameterUnit objects

Definition

Parameter value.

Range

N/A

unit

String

Definition

Parameter unit.

Range

N/A

type

String

Definition

Parameter type.

Range

boolean, string, integer, float, or list.

readonly

Boolean

Definition

Whether the cluster is read-only.

Range

N/A

value_range

String

Definition

Parameter value range.

Range

N/A

restart_required

Boolean

Definition

Whether the instance needs to be restarted.

Range

N/A

description

String

Definition

Parameter description.

Range

N/A
Table 4 ConfigurationParameterUnit

Parameter

Type

Description

type

String

Definition

Parameter type. The value can be cn or dn.

Range

cn or dn.

value

String

Definition

Parameter value.

Range

N/A

default_value

String

Definition

Default parameter value.

Range

N/A

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/configurations/2846d355-cd2a-4239-ae54-a7aef0b7963d

Example Responses

Status code: 200

Parameter configurations of the cluster queried.

{
  "configurations" : [ {
    "name" : "enable_constraint_optimization",
    "values" : [ {
      "type" : "cn",
      "value" : "on",
      "default_value" : "on"
    }, {
      "type" : "dn",
      "value" : "on",
      "default_value" : "on"
    } ],
    "unit" : null,
    "type" : "boolean",
    "readonly" : false,
    "value_range" : "on|off",
    "restart_required" : false,
    "description" : "Specifies whether the informational constraint optimization execution plan can be used for an HDFS foreign table."
  } ]
}

Status Codes

Status Code

Description

200

Parameter configurations of the cluster queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.
Parent Topic: Parameter Configurations