All Products
Search
Document Center

CloudOps Orchestration Service:ACS-BssOpenApi-EnableAutoRenewal

Last Updated:Dec 22, 2025

Template name

ACS-BssOpenApi-EnableAutoRenewal - Enables auto-renewal for a resource

Execute Now

Template description

Enables auto-renewal for resources.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Data type

Required

Default value

Limit

resourceIds

The IDs of the resources.

List

Yes

renewalPeriodUnit

The unit of the renewal period.

String

Yes

renewalPeriod

The renewal period.

Number

Yes

productCode

The product code.

String

Yes

OOSAssumeRole

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

String

Yes

regionId

The region ID.

String

No

{{ ACS::RegionId }}

Output parameters

N/A.

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "bss:ModifyPrepaidInstanceAutoRenew"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

ACS-BssOpenApi-EnableAutoRenewal

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Enable resource auto-renewal.
  name-en: ACS-BssOpenApi-EnableAutoRenewal
Parameters:
  regionId:
    Label:
      en: Region ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  resourceIds:
    Label:
      en: Resource IDs
    Type: List
  renewalPeriodUnit:
    Label:
      en: Renewal period unit
    Type: String
    AllowedValues:
      - M
      - Y
  renewalPeriod:
    Label:
      en: Renewal duration
    Type: Number
    AllowedValues:
      - 1
      - 2
      - 3
      - 6
      - 12
  productCode:
    Label:
      en: Product code
    Type: String
    AllowedValues:
      - ACS::Bastionhost::Instance
      - ACS::CBWP::CommonBandwidthPackage
      - ACS::ECS::Instance
      - ACS::EIP::EipAddress
      - ACS::MongoDB::DBInstance
      - ACS::Redis::DBInstance
      - ACS::ADB::DBCluster
      - ACS::RDS::DBInstance
      - ACS::PolarDB::DBCluster
      - ACS::SLB::LoadBalancer
      - ACS::DdosCoo::Instance
      - ACS::CEN::CenBandwidthPackage
      - ACS::KMS::Instance
      - ACS::VPN::VpnGateway
      - ACS::DRDS::DBInstance
      - ACS::DRDS::PolarDBXInstance
  OOSAssumeRole:
    Label:
      en: The RAM role assumed by OOS
    Type: String
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: ModifyInstanceRenewAttribute
    Action: ACS::ExecuteAPI
    Description:
      en: Modifies the auto-renewal settings of the instance.
    Properties:
      Service: BssOpenApi
      API: SetRenewal
      Parameters:
        RegionId: '{{ regionId }}'
        InstanceIDs:
          Fn::Join:
            - ','
            - '{{ resourceIds }}'
        RenewalStatus: 'AutoRenewal'
        RenewalPeriod: '{{ renewalPeriod }}'
        RenewalPeriodUnit: '{{ renewalPeriodUnit }}'
        ProductCode:
          Fn::Select:
            - '{{ productCode }}'
            - ACS::CBWP::CommonBandwidthPackage: cbwp
              ACS::Bastionhost::Instance: bastionhost
              ACS::ECS::Instance: ecs
              ACS::EIP::EipAddress: eip
              ACS::MongoDB::DBInstance: dds
              ACS::Redis::DBInstance: redisa
              ACS::ADB::DBCluster: ads
              ACS::RDS::DBInstance: rds
              ACS::PolarDB::DBCluster: polardb
              ACS::SLB::LoadBalancer: slb
              ACS::DdosCoo::Instance: ddos
              ACS::CEN::CenBandwidthPackage: cbn
              ACS::KMS::Instance: kms
              ACS::VPN::VpnGateway: vpn
              ACS::DRDS::DBInstance: drds
              ACS::DRDS::PolarDBXInstance: drds
        ProductType:
          Fn::Select:
            - '{{ productCode }}'
            - ACS::CBWP::CommonBandwidthPackage: ''
              ACS::Bastionhost::Instance: bastionhost
              ACS::ECS::Instance: ''
              ACS::EIP::EipAddress: ''
              ACS::MongoDB::DBInstance: ''
              ACS::Redis::DBInstance: ''
              ACS::ADB::DBCluster: ''
              ACS::RDS::DBInstance: rds
              ACS::PolarDB::DBCluster: online
              ACS::SLB::LoadBalancer: ''
              ACS::DdosCoo::Instance: 'ddoscoo'
              ACS::CEN::CenBandwidthPackage: 'cbn_bwp_pre'
              ACS::KMS::Instance: ''
              ACS::VPN::VpnGateway: ''
              ACS::DRDS::DBInstance: ''
              ACS::DRDS::PolarDBXInstance: ''
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - productCode
          - resourceIds
        Label:
          default:
            en: Select resources
      - Parameters:
          - renewalPeriodUnit
          - renewalPeriod
        Label:
          default:
            en: Set renewal parameters
      - Parameters:
          - OOSAssumeRole
        Label:
          default:
            en: Advanced options