文档

DATASOURCE::CEN::CenBandwidthPackages

更新时间:

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