API 一括廃止 - CloudOps Orchestration Service - Alibaba Cloud ドキュメントセンター

テンプレート名

ACS-ApiGateway-BulkyAbolishApi

今すぐ実行

テンプレートの説明

実行環境から API 操作を公開停止します。

テンプレートの種類

自動化

所有者

Alibaba Cloud

入力パラメーター

パラメーター	説明	データ型	必須	デフォルト値	制限
instanceId	API Gateway インスタンスの ID。	String	はい
regionId	リージョン ID。	String	いいえ	{{ ACS::RegionId }}
rateControl	レート制御設定。	Json	いいえ	{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10}
OOSAssumeRole	CloudOps Orchestration Service (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  
  name-en: ACS-ApiGateway-BulkyAbolishApi   
  categories:
    - security
Parameters:
  regionId:
    Label:
      en: RegionId       
    Type: String
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  instanceId:
    Label:
      en: InstanceId       
    Type: String
  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: describeApi
    Action: ACS::ExecuteAPI
    Description:
      en: Query stage and groupid of the apigateway instance      
    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.     
    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:            
            en: Select instance
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:             
            en: Control Options