使用DATASOURCE::VPC::PublicIpAddressPools查询IP地址池基本信息-资源编排-阿里云

DATASOURCE::VPC::PublicIpAddressPools类型用于查询用户可使用的IP地址池的基本信息。

语法

{
  "Type": "DATASOURCE::VPC::PublicIpAddressPools",
  "Properties": {
    "ResourceGroupId": String,
    "PublicIpAddressPoolName": String,
    "Isp": String,
    "RefreshOptions": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
ResourceGroupId	String	否	是	IP地址池所属的资源组ID。	无
PublicIpAddressPoolName	String	否	是	IP地址池实例的名称。	描述可以为空，或输入1~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`http://`或`https://`开头。
Isp	String	否	是	线路类型。	取值： BGP：BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。关于BGP（多线）线路和BGP（多线）_精品线路的更多信息，请参见什么是弹性公网IP。如果您是单线带宽的白名单用户，返回类型还可能为： ChinaTelecom：中国电信。 ChinaUnicom：中国联通。 ChinaMobile：中国移动。 ChinaTelecom_L2：中国电信L2。 ChinaUnicom_L2：中国联通L2。 ChinaMobile_L2：中国移动L2。如果您是杭州金融云用户，返回BGP_FinanceCloud。
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	有效值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

PublicIpAddressPoolIds：IP地址池的实例ID列表。
PublicIpAddressPools：IP地址池的实例详情列表。

属性名称	类型	描述	约束
PublicIpAddressPoolIds	List	IP地址池的实例ID列表。	无
PublicIpAddressPoolIds	List	IP地址池的实例详情列表。	无
Status	String	IP地址池实例状态。	无
Isp	String	线路类型。	无
Description	String	IP地址池实例的描述。	无
IpAddressRemaining	Boolean	是否还有空闲的IP地址。	取值： true：有空闲的IP地址。 false：没有空闲的IP地址。
Tags	List	标签列表。	无
TotalIpNum	Integer	公网IP地址池可用IP地址总数。	无
PublicIpAddressPoolId	String	IP地址池的实例ID。	无
ResourceGroupId	String	IP地址池所属的资源组ID。	无
CreateTime	String	创建时间。	无
UsedIpNum	String	公网IP地址池已用IP地址数。	无
PublicIpAddressPoolName	String	IP地址池实例的名称。	无
RegionId	String	查询的IP地址池所在的地域ID。	无

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Isp:
    AllowedValues:
    - BGP
    - BGP_PRO
    - ChinaTelecom
    - ChinaUnicom
    - ChinaMobile
    - ChinaTelecom_L2
    - ChinaUnicom_L2
    - ChinaMobile_L2
    Description: "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines\n\
      BGP_PRO: BGP (Multi-ISP) Pro lines\nFor more information about BGP (Multi-ISP)\
      \ and BGP (Multi-ISP) Pro, see EIP line types.\nIf you are allowed to use single-ISP\
      \ bandwidth, you can also choose one of the following values:\nChinaTelecom:\
      \ China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2:\
      \ China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile\
      \ L2\nIf your services are deployed in China East 1 Finance, \nthis parameter\
      \ is required and you must set the value to BGP_FinanceCloud."
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      Isp:
        Ref: Isp
    Type: DATASOURCE::VPC::PublicIpAddressPools
Outputs:
  PublicIpAddressPoolIds:
    Description: The list of public ip address pool IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPoolIds
  PublicIpAddressPools:
    Description: The list of public ip address pools.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddressPools

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Isp": {
      "Type": "String",
      "Description": "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines\nBGP_PRO: BGP (Multi-ISP) Pro lines\nFor more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types.\nIf you are allowed to use single-ISP bandwidth, you can also choose one of the following values:\nChinaTelecom: China Telecom\nChinaUnicom: China Unicom\nChinaMobile: China Mobile\nChinaTelecom_L2: China Telecom L2\nChinaUnicom_L2: China Unicom L2\nChinaMobile_L2: China Mobile L2\nIf your services are deployed in China East 1 Finance, \nthis parameter is required and you must set the value to BGP_FinanceCloud.",
      "AllowedValues": [
        "BGP",
        "BGP_PRO",
        "ChinaTelecom",
        "ChinaUnicom",
        "ChinaMobile",
        "ChinaTelecom_L2",
        "ChinaUnicom_L2",
        "ChinaMobile_L2"
      ]
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::PublicIpAddressPools",
      "Properties": {
        "Isp": {
          "Ref": "Isp"
        }
      }
    }
  },
  "Outputs": {
    "PublicIpAddressPoolIds": {
      "Description": "The list of public ip address pool IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPoolIds"
        ]
      }
    },
    "PublicIpAddressPools": {
      "Description": "The list of public ip address pools.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddressPools"
        ]
      }
    }
  }
}