すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:ALIYUN::ApiGateway::Instance

最終更新日:Jun 17, 2026

API Gateway の専用インスタンスを作成します。

構文

{
  "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

数値

いいえ

いいえ

サブスクリプション期間です。

有効な値:

  • PricingCycle が Month の場合、有効な値は 1~9 です。

  • PricingCycle が Year の場合、有効な値は 1~3 です。

PricingCycle

String

いいえ

いいえ

サブスクリプションインスタンスの課金サイクルです。

有効な値:

  • Month (デフォルト値) :月単位で課金されます。

  • Year:年単位で課金されます。

Tags

リスト

いいえ

はい

タグです。

最大 20 個のタグを設定できます。

詳細については、「Tags プロパティ」をご参照ください。

Tags の構文

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

Tags プロパティ

プロパティ名

データ型

必須

更新可否

説明

制約

Key

String

はい

いいえ

タグキーです。

タグキーは 1~128 文字にする必要があります。 aliyun または acs: で始めることはできません。 http:// または https:// を含めることはできません。

Value

String

いいえ

いいえ

タグ値です。

タグ値は 0~128 文字にする必要があります。 aliyun または acs: で始めることはできません。 http:// または https:// を含めることはできません。

戻り値

Fn::GetAtt

  • InstanceType:インスタンスタイプです。

  • InstanceId:インスタンス ID です。

  • VpcEgressAddress:VPC エグレスアドレスです。

  • InternetEgressAddress:インターネットエグレスアドレスです。

  • EgressIpv6Enable:IPv6 エグレスが有効かどうかを示します。

  • VpcIntranetEnable:VPC イントラネットが有効かどうかを示します。

  • SupportIpv6:IPv6 がサポートされているかどうかを示します。

  • VpcSlbIntranetEnable:VPC SLB イントラネットが有効かどうかを示します。

  • Arn:インスタンスの Alibaba Cloud リソースネーム (ARN) です。

例

YAML 形式

Parameters:
  InstanceName:
    Type: String
    Description: インスタンス名
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
ROSTemplateFormatVersion: '2015-09-01'
Outputs:
  EgressIpv6Enable:
    Description: IPv6 のエグレスが有効かどうかを示します。
    Value:
      Fn::GetAtt:
        - Instance
        - EgressIpv6Enable
  VpcEgressAddress:
    Description: VPC ネットワークのエグレスアドレス。
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEgressAddress
  InternetEgressAddress:
    Description: インターネットエグレスアドレス。
    Value:
      Fn::GetAtt:
        - Instance
        - InternetEgressAddress
  InstanceId:
    Description: インスタンス ID。
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  VpcIntranetEnable:
    Description: VPC イントラネットが有効かどうかを示します。
    Value:
      Fn::GetAtt:
        - Instance
        - VpcIntranetEnable
  SupportIpv6:
    Description: IPv6 がサポートされているかどうかを示します。
    Value:
      Fn::GetAtt:
        - Instance
        - SupportIpv6
  InstanceType:
    Description: インスタンスタイプ。
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceType
  VpcSlbIntranetEnable:
    Description: VPC SLB イントラネットが有効かどうかを示します。
    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": "インスタンス名"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    }
  },
  "ROSTemplateFormatVersion": "2015-09-01",
  "Outputs": {
    "EgressIpv6Enable": {
      "Description": "IPv6 のエグレスが有効かどうかを示します。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "EgressIpv6Enable"
        ]
      }
    },
    "VpcEgressAddress": {
      "Description": "VPC ネットワークのエグレスアドレス。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEgressAddress"
        ]
      }
    },
    "InternetEgressAddress": {
      "Description": "インターネットエグレスアドレス。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEgressAddress"
        ]
      }
    },
    "InstanceId": {
      "Description": "インスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "VpcIntranetEnable": {
      "Description": "VPC イントラネットが有効かどうかを示します。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcIntranetEnable"
        ]
      }
    },
    "SupportIpv6": {
      "Description": "IPv6 がサポートされているかどうかを示します。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "SupportIpv6"
        ]
      }
    },
    "InstanceType": {
      "Description": "インスタンスタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceType"
        ]
      }
    },
    "VpcSlbIntranetEnable": {
      "Description": "VPC SLB イントラネットが有効かどうかを示します。",
      "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"
        }
      }
    }
  }
}