Todos os produtos
Search

Este produto

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Central de documentação

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Última atualização: Jun 27, 2026

    O recurso ALIYUN::ApiGateway::Group cria um grupo de APIs.

    Sintaxe

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

    Propriedades

    Propriedade

    Tipo

    Obrigatório

    Editável

    Descrição

    Restrição

    GroupName

    String

    Sim

    Sim

    Nome do grupo de APIs.

    O nome deve ser único.

    Deve ter de 4 a 50 caracteres e conter letras, dígitos e sublinhados (_). Deve começar com uma letra.

    BasePath

    String

    Não

    Sim

    Caminho raiz da API.

    Exemplo: /qqq.

    Description

    String

    Não

    Sim

    Descrição do grupo de APIs.

    Máximo de 180 caracteres.

    InstanceId

    String

    Não

    Não

    Tipo de rede da instância do API Gateway.

    Valores válidos:

    • api-shared-vpc-001: Virtual Private Cloud (VPC)

    • api-shared-classic-001: rede clássica

    InternetEnable

    Boolean

    Não

    Sim

    Especifica se os subdomínios públicos estão ativados.

    Valores válidos:

    • true

    • false

    PassthroughHeaders

    String

    Não

    Não

    Header de repasse.

    Defina o valor como host.

    Tags

    List

    Não

    Sim

    Tags do grupo de APIs.

    Adicione até 20 tags ao grupo de APIs.

    Para mais informações, consulte Propriedades de Tags.

    VpcIntranetEnable

    Boolean

    Não

    Sim

    Especifica se os subdomínios privados estão ativados.

    Valores válidos:

    • true

    • false

    Sintaxe de Tags

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

    Propriedades de Tags

    Propriedade

    Tipo

    Obrigatório

    Editável

    Descrição

    Restrição

    Key

    String

    Sim

    Não

    Chave da tag.

    A chave da tag deve ter de 1 a 128 caracteres e não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

    Value

    String

    Não

    Não

    Valor da tag.

    O valor da tag pode ter até 128 caracteres e não pode conter http:// ou https://. Não pode começar com aliyun ou acs:.

    Valores de retorno

    Fn::GetAtt

    • SubDomain: subdomínio de segundo nível atribuído pelo sistema ao grupo de APIs. Use este domínio para testar chamadas de API.

    • GroupId: ID do grupo de APIs. Trata-se de um GUID gerado pelo sistema.

    • Tags: tags do grupo de APIs.

    Exemplos

    Nota

    Altere os valores dos parâmetros mascarados, como InstanceId, conforme as necessidades do seu negócio.

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