全部產品
Search
文件中心

:ALIYUN::ApiGateway::Instance

更新時間:Jun 19, 2024

ALIYUN::ApiGateway::Instance類型用於建立專享執行個體。

文法

{
  "Type": "ALIYUN::ApiGateway::Instance",
  "Properties": {
    "InstanceName": String,
    "DeletionForce": Boolean,
    "InstanceSpec": String,
    "HttpsPolicy": String,
    "ZoneId": String,
    "PricingCycle": String,
    "ChargeType": String,
    "Duration": Number,
    "AutoPay": Boolean,
    "Tags": List
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

HttpsPolicy

String

HTTPS安全性原則。

取值:

  • HTTPS1_1_TLS1_0

  • HTTPS2_TLS1_0

  • HTTPS2_TLS1_2

更多資訊,請參見HTTPS安全性原則

InstanceName

String

執行個體名稱。

長度為1~50個字元,可包含漢字、英文字母、數字和特殊字元-/._

InstanceSpec

String

執行個體規格。

ZoneId

String

可用性區域ID。

AutoPay

Boolean

到期是否自動續約。

取值:

  • true(預設值)

  • false

ChargeType

String

付費類型。

取值:

  • PrePaid:預付費。

  • PostPaid(預設值):隨用隨付。

DeletionForce

Boolean

是否強制移除執行個體。

取值:

  • true

  • false(預設值)

Duration

Number

付費時間長度。

取值:

  • 當PricingCycle值為Month時:1~9。

  • 當PricingCycle取值為Year時:1~3。

PricingCycle

String

預付費執行個體的付費周期。

取值:

  • Month(預設值):月付型。

  • Year:按年付費。

Tags

List

標籤。

最多添加20個標籤。

更多資訊,請參見Tags屬性

Tags文法

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags屬性

屬性名稱

類型

必須

允許更新

描述

約束

Key

String

標籤鍵。

長度為1~128個字元,不能以aliyunacs:開頭,不能包含http://https://

Value

String

標籤值。

長度為0~128個字元,不能以aliyunacs:開頭,不能包含http://https://

傳回值

Fn::GetAtt

  • InstanceType:執行個體類型。

  • InstanceId:執行個體ID。

  • VpcEgressAddress:專用網路出口地址。

  • InternetEgressAddress:公網出口地址。

  • EgressIpv6Enable:IPv6出訪能力。

  • VpcIntranetEnable:是否支援專用網路。

  • SupportIpv6:是否支援IPv6。

  • VpcSlbIntranetEnable:是否支援VPC類型SLB。

樣本

YAML格式

Parameters:
  InstanceName:
    Type: String
    Description: Instance name
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
ROSTemplateFormatVersion: '2015-09-01'
Outputs:
  EgressIpv6Enable:
    Description: Whether enable egress IPv6.
    Value:
      Fn::GetAtt:
        - Instance
        - EgressIpv6Enable
  VpcEgressAddress:
    Description: VPC network egress address.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEgressAddress
  InternetEgressAddress:
    Description: Internet egress dddress.
    Value:
      Fn::GetAtt:
        - Instance
        - InternetEgressAddress
  InstanceId:
    Description: Instance ID.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  VpcIntranetEnable:
    Description: Whether enable VPC intranet.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcIntranetEnable
  SupportIpv6:
    Description: Whether support IPv6.
    Value:
      Fn::GetAtt:
        - Instance
        - SupportIpv6
  InstanceType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceType
  VpcSlbIntranetEnable:
    Description: Whether enable VPC SLB intranet.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcSlbIntranetEnable
Resources:
  Instance:
    Type: ALIYUN::ApiGateway::Instance
    Properties:
      InstanceName: TestInstance
      InstanceSpec: api.s1.small
      HttpsPolicy: HTTPS2_TLS1_0
      ZoneId:
        Ref: ZoneId

JSON格式

{
  "Parameters": {
    "InstanceName": {
      "Type": "String",
      "Description": "Instance name"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    }
  },
  "ROSTemplateFormatVersion": "2015-09-01",
  "Outputs": {
    "EgressIpv6Enable": {
      "Description": "Whether enable egress IPv6.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "EgressIpv6Enable"
        ]
      }
    },
    "VpcEgressAddress": {
      "Description": "VPC network egress address.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEgressAddress"
        ]
      }
    },
    "InternetEgressAddress": {
      "Description": "Internet egress dddress.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEgressAddress"
        ]
      }
    },
    "InstanceId": {
      "Description": "Instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "VpcIntranetEnable": {
      "Description": "Whether enable VPC intranet.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcIntranetEnable"
        ]
      }
    },
    "SupportIpv6": {
      "Description": "Whether support IPv6.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "SupportIpv6"
        ]
      }
    },
    "InstanceType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceType"
        ]
      }
    },
    "VpcSlbIntranetEnable": {
      "Description": "Whether enable VPC SLB intranet.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcSlbIntranetEnable"
        ]
      }
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::ApiGateway::Instance",
      "Properties": {
        "InstanceName": "TestInstance",
        "InstanceSpec": "api.s1.small",
        "HttpsPolicy": "HTTPS2_TLS1_0",
        "ZoneId": {
          "Ref": "ZoneId"
        }
      }
    }
  }
}