全部產品
Search
文件中心

Resource Orchestration Service:DATASOURCE::CEN::CenBandwidthPackages

更新時間:Sep 24, 2024

DATASOURCE::CEN::CenBandwidthPackages類型用於查詢當前登入帳號下雲企業網頻寬包的詳細資料。

文法

{
  "Type": "DATASOURCE::CEN::CenBandwidthPackages",
  "Properties": {
    "IsOrKey": Boolean,
    "Filter": List,
    "IncludeReservationData": Boolean,
    "RefreshOptions": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

IsOrKey

Boolean

過濾條件之間的關係。

取值:

  • true:過濾條件之間是或的關係。即只要符合其中一個過濾條件,則視為匹配過濾條件。

  • false(預設值):過濾條件之間是與的關係。即必須符合所有過濾條件,才視為匹配過濾條件。

Filter

List

過濾條件。

更多資訊,請參見Filter屬性

IncludeReservationData

Boolean

是否包含續約資料。

取值:

  • true:包含續約資料。

  • false:不包含續約資料。

RefreshOptions

String

當資源棧更新時,資料來源資源的重新整理策略。

取值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

Filter文法

"Filter": [
  {
    "Value": List,
    "Key": String
  }
]

Filter屬性

屬性名稱

類型

必須

允許更新

描述

約束

Value

List

根據Key指定過濾值。

一個Key支援指定多個過濾值,每個過濾值之間是或的關係。即只要符合其中一個過濾值,則視為匹配過濾要求。

Key

String

過濾條件。

取值:

  • CenId:雲企業網執行個體的ID。

  • Status:頻寬包執行個體的狀態。

  • CenBandwidthPackageId:頻寬包的ID。

  • Name:頻寬包的名稱。

返回資料(Fn::GetAtt)

  • CenBandwidthPackages:頻寬包的詳情列表。

  • CenBandwidthPackageIds:頻寬包的ID列表。

屬性名稱

類型

描述

約束

CenBandwidthPackageIds

List

頻寬包的ID列表。

CenBandwidthPackages

List

頻寬包的詳情列表。

ReservationActiveTime

String

臨時升配到期時間。

CenBandwidthPackageId

String

頻寬包的ID。

Status

String

頻寬包是否已綁定雲企業網執行個體。

取值:

  • Idle:未綁定。

  • InUse:已綁定。

CreationTime

String

頻寬包的建立時間。

採用ISO8601格式表示,格式為:YYYY-MM-DDThh:mmZ。

ReservationOrderType

String

續約變更配置方式。

取值:

  • TEMP_UPGRADE:短時升配。

  • UPGRADE:升配。

BandwidthPackageChargeType

String

頻寬包的計費方式。

ReservationInternetChargeType

String

變更配置之後的計費方式。

GeographicRegionAId

String

要查詢的地區ID。

取值:

  • china:中國內地。

  • asia-pacific:亞太地區。

  • europe:歐洲。

  • australia:澳洲。

  • north-america:北美。

Bandwidth

Number

頻寬包的峰值頻寬。

Description

String

頻寬包描述。

ExpiredTime

String

頻寬包逾時時間。

採用ISO8601格式表示,格式為:YYYY-MM-DDThh:mmZ。

ReservationBandwidth

String

臨時升配結束後恢複的頻寬。

GeographicSpanId

String

地區對應的ID。

GeographicRegionBId

String

頻寬包執行個體的另一個互連地區ID。

取值:

  • china:中國內地。

  • asia-pacific:亞太地區。

  • europe:歐洲。

  • australia:澳洲。

  • north-america:北美。

IsCrossBorder

Boolean

是否是跨境頻寬包。

取值:

  • true:是跨境頻寬包。

  • false:不是跨境頻寬包。

BusinessStatus

String

頻寬包的狀態。

取值:

  • Normal:正常。

  • FinancialLocked:欠費鎖定。

  • SecurityLocked:安全風控鎖定。

Name

String

頻寬包的名稱。

HasReservationData

String

是否有續約資料。

取值:

  • true:有續約資料。

  • false:無續約資料。

說明

當參數IncludeReservationData取值為true,且有未生效的訂購資料時,本參數取值為true。

CenIds

List

頻寬包對應的雲企業網執行個體的列表。

例如:

[ "cen-xxjsjfkffkfkfjkf****" ]

OrginInterRegionBandwidthLimits

Map

互連地區的詳細資料。

例如:

{
      "BandwidthLimit" : "1",
      "OppositeRegionId" : "us-west-1",
      "GeographicSpanId" : "north-america_china",
      "LocalRegionId" : "cn-hangzhou"
    }

樣本

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IncludeReservationData": {
      "Type": "Boolean",
      "Description": "Specifies whether to include renewal data.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::CEN::CenBandwidthPackages",
      "Properties": {
        "IncludeReservationData": {
          "Ref": "IncludeReservationData"
        }
      }
    }
  },
  "Outputs": {
    "CenBandwidthPackages": {
      "Description": "The information about CenBandwidthPackages.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CenBandwidthPackages"
        ]
      }
    },
    "CenBandwidthPackageIds": {
      "Description": "The list of The Cen bandwidth ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CenBandwidthPackageIds"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IncludeReservationData:
    Type: Boolean
    Description: Specifies whether to include renewal data.
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::CEN::CenBandwidthPackages
    Properties:
      IncludeReservationData:
        Ref: IncludeReservationData
Outputs:
  CenBandwidthPackages:
    Description: The information about CenBandwidthPackages.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CenBandwidthPackages
  CenBandwidthPackageIds:
    Description: The list of The Cen bandwidth ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CenBandwidthPackageIds