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

Syntax

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

Properties

Property name	Type	Required	Update allowed	Description	Constraints
ResourceGroupId	String	No	Yes	Resource group ID.	None
CommonBandwidthPackageName	String	No	Yes	Name of the Internet Shared Bandwidth instance.	None
CommonBandwidthPackageId	String	No	Yes	ID of the Internet Shared Bandwidth instance.	None
RefreshOptions	String	No	Yes	Refresh policy for the data source on stack update.	Valid values: Never (default): Does not refresh the data source on stack update. Always: Refreshes the data source on every stack update.

Return values (Fn::GetAtt)

CommonBandwidthPackageIds: IDs of the queried instances.
CommonBandwidthPackages: Details of the queried instances.

Property name	Type	Description	Constraints
CommonBandwidthPackageIds	List	IDs of the queried instances.	None
CommonBandwidthPackages	List	Details of the queried instances.	None
BusinessStatus	String	Business status of the instance.	Valid values: Normal: Running as expected. FinancialLocked: Overdue payment. Unactivated: Not activated.
Ratio	Integer	Minimum bandwidth percentage for the instance.	Returned only if InternetChargeType is set to PayBy95. Note Available only on the China site (www.aliyun.com).
CommonBandwidthPackageName	String	Name of the instance.	None
ExpiredTime	String	Expiration time of the instance.	Format: YYYY-MM-DDThh:mm:ssZ.
InternetChargeType	String	Billing method of the instance.	Valid values: PayBy95: Pay-by-enhanced-95th-percentile. PayByBandwidth: Pay-by-bandwidth. PayByDominantTraffic: Pay-by-dominant-traffic.
ReservationOrderType	String	Renewal method with specification change.	Valid values: RENEWCHANGE: Renewal with specification change. TEMP_UPGRADE: Temporary upgrade. UPGRADE: Upgrade.
Status	String	Status of the instance.	Valid values: Available: Available for use. Modification in progress.
Description	String	Description of the instance.	None
PaymentType	String	Billing method.	Valid values: postpaid: Pay-as-you-go. prepaid: Subscription.
ReservationBandwidth	String	Bandwidth after specification change.	Unit: Mbps.
RegionId	String	Region ID of the instance.	None
ResourceGroupId	String	Resource group ID.	None
HasReservationData	String	Whether a pending order exists.	Valid values: true: A pending order exists. false: No pending order exists.
SecurityProtectionTypes	List	Security protection level.	Valid values: Empty: Basic Anti-DDoS plan. AntiDDoS_Enhanced: Enhanced Anti-DDoS plan.
ReservationInternetChargeType	String	Billing method after specification change.	Valid values: PayBy95: Pay-by-enhanced-95th-percentile. PayByBandwidth: Pay-by-bandwidth. PayByDominantTraffic: Pay-by-dominant-traffic.
Isp	String	Line type.	If on the whitelist for multi-ISP bandwidth: BGP: BGP (Multi-ISP). BGP_PRO: BGP (Multi-ISP) Pro. If on the whitelist for single-ISP bandwidth: ChinaTelecom: China Telecom. ChinaUnicom: China Unicom. ChinaMobile: China Mobile. ChinaTelecom_L2: China Telecom L2. ChinaUnicom_L2: China Unicom L2. ChinaMobile_L2: China Mobile L2. For Alibaba Finance Cloud users in the Hangzhou region, the value is BGP_FinanceCloud.
PublicIpAddresses	List	Public IP addresses of the instance.	Example: `[ { "IpAddress" : "47.95.XX.XX", "AllocationId" : "eip-bp13e9i2qst4g6jzi****", "BandwidthPackageIpRelationStatus" : "BINDED" } ]`
DeletionProtection	Boolean	Whether deletion protection is enabled.	Valid values: true: Enabled. false: Disabled.
ServiceManaged	Integer	Whether the resource is created by a service account.	Valid values: 0: Not created by a service account. 1: Created by a service account.
CommonBandwidthPackageId	String	Instance ID.	None
Bandwidth	String	Peak bandwidth of the instance.	Unit: Mbps.
ReservationActiveTime	String	Renewal active time.	Format: YYYY-MM-DDThh:mm:ssZ.
CreateTime	String	Creation time.	Format: YYYY-MM-DDThh:mm:ssZ.

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