本产品(
云网管/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 | 创建新的专线 | 创建新的专线。 |
ListDedicatedLines | ListDedicatedLines | 分页获取专线列表。 |
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删除物理空间。 |
ListIpBlocks | ListIpBlocks | ListIpBlocks |
监控相关
API | 标题 | API概述 |
---|---|---|
CreateMonitorItem | 创建监控项 | 创建监控项。 |
GetMonitorItem | 查询监控项详情 | 根据监控项ID查询监控项详情。 |
CreateTimePeriod | 创建时间范围 | 创建时间范围。 |
ListAlarmStatus | 获取监控状态列表 | 获取监控状态列表,包括单设备监控状态、专线监控状态及聚合数据监控状态。 |
ListAlarmStatusHistories | 获取监控状态的历史时序数据 | 获取监控状态的历史时序数据。 |
ListAlarmStatusStatistics | 获取告警统计 | 获取告警统计。 |
GetAlarmStatus | 获取告警状态详情 | 获取告警状态详情,包含告警状态、时间、结果等内容。 |
ListMonitorData | 获取监控时序数据 | 获取监控时序数据。 |
ListNotificationHistories | 获取通知发送的历史记录列表 | 获取通知发送的历史记录列表。 |
ListNotificationHistoriesStatistics | ListNotificationHistoriesStatistics | 获取通知记录统计 |
EnableNotification | 启用监控项的告警通知功能 | 启用监控项的告警通知功能。 |
DisableNotification | 将监控项通知功能禁用到指定时间 | 将监控项通知功能禁用到指定时间。 |
CreateEventDefinition | 创建事件定义 | 创建事件定义。 |
ListEventDefinitions | 获取事件定义列表 | 获取事件定义列表。 |
UpdateEventDefinition | 更新事件定义 | 更新事件定义。 |
DeleteEventDefinition | 删除事件定义 | 删除事件定义。 |
ListEvents | 获取事件列表 | 获取事件列表。 |
CloseEvent | 关闭事件 | 关闭正在告警的事件。 |
ListLogs | 查询syslog日志 | 查询syslog日志。 |
巡检相关
API | 标题 | API概述 |
---|---|---|
ListInspectionTasks | 获取巡检任务列表 | 获取巡检任务列表。 |
ListInspectionDevices | 获取巡检设备列表 | 获取巡检设备列表信息。 |
CreateRealtimeTask | 创建实时任务 | 创建实时任务。 |
CreateTask | 创建巡检任务 | 创建巡检任务。 |
RetryTasks | 重试巡检任务 | 重试巡检任务。 |
GetTask | 查询巡检任务 | 查询巡检任务详情。 |
GetRealtimeTask | 获取实时任务详情 | 获取实时任务详情。 |
ListTasksHistories | 获取任务历史列表 | 获取任务历史列表。 |
GetInspectionTask | 获取巡检任务详情 | 获取巡检任务详情。 |
其他
API | 标题 | API概述 |
---|---|---|
DeleteSpaceModel | DeleteSpaceModel | |
CreateOsVersion | 创建OS版本 | 创建OS版本。 |
UpdateSpaceModel | UpdateSpaceModel | |
GetSpaceModelInstance | GetSpaceModelInstance | |
ListOsVersions | ListOsVersions | |
UpdateSpaceModelInstance | 更新关联物理空间模型 | 更新关联物理空间模型。 |
GetSpaceModel | GetSpaceModel | |
GetOssPolicy | 获取下载签名 | 获取下载文件时的签名参数。 |
GetSpaceModelSort | GetSpaceModelSort | |
LockSpaceModel | 锁定物理空间模型 | |
ListSpaceModels | ListSpaceModels | |
CreateSpaceModel | CreateSpaceModel | |
GetOsVersion | 获取镜像版本 | 获取镜像版本下载地址。 |
UpdateOsVersion | UpdateOsVersion | |
DeleteOsVersion | DeleteOsVersion | |
DeleteDeliveryArchVersion | DeleteDeliveryArchVersion |