Use DATASOURCE::VPC::CommonBandwidthPackages to query the Internet Shared Bandwidth instances in a region - Resource Orchestration Service

DATASOURCE::VPC::CommonBandwidthPackages is used to query the Internet Shared Bandwidth instances in a region.

Syntax

{
  "Type": "DATASOURCE::VPC::CommonBandwidthPackages",
  "Properties": {
    "ResourceGroupId": String,
    "CommonBandwidthPackageName": String,
    "CommonBandwidthPackageId": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
CommonBandwidthPackageName	String	No	Yes	The name of the Internet Shared Bandwidth instance.	None.
CommonBandwidthPackageId	String	No	Yes	The ID of the Internet Shared Bandwidth instance.	None.
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.

Return values (Fn::GetAtt)

CommonBandwidthPackageIds: the IDs of the Internet Shared Bandwidth instances.
CommonBandwidthPackages: details of the Internet Shared Bandwidth instances.

Property	Type	Description	Constraint
CommonBandwidthPackageIds	List	The IDs of the Internet Shared Bandwidth instances.	None.
CommonBandwidthPackages	List	Details of the Internet Shared Bandwidth instances.	None.
BusinessStatus	String	The business status of the Internet Shared Bandwidth instance.	Valid values: Normal: The Internet Shared Bandwidth instance works as expected. FinancialLocked: The Internet Shared Bandwidth instance has an overdue payment. Unactivated: The Internet Shared Bandwidth instance is not activated.
Ratio	Integer	The percentage of the minimum bandwidth commitment of the Internet Shared Bandwidth instance.	This property is returned if InternetChargeType is set to PayBy95. Note The Ratio property is available only on the China site (aliyun.com).
CommonBandwidthPackageName	String	The name of the Internet Shared Bandwidth instance.	None.
ExpiredTime	String	The expiration time of the Internet Shared Bandwidth instance.	The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.
InternetChargeType	String	The metering method of the Internet Shared Bandwidth instance.	Valid values: PayBy95: pay-by-enhanced-95th-percentile PayByBandwidth: pay-by-bandwidth PayByDominantTraffic: pay-by-dominant-data-transfer
ReservationOrderType	String	The type of the configuration change during renewal.	Valid values: RENEWCHANGE: renewal with a configuration change TEMP_UPGRADE: temporary upgrade UPGRADE: upgrade
Status	String	The status of the Internet Shared Bandwidth instance.	Valid values: Available: The Internet Shared Bandwidth instance is available. Modifying: The Internet Shared Bandwidth instance is being modified.
Description	String	The description of the Internet Shared Bandwidth instance.	None.
PaymentType	String	The billing method.	Valid values: postpaid: pay-as-you-go prepaid: subscription
ReservationBandwidth	String	The bandwidth of the Internet Shared Bandwidth instance after the instance configurations are changed.	Unit: Mbit/s.
RegionId	String	The region ID of the Internet Shared Bandwidth instance.	None.
ResourceGroupId	String	The ID of the resource group.	None.
HasReservationData	String	Indicates whether orders that have not taken effect exist.	Valid values: true false
SecurityProtectionTypes	List	The editions of Anti-DDoS.	Valid values: Null: If Null is returned, Anti-DDoS Origin is used by default. AntiDDoS_Enhanced: If AntiDDoS_Enhanced is returned, Anti-DDoS Proxy is used.
ReservationInternetChargeType	String	The metering method of the Internet Shared Bandwidth instance after the instance configurations are changed.	Valid values: PayBy95: pay-by-enhanced-95th-percentile PayByBandwidth: pay-by-bandwidth PayByDominantTraffic: pay-by-dominant-data-transfer
Isp	String	The line type.	Valid values when your account is included in the multi-ISP bandwidth whitelist: BGP: BGP (Multi-ISP) BGP_PRO: BGP (Multi-ISP) Pro Valid values when your account is included in the single-ISP bandwidth whitelist: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 Valid value when your services are deployed in China East 1 Finance: BGP_FinanceCloud
PublicIpAddresses	List	Details of the public IP addresses that are associated with the Internet Shared Bandwidth instance.	Example: `[ { "IpAddress" : "47.95.XX.XX", "AllocationId" : "eip-bp13e9i2qst4g6jzi****", "BandwidthPackageIpRelationStatus" : "BINDED" } ]`
DeletionProtection	Boolean	Indicates whether deletion protection is enabled.	Valid values: true false
ServiceManaged	Integer	Indicates whether the Internet Shared Bandwidth instance is created by using the service account.	Valid values: 0: The Internet Shared Bandwidth instance is not created by using the service account. 1: The Internet Shared Bandwidth instance is created by using the service account.
CommonBandwidthPackageId	String	The ID of the Internet Shared Bandwidth instance.	None.
Bandwidth	String	The maximum bandwidth of the Internet Shared Bandwidth instance.	Unit: Mbit/s.
ReservationActiveTime	String	The time when the renewal takes effect.	The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.
CreateTime	String	The creation time.	The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CommonBandwidthPackageName": {
      "Type": "String",
      "Description": "The name of the Internet Shared Bandwidth instance."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CommonBandwidthPackages",
      "Properties": {
        "CommonBandwidthPackageName": {
          "Ref": "CommonBandwidthPackageName"
        }
      }
    }
  },
  "Outputs": {
    "CommonBandwidthPackages": {
      "Description": "The list of common bandwidth packages.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackages"
        ]
      }
    },
    "CommonBandwidthPackageIds": {
      "Description": "The list of common bandwidth package IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CommonBandwidthPackageName:
    Type: String
    Description: The name of the Internet Shared Bandwidth instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::CommonBandwidthPackages
    Properties:
      CommonBandwidthPackageName:
        Ref: CommonBandwidthPackageName
Outputs:
  CommonBandwidthPackages:
    Description: The list of common bandwidth packages.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackages
  CommonBandwidthPackageIds:
    Description: The list of common bandwidth package IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageIds