Cria uma instância dedicada do API Gateway.
Sintaxe
{
"Type": "ALIYUN::ApiGateway::Instance",
"Properties": {
"InstanceName": String,
"DeletionForce": Boolean,
"InstanceSpec": String,
"HttpsPolicy": String,
"ZoneId": String,
"PricingCycle": String,
"ChargeType": String,
"Duration": Number,
"AutoPay": Boolean,
"Tags": List
}
}
Propriedades
|
Nome da propriedade |
Tipo |
Obrigatório |
Atualização permitida |
Descrição |
Restrições |
|
HttpsPolicy |
String |
Sim |
Não |
Política de segurança HTTPS. |
Valores válidos:
Para mais informações, consulte Políticas de segurança HTTPS. |
|
InstanceName |
String |
Sim |
Não |
Nome da instância. |
O nome deve ter de 1 a 50 caracteres e pode conter caracteres chineses, letras, dígitos e os caracteres especiais |
|
InstanceSpec |
String |
Sim |
Não |
Especificação da instância. |
Nenhuma |
|
ZoneId |
String |
Sim |
Não |
ID da zona. |
Nenhuma |
|
AutoPay |
Boolean |
Não |
Não |
Defina se a renovação automática está ativada para a instância. |
Valores válidos:
|
|
ChargeType |
String |
Não |
Não |
Método de faturamento. |
Valores válidos:
|
|
DeletionForce |
Boolean |
Não |
Não |
Defina se a exclusão forçada da instância está ativada. |
Valores válidos:
|
|
Duration |
Number |
Não |
Não |
Duração da assinatura. |
Valores válidos:
|
|
PricingCycle |
String |
Não |
Não |
Ciclo de faturamento da instância por assinatura. |
Valores válidos:
|
|
Tags |
List |
Não |
Sim |
Tags associadas. |
Limite de 20 tags. Para mais informações, consulte Propriedade Tags. |
Sintaxe de Tags
"Tags": [
{
"Key": String,
"Value": String
}
]
Propriedade Tags
|
Nome da propriedade |
Tipo |
Obrigatório |
Atualização permitida |
Descrição |
Restrições |
|
Key |
String |
Sim |
Não |
Chave da tag. |
A chave da tag deve ter de 1 a 128 caracteres. Não pode começar com |
|
Value |
String |
Não |
Não |
Valor da tag. |
O valor da tag deve ter de 0 a 128 caracteres. Não pode começar com |
Valores de retorno
Fn::GetAtt
InstanceType: especificação da instância.
InstanceId: ID da instância.
VpcEgressAddress: endereço de saída da VPC.
InternetEgressAddress: endereço de saída da Internet.
EgressIpv6Enable: indica se a saída IPv6 está ativada.
VpcIntranetEnable: indica se a intranet da VPC está ativada.
SupportIpv6: indica se há suporte a IPv6.
VpcSlbIntranetEnable: indica se a intranet SLB da VPC está ativada.
Arn: Alibaba Cloud Resource Name (ARN) da instância.
Exemplos
Formato YAML
Parameters:
InstanceName:
Type: String
Description: Instance name
ZoneId:
Type: String
AssociationProperty: ZoneId
ROSTemplateFormatVersion: '2015-09-01'
Outputs:
EgressIpv6Enable:
Description: Indicates whether egress for IPv6 is enabled.
Value:
Fn::GetAtt:
- Instance
- EgressIpv6Enable
VpcEgressAddress:
Description: VPC network egress address.
Value:
Fn::GetAtt:
- Instance
- VpcEgressAddress
InternetEgressAddress:
Description: Internet egress address.
Value:
Fn::GetAtt:
- Instance
- InternetEgressAddress
InstanceId:
Description: Instance ID.
Value:
Fn::GetAtt:
- Instance
- InstanceId
VpcIntranetEnable:
Description: Indicates whether the VPC intranet is enabled.
Value:
Fn::GetAtt:
- Instance
- VpcIntranetEnable
SupportIpv6:
Description: Indicates whether IPv6 is supported.
Value:
Fn::GetAtt:
- Instance
- SupportIpv6
InstanceType:
Description: Instance type.
Value:
Fn::GetAtt:
- Instance
- InstanceType
VpcSlbIntranetEnable:
Description: Indicates whether the VPC SLB intranet is enabled.
Value:
Fn::GetAtt:
- Instance
- VpcSlbIntranetEnable
Resources:
Instance:
Type: ALIYUN::ApiGateway::Instance
Properties:
InstanceName: TestInstance
InstanceSpec: api.s1.small
HttpsPolicy: HTTPS2_TLS1_0
ZoneId:
Ref: ZoneId
Formato JSON
{
"Parameters": {
"InstanceName": {
"Type": "String",
"Description": "Instance name"
},
"ZoneId": {
"Type": "String",
"AssociationProperty": "ZoneId"
}
},
"ROSTemplateFormatVersion": "2015-09-01",
"Outputs": {
"EgressIpv6Enable": {
"Description": "Indicates whether egress for IPv6 is enabled.",
"Value": {
"Fn::GetAtt": [
"Instance",
"EgressIpv6Enable"
]
}
},
"VpcEgressAddress": {
"Description": "VPC network egress address.",
"Value": {
"Fn::GetAtt": [
"Instance",
"VpcEgressAddress"
]
}
},
"InternetEgressAddress": {
"Description": "Internet egress address.",
"Value": {
"Fn::GetAtt": [
"Instance",
"InternetEgressAddress"
]
}
},
"InstanceId": {
"Description": "Instance ID.",
"Value": {
"Fn::GetAtt": [
"Instance",
"InstanceId"
]
}
},
"VpcIntranetEnable": {
"Description": "Indicates whether the VPC intranet is enabled.",
"Value": {
"Fn::GetAtt": [
"Instance",
"VpcIntranetEnable"
]
}
},
"SupportIpv6": {
"Description": "Indicates whether IPv6 is supported.",
"Value": {
"Fn::GetAtt": [
"Instance",
"SupportIpv6"
]
}
},
"InstanceType": {
"Description": "Instance type.",
"Value": {
"Fn::GetAtt": [
"Instance",
"InstanceType"
]
}
},
"VpcSlbIntranetEnable": {
"Description": "Indicates whether the VPC SLB intranet is enabled.",
"Value": {
"Fn::GetAtt": [
"Instance",
"VpcSlbIntranetEnable"
]
}
}
},
"Resources": {
"Instance": {
"Type": "ALIYUN::ApiGateway::Instance",
"Properties": {
"InstanceName": "TestInstance",
"InstanceSpec": "api.s1.small",
"HttpsPolicy": "HTTPS2_TLS1_0",
"ZoneId": {
"Ref": "ZoneId"
}
}
}
}
}