Tous les produits
Search
Centre de documentation

Resource Orchestration Service:ALIYUN::ApiGateway::Instance

Dernière mise à jour :Aug 10, 2026

Créez une instance dédiée API Gateway.

Syntaxe

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

Propriétés

Nom de la propriété

Type

Obligatoire

Mise à jour autorisée

Description

Contraintes

HttpsPolicy

String

Oui

Non

La politique de sécurité HTTPS.

Valeurs valides :

  • HTTPS1_1_TLS1_0

  • HTTPS2_TLS1_0

  • HTTPS2_TLS1_2

Pour plus d'informations, consultez les politiques de sécurité HTTPS.

InstanceName

String

Oui

Non

Le nom de l'instance.

Le nom doit comporter entre 1 et 50 caractères. Il peut contenir des caractères chinois, des lettres, des chiffres et les caractères spéciaux -/._.

InstanceSpec

String

Oui

Non

Le type d'instance.

Aucune

ZoneId

String

Oui

Non

L'ID de zone.

Aucune

AutoPay

Boolean

Non

Non

Indique si le renouvellement automatique est activé pour l'instance.

Valeurs valides :

  • true (par défaut)

  • false

ChargeType

String

Non

Non

La méthode de facturation.

Valeurs valides :

  • Prepaid (abonnement)

  • PostPaid (par défaut) : paiement à l'utilisation

DeletionForce

Boolean

Non

Non

Indique si la suppression forcée de l'instance est activée.

Valeurs valides :

  • true

  • false (par défaut)

Duration

Number

Non

Non

La durée de l'abonnement.

Valeurs valides :

  • Si PricingCycle est défini sur Month, les valeurs valides vont de 1 à 9.

  • Si PricingCycle est défini sur Year, les valeurs valides vont de 1 à 3.

PricingCycle

String

Non

Non

Le cycle de facturation de l'instance d'abonnement.

Valeurs valides :

  • Month (par défaut) : facturation mensuelle.

  • Year : facturation annuelle.

Tags

List

Non

Oui

Les tags.

Un maximum de 20 tags.

Pour plus d'informations, consultez la section Propriété Tags.

Syntaxe des tags

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

Propriété Tags

Nom de la propriété

Type

Obligatoire

Mise à jour autorisée

Description

Contraintes

Key

String

Oui

Non

La clé du tag.

La clé du tag doit comporter entre 1 et 128 caractères. Elle ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ni https:// .

Value

String

Non

Non

La valeur du tag.

La valeur du tag doit comporter entre 0 et 128 caractères. Elle ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ni https:// .

Valeurs de retour

Fn::GetAtt

  • InstanceType : le type d'instance.

  • InstanceId : l'ID de l'instance.

  • VpcEgressAddress : l'adresse de sortie VPC.

  • InternetEgressAddress : l'adresse de sortie Internet.

  • EgressIpv6Enable : indique si la sortie IPv6 est activée.

  • VpcIntranetEnable : indique si l'intranet VPC est activé.

  • SupportIpv6 : indique si IPv6 est pris en charge.

  • VpcSlbIntranetEnable : indique si l'intranet VPC SLB est activé.

  • Arn : le nom de ressource Alibaba Cloud (ARN) de l'instance.

Exemples

Format YAML

Parameters:
  InstanceName:
    Type: String
    Description: Instance name
  ZoneId:
    Type: String
    AssociationProperty: ZoneId
ROSTemplateFormatVersion: '2015-09-01'
Outputs:
  EgressIpv6Enable:
    Description: Indicates whether egress for IPv6 is enabled.
    Value:
      Fn::GetAtt:
        - Instance
        - EgressIpv6Enable
  VpcEgressAddress:
    Description: VPC network egress address.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEgressAddress
  InternetEgressAddress:
    Description: Internet egress address.
    Value:
      Fn::GetAtt:
        - Instance
        - InternetEgressAddress
  InstanceId:
    Description: Instance ID.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  VpcIntranetEnable:
    Description: Indicates whether the VPC intranet is enabled.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcIntranetEnable
  SupportIpv6:
    Description: Indicates whether IPv6 is supported.
    Value:
      Fn::GetAtt:
        - Instance
        - SupportIpv6
  InstanceType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceType
  VpcSlbIntranetEnable:
    Description: Indicates whether the VPC SLB intranet is enabled.
    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

Format JSON

{
  "Parameters": {
    "InstanceName": {
      "Type": "String",
      "Description": "Instance name"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ZoneId"
    }
  },
  "ROSTemplateFormatVersion": "2015-09-01",
  "Outputs": {
    "EgressIpv6Enable": {
      "Description": "Indicates whether egress for IPv6 is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "EgressIpv6Enable"
        ]
      }
    },
    "VpcEgressAddress": {
      "Description": "VPC network egress address.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEgressAddress"
        ]
      }
    },
    "InternetEgressAddress": {
      "Description": "Internet egress address.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEgressAddress"
        ]
      }
    },
    "InstanceId": {
      "Description": "Instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "VpcIntranetEnable": {
      "Description": "Indicates whether the VPC intranet is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcIntranetEnable"
        ]
      }
    },
    "SupportIpv6": {
      "Description": "Indicates whether IPv6 is supported.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "SupportIpv6"
        ]
      }
    },
    "InstanceType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceType"
        ]
      }
    },
    "VpcSlbIntranetEnable": {
      "Description": "Indicates whether the VPC SLB intranet is enabled.",
      "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"
        }
      }
    }
  }
}