全部产品
Search
文档中心

资源编排:ALIYUN::ECD::NetworkPackage

更新时间:Sep 06, 2024

ALIYUN::ECD::NetworkPackage类型用于为办公网络创建一个公网精品带宽。

语法

{
  "Type": "ALIYUN::ECD::NetworkPackage",
  "Properties": {
    "OfficeSiteId": String,
    "PromotionId": String,
    "Bandwidth": Integer,
    "AutoRenew": Boolean,
    "Period": Integer,
    "AutoPay": Boolean,
    "PayType": String,
    "PeriodUnit": String,
    "InternetChargeType": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Bandwidth

Integer

公网精品带宽的带宽大小。

单位:Mbps。取值范围:

  • 如果是包年包月精品带宽,则取值范围是2~1000。

  • 如果是按量付费精品带宽,且类型是按使用流量计费(PayByTraffic),则取值范围是2~200;

  • 如果是按量付费精品带宽,且类型是按固定带宽计费(PayByBandwidth),则取值范围是2~1000。

OfficeSiteId

String

办公网络ID。

AutoPay

Boolean

是否自动支付。

取值:

  • true:自动支付。请确保账户余额充足,否则会产生异常订单。(默认值)。

  • false:只产生订单,不支付。您可以登录控制台,在费用与成本的我的订单页面,根据返回的订单号进行支付。

AutoRenew

Boolean

是否自动续费。

取值:

  • true:自动续费。

  • false:不自动续费。

InternetChargeType

String

公网精品带宽的计费方式。

  • 当参数PayType取值为PrePaid时,取值范围:

    • PayByBandwidth:按固定带宽计费。

  • 当参数PayType取值为PostPaid时,取值范围:

    • PayByTraffic:按使用流量计费。

    • PayByBandwidth:按固定带宽计费。

PayType

String

付费类型。

取值:

  • PostPaid:按量付费。

  • PrePaid:包年包月。

Period

Integer

购买资源的时长。

单位由PeriodUnit指定。当参数PayType取值为PrePaid时才生效,且为必选值。如果PeriodUnit为Month,该参数的取值范围:

  • 1

  • 2

  • 3

  • 6

如果PeriodUnit为Year,该参数的取值范围:

  • 1

  • 2

  • 3

  • 4

  • 5

PeriodUnit

String

包年包月精品带宽的购买时长单位。

当参数PayType取值为PrePaid时才生效,且为必选值。取值:

  • Month:月。

  • Year:年。

  • Week:周。

PromotionId

String

优惠活动ID。

返回值

Fn::GetAtt

NetworkPackageId:精品带宽ID。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OfficeSiteId:
    Type: String
    Description:
      en: The ID of the workspace..
    Required: true
  Bandwidth:
    Type: Number
    Description:
      en: |-
        The maximum public bandwidth. Unit: Mbit/s.
        Valid values for the pay-by-data-transfer type (PayByTraffic): 10 to 200. 
         Valid values for the pay-by-bandwith type (PayByBandwidth): 10 to 1000.
    Required: true
    MinValue: 2
    MaxValue: 1000
  PayType:
    Type: String
    Description:
      en: |-
        The billing method of the Internet access package. Enumeration Value:
        PostPaid
        PrePaid
    AllowedValues:
      - PostPaid
      - PrePaid
    Required: false
  InternetChargeType:
    AssociationPropertyMetadata:
      LocaleKey: InternetChargeType
    Type: String
    Description:
      en: |-
        The metering method of the pay-as-you-go Internet access package. Valid values: 
        PayByTraffic: pay-by-data-transfer.
        PayByBandwidth: pay-by-bandwidth. 
        Default value: PayByTraffic.
    AllowedValues:
      - PayByTraffic
      - PayByBandwidth
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::ECD::NetworkPackage
    Properties:
      OfficeSiteId:
        Ref: OfficeSiteId
      Bandwidth:
        Ref: Bandwidth
      PayType:
        Ref: PayType
      InternetChargeType:
        Ref: InternetChargeType
Outputs:
  NetworkPackageId:
    Description: The ID of the Internet access package.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - NetworkPackageId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OfficeSiteId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace.."
      },
      "Required": true
    },
    "Bandwidth": {
      "Type": "Number",
      "Description": {
        "en": "The maximum public bandwidth. Unit: Mbit/s.\nValid values for the pay-by-data-transfer type (PayByTraffic): 10 to 200. \n Valid values for the pay-by-bandwith type (PayByBandwidth): 10 to 1000."
      },
      "Required": true,
      "MinValue": 2,
      "MaxValue": 1000
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "en": "The billing method of the Internet access package. Enumeration Value:\nPostPaid\nPrePaid"
      },
      "AllowedValues": [
        "PostPaid",
        "PrePaid"
      ],
      "Required": false
    },
    "InternetChargeType": {
      "AssociationPropertyMetadata": {
        "LocaleKey": "InternetChargeType"
      },
      "Type": "String",
      "Description": {
        "en": "The metering method of the pay-as-you-go Internet access package. Valid values: \nPayByTraffic: pay-by-data-transfer.\nPayByBandwidth: pay-by-bandwidth. \nDefault value: PayByTraffic."
      },
      "AllowedValues": [
        "PayByTraffic",
        "PayByBandwidth"
      ],
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::ECD::NetworkPackage",
      "Properties": {
        "OfficeSiteId": {
          "Ref": "OfficeSiteId"
        },
        "Bandwidth": {
          "Ref": "Bandwidth"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "InternetChargeType": {
          "Ref": "InternetChargeType"
        }
      }
    }
  },
  "Outputs": {
    "NetworkPackageId": {
      "Description": "The ID of the Internet access package.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "NetworkPackageId"
        ]
      }
    }
  }
}