ALIYUN::ApiGateway::App類型用於建立App。App是您調用第三方API時的身份,要調用第三方API必須建立App。
文法
{
"Type": "ALIYUN::ApiGateway::App",
"Properties": {
"Description": String,
"Tags": List,
"AppName": String,
"AppSecret": String,
"AppCode": String,
"AppKey": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
AppName | String | 是 | 是 | App的名稱。 | 全域唯一。建議命名時加上特定標識,避免重名。 長度為4~15個字元,必須以英文字元或中文字元開頭,可包含英文字元、中文字元、數字和底線(_)。 |
AppCode | String | 否 | 否 | 應用的AppCode。 | 無 |
AppKey | String | 否 | 否 | App的密鑰。 | 用於調用API時使用。 |
AppSecret | String | 否 | 否 | App密碼。 | 無 |
Description | String | 否 | 是 | App描述資訊。 | 長度不超過180個字元。 |
Tags | List | 否 | 是 | 標籤。 | 最多設定20個標籤。 |
Tags文法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標籤鍵。 | 長度為1~128個字元,不能以 |
Value | String | 否 | 否 | 標籤值。 | 長度為0~128個字元,不能以 |
傳回值
Fn::GetAtt
AppKey:App的密鑰。
AppSecret:App的密碼。
AppId:App的ID。
Tags:標籤。
AppCode:應用的AppCode。
樣本
YAML
格式
ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
APP:
Type: ALIYUN::ApiGateway::App
Properties:
Description: Test Create App
AppName: DemoApp
Outputs:
AppId:
Description: The id of the created APP
Value:
Fn::GetAtt:
- APP
- AppId
AppKey:
Description: The key of the APP
Value:
Fn::GetAtt:
- APP
- AppKey
AppSecret:
Description: The secret of the APP
Value:
Fn::GetAtt:
- APP
- AppSecret
JSON
格式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
},
"Resources": {
"APP": {
"Type": "ALIYUN::ApiGateway::App",
"Properties": {
"Description": "Test Create App",
"AppName": "DemoApp"
}
}
},
"Outputs": {
"AppId": {
"Description": "The id of the created APP",
"Value": {
"Fn::GetAtt": [
"APP",
"AppId"
]
}
},
"AppKey": {
"Description": "The key of the APP",
"Value": {
"Fn::GetAtt": [
"APP",
"AppKey"
]
}
},
"AppSecret": {
"Description": "The secret of the APP",
"Value": {
"Fn::GetAtt": [
"APP",
"AppSecret"
]
}
}
}
}