All Products
Search
Document Center

CloudOps Orchestration Service:ACS-Redis-FlushExpireKeys

Last Updated:Nov 22, 2024

Template name

ACS-Redis-FlushExpireKeys

Execute Now

Template description

Deletes expired keys on ApsaraDB for Redis instances.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

Targets

The destination instances.

Json

Yes

RegionId

The region ID.

String

No

{{ ACS::RegionId }}

RateControl

The rate control settings.

Json

No

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

OOSAssumeRole

The 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": [
                "kvstore:DescribeInstances",
                "kvstore:FlushExpireKeys"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

For more information, see ACS-Redis-FlushExpireKeys.yml at GitHub.

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: FlushExpireKeys of redis instances
   
  name-en: ACS-Redis-FlushExpireKeys
   
  categories:
    - security
Parameters:
  RegionId:
    Type: String
    Label:
      en: RegionId
       
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  Targets:
    Type: Json
    Label:
      en: TargetInstance
       
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: ALIYUN::Redis::Instance
      RegionId: regionId
  RateControl:
    Label:
      en: RateControl
       
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
       
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: GetInstance
    Description:
      en: Get the redis instances
       
    Action: ACS::SelectTargets
    Properties:
      ResourceType: ALIYUN::Redis::Instance
      RegionId: '{{ RegionId }}'
      Filters:
        - '{{ Targets }}'
    Outputs:
      instanceIds:
        Type: List
        ValueSelector: Instances.Instance[].InstanceId
  - Name: FlushExpireKeys
    Action: ACS::ExecuteApi
    Description:
      en: Flush expire keys of redis instances
       
    Properties:
      Service: r-kvstore
      API: FlushExpireKeys
      Parameters:
        InstanceId: '{{ ACS::TaskLoopItem }}'
        EffectiveTime: Immediately
    Loop:
      RateControl: '{{ RateControl }}'
      Items: '{{ GetInstance.instanceIds }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - config
        Label:
          default:
             
            en: Configure Parameters
      - Parameters:
          - regionId
          - instanceIds
        Label:
          default:
             
            en: Select Instances
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
             
            en: Control Options