通過阿里云Python SDK,您不用復雜編程即可訪問阿里云服務。本教程以運行Linux系統的電腦為例,介紹如何使用阿里云Python SDK調用系統運維管理 OOS(CloudOps Orchestration Service)的API執行滾動升級任務。
背景信息
滾動升級是指通過任務形式批量更新ECS實例配置。通過滾動升級,您可以為伸縮組內處于服務中狀態的ECS實例批量更新鏡像、執行腳本或者安裝OOS軟件包。
前提條件
已創建RAM用戶并獲取AccessKey,如果沒有,請創建RAM用戶的AccessKey。在調用阿里云API時您需要使用AccessKey完成身份驗證。
重要為避免主賬號泄露AccessKey帶來的安全風險,強烈建議您創建RAM用戶,授予RAM用戶相關訪問權限,再使用RAM用戶的AccessKey調用SDK。具體操作,請參見彈性伸縮系統權限策略參考。
RAM用戶的AccessKey Secret只能在創建AccessKey時顯示,創建完成后不支持查看。請在創建好AccessKey后,及時并妥善保存AccessKey Secret。
已配置環境變量,如果沒有,請參見在Linux、macOS和Windows系統配置環境變量。本文通過配置環境變量(
ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
)的方式配置Alibaba Cloud Credentials工具的身份驗證,實現以非AK硬編碼的方式訪問阿里云OpenAPI。已創建伸縮組并添加ECS實例。具體操作,請參見基于ECS實例創建伸縮組。
已在本地電腦中安裝Python,且版本不低于3.6。
步驟一:安裝阿里云Python SDK
確認是否已安裝Python。
python --version
返回Python版本表明已安裝Python,示例如下圖所示。
安裝系統運維管理 OOS(CloudOps Orchestration Service)的依賴。
pip install alibabacloud_oos20190601==3.2.1
步驟二:執行滾動升級任務
創建Python腳本并輸入執行滾動升級任務的代碼。
示例代碼中涉及的OOS模板參數說明,請參見模板參數說明。示例代碼如下:
# -*- coding: utf-8 -*- import os import sys from typing import List from alibabacloud_oos20190601.client import Client as oos20190601Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_oos20190601 import models as oos_20190601_models from alibabacloud_tea_util import models as util_models from alibabacloud_tea_util.client import Client as UtilClient class Sample: def __init__(self): pass @staticmethod def create_client() -> oos20190601Client: """ 使用AK&SK初始化賬號Client @return: Client @throws Exception """ # 工程代碼泄露可能會導致 AccessKey 泄露,并威脅賬號下所有資源的安全性。以下代碼示例僅供參考。 config = open_api_models.Config( # 必填,請確保代碼運行環境設置了環境變量 ALIBABA_CLOUD_ACCESS_KEY_ID。, access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'], # 必填,請確保代碼運行環境設置了環境變量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。, access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'] ) config.endpoint = f'oos.cn-hangzhou.aliyuncs.com' return oos20190601Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() tags = { 'scaling_group': 'asg-bp1******' } start_execution_request = oos_20190601_models.StartExecutionRequest( region_id='cn-hangzhou', template_name='ACS-ESS-RollingUpdateByRunCommandInScalingGroup', parameters='''{"invokeType": "invoke", "scalingGroupId": "asg-bp1******", "commandType": "RunShellScript", "invokeScript": "df -h;ifconfig", "rollbackScript": "df -h;ifconfig", "OOSAssumeRole": "", "exitProcess": [ "ScaleIn", "ScaleOut", "HealthCheck", "AlarmNotification", "ScheduledAction" ], "enterProcess": [ "ScaleIn", "ScaleOut", "HealthCheck", "AlarmNotification", "ScheduledAction" ], "batchNumber": 2, "batchPauseOption": "Automatic"}''', tags=tags ) runtime = util_models.RuntimeOptions() try: # 復制代碼運行請自行打印 API 的返回值 resp = client.start_execution_with_options(start_execution_request, runtime) print(resp.body) except Exception as error: # 此處僅做打印展示,請謹慎對待異常處理,在工程項目中切勿直接忽略異常。 # 錯誤 message print(error.message) # 診斷地址 print(error.data.get("Recommend")) UtilClient.assert_as_string(error.message) if __name__ == '__main__': Sample.main(sys.argv[1:])
運行Python腳本并查看返回信息。
說明執行回滾任務時需要填入源滾動升級任務的執行ID。您可以在命令的返回信息中找到滾動升級任務的執行ID等信息,如下圖所示即代表運行成功。
步驟三:(可選)執行回滾任務
如果滾動升級過程中出現異常,或者滾動升級后又需要使用歷史配置,您可以執行回滾任務為伸縮組內ECS實例恢復配置。
創建Python腳本并輸入執行回滾任務的代碼。
示例代碼中涉及的OOS模板參數說明,請參見模板參數說明。示例代碼如下:
# -*- coding: utf-8 -*- import os import sys from typing import List from alibabacloud_oos20190601.client import Client as oos20190601Client from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_oos20190601 import models as oos_20190601_models from alibabacloud_tea_util import models as util_models from alibabacloud_tea_util.client import Client as UtilClient class Sample: def __init__(self): pass @staticmethod def create_client() -> oos20190601Client: """ 使用AK&SK初始化賬號Client @return: Client @throws Exception """ # 工程代碼泄露可能會導致 AccessKey 泄露,并威脅賬號下所有資源的安全性。以下代碼示例僅供參考。 config = open_api_models.Config( # 必填,請確保代碼運行環境設置了環境變量 ALIBABA_CLOUD_ACCESS_KEY_ID。, access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'], # 必填,請確保代碼運行環境設置了環境變量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。, access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'] ) config.endpoint = f'oos.cn-hangzhou.aliyuncs.com' return oos20190601Client(config) @staticmethod def main( args: List[str], ) -> None: client = Sample.create_client() tags = { 'scaling_group': 'asg-bp1******' } start_execution_request = oos_20190601_models.StartExecutionRequest( region_id='cn-hangzhou', template_name='ACS-ESS-RollingUpdateByRunCommandInScalingGroup', parameters='''{"invokeType": "rollback", "scalingGroupId": "asg-bp1******", "commandType": "RunShellScript", "rollbackScript": "df -h;ifconfig", "OOSAssumeRole": "", "sourceExecutionId": "exec-c1******", "batchNumber": 2, "batchPauseOption": "Automatic"}''', tags=tags ) runtime = util_models.RuntimeOptions() try: # 復制代碼運行請自行打印 API 的返回值 resp = client.start_execution_with_options(start_execution_request, runtime) print(resp.body) except Exception as error: # 此處僅做打印展示,請謹慎對待異常處理,在工程項目中切勿直接忽略異常。 # 錯誤 message print(error.message) # 診斷地址 print(error.data.get("Recommend")) UtilClient.assert_as_string(error.message) if __name__ == '__main__': Sample.main(sys.argv[1:])
運行Python腳本并查看返回信息。
示例如下圖所示。
模板參數說明
本教程中使用了公共模板ACS-ESS-RollingUpdateByRunCommandInScalingGroup,參數說明如下表所示。
參數 | 說明 |
invokeType | 任務類型。取值范圍:
|
scalingGroupId | 待執行任務的伸縮組。 |
commandType | 待執行的腳本類型,取值RunShellScript代表Shell腳本。 |
invokeScript | 執行滾動升級任務時,在ECS實例中執行的腳本。 |
rollbackScript | 執行回滾任務時,在ECS實例中執行的腳本。 |
OOSAssumeRole | 執行任務時使用的RAM角色,默認為OOSServiceRole。 |
enterProcess | 開始執行任務時暫停的伸縮組流程。 |
exitProcess | 結束任務時需要恢復的伸縮組流程。 |
batchNumber | 執行任務時,將伸縮組內ECS實例分成幾個批次,每批次至少包括一臺ECS實例。 |
batchPauseOption | 執行任務時的暫停設置。取值范圍:
|
sourceExecutionId | 執行回滾任務時,源滾動升級任務的執行ID。 |