調用ALIYUN::ApiGateway::Deployment發布API到指定的運行環境 -

ALIYUN::ApiGateway::Deployment類型用於發布API到指定的運行環境，或者切換發行的API到指定的版本。

文法

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

屬性

屬性名稱	類型	必須	允許更新	描述	約束
ApiId	String	是	否	API編號。	無
GroupId	String	是	否	API分組編號。	無
StageName	String	是	是	運行環境名稱。	取值： TEST PRE RELEASE HistoryVersion和該參數不能同時指定。
Description	String	否	是	本次發布備忘說明。	無
HistoryVersion	String	否	是	當指定該參數時，表示將發行API的版本切換到指定版本；當不指定該參數時，表示發布API。	StageName和該參數不能同時指定。

傳回值

Fn::GetAtt

無。

樣本

`YAML`格式

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

`JSON`格式

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

文法

屬性

傳回值

樣本

YAML格式

JSON格式

`YAML`格式

`JSON`格式