All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ECS-BulkyRenewInstances

Last Updated:Nov 01, 2024

Template name

ACS-ECS-BulkyRenewInstances

Execute Now

Template description

Renews multiple subscription 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 that you want to renew.

Json

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

periodUnit

The unit of the subscription duration of the ECS instances after renewal.

String

No

Month

period

The renewal duration of the subscription instance.

Number

No

1

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:RenewInstance"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

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

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Bulky renew ECS prepaid instances
  zh-cn: the description in Chinese
  name-en: Bulky Renew Instances
  name-zh-cn: the description in Chinese
  categories:
    - instance_manage
    - application_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
  periodUnit:
    Description:
      en: The unit of the renewal period (Period)
      zh-cn: the description in Chinese
          
         
    Label:
      en: PeriodUnit
      zh-cn: the description in Chinese
    Type: String
    AssociationPropertyMetadata:
      LocaleKey: PricingCycle
    AllowedValues:
      - Week
      - Month
    Default: Month
  period:
    Label:
      en: Period
      zh-cn: the description in Chinese
    Type: Number
    Default: 1
    MinValue: 1
    MaxValue: 60
  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'
      Filters:
        - '{{ targets }}'
    Outputs:
      instanceIds:
        Type: List
        ValueSelector: 'Instances.Instance[].InstanceId'
  - Name: renewInstance
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Renew ECS instance with the specified instance ID
      zh-cn: the description in Chinese
    Properties:
      Service: ECS
      API: RenewInstance
      Parameters:
        RegionId: '{{regionId}}'
        InstanceId: '{{ ACS::TaskLoopItem }}'
        Period: '{{ period }}'
        PeriodUnit: '{{ periodUnit }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ getInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - periodUnit
          - period
        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