ACS-ECS-BulkyCreateDiagnoseReportForInstanceConnectionFailure - CloudOps Orchestration Service

Template name

ACS-ECS-BulkyCreateDiagnoseReportForInstanceConnectionFailure - Bulk-creates diagnostic reports for failures to remotely connect to ECS instances

Execute Now

Template description

Creates diagnostics reports about failed connections for multiple Elastic Compute Service (ECS) instances at a time.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter	Description	Type	Required	Default value	Limit
targets	Target instance	String	Yes
regionId	The region ID.	String	No	{{ ACS::RegionId }}
rateControl	Concurrent task execution rate	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

Parameter	Description	Type
metricResults		Json

Permission policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:CreateDiagnosticReport",
                "ecs:DescribeCloudAssistantStatus",
                "ecs:DescribeDiagnosticReportAttributes",
                "ecs:DescribeInstances",
                "ecs:DescribeInstancesFullStatus"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "oos:GetApplicationGroup"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Details

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

Template content

FormatVersion: OOS-2019-06-01
Description:
  name-en: ACS-ECS-BulkyCreateDiagnoseReportForInstanceConnectionFailure
  name-zh-cn: Bulky create diagnostic report for ECS instance connection failure
  en: Bulky create diagnostic report for ECS instance connection failure
  zh-cn: Bulky create diagnostic report for ECS instance connection failure
Parameters:
  regionId:
    Type: String
    Label:
      en: RegionId
      zh-cn: Region ID
    AssociationProperty: RegionId
    Default: '{{ ACS::RegionId }}'
  targets:
    Type: String
    Label:
      en: TargetInstance
      zh-cn: Target Instance
    AssociationProperty: Targets
    AssociationPropertyMetadata:
      ResourceType: 'ALIYUN::ECS::Instance'
      RegionId: regionId
  rateControl:
    Label:
      en: RateControl
      zh-cn: Concurrency rate for task execution
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 10
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: The RAM role assumed by OOS
    Type: String
    Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: getInstance
  Description:
    en: Views the ECS instances
    zh-cn: Views the ECS instances
  Action: ACS::SelectTargets
  Properties:
    ResourceType: ALIYUN::ECS::Instance
    RegionId: '{{ regionId }}'
    Filters:
      - '{{ targets }}'
  Outputs:
    instanceIds:
      Type: List
      ValueSelector: Instances.Instance[].InstanceId
- Name: createDiagnosticReport
  Action: ACS::ECS::CreateDiagnoseReportForInstanceConnectionFailure
  Description:
    en: Create diagnostic report for ECS instance
    zh-cn: Create diagnostic report for ECS instance
  Properties:
    regionId: '{{ regionId }}'
    instanceId: '{{ ACS::TaskLoopItem }}'
  Loop:
    RateControl: '{{ rateControl }}'
    Items: '{{ getInstance.instanceIds }}'
    Outputs:
      metricResults:
        AggregateType: Fn::ListJoin
        AggregateField: metricResult
  Outputs:
    metricResult:
      Type: Json
      ValueSelector: .metricResults
Outputs:
  metricResults:
    Type: Json
    Value: '{{ createDiagnosticReport.metricResults }}'
Metadata:
  ALIYUN::OOS::Interface:
    ParameterGroups:
      - Parameters:
          - regionId
          - targets
        Label:
          default:
            zh-cn: Configure Parameters
            en: Configure Parameters
      - Parameters:
          - rateControl
          - OOSAssumeRole
        Label:
          default:
            zh-cn: Control Options
            en: Control Options