ALIYUN::APIG::HttpApi

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 创建一个HTTP协议的API，适用于内部服务调用或开发测试。
  en: Create an HTTP API for internal service calls or dev/test environments.
Parameters:
  HttpApiName:
    Type: String
    Label:
      zh-cn: API名称
      en: API Name
    Description:
      zh-cn: HTTP API的名称，长度为1~64个字符。
      en: The name of the HTTP API, 1 to 64 characters.
    MinLength: 1
    MaxLength: 64
    AssociationProperty: AutoCompleteInput
    AssociationPropertyMetadata:
      Length: 5
      Prefix: my-api-
      CharacterClasses:
        - Class: lowercase
          min: 1
    Default: my-api
Resources:
  HttpApi:
    Type: ALIYUN::APIG::HttpApi
    Properties:
      HttpApiName:
        Ref: HttpApiName
      Type: Http
      Protocols:
        - HTTP
      BasePath: /
Outputs:
  HttpApiId:
    Label:
      zh-cn: API ID
      en: API ID
    Value:
      Fn::GetAtt:
        - HttpApi
        - HttpApiId

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "创建一个HTTP协议的API，适用于内部服务调用或开发测试。",
    "en": "Create an HTTP API for internal service calls or dev/test environments."
  },
  "Parameters": {
    "HttpApiName": {
      "Type": "String",
      "Label": {
        "zh-cn": "API名称",
        "en": "API Name"
      },
      "Description": {
        "zh-cn": "HTTP API的名称，长度为1~64个字符。",
        "en": "The name of the HTTP API, 1 to 64 characters."
      },
      "MinLength": 1,
      "MaxLength": 64,
      "AssociationProperty": "AutoCompleteInput",
      "AssociationPropertyMetadata": {
        "Length": 5,
        "Prefix": "my-api-",
        "CharacterClasses": [
          {
            "Class": "lowercase",
            "min": 1
          }
        ]
      },
      "Default": "my-api"
    }
  },
  "Resources": {
    "HttpApi": {
      "Type": "ALIYUN::APIG::HttpApi",
      "Properties": {
        "HttpApiName": {
          "Ref": "HttpApiName"
        },
        "Type": "Http",
        "Protocols": [
          "HTTP"
        ],
        "BasePath": "/"
      }
    }
  },
  "Outputs": {
    "HttpApiId": {
      "Label": {
        "zh-cn": "API ID",
        "en": "API ID"
      },
      "Value": {
        "Fn::GetAtt": [
          "HttpApi",
          "HttpApiId"
        ]
      }
    }
  }
}

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 创建REST类型API，支持HTTP和HTTPS双协议，配置版本化基础路径。
  en: Create a RESTful API with both HTTP and HTTPS, with a versioned base path.
Parameters:
  HttpApiName:
    Type: String
    Label:
      zh-cn: API名称
      en: API Name
    Description:
      zh-cn: RESTful API的名称，长度为1~64个字符。
      en: The name of the RESTful API, 1 to 64 characters.
    MinLength: 1
    MaxLength: 64
    AssociationProperty: AutoCompleteInput
    AssociationPropertyMetadata:
      Length: 5
      Prefix: rest-api-
      CharacterClasses:
        - Class: lowercase
          min: 1
    Default: rest-api
  BasePath:
    Type: String
    Label:
      zh-cn: API基础路径
      en: API Base Path
    Description:
      zh-cn: >-
        API的基础路径，需以/开头。建议使用版本号作为路径前缀，
        如/v1、/v2，便于API版本管理。
      en: >-
        The base path of the API, must start with /.
        Using a version prefix like /v1, /v2 is recommended.
    Default: /v1
    AllowedValues:
      - /v1
      - /v2
      - /api/v1
      - /api/v2
  Description:
    Type: String
    Label:
      zh-cn: API描述
      en: API Description
    Description:
      zh-cn: API的功能描述信息。
      en: Functional description of the API.
    Default: 生产环境RESTful API服务
    MaxLength: 256
Resources:
  RestApi:
    Type: ALIYUN::APIG::HttpApi
    Properties:
      HttpApiName:
        Ref: HttpApiName
      Type: Rest
      Protocols:
        - HTTP
        - HTTPS
      BasePath:
        Ref: BasePath
      Description:
        Ref: Description
Outputs:
  HttpApiId:
    Label:
      zh-cn: API ID
      en: API ID
    Value:
      Fn::GetAtt:
        - RestApi
        - HttpApiId

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "创建REST类型API，支持HTTP和HTTPS双协议，配置版本化基础路径。",
    "en": "Create a RESTful API with both HTTP and HTTPS, with a versioned base path."
  },
  "Parameters": {
    "HttpApiName": {
      "Type": "String",
      "Label": {
        "zh-cn": "API名称",
        "en": "API Name"
      },
      "Description": {
        "zh-cn": "RESTful API的名称，长度为1~64个字符。",
        "en": "The name of the RESTful API, 1 to 64 characters."
      },
      "MinLength": 1,
      "MaxLength": 64,
      "AssociationProperty": "AutoCompleteInput",
      "AssociationPropertyMetadata": {
        "Length": 5,
        "Prefix": "rest-api-",
        "CharacterClasses": [
          {
            "Class": "lowercase",
            "min": 1
          }
        ]
      },
      "Default": "rest-api"
    },
    "BasePath": {
      "Type": "String",
      "Label": {
        "zh-cn": "API基础路径",
        "en": "API Base Path"
      },
      "Description": {
        "zh-cn": "API的基础路径，需以/开头。建议使用版本号作为路径前缀，如/v1、/v2，便于API版本管理。",
        "en": "The base path of the API, must start with /. Using a version prefix like /v1, /v2 is recommended."
      },
      "Default": "/v1",
      "AllowedValues": [
        "/v1",
        "/v2",
        "/api/v1",
        "/api/v2"
      ]
    },
    "Description": {
      "Type": "String",
      "Label": {
        "zh-cn": "API描述",
        "en": "API Description"
      },
      "Description": {
        "zh-cn": "API的功能描述信息。",
        "en": "Functional description of the API."
      },
      "Default": "生产环境RESTful API服务",
      "MaxLength": 256
    }
  },
  "Resources": {
    "RestApi": {
      "Type": "ALIYUN::APIG::HttpApi",
      "Properties": {
        "HttpApiName": {
          "Ref": "HttpApiName"
        },
        "Type": "Rest",
        "Protocols": [
          "HTTP",
          "HTTPS"
        ],
        "BasePath": {
          "Ref": "BasePath"
        },
        "Description": {
          "Ref": "Description"
        }
      }
    }
  },
  "Outputs": {
    "HttpApiId": {
      "Label": {
        "zh-cn": "API ID",
        "en": "API ID"
      },
      "Value": {
        "Fn::GetAtt": [
          "RestApi",
          "HttpApiId"
        ]
      }
    }
  }
}

ROSTemplateFormatVersion: '2015-09-01'
Description:
  zh-cn: 创建WebSocket API并配置HTTPS安全域名，实现安全的实时通信服务。
  en: Create a WebSocket API with an HTTPS domain for secure real-time communication.
Parameters:
  HttpApiName:
    Type: String
    Label:
      zh-cn: API名称
      en: API Name
    Description:
      zh-cn: WebSocket API的名称，长度为1~64个字符。
      en: The name of the WebSocket API, 1 to 64 characters.
    MinLength: 1
    MaxLength: 64
    AssociationProperty: AutoCompleteInput
    AssociationPropertyMetadata:
      Length: 5
      Prefix: ws-api-
      CharacterClasses:
        - Class: lowercase
          min: 1
    Default: ws-api
  BasePath:
    Type: String
    Label:
      zh-cn: WebSocket基础路径
      en: WebSocket Base Path
    Description:
      zh-cn: WebSocket API的基础路径，需以/开头。
      en: The base path of the WebSocket API, must start with /.
    Default: /ws
  DomainName:
    Type: String
    Label:
      zh-cn: 域名
      en: Domain Name
    Description:
      zh-cn: >-
        WebSocket服务的域名，例如ws.example.com。
        需已完成域名备案和DNS解析。
      en: >-
        The domain name for WebSocket service, e.g. ws.example.com.
        DNS resolution and ICP filing must be completed.
    AllowedPattern: '^[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+$'
  CertIdentifier:
    Type: String
    Label:
      zh-cn: SSL证书标识
      en: SSL Certificate Identifier
    Description:
      zh-cn: SSL证书的唯一标识，可在SSL证书服务控制台获取。证书需与域名匹配。
      en: >-
        The unique identifier of the SSL certificate.
        The certificate must match the domain name.
Resources:
  WebSocketApi:
    Type: ALIYUN::APIG::HttpApi
    Properties:
      HttpApiName:
        Ref: HttpApiName
      Type: WebSocket
      Protocols:
        - HTTPS
      BasePath:
        Ref: BasePath
      Description:
        Fn::Sub: WebSocket实时通信API - ${HttpApiName}
  Domain:
    Type: ALIYUN::APIG::Domain
    Properties:
      DomainName:
        Ref: DomainName
      Protocol: HTTPS
      CertIdentifier:
        Ref: CertIdentifier
      ForceHttps: true
      TlsMin: TLS 1.2
      TlsMax: TLS 1.3
      Http2Option: Open
Outputs:
  HttpApiId:
    Label:
      zh-cn: API ID
      en: API ID
    Value:
      Fn::GetAtt:
        - WebSocketApi
        - HttpApiId
  DomainId:
    Label:
      zh-cn: 域名ID
      en: Domain ID
    Value:
      Fn::GetAtt:
        - Domain
        - DomainId
  DomainName:
    Label:
      zh-cn: 域名
      en: Domain Name
    Value:
      Fn::GetAtt:
        - Domain
        - DomainName

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
    "zh-cn": "创建WebSocket API并配置HTTPS安全域名，实现安全的实时通信服务。",
    "en": "Create a WebSocket API with an HTTPS domain for secure real-time communication."
  },
  "Parameters": {
    "HttpApiName": {
      "Type": "String",
      "Label": {
        "zh-cn": "API名称",
        "en": "API Name"
      },
      "Description": {
        "zh-cn": "WebSocket API的名称，长度为1~64个字符。",
        "en": "The name of the WebSocket API, 1 to 64 characters."
      },
      "MinLength": 1,
      "MaxLength": 64,
      "AssociationProperty": "AutoCompleteInput",
      "AssociationPropertyMetadata": {
        "Length": 5,
        "Prefix": "ws-api-",
        "CharacterClasses": [
          {
            "Class": "lowercase",
            "min": 1
          }
        ]
      },
      "Default": "ws-api"
    },
    "BasePath": {
      "Type": "String",
      "Label": {
        "zh-cn": "WebSocket基础路径",
        "en": "WebSocket Base Path"
      },
      "Description": {
        "zh-cn": "WebSocket API的基础路径，需以/开头。",
        "en": "The base path of the WebSocket API, must start with /."
      },
      "Default": "/ws"
    },
    "DomainName": {
      "Type": "String",
      "Label": {
        "zh-cn": "域名",
        "en": "Domain Name"
      },
      "Description": {
        "zh-cn": "WebSocket服务的域名，例如ws.example.com。需已完成域名备案和DNS解析。",
        "en": "The domain name for WebSocket service, e.g. ws.example.com. DNS resolution and ICP filing must be completed."
      },
      "AllowedPattern": "^[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+$"
    },
    "CertIdentifier": {
      "Type": "String",
      "Label": {
        "zh-cn": "SSL证书标识",
        "en": "SSL Certificate Identifier"
      },
      "Description": {
        "zh-cn": "SSL证书的唯一标识，可在SSL证书服务控制台获取。证书需与域名匹配。",
        "en": "The unique identifier of the SSL certificate. The certificate must match the domain name."
      }
    }
  },
  "Resources": {
    "WebSocketApi": {
      "Type": "ALIYUN::APIG::HttpApi",
      "Properties": {
        "HttpApiName": {
          "Ref": "HttpApiName"
        },
        "Type": "WebSocket",
        "Protocols": [
          "HTTPS"
        ],
        "BasePath": {
          "Ref": "BasePath"
        },
        "Description": {
          "Fn::Sub": "WebSocket实时通信API - ${HttpApiName}"
        }
      }
    },
    "Domain": {
      "Type": "ALIYUN::APIG::Domain",
      "Properties": {
        "DomainName": {
          "Ref": "DomainName"
        },
        "Protocol": "HTTPS",
        "CertIdentifier": {
          "Ref": "CertIdentifier"
        },
        "ForceHttps": true,
        "TlsMin": "TLS 1.2",
        "TlsMax": "TLS 1.3",
        "Http2Option": "Open"
      }
    }
  },
  "Outputs": {
    "HttpApiId": {
      "Label": {
        "zh-cn": "API ID",
        "en": "API ID"
      },
      "Value": {
        "Fn::GetAtt": [
          "WebSocketApi",
          "HttpApiId"
        ]
      }
    },
    "DomainId": {
      "Label": {
        "zh-cn": "域名ID",
        "en": "Domain ID"
      },
      "Value": {
        "Fn::GetAtt": [
          "Domain",
          "DomainId"
        ]
      }
    },
    "DomainName": {
      "Label": {
        "zh-cn": "域名",
        "en": "Domain Name"
      },
      "Value": {
        "Fn::GetAtt": [
          "Domain",
          "DomainName"
        ]
      }
    }
  }
}