Help Center/ Data Warehouse Service/ API Reference/ API Description/ Parameter Configurations/ Querying a Cluster Parameter Template
Updated on 2026-10-21 GMT+08:00
View PDF

Querying a Cluster Parameter Template

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

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

configurations

Array of ClusterConfiguration objects

Definition

Information about the parameter template associated with a cluster.

Range

N/A
Table 3 ClusterConfiguration

Parameter

Type

Description

id

String

Definition

Parameter template ID.

Range

N/A

name

String

Definition

Parameter template name.

Range

N/A

type

String

Definition

Parameter template type.

Range

Currently, only hiddenParameterGroup and securityParameterGroup are valid. Other parameter templates can only be displayed and cannot be modified through external APIs.

  • hiddenParameterGroup: hidden parameter template, which corresponds to the parameter template on the Parameter Modifications page

  • securityParameterGroup: security parameter template

  • parameterGroup: GUC parameter template

  • GUCConfig: GUC configuration parameter template

  • OBSConfig: OBS configuration parameter template

status

String

Definition:

Cluster parameter status

Range:

  • In-Sync: Data has been synchronized.

  • Applying: The policy is being applied.

  • Pending-Reboot: The configuration takes effect only after the system is restarted.

  • Sync-Failure: The application fails.

fail_reason

String

Definition

Cause of the parameter application failure.

Range

N/A

Example Requests

Query a cluster parameter template.

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/configurations

Example Responses

Status code: 200

{
  "configurations" : [ {
    "id" : "509be37f-5420-40fb-89c2-0c5c9b8c90f6",
    "name" : "defaultGUCConfig",
    "type" : "GUCConfig",
    "status" : "In-Sync",
    "fail_reason" : "null"
  }, {
    "id" : "3f62172a-8258-46a3-a761-e691265d6689",
    "name" : "parameterGroupFor_3bc94408-265d-4076-8c6d-cc35ebc2c747",
    "type" : "hiddenParameterGroup",
    "status" : "In-Sync",
    "fail_reason" : "null"
  }, {
    "id" : "93cb2c86-a598-48ca-8c2c-0389f4b78511",
    "name" : "defaultOBSConfig",
    "type" : "OBSConfig",
    "status" : "In-Sync",
    "fail_reason" : "null"
  }, {
    "id" : "3f377a36-1fa2-48fe-a1fa-a8801dae01ed",
    "name" : "Default-Parameter-Template-DWS-8_2_0",
    "type" : "parameterGroup",
    "status" : "In-Sync",
    "fail_reason" : "null"
  }, {
    "id" : "d8f9ec5a-8235-4000-9433-187409738e8b",
    "name" : "security-paragroup-dws",
    "type" : "securityParameterGroup",
    "status" : "In-Sync",
    "fail_reason" : "null"
  } ]
}

Status Codes

Status Code

Description

200

Cluster parameter template 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