All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ECS-BulkyUpgradeInternetBandwidth

Last Updated:Nov 26, 2024

Template name

ACS-ECS-BulkyUpgradeInternetBandwidth

Execute Now

Template description

Upgrades the public bandwidth of multiple Elastic Compute Service (ECS) instances at a time.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

targets

The ECS instances whose public bandwidth you want to upgrade.

Json

Yes

maxBandwidthIn

The maximum inbound public bandwidth.

Number

Yes

maxBandwidthOut

The maximum outbound public bandwidth.

Number

Yes

startTime

The time when the public bandwidth upgrade starts.

String

Yes

endTime

The time when the public bandwidth upgrade ends.

String

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

rateControl

The rate control settings.

Json

No

{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}

OOSAssumeRole

The Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS).

String

No

""

Output parameters

None

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DescribeInstances",
                "ecs:ModifyInstanceNetworkSpec"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

For more information, see ACS-ECS-BulkyUpgradeInternetBandwidth.yml at GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Bulky upgrades internet bandwidth of ECS instances
  zh-cn: the description in Chinese
  name-en: ACS-ECS-BulkyUpgradeInternetBandwidth
  name-zh-cn: the description in Chinese
  categories:
    - instance_manage
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: the description in Chinese
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: Json
    Label:
      en: TargetInstance
      zh-cn: the description in Chinese
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: ALIYUN::ECS::Instance
      RegionId: regionId
  maxBandwidthIn:
    Label:
      en: MaxBandwidthIn
      zh-cn: the description in Chinese
    Type: Number
    MinValue: 1
    MaxValue: 200
  maxBandwidthOut:
    Label:
      en: MaxBandwidthOut
      zh-cn: the description in Chinese
    Type: Number
    MinValue: 0
    MaxValue: 100
  startTime:
    Label:
      en: StartTime
      zh-cn: the description in Chinese
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'YYYY-MM-DDTHH:mmZ'
  endTime:
    Label:
      en: EndTime
      zh-cn: the description in Chinese
    Type: String
    AssociationProperty: DateTime
    AssociationPropertyMetadata:
      Format: 'YYYY-MM-DDTHHZ'
  rateControl:
    Label:
      en: RateControl
      zh-cn: the description in Chinese
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: the description in Chinese
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: getInstance
  Description:
    en: Views the ECS instances
    zh-cn: the description in Chinese
  Action: ACS::SelectTargets
  Properties:
    ResourceType: ALIYUN::ECS::Instance
    RegionId: '{{ regionId }}'
    Filters:
      - '{{ targets }}'
  Outputs:
    instanceIds:
      Type: List
      ValueSelector: Instances.Instance[].InstanceId
- Name: modifyInstanceNetworkSpec
  Action: ACS::ExecuteAPI
  Description:
    en: Modifies the temporary bandwidth of the ECS instance with the specified parameters
    zh-cn: the description in Chinese
  Properties:
    Service: ECS
    API: ModifyInstanceNetworkSpec
    Parameters:
      RegionId: '{{ regionId }}'
      InstanceId: '{{ ACS::TaskLoopItem }}'
      InternetMaxBandwidthIn: '{{ maxBandwidthIn }}'
      InternetMaxBandwidthOut: '{{ maxBandwidthOut }}'
      StartTime: '{{ startTime }}'
      EndTime: '{{ endTime }}'
  Loop:
    RateControl: '{{ rateControl }}'
    Items: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - maxBandwidthIn
          - maxBandwidthOut
          - startTime
          - endTime
        Label:
          default:
            zh-cn: the description in Chinese
            en: Configure Parameters
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: the description in Chinese
            en: Select Ecs Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: the description in Chinese
            en: Control Options