Help Center/ Resource Governance Center/ API Reference/ APIs/ Managing Templates/ Querying Template Deployment Parameters
Updated on 2025-08-22 GMT+08:00

Querying Template Deployment Parameters

Function

This API is used to query the parameters for deploying templates.

URI

GET https://{endpoint}/v1/rgc/templates/{template_name}/deploy-params

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

template_name

Yes

String

Template name.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

version

Yes

String

Template version.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

variables

Array of TemplateParamVariable objects

Parameters for template deployment.

Table 4 TemplateParamVariable

Parameter

Type

Description

default

Object

Default value of a variable.

name

String

Variable name.

description

String

Variable description.

nullable

Boolean

Whether the variable can be null.

sensitive

Boolean

Whether the variable is a sensitive variable.

type

String

Variable type.

validations

Array of TemplateParamVariableValidation objects

Rules for validating parameter variables for template deployment.

Table 5 TemplateParamVariableValidation

Parameter

Type

Description

condition

String

Validation conditions.

error_message

String

Error message of a validation failure.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of the request.

encoded_authorization_message

String

Encrypted error message.

details

Array of ForbiddenErrorDetail objects

Error message indicating no permissions for cross-service invoking.

Table 7 ForbiddenErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Querying the parameters for deploying templates

GET https://{endpoint}/v1/rgc/templates/{template_name}/deploy-params?version=V1

Example Responses

Status code: 200

Request succeeded.

{
  "variables" : [ {
    "default" : "object",
    "name" : "string",
    "nullable" : "boolean",
    "sensitive" : "boolean",
    "description" : "string",
    "type" : "string",
    "validations" : [ {
      "condition" : "string",
      "error_message" : "string"
    } ]
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

403

No permissions.

Error Codes

See Error Codes.