Obtém uma lista de APIs HTTP do Cloud-native API Gateway (APIG).
Sintaxe
{
"Type": "DATASOURCE::APIG::HttpApis",
"Properties": {
"HttpApiName": String,
"ResourceGroupId": String,
"RefreshOptions": String
}
}
Propriedades
|
Propriedade |
Tipo |
Obrigatória |
Editável |
Descrição |
Restrição |
|
HttpApiName |
String |
Não |
Sim |
Nome da API. |
Nenhuma. |
|
ResourceGroupId |
String |
Não |
Sim |
ID do grupo de recursos. |
Nenhuma. |
|
RefreshOptions |
String |
Não |
Sim |
Política de atualização dos recursos da source de dados durante a atualização da pilha. |
Valores válidos:
|
Valores de retorno
Fn::GetAtt
HttpApis: detalhes das APIs.
HttpApiIds: IDs das APIs.
|
Propriedade |
Tipo |
Descrição |
Restrição |
|
HttpApiIds |
List |
IDs das APIs. |
Nenhuma. |
|
HttpApis |
List |
Detalhes das APIs. |
Nenhuma. |
|
Description |
String |
Descrição da API. |
Nenhuma. |
|
HttpApiId |
String |
ID da API. |
Nenhuma. |
|
BasePath |
String |
Caminho base da API. |
Nenhuma. |
|
ResourceGroupId |
String |
ID do grupo de recursos. |
Nenhuma. |
|
HttpApiName |
String |
Nome da API. |
Nenhuma. |
|
Type |
String |
Tipo da API. |
Nenhuma. |
Exemplos
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
HttpApiName:
Type: String
Description:
en: The name of the API.
Required: false
Resources:
ExtensionDataSource:
Type: DATASOURCE::APIG::HttpApis
Properties:
HttpApiName:
Ref: HttpApiName
Outputs:
HttpApis:
Description: The list of http apis.
Value:
Fn::GetAtt:
- ExtensionDataSource
- HttpApis
HttpApiIds:
Description: The list of http api IDs.
Value:
Fn::GetAtt:
- ExtensionDataSource
- HttpApiIds
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"HttpApiName": {
"Type": "String",
"Description": {
"en": "The name of the API."
},
"Required": false
}
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::APIG::HttpApis",
"Properties": {
"HttpApiName": {
"Ref": "HttpApiName"
}
}
}
},
"Outputs": {
"HttpApis": {
"Description": "The list of http apis.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"HttpApis"
]
}
},
"HttpApiIds": {
"Description": "The list of http api IDs.",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"HttpApiIds"
]
}
}
}
}