阿里云 阿里云 专有云企业版 专有云企业版 混合云管理平台 混合云管理平台 Apsara Uni-manager运维控制台 Apsara Uni-manager运维控制台 开发指南 开发指南 产品版本：V3.13.0 文档版本：20210111 产品版本：V3.13.0 文档版本：20210111 混合云管理平台 Apsara Uni-manager运维控制台 开发 指南· 法律声明 法律声明 阿里云提醒您在阅读或使用本文档之前仔细阅读、充分理解本法律声明各条款的内容。 如果您阅读或使用本文档，您的阅读或使用行为将被视为对本声明全部内容的认可。 1. 您应当通过阿里云网站或阿里云提供的其他授权通道下载、获取本文档，且仅能用 于自身的合法合规的业务活动。本文档的内容视为阿里云的保密信息，您应当严格 遵守保密义务；未经阿里云事先书面同意，您不得向任何第三方披露本手册内容或 提供给任何第三方使用。 2. 未经阿里云事先书面许可，任何单位、公司或个人不得擅自摘抄、翻译、复制本文 档内容的部分或全部，不得以任何方式或途径进行传播和宣传。 3. 由于产品版本升级、调整或其他原因，本文档内容有可能变更。阿里云保留在没有 任何通知或者提示下对本文档的内容进行修改的权利，并在阿里云授权通道中不时 发布更新后的用户文档。您应当实时关注用户文档的版本变更并通过阿里云授权渠 道下载、获取最新版的用户文档。 4. 本文档仅作为用户使用阿里云产品及服务的参考性指引，阿里云以产品及服务 的“现状”、“有缺陷”和“当前功能”的状态提供本文档。阿里云在现有技术的 基础上尽最大努力提供相应的介绍及操作指引，但阿里云在此明确声明对本文档内 容的准确性、完整性、适用性、可靠性等不作任何明示或暗示的保证。任何单位、 公司或个人因为下载、使用或信赖本文档而发生任何差错或经济损失的，阿里云不 承担任何法律责任。在任何情况下，阿里云均不对任何间接性、后果性、惩戒性、 偶然性、特殊性或刑罚性的损害，包括用户使用或信赖本文档而遭受的利润损失， 承担责任（即使阿里云已被告知该等损失的可能性）。 5. 阿里云网站上所有内容，包括但不限于著作、产品、图片、档案、资讯、资料、网 站架构、网站画面的安排、网页设计，均由阿里云和/或其关联公司依法拥有其知识 产权，包括但不限于商标权、专利权、著作权、商业秘密等。非经阿里云和/或其关 联公司书面同意，任何人不得擅自使用、修改、复制、公开传播、改变、散布、发 行或公开发表阿里云网站、产品程序或内容。此外，未经阿里云事先书面同意，任 何人不得为了任何营销、广告、促销或其他目的使用、公布或复制阿里云的名称 （包括但不限于单独为或以组合形式包含“阿里云”、“Aliyun”、“万网”等阿 里云和/或其关联公司品牌，上述品牌的附属标志及图案或任何类似公司名称、商 号、商标、产品或服务名称、域名、图案标示、标志、标识或通过特定描述使第三 方能够识别阿里云和/或其关联公司）。 6. 如若发现本文档存在任何错误，请与阿里云取得直接联系。 > 文档版本：20210111 I Apsara Uni-manager运维控制台 开发 指南· 通用约定 混合云管理平台 通用约定 格式 危险 说明 该类警示信息将导致系统重大变更甚至故 障，或者导致人身伤害等结果。 样例 危险 重置操作将丢失用户配置数据。 警告 警告 该类警示信息可能会导致系统重大变更甚 至故障，或者导致人身伤害等结果。 重启操作将导致业务中断，恢复业务 时间约十分钟。 注意 注意 用于警示信息、补充说明等，是用户必须 了解的内容。 说明 用于补充说明、最佳实践、窍门等，不是 用户必须了解的内容。 权重设置为0，该服务器不会再接受新 请求。 说明 您也可以通过按Ct rl+A选中全部文 件。 > 多级菜单递进。 单击设置 > 网络 > 设置网络类型 。 粗体 表示按键、菜单、页面名称等UI元素。 在结果确认 页面，单击确定 。 Courier字体 斜体 命令或代码。 表示参数、变量。 执行 cd /d C:/window 命令，进入 Windows系统文件夹。 bae log list --inst anceid Inst ance_ID [] 或者 [a|b] 表示可选项，至多选择一个。 {} 或者 {a|b} 表示必选项，至多选择一个。 > 文档版本：20210111 ipconfig [-all|-t ] swit ch {act ive|st and} I 混合云管理平台 Apsara Uni-manager运维控制台 开发 指南· 目录 目录 1.通过ASAPI调用云产品SDK 07 1.1. ASAPI概述 07 1.2. 准备工作 07 1.2.1. 登录API与工具控制台 07 1.2.2. 查看API信息 08 1.2.3. 生成ASAPI的Endpoint 09 1.2.4. 获取ASAPI的core包 09 1.2.5. 获取AccessKey 10 1.2.6. 获取Region ID 11 1.3. 公共参数 11 1.4. SDK说明 12 1.4.1. Java SDK调用 13 1.4.2. Python SDK调用 14 1.4.3. Node SDK调用 18 1.4.4. POP SDK调用 19 1.5. HT T P调用方式 21 1.5.1. 概述 21 1.5.2. 请求结构 21 1.5.3. 签名机制 22 1.5.4. 返回结果 27 2.API参考 29 2.1. 公共参数 29 2.2. 调用方式 29 2.3. Apsara Uni-manager运维控制台鉴权 30 2.4. 监控告警 30 2.4.1. GetAlertList > 文档版本：20210111 30 I Apsara Uni-manager运维控制台 开发 指南· 目录 2.4.2. GetHistoryAlert 38 2.4.3. PushToASO 50 2.5. 库存管理 2.5.1. GetOverView 52 52 2.5.2. GetEcsInventoryByCurrent 108 2.5.3. GetEcsInventoryByZoneId 111 2.5.4. GetEcsInventoryList 113 2.5.5. GetNasInventoryInfo 115 2.5.6. GetOssInventoryInfo 117 2.5.7. GetOtsInnerInventoryInfo 119 2.5.8. GetRdsInventoryInfo 121 2.5.9. GetSlbInventoryInfo 146 2.5.10. GetSlsInnerInfo 148 2.5.11. GetPanguInventoryByClusterName 150 2.6. 任务管理 152 2.6.1. GetScriptInfo 152 2.6.2. GetScriptList 153 2.6.3. GetTaskExecuteHistory 156 2.6.4. GetTaskOutput 159 2.6.5. GetTaskInfo 163 2.6.6. GetTaskList 167 2.7. 物理平台 II 混合云管理平台 171 2.7.1. GetMachineByIp 171 2.7.2. GetMachineByName 184 2.7.3. GetMachineList 197 2.7.4. GetNetworkMachineByIp 211 2.7.5. GetNetworkMachineByName 215 2.7.6. GetClusterListByProduct 220 > 文档版本：20210111 混合云管理平台 Apsara Uni-manager运维控制台 开发 指南· 目录 2.7.7. GetProductList 224 2.7.8. GetProductVersion 226 2.7.9. GetServerRoleList 228 2.7.10. GetServerroleVersion 231 > 文档版本：20210111 III 混合云管理平台 Apsara Uni-manager运维控制台 开发 指南· 通过ASAPI调用云产品SDK 1.通过ASAPI调用云产品SDK 1.1. ASAPI概述 本节主要从功能和架构等方面对专有云ASAPI（Apsara St ack API）系统进行简单的介绍。 专有云ASAPI将集成所有的功能到一个平台上，对外形成专有云唯一的入口，它会对API进行有效的分类、调 用审计和管理。此外，它还能组装、定制现有的API和快速适配客户的API。各云产品可以直接通过ASAPI调 用云平台中所需的数据和功能，避免各个产品调用方式不一致且独自封装而造成的接口不统一，既保证接口 程序的完整性，又加快开发的进度，提高代码的可移植性。 ASAPI定位于专有云API的统一管理和调用，以及定制开发。承接了专有云上大部分云产品的接入，支持不同 后端API的透传或封装，以对外呈现统一的调用方式。可以通过SDK和Port al调用ASAPI上注册的API，对专有 云版本、产品版本及其API版本提供完整的管理能力，能按需定制SDK。 1.2. 准备工作 1.2.1. 登录API与工具控制台 > 文档版本：20210111 7 Apsara Uni-manager运维控制台 开发 指南· 通过ASAPI调用云产品SDK 混合云管理平台 您可以通过Apsara Uni-manager运营控制台登录API与工具控制台。 前提条件 登录Apsara Uni-manager运营控制台前，确认您已从部署人员处获取Apsara Uni-manager运营控制台的 服务域名地址。 推荐使用Chrome浏览器。 操作步骤 1. 在浏览器地址栏中，输入Apsara Uni-manager运营控制台的访问地址，按回车键。 2. 输入正确的用户名及密码。 请向运营管理员获取登录控制台的用户名和密码。 说明 首次登录Apsara Uni-manager运营控制台时，需要修改登录用户名的密码，请按照提示 完成密码修改。为提高安全性，密码长度必须为 8~20