DATASOURCE::APIG::Gateway_资源编排(ROS)-阿里云帮助中心

DATASOURCE::APIG::Gateway类型用于查询网关详情。

语法

{
  "Type": "DATASOURCE::APIG::Gateway",
  "Properties": {
    "GatewayId": String,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

GatewayId

String

是

云原生 API 网关 ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

ResourceGroupId：资源组 ID。
CreateTime：网关创建时间戳。
Vpc：网关关联的专有网络。
LoadBalancers：网关的入口地址列表。
SecurityGroup：网关的安全组。
GatewayId：网关 ID。
Zones：网关关联的可用区列表。
Environments：网关关联的环境列表。
VSwitch：网关关联的虚拟交换机。
Version：网关版本。
UpdateTime：网关更新时间戳。
PaymentType：付费类型。
GatewayName：网关名称。
Spec：网关规格。
ExpireTime：包年包月到期时间戳。
Tags：资源标签。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GatewayId:
    Type: String
    Description:
      en: Cloud-native API Gateway ID.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Gateway
    Properties:
      GatewayId:
        Ref: GatewayId
Outputs:
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CreateTime:
    Description: 'The creation timestamp. Unit: milliseconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  Vpc:
    Description: The VPC associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Vpc
  LoadBalancers:
    Description: The list of Gateway ingress addresses.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - LoadBalancers
  SecurityGroup:
    Description: The Security Group of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecurityGroup
  GatewayId:
    Description: The ID of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GatewayId
  Zones:
    Description: The List of zones associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Zones
  Environments:
    Description: The list of environments associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Environments
  VSwitch:
    Description: The virtual switch associated with the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitch
  Version:
    Description: The gateway version.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Version
  UpdateTime:
    Description: 'Update timestamp. Unit: milliseconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdateTime
  PaymentType:
    Description: The payment type of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  GatewayName:
    Description: The name of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - GatewayName
  Spec:
    Description: Gateway instance specifications.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Spec
  ExpireTime:
    Description: 'Package year and package month expiration timestamp. Unit: milliseconds.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpireTime
  Tags:
    Description: The tags of the Gateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GatewayId": {
      "Type": "String",
      "Description": {
        "en": "Cloud-native API Gateway ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Gateway",
      "Properties": {
        "GatewayId": {
          "Ref": "GatewayId"
        }
      }
    }
  },
  "Outputs": {
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation timestamp. Unit: milliseconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Vpc": {
      "Description": "The VPC associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Vpc"
        ]
      }
    },
    "LoadBalancers": {
      "Description": "The list of Gateway ingress addresses.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LoadBalancers"
        ]
      }
    },
    "SecurityGroup": {
      "Description": "The Security Group of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroup"
        ]
      }
    },
    "GatewayId": {
      "Description": "The ID of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GatewayId"
        ]
      }
    },
    "Zones": {
      "Description": "The List of zones associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Zones"
        ]
      }
    },
    "Environments": {
      "Description": "The list of environments associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Environments"
        ]
      }
    },
    "VSwitch": {
      "Description": "The virtual switch associated with the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitch"
        ]
      }
    },
    "Version": {
      "Description": "The gateway version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Version"
        ]
      }
    },
    "UpdateTime": {
      "Description": "Update timestamp. Unit: milliseconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdateTime"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "GatewayName": {
      "Description": "The name of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "GatewayName"
        ]
      }
    },
    "Spec": {
      "Description": "Gateway instance specifications.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Spec"
        ]
      }
    },
    "ExpireTime": {
      "Description": "Package year and package month expiration timestamp. Unit: milliseconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    }
  }
}