Todos los productos
Search

Este producto

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Centro de documentos

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Última actualización: Sep 05, 2026

    ALIYUN::ApiGateway::Group se usa para crear un grupo de API.

    Sintaxis

    {
  "Type": "ALIYUN::ApiGateway::Group",
  "Properties": {
    "GroupName": String,
    "Description": String,
    "InstanceId": String,
    "PassthroughHeaders": String,
    "InternetEnable": Boolean,
    "VpcIntranetEnable": Boolean,
    "Tags": List,
    "BasePath": String
  }
}

    Propiedades

    Propiedad

    Tipo

    Obligatorio

    Editable

    Descripción

    Restricción

    GroupName

    String

    Sí

    Sí

    Nombre del grupo de API.

    El nombre debe ser único.

    El nombre debe tener entre 4 y 50 caracteres, y puede contener letras, dígitos y guiones bajos (_). Debe comenzar con una letra.

    BasePath

    String

    No

    Sí

    Ruta raíz de la API.

    Ejemplo: /qqq.

    Description

    String

    No

    Sí

    Descripción del grupo de API.

    La descripción puede tener hasta 180 caracteres.

    InstanceId

    String

    No

    No

    Tipo de red de la instancia de API Gateway.

    Valores válidos:

    • api-shared-vpc-001: virtual private cloud (VPC)

    • api-shared-classic-001: red clásica

    InternetEnable

    Boolean

    No

    Sí

    Indica si se habilitan los subdominios públicos.

    Valores válidos:

    • true

    • false

    PassthroughHeaders

    String

    No

    No

    Encabezado de paso directo.

    Establezca el valor en host.

    Tags

    List

    No

    Sí

    Etiquetas del grupo de API.

    Puede agregar hasta 20 etiquetas al grupo de API.

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

    VpcIntranetEnable

    Boolean

    No

    Sí

    Indica si se habilitan los subdominios privados.

    Valores válidos:

    • true

    • false

    Sintaxis de Tags

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

    Propiedades de Tags

    Propiedad

    Tipo

    Obligatorio

    Editable

    Descripción

    Restricción

    Key

    String

    Sí

    No

    Clave de la etiqueta.

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

    Value

    String

    No

    No

    Valor de la etiqueta.

    El valor de la etiqueta puede tener hasta 128 caracteres y no puede contener http:// ni https://. Tampoco puede comenzar con aliyun ni acs:.

    Valores de retorno

    Fn::GetAtt

    • SubDomain: dominio de segundo nivel que el sistema asigna al grupo de API. Se usa para probar las llamadas a la API.

    • GroupId: ID del grupo de API. Es un GUID generado por el sistema.

    • Tags: etiquetas del grupo de API.

    Ejemplos

    Nota

    Modifique los valores de los parámetros ocultos, como InstanceId, según sus requisitos empresariales.

    Formato YAML

    ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Group:
    Type: ALIYUN::ApiGateway::Group
    Properties:
      InternetEnable: false
      GroupName: TestGroup
      InstanceId: api-shared-vpc-***
      VpcIntranetEnable: false
      PassthroughHeaders: host
Outputs: {}

    Formato JSON

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Group": {
      "Type": "ALIYUN::ApiGateway::Group",
      "Properties": {
        "InternetEnable": false,
        "GroupName": "TestGroup",
        "InstanceId": "api-shared-vpc-***",
        "VpcIntranetEnable": false,
        "PassthroughHeaders": "host"
      }
    }
  },
  "Outputs": {
  }
}