Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Resource Formation Service/ API Reference (ME-Abu Dhabi Region)/ API/ Querying the Input Parameters of a Template

Querying the Input Parameters of a Template

Updated on 2022-02-22 GMT+08:00

Function

This API is used to query the input parameter of a template.

URI

GET /v2/templates/{template_id}/inputs

Table 1 Parameter description

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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback