All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::VPC::CommonBandwidthPackages

    Document Center

    Resource Orchestration Service:DATASOURCE::VPC::CommonBandwidthPackages

    Last Updated:Aug 22, 2023

    DATASOURCE::VPC::CommonBandwidthPackages is used to query the elastic IP address (EIP) bandwidth plans in a specified region.

    Syntax

    {
  "Type": "DATASOURCE::VPC::CommonBandwidthPackages",
  "Properties": {
    "ResourceGroupId": String,
    "CommonBandwidthPackageName": String,
    "CommonBandwidthPackageId": 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 EIP bandwidth plan.

    None.

    CommonBandwidthPackageId

    String

    No

    Yes

    The ID of the EIP bandwidth plan.

    None.

    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 service state of the EIP bandwidth plan.

    Valid values:

    • Normal: The EIP bandwidth plan works as expected.

    • FinancialLocked: The EIP bandwidth plan has an overdue payment.

    • Unactivated: The EIP bandwidth plan is not activated.

    Ratio

    Integer

    The percentage of the minimum bandwidth commitment.

    This property is returned if the InternetChargeType property is set to PayBy95.

    Note

    This property is available only on the China site (aliyun.com).

    CommonBandwidthPackageName

    String

    The name of the EIP bandwidth plan.

    None.

    ExpiredTime

    String

    The time when the EIP bandwidth plan expires.

    The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.

    InternetChargeType

    String

    The metering method of the EIP bandwidth plan.

    Valid values:

    • PayBy95: the enhanced 95th percentile metering method.

    • PayByBandwidth: the pay-by-bandwidth metering method.

    • PayByDominantTraffic: the pay-by-data-transfer metering method based on data transfer in the dominant direction. The dominant direction is the direction in which a greater amount of data is transferred.

    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 state of the EIP bandwidth plan.

    Valid values:

    • Available: The EIP bandwidth plan is available.

    • Modifying: The EIP bandwidth plan is being modified.

    Description

    String

    The description of the EIP bandwidth plan.

    None.

    PaymentType

    String

    The billing method of the EIP bandwidth plan.

    Valid values:

    • postpaid: pay-as-you-go

    • prepaid: subscription

    ReservationBandwidth

    String

    The bandwidth value of the EIP bandwidth plan after the configurations are changed.

    Unit: Mbit/s.

    RegionId

    String

    The region ID of the EIP bandwidth plan.

    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 Pro or Premium is used.

    ReservationInternetChargeType

    String

    The metering method of the EIP bandwidth plan after the configurations are changed.

    Valid values:

    • PayBy95: the enhanced 95th percentile metering method

    • PayByBandwidth: the pay-by-bandwidth metering method

    • PayByDominantTraffic: the pay-by-data-transfer metering method based on data transfer in the dominant direction

    Isp

    String

    The line type.

    Valid values if your Alibaba Cloud account is added to the whitelist for multi-ISP bandwidth:

    • BGP: BGP (Multi-ISP)

    • BGP_PRO: BGP (Multi-ISP) Pro

    Valid values if your Alibaba Cloud account is added to 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

    Valid value if your services are deployed in China East 1 Finance: BGP_FinanceCloud

    PublicIpAddresses

    List

    Details of the public addresses that are associated with the EIP bandwidth plan.

    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 EIP public bandwidth is created by using the service account.

    Valid values:

    • 0: The EIP public bandwidth is not created by using the service account.

    • 1: The EIP public bandwidth is created by using the service account.

    CommonBandwidthPackageId

    String

    The ID of the EIP bandwidth plan.

    None.

    Bandwidth

    String

    The maximum bandwidth of the EIP bandwidth plan.

    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 time when the EIP bandwidth plan was created.

    The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.

    Examples

    • JSON format

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

      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