API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(Advisor/2018-01-20)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

多维巡检

API

标题

API概述

DescribeAdvisorChecks 获取巡检项 获取用户当前可用的巡检项
DescribeAdvices 获取最新巡检结果 可根据多个维度获取用户最新的巡检结果,全量返回。
DescribeAdvisorResources 获取资源列表 拉取巡检资源列表(需要在触发资源信息同步后才能获取最新结果)。
RefreshAdvisorCheck 刷新并触发巡检 刷新诊断项,触发该巡检项的资源指标同步并重新巡检。 该API会按照输入的多个维度(云产品、云资源、诊断项名称)创建巡检任务,都为空则默认按照该用户下所有资源为所有诊断项创建巡检任务。
RefreshAdvisorResource 资源信息同步 根据具体的产品+资源ID,触发资源信息同步任务,返回创建的任务ID。
DescribeAdvicesPage 分页获取最新巡检结果 可根据多个维度获取用户最新的巡检结果,分页返回。
GetTaskStatusById 查询任务状态 根据任务ID查询任务执行状态。
GetHistoryAdvices 分页获取历史巡检结果 分页获取历史巡检结果,按产品、日期、严重级别查询。
DescribeAdvicesFlatPage 分页获取最新巡检结果(展平) 可根据多个维度获取用户最新的巡检结果,分页返回(部分字段展平)。

成本优化

API

标题

API概述

GetProductList 获取全量产品 获取云产品的列表
DescribeCostCheckResults 巡检项聚合成本优化结果概览 查询巡检项聚合成本优化结果概览
DescribeCostCheckAdvices 成本优化结果详情 查询成本优化结果详情
GetInspectProgress 获取任务执行进度 获取任务执行进度(普通用户、RD单账号)
RefreshAdvisorCostCheck 发起成本优化巡检 发起成本优化巡检
DescribeAdvisorChecksFoPages 分页获取巡检项 巡检项设置-分页
DescribeCostOptimizationOverview 成本数据概览 成本优化-概览