DocsICP FilingConsole
官方文档
首页

ALIYUN::ApiGateway::Instance

更新时间：
复制 MD 格式
产品详情
我的收藏

Creates a dedicated API Gateway instance.

Syntax

{
  "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
  }
}

Properties

Property Name

Type

Required

Update allowed

Description

Constraints

HttpsPolicy

String

Yes

No

The HTTPS security policy.

Valid values:

  • HTTPS1_1_TLS1_0

  • HTTPS2_TLS1_0

  • HTTPS2_TLS1_2

For more information, see HTTPS security policies.

InstanceName

String

Yes

No

The instance name.

The name must be 1 to 50 characters in length. It can contain Chinese characters, letters, digits, and the special characters -/._.

InstanceSpec

String

Yes

No

The instance type.

For more information, see Dedicated instances.

ZoneId

String

Yes

No

The zone ID.

None

AutoPay

Boolean

No

No

Specifies whether to enable auto-renewal for the instance.

Valid values:

  • true (default)

  • false

ChargeType

String

No

No

The billing method.

Valid values:

  • Prepaid (subscription)

  • PostPaid (default): pay-as-you-go

DeletionForce

Boolean

No

No

Specifies whether to forcefully delete the instance.

Valid values:

  • true

  • false (default)

Duration

Number

No

No

The subscription duration.

Valid values:

  • If PricingCycle is set to Month, the valid values are 1 to 9.

  • If PricingCycle is set to Year, the valid values are 1 to 3.

PricingCycle

String

No

No

The billing cycle of the subscription instance.

Valid values:

  • Month (default): billed on a monthly basis.

  • Year: billed on an annual basis.

Tags

List

No

Yes

The tags.

A maximum of 20 tags.

For more information, see Tags property.

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags property

Property Name

Type

Required

Update allowed

Description

Constraints

Key

String

Yes

No

The tag key.

The tag key must be 1 to 128 characters in length. It cannot start with aliyun or acs:. It cannot contain http:// or https:// .

Value

String

No

No

The tag value.

The tag value must be 0 to 128 characters in length. It cannot start with aliyun or acs:. It cannot contain http:// or https:// .

Return values

Fn::GetAtt

  • InstanceType: The instance type.

  • InstanceId: The instance ID.

  • VpcEgressAddress: The VPC egress address.

  • InternetEgressAddress: The Internet egress address.

  • EgressIpv6Enable: Indicates whether IPv6 egress is enabled.

  • VpcIntranetEnable: Indicates whether the VPC intranet is enabled.

  • SupportIpv6: Indicates whether IPv6 is supported.

  • VpcSlbIntranetEnable: Indicates whether the VPC SLB intranet is enabled.

  • Arn: The Alibaba Cloud Resource Name (ARN) of the instance.

Examples

YAML format

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

JSON format

{
  "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"
        }
      }
    }
  }
}
Previous：ALIYUN::ApiGateway::GroupNext：ALIYUN::ApiGateway::LogConfig