文档

API概览

更新时间:
本产品(云网管/2020-08-25)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

API目录

API标题API概述
ListRegions查询可用地域列表获取产品已上线可使用的地域信息。
ListInstances获取实例列表查询用户创建的所有实例列表。
UpdateInstance编辑实例修改实例名称。

资源管理相关

API标题API概述
CreateDedicatedLine创建新的专线创建新的专线。
ListDedicatedLinesListDedicatedLines分页获取专线列表。
GetDedicatedLine根据ID查询专线详情根据ID查询专线详情。
UpdateDedicatedLine根据ID编辑专线信息根据ID编辑专线信息。
DeleteDedicatedLine根据ID删除专线根据ID删除专线。
CreateDevice创建新的设备创建新的设备。
ListDevices分页获取设备列表分页获取设备列表。
GetDevice根据ID查询设备详情根据ID查询设备详情。
CreateDevices批量导入设备批量导入设备。
GetDeviceConfig根据ID查询设备配置详情根据ID查询设备配置详情。
GetDeviceConfigDiff根据查询设备配置DIFF根据查询设备配置DIFF。
GetDeviceOpLog查询设备操作日志分页查询设备操作日志。
GetDeviceConfigDate查询设备配置变化日期查询设备配置变化日期列表。
UpdateDevice根据ID编辑设备根据ID编辑设备。
UpdateDevices批量编辑设备的账号密码等批量编辑设备的账号密码等。
DeleteDevice删除设备根据ID删除设备。
DeleteDevices批量删除设备批量删除设备。
CreateDeviceForm创建新的设备形态创建新的设备形态。
ListDeviceForms获取设备形态列表获取设备形态列表。
GetDeviceForm根据ID查询设备形态详情根据ID查询设备形态详情。
UpdateDeviceForm编辑已经存在的设备形态编辑已经存在的设备形态。
DeleteDeviceForm根据ID删除设备形态根据ID删除设备形态。
CreateDeviceProperty创建新的设备属性创建新的设备属性。
ListDeviceProperties获取设备属性列表获取设备属性列表。
GetDeviceProperty根据ID查询设备属性详情根据ID查询设备属性详情。
ListDeviceValues获取设备属性值的列表获取设备属性值的列表。
UpdateDeviceProperty根据ID编辑设备属性根据ID编辑设备属性。
DeleteDeviceProperty根据ID删除设备属性根据ID删除设备属性。
CreatePhysicalSpace创建新的物理空间创建新的物理空间。
ListPhysicalSpaces获取物理空间列表分页获取物理空间列表。
ListTreePhysicalSpaces获取物理空间列表获取物理空间列表,以树形方式返回。
GetPhysicalSpace根据ID查询物理空间详情根据ID查询物理空间详情。
UpdatePhysicalSpace根据ID编辑物理空间根据ID编辑物理空间。
DeletePhysicalSpace根据ID删除物理空间根据ID删除物理空间。
ListIpBlocksListIpBlocksListIpBlocks

监控相关

API标题API概述
CreateMonitorItem创建监控项创建监控项。
GetMonitorItem查询监控项详情根据监控项ID查询监控项详情。
CreateTimePeriod创建时间范围创建时间范围。
ListAlarmStatus获取监控状态列表获取监控状态列表,包括单设备监控状态、专线监控状态及聚合数据监控状态。
ListAlarmStatusHistories获取监控状态的历史时序数据获取监控状态的历史时序数据。
ListAlarmStatusStatistics获取告警统计获取告警统计。
GetAlarmStatus获取告警状态详情获取告警状态详情,包含告警状态、时间、结果等内容。
ListMonitorData获取监控时序数据获取监控时序数据。
ListNotificationHistories获取通知发送的历史记录列表获取通知发送的历史记录列表。
ListNotificationHistoriesStatisticsListNotificationHistoriesStatistics获取通知记录统计
EnableNotification启用监控项的告警通知功能启用监控项的告警通知功能。
DisableNotification将监控项通知功能禁用到指定时间将监控项通知功能禁用到指定时间。
CreateEventDefinition创建事件定义创建事件定义。
ListEventDefinitions获取事件定义列表获取事件定义列表。
UpdateEventDefinition更新事件定义更新事件定义。
DeleteEventDefinition删除事件定义删除事件定义。
ListEvents获取事件列表获取事件列表。
CloseEvent关闭事件关闭正在告警的事件。
ListLogs查询syslog日志查询syslog日志。

巡检相关

API标题API概述
ListInspectionTasks获取巡检任务列表获取巡检任务列表。
ListInspectionDevices获取巡检设备列表获取巡检设备列表信息。
CreateRealtimeTask创建实时任务创建实时任务。
CreateTask创建巡检任务创建巡检任务。
RetryTasks重试巡检任务重试巡检任务。
GetTask查询巡检任务查询巡检任务详情。
GetRealtimeTask获取实时任务详情获取实时任务详情。
ListTasksHistories获取任务历史列表获取任务历史列表。
GetInspectionTask获取巡检任务详情获取巡检任务详情。

其他

API标题API概述
DeleteSpaceModelDeleteSpaceModel
CreateOsVersion创建OS版本创建OS版本。
UpdateSpaceModelUpdateSpaceModel
GetSpaceModelInstanceGetSpaceModelInstance
ListOsVersionsListOsVersions
UpdateSpaceModelInstance更新关联物理空间模型更新关联物理空间模型。
GetSpaceModelGetSpaceModel
GetOssPolicy获取下载签名获取下载文件时的签名参数。
GetSpaceModelSortGetSpaceModelSort
LockSpaceModel锁定物理空间模型
ListSpaceModelsListSpaceModels
CreateSpaceModelCreateSpaceModel
GetOsVersion获取镜像版本获取镜像版本下载地址。
UpdateOsVersionUpdateOsVersion
DeleteOsVersionDeleteOsVersion
DeleteDeliveryArchVersionDeleteDeliveryArchVersion