Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::APIG::Domain

Última atualização: Jun 27, 2026

O recurso ALIYUN::APIG::Domain cria um nome de domínio para o Cloud-native API Gateway (APIG).

Sintaxe

{
  "Type": "ALIYUN::APIG::Domain",
  "Properties": {
    "DomainName": String,
    "Protocol": String,
    "TlsMax": String,
    "CertIdentifier": String,
    "ResourceGroupId": String,
    "TlsCipherSuitesConfig": Map,
    "ForceHttps": Boolean,
    "TlsMin": String,
    "Http2Option": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

DomainName

String

Sim

Não

Nome do domínio.

Nenhuma.

Protocol

String

Sim

Sim

Tipo de protocolo do domínio.

Valores válidos:

  • HTTP: somente HTTP.

  • HTTPS: somente HTTPS.

TlsMax

String

Não

Sim

Versão máxima do TLS para o domínio.

Máximo: TLS 1.3.

CertIdentifier

String

Não

Sim

ID do certificado.

Nenhuma.

ResourceGroupId

String

Não

Sim

ID do grupo de recursos.

Nenhuma.

TlsCipherSuitesConfig

Map

Não

Sim

Configuração do conjunto de cifras TLS.

Consulte as propriedades de TlsCipherSuitesConfig.

ForceHttps

Boolean

Não

Sim

Indica se o redirecionamento HTTPS forçado está ativado quando o protocolo é HTTPS.

Nenhuma.

TlsMin

String

Não

Sim

Versão mínima do TLS para o domínio.

Mínimo: TLS 1.0.

Http2Option

String

Não

Sim

Configuração de HTTP/2.

Valores válidos:

  • GlobalConfig

  • Close

  • Open

Sintaxe de TlsCipherSuitesConfig

"TlsCipherSuitesConfig": {
  "ConfigType": String,
  "TlsCipherSuite": List
}

Propriedades de TlsCipherSuitesConfig

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

ConfigType

String

Não

Sim

Tipo de configuração.

Nenhuma.

TlsCipherSuite

List

Não

Sim

Lista de conjuntos de cifras TLS.

Consulte a propriedade TlsCipherSuite.

Sintaxe de TlsCipherSuite

"TlsCipherSuite": [{
  "Name": String
}]

Propriedade TlsCipherSuite

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

Name

String

Não

Sim

Nome do conjunto de cifras.

Nenhuma.

Valores de retorno

Fn::GetAtt

  • DomainId: ID do domínio.

  • DomainName: nome do domínio.

  • Protocol: tipo de protocolo.

  • CertIdentifier: ID do certificado.

  • Http2Option: configuração de HTTP/2.

  • TlsMax: versão máxima do TLS.

  • TlsMin: versão mínima do TLS.

  • TlsCipherSuitesConfig: configuração do conjunto de cifras TLS.

  • ResourceGroupId: ID do grupo de recursos.

  • ForceHttps: indica se o redirecionamento HTTPS forçado está ativado quando o protocolo é HTTPS.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainName:
    Description:
      en: The name of the Domain.
    MaxLength: 128
    MinLength: 1
    Required: true
    Type: String
  Protocol:
    AllowedValues:
      - HTTP
      - HTTPS
    Description:
      en: 'The types of protocols supported by the domain are as follows:

        * HTTP: Supports only the HTTP protocol.

        * HTTPS: Supports only the HTTPS protocol.'
    Required: true
    Type: String
Resources:
  ExtensionResource:
    Properties:
      DomainName:
        Ref: DomainName
      Protocol:
        Ref: Protocol
    Type: ALIYUN::APIG::Domain
Outputs:
  DomainId:
    Description: The ID of the Domain.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DomainId
  DomainName:
    Description: The name of the Domain.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DomainName
  Protocol:
    Description: The types of protocols.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Protocol
                        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainName": {
      "Type": "String",
      "Description": {
        "en": "The name of the Domain."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 128
    },
    "Protocol": {
      "Type": "String",
      "Description": {
        "en": "The types of protocols supported by the domain are as follows:\n* HTTP: Supports only the HTTP protocol.\n* HTTPS: Supports only the HTTPS protocol."
      },
      "AllowedValues": [
        "HTTP",
        "HTTPS"
      ],
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::APIG::Domain",
      "Properties": {
        "DomainName": {
          "Ref": "DomainName"
        },
        "Protocol": {
          "Ref": "Protocol"
        }
      }
    }
  },
  "Outputs": {
    "DomainId": {
      "Description": "The ID of the Domain.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DomainId"
        ]
      }
    },
    "DomainName": {
      "Description": "The name of the Domain.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DomainName"
        ]
      }
    },
    "Protocol": {
      "Description": "The types of protocols.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Protocol"
        ]
      }
    }
  }
}