Todos los productos
Search
Centro de documentos

Resource Orchestration Service:ALIYUN::ApiGateway::Instance

Última actualización: Sep 04, 2026

Crea una instancia dedicada de API Gateway.

Sintaxis

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

Propiedades

Nombre de la propiedad

Tipo

Obligatorio

Actualización permitida

Descripción

Restricciones

HttpsPolicy

String

Sí

No

Directiva de seguridad HTTPS.

Valores válidos:

  • HTTPS1_1_TLS1_0

  • HTTPS2_TLS1_0

  • HTTPS2_TLS1_2

Para obtener más información, consulte HTTPS security policies.

InstanceName

String

Sí

No

Nombre de la instancia.

El nombre debe tener entre 1 y 50 caracteres. Puede contener caracteres chinos, letras, dígitos y los caracteres especiales -/._.

InstanceSpec

String

Sí

No

Tipo de instancia.

Ninguna

ZoneId

String

Sí

No

ID de zona.

Ninguna

AutoPay

Boolean

No

No

Especifica si se habilita la renovación automática para la instancia.

Valores válidos:

  • true (predeterminado)

  • false

ChargeType

String

No

No

Método de facturación.

Valores válidos:

  • Prepaid (suscripción)

  • PostPaid (predeterminado): pay-as-you-go

DeletionForce

Boolean

No

No

Especifica si se elimina forzosamente la instancia.

Valores válidos:

  • true

  • false (predeterminado)

Duration

Number

No

No

Duración de la suscripción.

Valores válidos:

  • Si PricingCycle se establece en Month, los valores válidos son del 1 al 9.

  • Si PricingCycle se establece en Year, los valores válidos son del 1 al 3.

PricingCycle

String

No

No

Ciclo de facturación de la instancia de suscripción.

Valores válidos:

  • Month (predeterminado): facturación mensual.

  • Year: facturación anual.

Tags

List

No

Sí

Etiquetas.

Máximo de 20 etiquetas.

Para obtener más información, consulte Tags property.

Sintaxis de Tags

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

Propiedad Tags

Nombre de la propiedad

Tipo

Obligatorio

Actualización permitida

Descripción

Restricciones

Key

String

Sí

No

Clave de la etiqueta.

La clave de la etiqueta debe tener entre 1 y 128 caracteres. No puede comenzar con aliyun ni con acs:. No puede contener http:// ni https:// .

Value

String

No

No

Valor de la etiqueta.

El valor de la etiqueta debe tener entre 0 y 128 caracteres. No puede comenzar con aliyun ni con acs:. No puede contener http:// ni https:// .

Valores de retorno

Fn::GetAtt

  • InstanceType: tipo de instancia.

  • InstanceId: ID de la instancia.

  • VpcEgressAddress: dirección de salida de la VPC.

  • InternetEgressAddress: dirección de salida a Internet.

  • EgressIpv6Enable: indica si la salida IPv6 está habilitada.

  • VpcIntranetEnable: indica si la intranet de la VPC está habilitada.

  • SupportIpv6: indica si IPv6 es compatible.

  • VpcSlbIntranetEnable: indica si la intranet SLB de la VPC está habilitada.

  • Arn: Alibaba Cloud Resource Name (ARN) de la instancia.

Ejemplos

Formato 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

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