Query CEN bandwidth plan details for the current account - Resource Orchestration Service

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
IsOrKey	Boolean	No	Yes	Whether to apply the OR logic operator to the filters.	Valid values: true: The OR logic operator is applied to the filters. Bandwidth plans that match any filter are returned. false (default): The AND logic operator is applied to the filters. Only bandwidth plans that match all filters are returned.
Filter	List	No	Yes	The filters.	For more information, see Filter properties.
IncludeReservationData	Boolean	No	Yes	Whether to include renewal data.	Valid values: true false
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): Does not refresh data source resources when the stack is updated. Always: Refreshes data source resources when the stack is updated.

Filter syntax

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

Filter properties

Property

Type

Required

Editable

Description

Constraint

Value

List

No

The filter value. You can specify values based on the filter key.

Multiple values can be specified per filter key. Values are combined with OR logic, so bandwidth plans matching any value are returned.

Key

String

Yes

No

The filter key.

Valid values:

CenId: the CEN instance ID
Status: the bandwidth plan status
CenBandwidthPackageId: the bandwidth plan ID
Name: the bandwidth plan name

Return values (Fn::GetAtt)

CenBandwidthPackages: the bandwidth plan details.
CenBandwidthPackageIds: the bandwidth plan IDs.

Property	Type	Description	Constraint
CenBandwidthPackageIds	List	The bandwidth plan IDs.	None.
CenBandwidthPackages	List	The bandwidth plan details.	None.
ReservationActiveTime	String	The temporary upgrade expiration time.	None.
CenBandwidthPackageId	String	The bandwidth plan ID.	None.
Status	String	Whether the bandwidth plan is associated with a CEN instance.	Valid values: Idle: The bandwidth plan is not associated with a CEN instance. InUse: The bandwidth plan is associated with a CEN instance.
CreationTime	String	The time when the bandwidth plan was created.	The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format.
ReservationOrderType	String	The configuration change type during renewal.	Valid values: TEMP_UPGRADE: temporary upgrade UPGRADE: upgrade
BandwidthPackageChargeType	String	The billing method of the bandwidth plan.	None.
ReservationInternetChargeType	String	The billing method after the configuration change.	None.
GeographicRegionAId	String	The queried area ID.	Valid values: china: Chinese mainland asia-pacific: Asia Pacific europe: Europe australia: Australia north-america: North America
Bandwidth	Number	The maximum bandwidth of the bandwidth plan.	None.
Description	String	The bandwidth plan description.	None.
ExpiredTime	String	The bandwidth plan expiration time.	The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format.
ReservationBandwidth	String	The bandwidth restored when the temporary upgrade ends.	None.
GeographicSpanId	String	The connected area ID.	None.
GeographicRegionBId	String	The ID of the other area in the bandwidth plan's cross-region connection.	Valid values: china: Chinese mainland asia-pacific: Asia Pacific europe: Europe australia: Australia north-america: North America
IsCrossBorder	Boolean	Whether the bandwidth plan is a cross-border bandwidth plan.	Valid values: true false
BusinessStatus	String	The bandwidth plan state.	Valid values: Normal: The bandwidth plan works as expected. FinancialLocked: The bandwidth plan is locked due to overdue payments. SecurityLocked: The bandwidth plan is locked due to security reasons.
Name	String	The bandwidth plan name.	None.
HasReservationData	String	Whether renewal data is included.	Valid values: true false Note Returns true when IncludeReservationData is set to true and specific orders have not taken effect.
CenIds	List	The CEN instance IDs associated with the bandwidth plan.	Example: `[ "cen-xxjsjfkffkfkfjkf****" ]`
OrginInterRegionBandwidthLimits	Map	The cross-region connection details.	Example: `{ "BandwidthLimit" : "1", "OppositeRegionId" : "us-west-1", "GeographicSpanId" : "north-america_china", "LocalRegionId" : "cn-hangzhou" }`

Examples

`JSON` format

{
  "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` format

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