DATASOURCE::ApiGateway::Instances类型用于查询实例列表。

语法

{
  "Type": "DATASOURCE::ApiGateway::Instances",
  "Properties": {
    "Language": String,
    "InstanceId": String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
Language String 否 是 语言类型。 取值：
  • en：英文。
  • zh：中文。
  • ja：日文。
InstanceId String 否 是 实例ID。 无

返回数据（Fn::GetAtt）

  • ApiGatewayInstances：实例详情列表。
  • ApiGatewayInstanceIds：实例ID列表。
属性名称 类型 描述 约束
ApiGatewayInstanceIds List 实例ID列表。 无
ApiGatewayInstances List 实例详情列表。 无
Status String 实例状态。 无
InstanceId String 实例ID。 无
VpcSlbIntranetEnable Boolean 是否支持VPC类型SLB。 取值：
  • true：支持。
  • false：不支持。
ClassicEgressAddress String 经典网络出方向访问规则。 无
ZoneLocalName String 可用区域。 无
VipTypeList String 弹性公网IP类型。 无
UserVpcId String 绑定的专有网络ID。 无
VpcIntranetEnable Boolean 是否开启公网。 取值：
  • true：开启公网。
  • false：关闭公网。
VpcOwnerId String 专有网络所属账号ID。 无
InstanceRpsLimit Integer 实例Rps限制。 无
InstanceType String 实例类型。 取值：
  • VPC_SHARED：共享实例。
  • VPC_DEDICATED：专享实例。
RegionId String 所在的地域。 无
InstanceSpec String 实例规格。 无
InstanceChargeType String 实例的计费方式。 取值：
  • PrePaid：包年包月。
  • PayAsYouGo：按量付费。
HttpsPolicies String HTTPS安全策略。 无
VpcEgressAddress String 内网VPC出口网段。 无
EgressIpv6Enable Boolean 是否支持IPv6出访能力。 取值：
  • true：支持IPv6出访能力。
  • false：不支持IPv6出访能力。
ExpiredTime String 实例过期时间。 格林威治时间。
InstanceName String 实例名称。 无
ZoneId String 可用区ID。 无
SupportIpv6 Boolean 是否支持IPv6。 取值：
  • true：支持IPv6。
  • false：不支持IPv6。
InternetEgressAddress String 公网出口地址。 无
CreatedTime String 实例创建时间。 格林威治时间。
UserVswitchId String 绑定的虚拟交换机ID。 无
InstanceSpecAttributes List 实例规格。 无

示例

  • JSON格式 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "API Gateway Instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Instances",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGatewayInstances": {
      "Description": "The information about ApiGateway groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGatewayInstances"
        ]
      }
    },
    "ApiGatewayInstanceIds": {
      "Description": "The list of The ApiGateway group ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGatewayInstanceIds"
        ]
      }
    }
  }
}

  • YAML格式 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description: API Gateway Instance ID.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Instances
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  ApiGatewayInstances:
    Description: The information about ApiGateway groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstances
  ApiGatewayInstanceIds:
    Description: The list of The ApiGateway group ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstanceIds