DATASOURCE::VPC::CommonBandwidthPackage_资源编排(ROS)-阿里云帮助中心

DATASOURCE::VPC::CommonBandwidthPackage类型用于查询指定地域的单个共享带宽实例详情。

语法

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

属性

属性名称	类型	必须	允许更新	描述	约束
CommonBandwidthPackageName	String	否	是	共享带宽名称。	无
CommonBandwidthPackageId	String	否	是	共享带宽实例ID。	无
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	有效值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

Status：共享带宽实例的状态。
Description：共享带宽的描述信息。
ResourceGroupId：资源组ID。
CommonBandwidthPackageName：共享带宽实例名称。
ServiceManaged：是否为服务账号创建的资源。
InstanceChargeType：实例的计费方式。
Isp：线路类型。
HasReservationData：是否有待生效的订单。
DeletionProtection：是否开启删除保护。
BusinessStatus：共享带宽实例的业务状态。
ReservationInternetChargeType：变配之后的计费方式。
InternetChargeType：共享带宽的计费方式。
ReservationOrderType：续费变配方式。
Bandwidth：共享带宽的带宽峰值。
ExpiredTime：共享带宽实例的过期时间。
CreationTime：创建时间。
PublicIpAddresses：共享带宽实例中的公网IP地址。
Ratio：共享带宽的保底百分比。
ReservationActiveTime：续费生效时间。
ReservationBandwidth：变配之后的带宽值。
CommonBandwidthPackageId：共享带宽实例的ID。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CommonBandwidthPackageName:
    Type: String
    Description:
      en: The name of the Internet Shared Bandwidth instance.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::VPC::CommonBandwidthPackage
    Properties:
      CommonBandwidthPackageName:
        Ref: CommonBandwidthPackageName
Outputs:
  Status:
    Description: |-
      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.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Status
  Description:
    Description: The description of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  CommonBandwidthPackageName:
    Description: The name of the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageName
  ServiceManaged:
    Description: |-
      Indicates whether the resource is created by the service account. Valid values:
      * 0: The resource is not created by the service account.
      * 1: The resource is created by the service account.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ServiceManaged
  InstanceChargeType:
    Description: |-
      The billing method of the Internet Shared Bandwidth instance. Valid value:
      * PostPaid: pay-as-you-go
      * PrePaid: subscription
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceChargeType
  Isp:
    Description: |-
      The line type. Valid values:
      BGP (default): BGP (Multi-ISP) lines.
      BGP_PRO: BGP (Multi-ISP) Pro lines.
      Valid values if you are allowed to use single-ISP bandwidth:
      ChinaTelecom
      ChinaUnicom
      ChinaMobile
      ChinaTelecom_L2
      ChinaUnicom_L2
      ChinaMobile_L2
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Isp
  HasReservationData:
    Description: |-
      Indicates whether the information about pending orders is returned. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HasReservationData
  DeletionProtection:
    Description: |-
      Indicates whether deletion protection is enabled. Valid values:
      * false
      * true
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DeletionProtection
  BusinessStatus:
    Description: |-
      The service status of the Internet Shared Bandwidth instance. Valid values:
      * Normal: The Internet Shared Bandwidth instance runs as expected.
      * FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance
      * Unactivated: The Internet Shared Bandwidth instance is not activated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - BusinessStatus
  ReservationInternetChargeType:
    Description: |-
      The metering method after the configurations are changed. Valid value:
      * PayBy95: Charged by Enhanced 95th Percentile.
      * PayByBandwidth: Charged by Bandwidth.
      * PayByDominantTraffic: Charged by Dominant Traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationInternetChargeType
  InternetChargeType:
    Description: |-
      The metering method of the Internet Shared Bandwidth instance. Valid value:
      * PayBy95: Charged by Enhanced 95th Percentile.
      * PayByBandwidth: Charged by Bandwidth.
      * PayByDominantTraffic: Charged by Dominant Traffic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InternetChargeType
  ReservationOrderType:
    Description: |-
      The renewal method. Valid values:
      * RENEWCHANGE: renewal with a specification change
      * TEMP_UPGRADE: renewal with a temporary upgrade
      * UPGRADE: renewal with an upgrade
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationOrderType
  Bandwidth:
    Description: 'The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Bandwidth
  ExpiredTime:
    Description: The time when the Internet Shared Bandwidth instance expired. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExpiredTime
  CreationTime:
    Description: The time when the Internet Shared Bandwidth instance was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreationTime
  PublicIpAddresses:
    Description: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PublicIpAddresses
  Ratio:
    Description: The percentage of the minimum bandwidth commitment. Only 20 is returned.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Ratio
  ReservationActiveTime:
    Description: The time when the renewal took effect. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationActiveTime
  ReservationBandwidth:
    Description: 'The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ReservationBandwidth
  CommonBandwidthPackageId:
    Description: The ID of the Internet shared bandwidth.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CommonBandwidthPackageId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CommonBandwidthPackageName": {
      "Type": "String",
      "Description": {
        "en": "The name of the Internet Shared Bandwidth instance."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CommonBandwidthPackage",
      "Properties": {
        "CommonBandwidthPackageName": {
          "Ref": "CommonBandwidthPackageName"
        }
      }
    }
  },
  "Outputs": {
    "Status": {
      "Description": "The status of the Internet Shared Bandwidth instance. Valid values:\n* Available: The Internet Shared Bandwidth instance is available.\n* Modifying: The Internet Shared Bandwidth instance is being modified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Status"
        ]
      }
    },
    "Description": {
      "Description": "The description of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CommonBandwidthPackageName": {
      "Description": "The name of the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageName"
        ]
      }
    },
    "ServiceManaged": {
      "Description": "Indicates whether the resource is created by the service account. Valid values:\n* 0: The resource is not created by the service account.\n* 1: The resource is created by the service account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ServiceManaged"
        ]
      }
    },
    "InstanceChargeType": {
      "Description": "The billing method of the Internet Shared Bandwidth instance. Valid value:\n* PostPaid: pay-as-you-go\n* PrePaid: subscription",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceChargeType"
        ]
      }
    },
    "Isp": {
      "Description": "The line type. Valid values:\nBGP (default): BGP (Multi-ISP) lines.\nBGP_PRO: BGP (Multi-ISP) Pro lines.\nValid values if you are allowed to use single-ISP bandwidth:\nChinaTelecom\nChinaUnicom\nChinaMobile\nChinaTelecom_L2\nChinaUnicom_L2\nChinaMobile_L2",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Isp"
        ]
      }
    },
    "HasReservationData": {
      "Description": "Indicates whether the information about pending orders is returned. Valid values:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasReservationData"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "Indicates whether deletion protection is enabled. Valid values:\n* false\n* true",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DeletionProtection"
        ]
      }
    },
    "BusinessStatus": {
      "Description": "The service status of the Internet Shared Bandwidth instance. Valid values:\n* Normal: The Internet Shared Bandwidth instance runs as expected.\n* FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance\n* Unactivated: The Internet Shared Bandwidth instance is not activated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "BusinessStatus"
        ]
      }
    },
    "ReservationInternetChargeType": {
      "Description": "The metering method after the configurations are changed. Valid value:\n* PayBy95: Charged by Enhanced 95th Percentile.\n* PayByBandwidth: Charged by Bandwidth.\n* PayByDominantTraffic: Charged by Dominant Traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationInternetChargeType"
        ]
      }
    },
    "InternetChargeType": {
      "Description": "The metering method of the Internet Shared Bandwidth instance. Valid value:\n* PayBy95: Charged by Enhanced 95th Percentile.\n* PayByBandwidth: Charged by Bandwidth.\n* PayByDominantTraffic: Charged by Dominant Traffic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InternetChargeType"
        ]
      }
    },
    "ReservationOrderType": {
      "Description": "The renewal method. Valid values:\n* RENEWCHANGE: renewal with a specification change\n* TEMP_UPGRADE: renewal with a temporary upgrade\n* UPGRADE: renewal with an upgrade",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationOrderType"
        ]
      }
    },
    "Bandwidth": {
      "Description": "The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "The time when the Internet Shared Bandwidth instance expired. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpiredTime"
        ]
      }
    },
    "CreationTime": {
      "Description": "The time when the Internet Shared Bandwidth instance was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreationTime"
        ]
      }
    },
    "PublicIpAddresses": {
      "Description": "The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddresses"
        ]
      }
    },
    "Ratio": {
      "Description": "The percentage of the minimum bandwidth commitment. Only 20 is returned.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ratio"
        ]
      }
    },
    "ReservationActiveTime": {
      "Description": "The time when the renewal took effect. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationActiveTime"
        ]
      }
    },
    "ReservationBandwidth": {
      "Description": "The new maximum bandwidth after the configurations are changed. Unit: Mbit/s.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReservationBandwidth"
        ]
      }
    },
    "CommonBandwidthPackageId": {
      "Description": "The ID of the Internet shared bandwidth.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommonBandwidthPackageId"
        ]
      }
    }
  }
}