本产品（oos/2019-06-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用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 | 更新未结束的执行 | 更新未结束（处于Running, Waiting状态）的执行。 |
| 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 | 创建一个加密参数 | 创建一个加密参数。请确保在使用该接口前有操作kms CreateSecret API的权限。 |
| DeleteSecretParameter | 删除一个加密参数 | 删除一个加密参数。请确保在使用该接口前有操作kms DeleteSecret API的权限。 |
| UpdateSecretParameter | 更新一个加密参数 | 更新一个加密参数。请确保在使用该接口前有操作kms UpdateSecretValue API的权限。 |
| GetSecretParameter | 获取一个加密参数和参数值 | 获取一个加密参数，包括参数值。请确保在使用该接口前有操作kms GetSecretValue API的权限。 |
| ListSecretParameters | 获取加密参数列表 | 查询普通参数，支持多种查询。 |
| ListSecretParameterVersions | 查询加密参数的多个版本对象 | 查询加密参数的多个版本对象。 |
| GetSecretParametersByPath | 通过路径获取加密参数 | 通过路径获取加密参数。请确保在使用该接口前有操作kms GetSecretValue API的权限。 |
| GetSecretParameters | 获取一个或多个加密参数的详细信息 | 获取一个或多个加密参数的详细信息。请确保在使用该接口前有操作kms 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 | 更新运维项 | 修改运维项。 |
| DeleteOpsItems | 批量删除运维项 | 删除运维项 |
服务配置
|
API |
标题 |
API概述 |
| SetServiceSettings | 设置服务配置 | 开启或关闭模板执行记录的投递功能，以及投递存储地点，关联云效企业ID。 |
| 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。 |
| DescribeApplicationGroupBill | 查询应用分组资源成本 | 查询应用分组资源成本。 |
标签
|
API |
标题 |
API概述 |
| ListTagKeys | 查询已创建的标签 | 查询已创建的标签。 |
| ListTagValues | 查询已创建的标签值 | 查询已创建的标签值。 |
| ListTagResources | 查询资源标签关系 | 查询可见的资源标签关系。 |
| UntagResources | 删除用户标签资源关系 | 删除用户标签资源关系，即可为资源删除用户标签。 |
| TagResources | 创建标签资源关系 | 创建标签资源关系，即可为资源创建用户标签。 |
资源组
|
API |
标题 |
API概述 |
| ChangeResourceGroup | 更改资源组 | 修改云资源所属的资源组。 |
扩展
|
API |
标题 |
API概述 |
| UpdateInstancePackageState | 更新实例安装的扩展 | 更新实例安装的扩展 |
| ListInstancePackageStates | 查询某个实例已安装的扩展 | 列出实例软件包状态 |
其他
|
API |
标题 |
API概述 |
| GenerateOpsItem | 生成运维项 | 生成运维项。 |
| GetTemplateParameterConstraints | Gets the available values for template parameters | 获取参数可用值 |
该文章对您有帮助吗？