API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (oos/2019-06-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
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 | Lists the versions of a specified template. |
| ListTemplates | ListTemplates | Queries templates. Multiple methods are supported to filter templates. |
| GetTemplate | GetTemplate | Retrieves a template, including its content. |
| ListExecutionRiskyTasks | ListExecutionRiskyTasks | Lists the high-risk tasks in a template. |
| ValidateTemplateContent | ValidateTemplateContent | Validates the syntax of a template. |
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 RAM policy required to execute a template. |
| 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 common parameter. |
| UpdateParameter | UpdateParameter | Updates a common parameter. |
| GetParameter | GetParameter | Queries a standard or common parameter and its value. |
| ListParameters | ListParameters | Queries common parameters. Multiple methods are supported to filter common parameters. |
| ListParameterVersions | ListParameterVersions | Lists the versions of a specified standard parameter. |
| GetParametersByPath | GetParametersByPath | Queries the parameters by path. |
| GetParameters | GetParameters | Queries the details of 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 encrypted parameter. This operation requires permission to call the Key Management Service (KMS) DeleteSecret API. |
| 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 an encrypted parameter, including its value. Before you call this operation, ensure that you have the permissions to call the GetSecretValue API operation of Key Management Service (KMS). |
| ListSecretParameters | ListSecretParameters | Queries common parameters. Multiple types of queries are supported. |
| ListSecretParameterVersions | ListSecretParameterVersions | Queries multiple versions of a encrypted parameter. |
| GetSecretParametersByPath | GetSecretParametersByPath | Retrieves encrypted parameters by path. Before you call this operation, ensure that you have permission to call the GetSecretValue operation of Key Management Service (KMS). |
| GetSecretParameters | GetSecretParameters | Queries the details of one or more encrypted parameters. You must have permission to call GetSecretValue API of Key Management Service (KMS) to use 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 details 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 information 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 for detailed or aggregated information about 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. |
OpsItem
|
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. |
| DeleteOpsItems | DeleteOpsItems | Deletes O\\\&M Items. |
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. The Application Management service is available only in the China (Hangzhou) region, and you must use the endpoint of this region. |
| GetApplicationGroup | GetApplicationGroup | Retrieves the details of an application group. Application Management is available only in the China (Hangzhou) region. You must use the endpoint for this region. |
| ListApplicationGroups | ListApplicationGroups | Queries a list of application groups. The Application Management feature is available only in the China (Hangzhou) region. Ensure that you use the endpoint for this region. |
| DeployApplicationGroup | DeployApplicationGroup | Deploys an application group. Application Management is available only in the China (Hangzhou) region. You must use the endpoint for 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 | Lists 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. |
Extentions
|
API |
Title |
Description |
| UpdateInstancePackageState | UpdateInstancePackageState | Updates the state of an extension installed on an instance. |
| ListInstancePackageStates | ListInstancePackageStates | Lists the status of each package on an instance. |
Other
|
API |
Title |
Description |
| GenerateOpsItem | GenerateOpsItem | Generates an O\\\&M item. |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | Retrieves the allowed values for parameters. |
Others
|
API |
Title |
Description |
| CheckGitRepoFileExists | CheckGitRepoFileExists | Checks whether a file exists in a repository. |
| CheckGitRepositoryExists | CheckGitRepositoryExists | Checks whether a repository exists. |
| CreateGitRepository | CreateGitRepository | Creates a Git repository. |
| GetGitBranch | GetGitBranch | Queries the details of a Git branch. You can query public repositories without authorization. |
| GetGitRepository | GetGitRepository | Queries the details of a Git repository. |
| ListGitAccounts | ListGitAccounts | Lists the Git accounts authorized for the current Alibaba Cloud account in Application Management. |
| ListGitBranches | ListGitBranches | Lists all branches of a specified Git repository. |
| ListGitOrganizations | ListGitOrganizations | Retrieves the Git organizations for an authorized user. |
| ListGitRepositoryContents | ListGitRepositoryContents | Lists the files and directories in a repository. |