This product(
oos/2019-06-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Region
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Queries supported regions. |
Template
| API | Title | Description |
|---|---|---|
| CreateTemplate | CreateTemplate | Creates a template. |
| DeleteTemplates | DeleteTemplates | Deletes multiple templates. |
| DeleteTemplate | DeleteTemplate | Deletes a template. |
| UpdateTemplate | UpdateTemplate | Updates the information about an existing template. |
| ListTemplateVersions | ListTemplateVersions | Queries a list of versions of a template. |
| ListTemplates | ListTemplates | Queries templates. Multiple methods are supported to filter templates. |
| GetTemplate | GetTemplate | Queries the information about a template, including the content of the template. |
| ListExecutionRiskyTasks | ListExecutionRiskyTasks | Queries high-risk tasks in the execution of a template. |
| ValidateTemplateContent | ValidateTemplateContent | Check whether a template is valid. |
Execution
| API | Title | Description |
|---|---|---|
| DeleteExecutions | DeleteExecutions | Deletes executions. |
| StartExecution | StartExecution | Starts an execution. |
| UpdateExecution | UpdateExecution | Updates an execution in the Running or Waiting state. |
| GetExecutionTemplate | GetExecutionTemplate | Queries the information about the template of an execution, including the content of the template. |
| ListExecutions | ListExecutions | Queries executions. Multiple methods are supported to filter executions. |
| ListExecutionLogs | ListExecutionLogs | Queries the logs of an execution. |
| ListTaskExecutions | ListTaskExecutions | Queries task executions. Multiple methods are supported to filter task executions. |
| ListResourceExecutionStatus | ListResourceExecutionStatus | Queries the information about a scheduled execution that involves O\&M operations on Elastic Compute Service (ECS) instances. |
| CancelExecution | CancelExecution | Cancels an execution. |
| GenerateExecutionPolicy | GenerateExecutionPolicy | Queries the Resource Access Management (RAM) policy required for template execution. |
| NotifyExecution | NotifyExecution | Notifies an execution in the Waiting state of the subsequent operations. |
| TriggerExecution | TriggerExecution | Debugs a started execution that contains an event trigger task or alert trigger task. If the operation is called, a message body is sent to the event trigger task or alert trigger task. After the trigger task receives the message body, the trigger task generates a new child execution. |
Action
| API | Title | Description |
|---|---|---|
| ListActions | ListActions | Queries the available actions, including atomic actions and cloud product actions. |
Parameter
| API | Title | Description |
|---|---|---|
| Common Parameter | Common Parameter | |
| CreateParameter | CreateParameter | Creates a common parameter. |
| DeleteParameter | DeleteParameter | Deletes a common parameter. |
| UpdateParameter | UpdateParameter | Updates a common parameter. |
| GetParameter | GetParameter | Queries a common parameter and its value. |
| ListParameters | ListParameters | Queries common parameters. Multiple methods are supported to filter common parameters. |
| ListParameterVersions | ListParameterVersions | Queries the versions of a common parameter. |
| GetParametersByPath | GetParametersByPath | Queries one or more parameters by path. |
| GetParameters | GetParameters | Queries the information about one or more parameters. |
| Secret Parameter | Secret Parameter | |
| CreateSecretParameter | CreateSecretParameter | Creates an encryption parameter. Make sure that you have the permissions to call the CreateSecret operation of Key Management Service (KMS) before you call this operation. |
| DeleteSecretParameter | DeleteSecretParameter | Deletes an encryption parameter. Make sure that you have the permissions to call the DeleteSecret operation of Key Management Service (KMS) before you call this operation. |
| UpdateSecretParameter | UpdateSecretParameter | Updates an encryption parameter. Make sure that you have the permissions to call the UpdateSecretValue operation of Key Management Service (KMS) before you call this operation. |
| GetSecretParameter | GetSecretParameter | Queries the information about an encryption parameter, including the parameter value. Make sure that you have the permissions to call the GetSecretValue operation of Key Management Service (KMS) before you call this operation. |
| ListSecretParameters | ListSecretParameters | Queries common parameters. Multiple types of queries are supported. |
| ListSecretParameterVersions | ListSecretParameterVersions | Queries versions of an encryption parameter. |
| GetSecretParametersByPath | GetSecretParametersByPath | Queries encryption parameters by path. Make sure that you have the permissions to call the GetSecretValue operation of Key Management Service (KMS) before you call this operation. |
| GetSecretParameters | GetSecretParameters | Queries the information about one or more encryption parameters. Make sure that you have the permissions to call the GetSecretValue operation of Key Management Service (KMS) before you call this operation. |
Patch Management
| API | Title | Description |
|---|---|---|
| Patch Baseline | Patch Baseline | |
| CreatePatchBaseline | CreatePatchBaseline | Creates a patch baseline. |
| DeletePatchBaseline | DeletePatchBaseline | Deletes a patch baseline. |
| UpdatePatchBaseline | UpdatePatchBaseline | Updates a patch baseline. |
| GetPatchBaseline | GetPatchBaseline | Queries the information of a patch baseline. |
| ListPatchBaselines | ListPatchBaselines | Queries a list of patch baselines. |
| RegisterDefaultPatchBaseline | RegisterDefaultPatchBaseline | Registers the default patch baseline. |
| Patch State | Patch State | |
| ListInstancePatchStates | ListInstancePatchStates | Queries the infromation about the patches of an instance. |
| ListInstancePatches | ListInstancePatches | Queries the patches of an instance. |
Inventory
| API | Title | Description |
|---|---|---|
| ListInventoryEntries | ListInventoryEntries | Queries the configurations of an Elastic Compute Service (ECS) instance. |
| GetInventorySchema | GetInventorySchema | Queries the properties of a configuration list. |
| SearchInventory | SearchInventory | Queries the details or aggregate information of a configuration inventory. |
State Configuration
| API | Title | Description |
|---|---|---|
| CreateStateConfiguration | CreateStateConfiguration | Creates a desired-state configuration. |
| DeleteStateConfigurations | DeleteStateConfigurations | Deletes multiple desired-state configurations at a time. |
| UpdateStateConfiguration | UpdateStateConfiguration | Updates a desired-state configuration. |
| ListStateConfigurations | ListStateConfigurations | Queries desired-state configurations. |
Other
| API | Title | Description |
|---|---|---|
| CreateOpsItem | CreateOpsItem | Creates an O\\\\\\\\\\&M Item. |
| GetOpsItem | GetOpsItem | Queries the details of an O\\\\\\\\\\&M item. |
| ListOpsItems | ListOpsItems | Queries O\\\&M items. |
| UpdateOpsItem | UpdateOpsItem | Modifies an O\\\\\\\\\\&M item. |
Service Settings
| API | Title | Description |
|---|---|---|
| SetServiceSettings | SetServiceSettings | Enables or disables the feature of delivering template execution records and sets the storage location and organization ID. |
| GetServiceSettings | GetServiceSettings | Queries the service settings, including the configuration of delivering template execution records and the associated organization ID. |
Application Management
| API | Title | Description |
|---|---|---|
| Application | Application | |
| CreateApplication | CreateApplication | Creates an application. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| DeleteApplication | DeleteApplication | Deletes an application. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| UpdateApplication | UpdateApplication | Updates an application. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| GetApplication | GetApplication | Queries the information of an application. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| ListApplications | ListApplications | Queries a list of applications. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| Application Group | Application Group | |
| CreateApplicationGroup | CreateApplicationGroup | Creates an application group. You can call this operation only for the application groups that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| DeleteApplicationGroup | DeleteApplicationGroup | Deletes an application group. You can call this operation only for the application groups which reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| UpdateApplicationGroup | UpdateApplicationGroup | Updates the information of an application group. You can call this operation only for the application groups that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| GetApplicationGroup | GetApplicationGroup | Queries the information about an application group. You can call this operation only for the application groups that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| ListApplicationGroups | ListApplicationGroups | Queries a list of application groups. You can call this operation only for the application groups that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| DeployApplicationGroup | DeployApplicationGroup | Deploys an application group. You can call this operation only for the applications which reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| ContinueDeployApplicationGroup | ContinueDeployApplicationGroup | Continues deploying an application group when an error occurs for calling the DeployApplicationGroup operation. You can call this operation only for the applications which reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region. |
| DescribeApplicationGroupBill | DescribeApplicationGroupBill | Queries the resource costs of an application group. |
Tag
| API | Title | Description |
|---|---|---|
| ListTagKeys | ListTagKeys | Queries the tags. |
| ListTagValues | ListTagValues | Queries the values of created tags. |
| ListTagResources | ListTagResources | Queries the tags that are added to one or more resources. |
| UntagResources | UntagResources | Removes tags from one or more resources. |
| TagResources | TagResources | Adds tags to one or more resources. |
Resource Group
| API | Title | Description |
|---|---|---|
| ChangeResourceGroup | ChangeResourceGroup | Modifies the resource group to which a cloud resource belongs. |