- What's New
- Service Overview
- User Guide
- Template Reference
-
API Reference
- Before You Start
-
API
- Calling APIs
-
Stacks
- Listing Events of a Stack
- Obtaining Stack Metadata
- Listing Stacks
- Creating a Stack
- Obtaining a Stack Template
- Listing Stack Resources
- Listing Stack Outputs
- Continuing to Deploy a Stack
- Deploying a Stack
- Deleting a Stack
- Updating a Stack
- Deleting a Stack with Conditions
- Continuing to Roll Back a Stack
- Execution Plans
- Template Analysis
- Template Management
-
Stack Sets
- Listing Stack Sets
- Creating a Stack Set
- Obtaining a Stack Set Template
- Listing Stack Set Operations
- Obtaining Metadata of a Stack Set
- Listing Stack Instances
- Creating Stack Instances
- Deleting Stack Instance Deprecated
- Updating Stack Instances
- Deleting Stack Instances
- Deploying a Stack Set
- Deleting a Stack Set
- Updating a Stack Set
- Obtaining Metadata of a Stack Set Operation
- Obtaining a Stack Instance
- Customized Providers
- Resource Formation - Hook
- Resource Formation - Module Management
- Permissions and Supported Actions
- Appendix
- Change History
- FAQs
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Stack Management
- CTS
-
Template Reference
- Template Introduction
-
List of Elements
- Resource Indexes
- AOS.Stack
- CCE.Addon.AutoScaler
- CCE.Cluster
- CCE.HelmRelease
- CCE.NodePool
- CCE.Pod
- CCE.Storage.OBS
- CCE.Storage.SFS
- DCS.Redis
- ECS.CloudServer
- ECS.KeyPair
- NAT.Instance
- NAT.SNatRule
- OBS.Bucket
- RDS.MySQL
- SFS.FileSystem
- ULB.Healthmonitor
- ULB.Listener
- ULB.LoadBalancer
- ULB.Member
- ULB.Pool
- VPC.EIP
- VPC.SecurityGroup
- VPC.SecurityGroupRule
- VPC.Subnet
- VPC.VPC
-
Data Structure
- AOS.BatchItem
- Basic.KeyValuePair
- Basic.Label
- Basic.LabelSelector
- Basic.NameAndSecretValue
- Basic.NameKeyPair
- Basic.NameValuePair
- CCE.Addon.AutoScaler.Node
- CCE.DataVolume
- CCE.HelmChart
- CCE.Labels
- CCE.NodePool
- CCE.PublicIP
- DCS.InstanceBackupPolicy
- DCS.PeriodicalBackupPlan
- ECS.DataVolume
- ECS.EIP
- ECS.ExtendParam
- ECS.MountedVolumes
- ECS.NICS
- ECS.Personality
- ECS.PublicIP
- ECS.RootVolume
- ECS.SecurityGroup
- ECS.ServerTags
- ECS.VolumeExtendParam
- K8S.PodSecurityContext
- K8S.SecurityContext.SeLinuxOptions
- MySQL.DBUser
- MySQL.DataBase
- MySQL.DataStore
- RDS.BackupStrategy
- RDS.HA.Mysql
- RDS.Volume
- ULB.StickySession
- VPC.BandWidth
- VPC.PublicIP
- Appendix
- FAQs
- Change History
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- API Overview
- Calling APIs
-
API
- Creating a Template
- Querying a Template List
- Updating a Template
- Deleting a Template
- Downloading a Template
- Querying a Template
- Querying the Input Parameters of a Template
- Creating a Stack
- Deleting a Stack
- Executing a Stack Lifecycle
- Querying a Stack List
- Querying a Stack
- Querying a Stack Element List
- Querying a Stack Element
- Querying a Stack Output
- Querying Stack Input
- Querying the Execution Record of a Stack
- Querying a Stack Execution Record List
- Appendix
- Change History
-
API Reference (Kuala Lumpur Region)
- Before You Start
-
API
- Calling APIs
-
Stacks
- Listing Events of a Stack
- Obtaining Stack Metadata
- Listing Stacks
- Creating a Stack
- Obtaining a Stack Template
- Listing Stack Resources
- Listing Stack Outputs
- Continuing to Deploy a Stack
- Deploying a Stack
- Deleting a Stack
- Updating a Stack
- Deleting a Stack with Conditions
- Continuing to Roll Back a Stack
- Execution Plans
- Template Analysis
- Template Management
-
Stack Sets
- Listing Stack Sets
- Creating a Stack Set
- Obtaining a Stack Set Template
- Listing Stack Set Operations
- Obtaining Metadata of a Stack Set
- Listing Stack Instances
- Creating Stack Instances
- Deleting Stack Instance Deprecated
- Updating Stack Instances
- Deploying a Stack Set
- Deleting Stack Instances
- Deleting a Stack Set
- Updating a Stack Set
- Obtaining Metadata of a Stack Set Operation
- Obtaining a Stack Instance
- Appendix
- Change History
- User Guide (Kuala Lumpur Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Querying the Input Parameters of a Template
Function
This API is used to query the input parameter of a template.
URI
GET /v2/templates/{template_id}/inputs
Parameter |
Mandatory |
Description |
---|---|---|
template_id |
Yes |
Template ID |
Request
N/A
Response
- Response parameters
For details about response parameters when the request fails, see Table 5.
Table 2 Response parameters Parameter
Type
Description
[Customized key]
Map<String,Object>
The key indicates the name of a template input parameter. The value indicates the attribute information of the template input parameter. For details, see Table 3.
Table 3 Data structure of the attribute information of a template input parameter Parameter
Type
Description
required
Boolean
Whether the parameter can be left blank. The options are as follows: true or false.
default
Integer or String or Float or Boolean
Default parameter in the template. Multiple types supported, such as integer, string, and boolean. It can be selected based on the type field.
description
String
Description of the parameter.
type
String
Input parameter types of a template.
- string: character string
- integer: integer
- boolean: Boolean
- enum: Enumeration. If an enumeration is used, the input must contain the valid_values field of the constraints field.
- float: floating point number
- secret: key
- password: password
- ip: IP address
constraints
Object
Constraints of the parameter value. For details, see Table 4.
label
String
Label group to which the parameter belongs.
advanced
Boolean
Whether the parameter is an advanced configuration. The default value must be available. The parameter is hidden by default on the GUI.
immutable
Boolean
Whether the parameter can be modified.
Table 4 Parameter constraint structure description Parameter
Type
Description
in_range
Array of integers
The value must be greater than or equal to the minimum value, and less than or equal to the maximum value.
regex
String
The input value must comply with the regular expression.
valid_values
Array of integers, string, float, or boolean
The input value must be one of the given values.
equal
Integer, string, float, or Boolean
The input value must be equal to this value.
greater_or_equal
Integer, string, float, or Boolean
The input value must be greater than or equal to this value.
greater_than
Integer, string, float, or Boolean
The input value must be greater than this value.
less_or_equal
Integer, string, float, or Boolean
The input value must be less than or equal to this value.
less_than
Integer, string, float, or Boolean
The input value must be less than this value.
- Example response
{ "key1": { "default": "192.168.12.22:30303/test_yj/frontend:latest", "immutable": false, "type": "string" }, "key2": { "default": 2, "immutable": false, "type": "integer" }, "key3": { "immutable": true, "type": "string" }, "key4": { "type": "float", "constraints": { "greater_or_equal": 0, "greater_than": 0, "less_or_equal": 2, "less_than": 2 } } }
Status Code
- Normal
Table 5 Status code Status Code
Description
200
Querying the input parameter is successful.
- Abnormal
Table 6 Status code Status Code
Description
400
The request parameter is incorrect.
404
The requested resource cannot be found.
500
The server fails to process the request due to an unexpected condition.
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