ALIYUN::ApiGateway::Deployment类型用于发布API到指定的运行环境，或者切换已发布的API到指定的版本。

语法

{
  "Type": "ALIYUN::ApiGateway::Deployment",
  "Properties": {
    "HistoryVersion": String ,
    "ApiId": String ,
    "Description": String ,
    "StageName": String ,
    "GroupId": String 
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
ApiId String 是 否 API 编号 无
StageName String 是 是 运行环境名称 取值：
  • TEST
  • PRE
  • RELEASE
HistoryVersion和该参数不能同时指定。
GroupId String 是 否 API分组编号 无
HistoryVersion String 否 是 当指定该参数时，表示将已发布API的版本切换到指定版本；当不指定该参数时，表示发布API。 StageName和该参数不能同时指定。
Description String 否 是 本次发布备注说明 无

返回值

Fn::GetAtt

无。

示例

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String ",
      "Description": "API group ID"
    },
    "ApiId": {
      "Type": "String ",
      "Description": "API ID"
    }
  },
  "Resources": {
    "Deployment": {
      "Type": "ALIYUN::ApiGateway::Deployment",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        },
        "ApiId": {
          "Ref": "ApiId"
        },
        "StageName": "PRE",
        "Description": "TEST_ONLY_CHANGE"
      }
    }
  }
}