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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template_name |
Yes |
String |
Template name. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
version |
Yes |
String |
Template version. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
variables |
Array of TemplateParamVariable objects |
Parameters for template deployment. |
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. |
Parameter |
Type |
Description |
---|---|---|
condition |
String |
Validation conditions. |
error_message |
String |
Error message of a validation failure. |
Status code: 403
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. |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot