ALIYUN::ApiGateway::Authorization類型用於給API授權App的存取權限。
文法
{
"Type": "ALIYUN::ApiGateway::Authorization",
"Properties": {
"ApiIds": List,
"AppIds": List,
"GroupId": String,
"StageName": String,
"Description": String,
"AuthValidTime": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
ApiIds | List | 是 | 是 | 指定操作的API編號。 | 支援輸入多個,最多支援 100 個。 |
AppIds | List | 是 | 是 | 應用編號清單。 | 由系統產生,全域唯一。支援輸入多個。 |
GroupId | String | 是 | 是 | API分組ID。 | 由系統產生,全域唯一。 |
StageName | String | 是 | 是 | 環境名稱。 | 取值:
|
AuthValidTime | String | 否 | 是 | 授權有效時間的截止時間。 | 請設定格林尼治標準時間 (GMT),如果為空白,即為授權永久有效。 |
Description | String | 否 | 是 | 授權說明 。 | 無 |
傳回值
Fn::GetAtt
無。
樣本
說明
請您根據實際情況更改脫敏的參數取值。例如GroupId、AppId、ApiId。
YAML
格式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
GroupId:
Type: String
Default: 10b1b4dc7a2e6ba8ca3****
Description: 操作的分組
AppId:
Type: Number
Default: 577****
Description: APP ID
ApiId:
Type: String
Default: 2a8b6d4ce2ad1f95cb****
Description: API ID
Resources:
Authorization:
Type: ALIYUN::ApiGateway::Authorization
Properties:
GroupId:
Ref: GroupId
StageName: TEST
AppIds:
- Ref: AppId
ApiIds:
- Ref: ApiId
JSON
格式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"GroupId": {
"Type": "String",
"Default": "10b1b4dc7a2e6ba8ca3****",
"Description": "操作的分組"
},
"AppId": {
"Type": "Number",
"Default": "577****",
"Description": "APP ID"
},
"ApiId": {
"Type": "String",
"Default": "2a8b6d4ce2ad1f95cb****",
"Description": "API ID"
}
},
"Resources": {
"Authorization": {
"Type": "ALIYUN::ApiGateway::Authorization",
"Properties": {
"GroupId": {
"Ref": "GroupId"
},
"StageName": "TEST",
"AppIds": [
{
"Ref": "AppId"
}
],
"ApiIds": [
{
"Ref": "ApiId"
}
]
}
}
}
}