如何使用DATASOURCE::VPC::PublicIpAddressPools類型查詢可使用的IP位址集區資訊 - Resource Orchestration Service

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（多線）_精品線路的更多資訊，請參見什麼是Elastic IP Address。如果您是單線頻寬的白名單使用者，傳回型別還可能為： 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"
        ]
      }
    }
  }
}