Updated on 2023-11-15 GMT+08:00

Downloading a Template

Function

This API is used to download a template.

URI

GET /v2/templates/{template_id}/archive

Table 1 Parameter description

Parameter

Mandatory

Description

template_id

Yes

Template ID

Request

N/A

Response message.

  • Response Parameters
    Table 2 Response header

    Parameter

    Type

    Description

    Content-Type

    String

    Message body type (format): application/octet-stream;charset=UTF-8

    Response content:

    The content of the template file is as follows:

    tosca_definitions_version: huaweicloud_tosca_version_1_0
    description: Sample template for IaaS resource
    inputs:
      az:
        default: 
        description: Availability Zone
        type: HuaweiCloud.ECS.AvailabilityZone.Name
        label: ECS
      flavor:
        default: s2.large.2
        description: ECS specifications
        label: ECS
      image:
        default: 1189efbf-d48b-46ad-a823-94b942e2a000
        description: ID of the image used by the ECS
        type: HuaweiCloud.ECS.Image.Id
        label: ECS
      sshKey-name:
        description: SSH key pair
        label: ECS
      mycloudserver_rootVolume_volumeType:
        description: System disk type
        label: ECS
      subnet-cidr:
        default: 192.168.1.0/24
        description: CIDR of the subnet
        label: Subnet
      subnet-gateway:
        default: 192.168.1.1
        description: Gateway of the subnet
        label: Subnet
      vm-name:
        default: my-cloudserver
        description: ECS name
        label: ECS
      vpc-cidr:
        default: 192.168.0.0/16
        description: Available subnet ranges under VPC
        label: VPC
    node_templates:
      mycloudserver:
        properties:
          availabilityZone:
            get_input: az
          flavor:
            get_input: flavor
          imageId:
            get_input: image
          name:
            get_input: vm-name
          nics:
            - subnetId:
                get_reference: mysubnet
          publicIP:
            eip:
              bandwidth:
                shareType: PER
                size: 1
              ipType: 5_bgp
          sshKeyName:
            get_input: sshKey-name
          vpcId:
            get_reference: myvpc
          rootVolume:
            volumeType:
              get_input: mycloudserver_rootVolume_volumeType
        requirements:
          - nics.subnetId:
              node: mysubnet
          - vpcId:
              node: myvpc
        type: HuaweiCloud.ECS.CloudServer
      mysubnet:
        properties:
          availabilityZone:
            get_input: az
          cidr:
            get_input: subnet-cidr
          dnsList:
            - 192.168.0.1
            - 192.168.0.0
          gateway:
            get_input: subnet-gateway
          name: ''
          vpcId:
            get_reference: myvpc
        requirements:
          - vpcId:
              node: myvpc
              relationship: HuaweiCloud.Relationships.ContainedIn
        type: HuaweiCloud.VPC.Subnet
      myvpc:
        properties:
          cidr:
            get_input: vpc-cidr
          name: ''
        type: HuaweiCloud.VPC.VPC
    outputs:
      ecs-eip:
        value:
          get_attribute:
            - mycloudserver
            - floatingIpId
      ecs-id:
        value:
          get_attribute:
            - mycloudserver
            - refID
      subnet-name:
        value:
          get_attribute:
            - mysubnet
            - refName
      vpc-name:
        value:
          get_attribute:
            - myvpc
            - refName

Status Code

  • Normal
    Table 3 Status Code

    Status Code

    Description

    200

    The template is successfully downloaded.

  • Abnormal
    Table 4 Status Code

    Status Code

    Description

    400

    The request cannot be parsed by the server due to incorrect parameters. Unless being modified, the request should not be sent again.

    404

    The requested resource does not exist.

    409

    The request cannot be completed due to a conflict with the current resource.

    500

    The server encountered an unexpected condition which prevented it from fulfilling the request.