计划程序 CLI

利用 AWS 实例计划程序命令行界面（CLI），您可以配置计划和时段，并估算给定计划的成本节省。

先决条件

此解决方案中的 CLI 需要 Python 3.8+ 及最新版本的 boto3。

凭证

要使用计划程序 CLI，您必须拥有 AWS CLI 的凭证。有关更多信息，请参阅《AWS CLI 用户指南》中的配置和凭证文件设置。

您的凭证必须具备以下权限：

计划程序 CLI 发出的请求以及对应的响应将记录在 AdminCliRequestHandler-yyyymmdd 日志流中。

安装计划程序 CLI

命令结构

计划程序 CLI 在命令行中使用多部分结构。下一部分用于指定计划程序 CLI python 脚本。计划程序 CLI 包含用于指定要对时段和计划执行的操作的命令。可以通过命令行按任意顺序指定操作的特定参数。

scheduler-cli <command> <arguments>

常见参数

计划程序 CLI 支持以下参数，所有命令都可使用这些参数：

可用命令

create-period

描述

创建时段。时段必须包含至少以下一个项目：begintime、endtime、weekdays、months 或 monthdays。

参数

示例

$ scheduler-cli create-period --name "weekdays" --begintime 09:00 --endtime 18:00 --weekdays mon-fri --stack Scheduler
{
   "Period": {
      "Name": "weekdays",
      "Endtime": "18:00",
      "Type": "period",
      "Begintime": "09:00",
      "Weekdays": [
         "mon-fri"
      ]
   }
    }

create-schedule

描述

创建计划。

参数

示例

$ scheduler-cli create-schedule --name LondonOfficeHours --periods weekdays,weekends --timezone Europe/London --stack Scheduler
{
   "Schedule": {
      "Enforced": false,
      "Name": "LondonOfficeHours",
      "StopNewInstances": true,
      "Periods": [
         "weekends",
         "weekdays"
      ],
      "Timezone": "Europe/London",
      "Type": "schedule"
   }
}

delete-period

示例

$ scheduler-cli delete-period --name weekdays --stack Scheduler
{
   "Period": "weekdays"
}

delete-schedule

描述

删除现有计划

参数

示例

$ scheduler-cli delete-schedule --name LondonOfficeHours --stack Scheduler
{
   "Schedule": "LondonOfficeHours"
}

describe-periods

描述

列出已为实例计划程序堆栈配置的时段

参数

示例

$ scheduler-cli describe-periods --stack Scheduler
{
   "Periods": [
      {
         "Name": "first-monday-in-quarter",
         "Months": [
            "jan/3"
         ],
         "Type": "period",
         "Weekdays": [
            "mon#1"
         ],
         "Description": "Every first Monday of each quarter"
      },
      {
         "Description": "Office hours",
         "Weekdays": [
            "mon-fri"
         ],
         "Begintime": "09:00",
         "Endtime": "17:00",
         "Type": "period",
         "Name": "office-hours"
      },

      {
         "Name": "weekdays",
         "Endtime": "18:00",
         "Type": "period",
         "Weekdays": [
            "mon-fri"
         ],
         "Begintime": "09:00"
      },
      {
         "Name": "weekends",
         "Type": "period",
         "Weekdays": [
            "sat-sun"
         ],
         "Description": "Days in weekend"
      }
   ]
}

describe-schedules

描述

列出已为实例计划程序堆栈配置的计划。

参数

示例

$ scheduler-cli describe-schedules --stack Scheduler

{
   "Schedules": [
      {
         "OverrideStatus": "running",
         "Type": "schedule",
         "Name": "Running",
         "UseMetrics": false
      },
      {
         "Timezone": "UTC",
         "Type": "schedule",
         "Periods": [
            "working-days@t2.micro",
            "weekends@t2.nano"
         ],
         "Name": "scale-up-down"
      },
      {
         "Timezone": "US/Pacific",
         "Type": "schedule",
         "Periods": [
            "office-hours"
         ],
         "Name": "seattle-office-hours"
      },
      {
         "OverrideStatus": "stopped",
         "Type": "schedule",
         "Name": "stopped",
         "UseMetrics": true
      }
   ]
}

describe-schedule-usage

描述

列出计划内运行的所有时段，并计算实例的计费时长（以小时为单位）。使用此命令可模拟计划以计算潜在的成本节省，以及创建或更新计划后的运行时段。

参数

示例

$ scheduler-cli describe-schedule-usage --stack InstanceScheduler --name seattle-office-hours
{
   "Usage": {
      "2017-12-04": {
         "BillingHours": 8,
         "RunningPeriods": {
            "Office-hours": {
               "Begin": "12/04/17 09:00:00",
               "End": "12/04/17 17:00:00",
               "BillingHours": 8,
               "BillingSeconds": 28800
            }
         },
         "BillingSeconds": 28800
      }
   },
   "Schedule": "seattle-office-hours"

update-period

描述

更新现有时段

参数

update-period 命令支持与 create-period 命令相同的参数。有关参数的更多信息，请参阅 create period 命令。

update-schedule

描述

删除现有计划

参数

update-schedule 命令支持与 create-schedule 命令相同的参数。有关参数的更多信息，请参阅 create schedule 命令。

help

描述

显示计划程序 CLI 的有效命令和参数的列表。

示例

$ scheduler-cli --help
usage: scheduler-cli [-h] [--version]
                     {create-period,create-schedule,delete-period,delete-schedule,describe-periods,describe-schedule-usage,describe-schedules,update-period,update-schedule}
                     ...

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

subcommands:
  Valid subcommands

  {create-period,create-schedule,delete-period,delete-schedule,describe-periods,describe-schedule-usage,describe-schedules,update-period,update-schedule}
                        Commands help
    create-period       Creates a period
    create-schedule     Creates a schedule
    delete-period       Deletes a period
    delete-schedule     Deletes a schedule
    describe-periods    Describes configured periods
    describe-schedule-usage
                        Calculates periods and billing hours in which
                        instances are running
    describe-schedules  Described configured schedules
    update-period       Updates a period
    update-schedule     Updates a schedule

在将 --help 参数与特定命令结合使用时，此参数将显示该命令的有效子命令和参数。

特定命令示例

$ scheduler-cli describe-schedules --help
usage: scheduler-cli describe-schedules [-h] [--name NAME] [--query QUERY]
                                        [--region REGION] --stack STACK

optional arguments:
  -h, --help         show this help message and exit
  --name NAME        Name of the schedule
  --query QUERY      JMESPath query to transform or filter the result
  --region REGION    Region in which the Instance Scheduler stack is
                        deployed
  --stack STACK, -s STACK
                     Name of the Instance Scheduler stack