文档

API概览

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

地域

API标题API概述
DescribeRegions查询当前支持的地域情况调用该API查询当前支持的地域情况。

模板

API标题API概述
CreateTemplate创建一个模版创建一个模版。
DeleteTemplates删除多个模版调用该API删除多个模版。
DeleteTemplate删除一个模版删除一个模版。
UpdateTemplate更新一个已经存在的模板更新一个已经存在的模板。
ListTemplateVersions查询一个模版的多个版本对象查询一个模版的多个版本对象。
ListTemplates查询模板支持多种过滤方式。
GetTemplate获取模版获取一个模版,包括内容。
ListExecutionRiskyTasks获取模版中的高风险任务获取模版中的高风险任务。
ValidateTemplateContent校验一个模版是否合法校验一个模版是否合法。

执行

API标题API概述
DeleteExecutions删除执行删除执行。
StartExecution启动一个执行启动一个执行。
UpdateExecution更新未结束的执行更新未结束的执行。
GetExecutionTemplate获取一个执行所使用的模板获取一个执行所使用的模板,包括内容。
ListExecutions查询执行查询执行,支持多种过滤方式。
ListExecutionLogs获取执行的详细日志获取执行的详细日志。
ListTaskExecutions查询任务执行查询任务执行,支持多种过滤方式。
ListResourceExecutionStatus查看包含ECS实例的定时运维执行信息查看包含ECS实例的定时运维执行信息。
CancelExecution取消执行取消执行。
GenerateExecutionPolicy获取执行所需 Ram Policy获取模板执行所需要的Ram Policy。
NotifyExecution通知执行如何运行通知一个状态为等待中的执行接下来如何运行。
TriggerExecution执行事件触发事件触发器或告警触发器任务,可对该类执行发送消息体内容,消息体会使事件或告警任务产生一个新的子执行。

动作

API标题API概述
ListActions查询可用动作查询可用动作,包括原子动作和云产品动作。

参数

API标题API概述
普通参数普通参数
CreateParameter创建一个普通参数创建一个普通参数。
DeleteParameter删除普通参数删除普通参数。
UpdateParameter更新一个已存在的普通参数更新一个已存在的普通参数。
GetParameter获取普通参数获取一个普通参数或公共参数,包括参数值。
ListParameters查询普通参数查询普通参数和公共参数,支持多种查询。
ListParameterVersions查看普通参数的多个版本对象查看普通参数的多个版本对象。
GetParametersByPath通过路径获取普通参数通过路径获取参数。
GetParameters获取一个或多个普通参数的详细信息获取一个或多个参数的详细信息。
加密参数加密参数
CreateSecretParameter创建一个加密参数创建一个加密参数。请确保在使用该接口前有操作CreateSecret API的权限。
DeleteSecretParameter删除一个加密参数删除一个加密参数。请确保在使用该接口前有操作DeleteSecret API的权限。
UpdateSecretParameter更新一个加密参数更新一个加密参数。
GetSecretParameter获取一个加密参数和参数值获取一个加密参数,包括参数值。请确保在使用该接口前有操作GetSecretValue API的权限。
ListSecretParameters获取 Secret 参数列表查询普通参数,支持多种查询。
ListSecretParameterVersions查询加密参数的多个版本对象查询加密参数的多个版本对象。
GetSecretParametersByPath通过路径获取加密参数通过路径获取加密参数。请确保在使用该接口前有操作GetSecretValue API的权限。
GetSecretParameters获取一个或多个加密参数的详细信息获取一个或多个加密参数的详细信息。请确保在使用该接口前有操作GetSecretValue API的权限。

补丁管理

API标题API概述
补丁基线补丁基线
CreatePatchBaseline创建补丁基线创建一个补丁基线。
DeletePatchBaseline删除补丁基线删除一个补丁基线。
UpdatePatchBaseline更新补丁基线更新一个补丁基线。
GetPatchBaseline获取补丁基线获取一个补丁基线的详细信息。
ListPatchBaselines列出修补程序基线获取补丁基线列表。
RegisterDefaultPatchBaseline注册默认补丁基线注册默认补丁基线。
补丁状态补丁状态
ListInstancePatchStates列出实例修补程序状态获取实例补丁信息。
ListInstancePatches列出实例修补程序获取实例补丁信息。

配置清单

API标题API概述
ListInventoryEntries查询一个实例下的配置清单记录查询一个实例下的配置清单记录。
GetInventorySchema获取配置清单的模式信息获取配置清单的模式信息。
SearchInventory查询配置清单的详细信息或聚合信息查询配置清单的详细信息或聚合信息。

终态配置

API标题API概述
CreateStateConfiguration创建一个终态配置创建终态配置。
DeleteStateConfigurations删除多个终态配置批量删除终态配置。
UpdateStateConfiguration更新一个终态配置更新终态配置。
ListStateConfigurations查询终态配置查询终态配置。

运维项

API标题API概述
CreateOpsItem创建运维项创建运维项。
GetOpsItem获取运维项获取运维项详情。
ListOpsItems查询运维项查询运维项。
UpdateOpsItem更新运维项修改运维项。

设置

API标题API概述
SetServiceSettings开启或关闭模板执行记录投递功能开启或关闭模板执行记录的投递功能,以及投递存储地点。
GetServiceSettings获取投递功能的配置信息获取投递功能的配置信息。

应用管理

API标题API概述
应用应用
CreateApplication创建一个应用创建一个应用。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
DeleteApplication删除一个应用删除一个应用。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
UpdateApplication更新应用更新一个应用。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
GetApplication获取一个应用的详细信息获取一个应用的详细信息。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
ListApplications查询应用列表查询应用列表。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
应用分组应用分组
CreateApplicationGroup创建一个应用分组创建一个应用分组。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
DeleteApplicationGroup删除一个应用分组删除一个应用分组。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
UpdateApplicationGroup更新一个应用分组的信息更新一个应用分组的信息。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
GetApplicationGroup获取一个应用分组的详细信息获取一个应用分组的详细信息。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
ListApplicationGroups查询应用分组列表查询应用分组列表。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
DeployApplicationGroup部署应用分组部署应用分组。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。
ContinueDeployApplicationGroup继续部署应用分组当应用分组部署失败时,调用此接口继续部署应用分组。应用管理的服务地域仅支持杭州,请使用杭州的endpoint。

标签与资源组

API标题API概述
ChangeResourceGroup更改资源组修改云资源所属的资源组。
ListTagKeys查询已创建的标签查询已创建的标签。
ListTagValues查询已创建的标签值查询已创建的标签值。
ListTagResources查询资源标签关系查询可见的资源标签关系。
UntagResources删除用户标签资源关系删除用户标签资源关系,即可为资源删除用户标签。
TagResources创建标签资源关系创建标签资源关系,即可为资源创建用户标签。
  • 本页导读 (0)
文档反馈