文档

ACS-ApiGateway-BulkyAbolishApi

更新时间:

模板名称

ACS-ApiGateway-BulkyAbolishApi 下线指定运行环境的指定API

立即执行

模板描述

下线指定运行环境的指定API

模板类型

自动化

所有者

Alibaba Cloud

输入参数

参数名称

描述

类型

是否必填

默认值

约束

instanceId

API网关实例ID

String

regionId

地域ID

String

{{ ACS::RegionId }}

rateControl

任务执行的并发比率

Json

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

OOSAssumeRole

OOS扮演的RAM角色

String

""

输出参数

执行此模板需要的权限策略

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "cloudapi:AbolishApi",
                "cloudapi:DescribeApi"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

详情

ACS-ApiGateway-BulkyAbolishApi详情

模板内容

FormatVersion: OOS-2019-06-01
Description:
  en: Abolishing a specified API in a specified stage
  zh-cn: 下线指定运行环境的指定API
  name-en: ACS-ApiGateway-BulkyAbolishApi
  name-zh-cn: 下线指定运行环境的指定API
  categories:
    - security
Parameters:
  regionId:
    Label:
      en: RegionId
      zh-cn: 地域ID
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceId:
    Label:
      en: InstanceId
      zh-cn: API网关实例ID
    Type: String
  rateControl:
    Label:
      en: RateControl
      zh-cn: 任务执行的并发比率
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: OOS扮演的RAM角色
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: describeApi
    Action: ACS::ExecuteAPI
    Description:
      en: Query stage and groupid of the apigateway instance
      zh-cn: 查询运行环境和分组信息
    Properties:
      Service: CLOUDAPI
      API: DescribeApi
      Parameters:
        RegionId: '{{ regionId }}'
        ApiId: '{{ instanceId }}'
    Outputs:
      stageName:
        Type: List
        ValueSelector: '.DeployedInfos.DeployedInfo[].StageName'
      groupId:
        Type: String
        ValueSelector: '.GroupId'
  - Name: abolishApi
    Action: ACS::ExecuteAPI
    Description:
      en: Abolishing a specified API in a specified stage.
      zh-cn: 下线指定运行环境的指定API。
    Properties:
      Service: CLOUDAPI
      API: AbolishApi
      Parameters:
        RegionId: '{{ regionId }}'
        ApiId: '{{ instanceId }}'
        GroupId: '{{ describeApi.groupId }}'
        StageName: '{{ ACS::TaskLoopItem }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ describeApi.stageName }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - instanceId
        Label:
          default:
            zh-cn: 选择实例
            en: Select instance
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: 高级选项
            en: Control Options