La ressource ALIYUN::ApiGateway::App permet de créer une application. Avant d'appeler une API tierce, vous devez créer une application et l'utiliser comme identité pour cet appel.
Syntaxe
{
"Type": "ALIYUN::ApiGateway::App",
"Properties": {
"Description": String,
"Tags": List,
"AppName": String,
"AppSecret": String,
"AppCode": String,
"AppKey": String
}
}
Propriétés
|**Propriété**
|
**Type**
|
**Obligatoire**
|
**Modifiable**
|
**Description**
|
**Contrainte**
| | --- | --- | --- | --- | --- | --- | |
AppName
|
String
|
Oui
|
Oui
|
Nom de l'application.
|
Le nom doit être unique à l'échelle globale. Nous vous recommandons d'ajouter un identifiant spécifique pour garantir son unicité.
Le nom doit comporter entre 4 et 15 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_). Il doit commencer par une lettre.
| |
AppCode
|
String
|
Non
|
Non
|
AppCode de l'application.
|
Aucune.
| |
AppKey
|
String
|
Non
|
Non
|
Clé de l'application.
|
La clé sert à appeler une API.
| |
AppSecret
|
String
|
Non
|
Non
|
Mot de passe de l'application.
|
Aucune.
| |
Description
|
String
|
Non
|
Oui
|
Description de l'application.
|
La description peut contenir jusqu'à 180 caractères.
| |
Tags
|
List
|
Non
|
Oui
|
Tags de l'application.
|
Vous pouvez ajouter jusqu'à 20 tags à l'application.
|
Syntaxe des tags
"Tags": [
{
"Value": String,
"Key": String
}
]
Propriétés des tags
|**Propriété**
|
**Type**
|
**Obligatoire**
|
**Modifiable**
|
**Description**
|
**Contrainte**
| | --- | --- | --- | --- | --- | --- | |
Key
|
String
|
Oui
|
Non
|
Clé du tag.
|
La clé du tag doit comporter entre 1 et 128 caractères et ne peut pas contenir `http://` ni `https://`. Elle ne peut pas commencer par `aliyun` ou `acs:`.
| |
Value
|
String
|
Non
|
Non
|
Valeur du tag.
|
La valeur du tag peut contenir jusqu'à 128 caractères et ne peut pas inclure `http://` ni `https://`. Elle ne peut pas commencer par `aliyun` ou `acs:`.
|
Valeurs renvoyées
Fn::GetAtt
AppKey : clé de l'application.
AppSecret : secret de l'application.
AppId : ID de l'application.
Tags : tags de l'application.
AppCode : AppCode de l'application.
Exemples
Format 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
Format 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"
]
}
}
}
}