本文介紹如何使用阿里云Python語言SDK開發包,調用數據管理DMS的ListInstances接口(獲取實例信息列表)。
步驟一:查看OpenAPI文檔
在調用OpenAPI前,建議您先閱讀對應接口文檔,了解、學習調用該接口所需要的參數及權限等,更多信息請參見API概覽。
步驟二:創建RAM用戶并完成授權
若您已創建RAM用戶并完成授權,可跳過此步驟。
步驟三:調用OpenAPI
本文介紹阿里云Python語言SDK方式調用OpenAPI,其他語言SDK的用法也類似,更多信息請參見數據管理DMS SDK。
準備Python環境
下載并安裝Python 3。如您已安裝Python,查看Python版本的命令示例:python --version
。
配置環境變量
配置環境變量ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
。
Linux和macOS系統:將以下命令中的
<access_key_id>
和<access_key_secret>
替換為您自己的AccessKey ID和AccessKey Secret,然后在終端設備中逐條運行。export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
Windows系統:新建環境變量文件,添加環境變量
ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
,并寫入已準備好的AccessKey ID和AccessKey Secret。然后重啟Windows系統。
安裝依賴
在終端設備中,逐條運行如下命令,安裝環境依賴。
pip install alibabacloud_credentials
pip install alibabacloud_dms_enterprise20181101
pip install alibabacloud_tea_console
下載示例代碼
訪問ListInstances,進入該接口在OpenAPI門戶的調試地址。
在左側的參數配置頁簽,填寫需要的參數信息,本示例無需輸入任何信息。
在右側的SDK示例頁簽,選擇Python語言,單擊下載完整工程按鈕,下載示例代碼包。
本地解壓并進入alibabacloud_sample目錄。
運行代碼
在終端設備執行以下命令。
python sample.py
返回示例如下。
[
LOG
] {
"headers": {
"date":"Wed, 19 Jul 2023 03:11:46 GMT",
"content-type":"application/json;charset=utf-8",
"transfer-encoding":"chunked",
"connection":"keep-alive",
"keep-alive":"timeout=25",
"vary":"Accept-Encoding",
"access-control-allow-origin":"*",
"access-control-expose-headers":"*",
"x-acs-request-id":"D960D80C-01CD-5FA4-AB12-7FA90BE0D35D",
"x-acs-trace-id":"8b51178c7317cbb3e0ba9b1223eba55a"
},
"statusCode":200,
"body": {
"InstanceList": {
"Instance": [
{
"DataLinkName":"dbl_mysql_7",
"DatabasePassword":"******",
"DatabaseUser":"root",
"DbaId":54****,
"DbaNickName":"db_doc",
"DdlOnline":0,
"EcsRegion":"cn-hangzhou",
"EnvType":"product",
"ExportTimeout":86400,
"Host":"172.20.XXX.XXX",
"InstanceAlias":"zjq-test",
"InstanceId":220****,
"InstanceSource":"ECS_OWN",
"InstanceType":"mysql",
"OwnerIdList":{
"OwnerIds":[54****]
},
"OwnerNameList":{
"OwnerNames":["db_doc"]
},
"Port":3306,
"QueryTimeout":7200,
"SafeRuleId":829***,
"SellSitd":false,
"StandardGroup":{
"GroupMode":"NONE_CONTROL",
"GroupName":"自由操作"
},
"State":"NORMAL",
"UseDsql":"1"
},
{
"DataLinkName":"dbl_sls_1",
"DatabasePassword":"******",
"DatabaseUser":"LTA****",
"DbaId":54****,
"DbaNickName":"db_doc",
"DdlOnline":0,
"EcsRegion":"cn-hangzhou",
"EnvType":"product",
"ExportTimeout":86400,
"Host":"cn-hangzhou.log.aliyuncs.com",
"InstanceAlias":"DMSTEST",
"InstanceId":22****,
"InstanceSource":"FILE",
"InstanceType":"sls",
"OwnerIdList":{
"OwnerIds":[54****]
},
"OwnerNameList":{
"OwnerNames":["db_doc"]
},
"Port":0,
"QueryTimeout":7200,
"SafeRuleId":82****,
"SellSitd":false,
"Sid":"dmstest",
"StandardGroup":{
"GroupMode":"NONE_CONTROL",
"GroupName":"自由操作"
},
"State":"NORMAL",
"UseDsql":"1"
}
}
]
},
"RequestId":"D960D80C-01CD-5FA4-AB12-7FA90BE0D35D",
"Success":true,
"TotalCount":2
}
}