ALIYUN::ApiGateway::Group類型用于創建API分組。
語法
{
"Type": "ALIYUN::ApiGateway::Group",
"Properties": {
"GroupName": String,
"Description": String,
"InstanceId": String,
"PassthroughHeaders": String,
"InternetEnable": Boolean,
"VpcIntranetEnable": Boolean,
"Tags": List,
"BasePath": String
}
} 屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
GroupName | String | 是 | 是 | API分組名稱。 | 名稱必須唯一。 長度為4~50個字符。必須以英文字母或漢字開頭。可包含英文字母、漢字、數字和下劃線（_）。 |
BasePath | String | 否 | 是 | API根路徑。 | 示例： |
Description | String | 否 | 是 | API分組描述。 | 長度不超過180個字符。 |
InstanceId | String | 否 | 否 | API網關實例類型。 | 取值：
|
InternetEnable | Boolean | 否 | 是 | 是否啟用公網子域名。 | 取值：
|
PassthroughHeaders | String | 否 | 否 | 配置透傳。 | 取值：host。 |
Tags | List | 否 | 是 | 標簽。 | 最多可以設置20個標簽。 更多信息，請參見Tags屬性。 |
VpcIntranetEnable | Boolean | 否 | 是 | 是否啟用私網子域名。 | 取值：
|
Tags語法
"Tags": [
{
"Value": String,
"Key": String
}
] Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標簽鍵。 | 長度為1~128個字符，不能以 |
Value | String | 否 | 否 | 標簽值。 | 長度為0~128個字符，不能以 |
返回值
Fn::GetAtt
SubDomain：系統給API分組綁定的二級域名，用于測試API調用情況。
GroupId：API分組ID。通過系統生成，全局唯一。
Tags：標簽。
示例
請您根據實際情況更改脫敏的參數取值，例如InstanceId。
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: {}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": {
}
}