API standards and multilingual preset SDKs
The OpenAPI of this product (oos/2019-06-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Region
|
API |
Title |
Description |
| DeleteTemplates | DeleteTemplates | Deletes multiple templates. |
| DeleteTemplate | DeleteTemplate | Deletes a template. |
| ListTemplateVersions | ListTemplateVersions | Lists the versions of a specified template. |
| 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. |
Template
|
API |
Title |
Description |
| StartExecution | StartExecution | Starts an execution. |
| GetExecutionTemplate | GetExecutionTemplate | Queries the information about the template of an execution, including the content of the template. |
| ListExecutions | ListExecutions | Lists query executions and supports multiple filters. |
| ListExecutionLogs | ListExecutionLogs | Returns the logs for an execution. |
| ListTaskExecutions | ListTaskExecutions | Queries task executions using multiple filters. |
| GenerateExecutionPolicy | GenerateExecutionPolicy | Queries the RAM policy required to execute a template. |
| NotifyExecution | NotifyExecution | Notifies an execution in the Waiting state of the subsequent operations. |
Execution
|
API |
Title |
Description |
| Common parameter | Common parameter | |
| DeleteParameter | DeleteParameter | Deletes common parameter. |
| GetParameter | GetParameter | Queries a standard or common parameter and its value. |
| 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. |
| Encrypted parameter | Encrypted parameter | |
| DeleteSecretParameter | DeleteSecretParameter | Deletes an encrypted parameter. This operation requires permission to call the Key Management Service (KMS) DeleteSecret API. |
| 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). |
| 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. |
Action
|
API |
Title |
Description |
| Patch baseline | Patch baseline | |
| DeletePatchBaseline | DeletePatchBaseline | Deletes a patch baseline. |
| GetPatchBaseline | GetPatchBaseline | Queries the details of a patch baseline. |
| Patch status | Patch status | |
| ListInstancePatchStates | ListInstancePatchStates | Retrieves the patch state of one or more instances. |
| ListInstancePatches | ListInstancePatches | Lists the patches for a specified instance. |
Parameter
|
API |
Title |
Description |
| SearchInventory | SearchInventory | Queries for detailed or aggregated information about inventory. |
| Encrypted parameter | Encrypted parameter |
Patch management
|
API |
Title |
Description |
| UpdateStateConfiguration | UpdateStateConfiguration | Updates a desired-state configuration. |
| Patch status | Patch status |
Configuration inventory
|
API |
Title |
Description |
| CreateOpsItem | CreateOpsItem | Creates an O\\\\\\\\\\&M Item. |
| UpdateOpsItem | UpdateOpsItem | Modifies an O\\\\\\\\\\&M item. |
Desired state configuration
|
API |
Title |
Description |
| SetServiceSettings | SetServiceSettings | Enables or disables template execution record delivery, configures delivery destinations, and associates an Apsara DevOps enterprise ID. |
| GetServiceSettings | GetServiceSettings | Retrieves the service's configuration settings, including the delivery configuration for executions and details about associated Apsara DevOps enterprises. |
O&M item
|
API |
Title |
Description |
| Application | Application | |
| 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. |
| Application group | Application group | |
| 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. |
Service configuration
|
API |
Title |
Description |
| ListTagValues | ListTagValues | Lists the values of created tags. |
Application management
|
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. |
Tag
|
API |
Title |
Description |
| GenerateOpsItem | GenerateOpsItem | Generates an O\\\&M item. |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | Retrieves the allowed values for parameters. |
| UpdateTemplateAttributes | UpdateTemplateAttributes | Updates the attributes of a template. |
| CheckGitRepoFileExists | CheckGitRepoFileExists | Checks whether a file exists in a repository. |
| ListGitOrganizations | ListGitOrganizations | Retrieves the Git organizations for an authorized user. |
| ListGitRepositories | ListGitRepositories | Lists Git repositories. |
| ListGitBranches | ListGitBranches | Lists all branches of a specified Git repository. |
| ListGitAccounts | ListGitAccounts | Lists the Git accounts authorized by the current Alibaba Cloud user for Application Management. |
| CreateGitRepository | CreateGitRepository | Creates a Git repository. |
| CheckGitRepositoryExists | CheckGitRepositoryExists | Checks whether a repository exists. |
| GetGitBranch | GetGitBranch | Queries the details of a Git branch. You can query public repositories without authorization. |
| ListGitRepositoryContents | ListGitRepositoryContents | Lists the files and directories in a repository. |
| GetGitRepository | GetGitRepository | Queries the details of a Git repository. |
| ListTaskExecutionInvocations | ListTaskExecutionInvocations | Retrieves the execution IDs of Cloud Assistant commands for a task execution. |
| GetChatConfiguration | GetChatConfiguration | Creates, updates, retrieves, and deletes chat configurations for platforms such as DingTalk. |
| CreateChatConfiguration | CreateChatConfiguration | You can create, update, query, and delete chat configurations for platforms such as DingTalk. |
| ListChatConfigurations | ListChatConfigurations | Creates, updates, retrieves, and deletes chat configurations for platforms such as DingTalk. |
| UpdateChatConfiguration | UpdateChatConfiguration | Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk. |
| DeleteChatConfiguration | DeleteChatConfiguration | Use this operation to create, update, query, and delete chat configurations for platforms such as DingTalk. |
| ListDeployRevisions | ListDeployRevisions | Lists the revisions for an application. |
| CreateDeployRevision | CreateDeployRevision | Creates a deployment revision. |
| GetDeployRevision | GetDeployRevision | Retrieves the details of an application revision. |
| StartDebugExecution | StartDebugExecution | Starts a debug execution. |
Resource group
|
API |
Title |
Description |
| CancelExecution | CancelExecution | Cancels an execution. |
| ChangeResourceGroup | ChangeResourceGroup | Modifies the resource group to which a cloud resource belongs. |
| 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. |
| 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. |
| 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. |
| CreateParameter | CreateParameter | Creates a common parameter. |
| CreatePatchBaseline | CreatePatchBaseline | Creates a patch baseline. |
| 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. |
| CreateStateConfiguration | CreateStateConfiguration | Creates a desired-state configuration. |
| CreateTemplate | CreateTemplate | Creates a template. |
| 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. |
| 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. |
| DeleteExecutions | DeleteExecutions | Deletes executions. |
| DeleteOpsItems | DeleteOpsItems | Deletes O\\\&M Items. |
| DeleteStateConfigurations | DeleteStateConfigurations | Deletes multiple desired-state configurations at a time. |
| DescribeApplicationGroupBill | DescribeApplicationGroupBill | Queries the resource costs of an application group. |
| DescribeRegions | DescribeRegions | Queries supported regions. |
| GetInventorySchema | GetInventorySchema | Queries the properties of a configuration list. |
| GetOpsItem | GetOpsItem | Queries the details of an O\\\\\\\\\\&M item. |
| ListActions | ListActions | Queries the available actions, including atomic actions and cloud product actions. |
| 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. |
| ListInventoryEntries | ListInventoryEntries | Queries the configurations of an Elastic Compute Service (ECS) instance. |
| ListOpsItems | ListOpsItems | Queries O\\\&M items. |
| ListParameters | ListParameters | Queries common parameters. Multiple methods are supported to filter common parameters. |
| ListPatchBaselines | ListPatchBaselines | Queries a list of patch baselines. |
| ListResourceExecutionStatus | ListResourceExecutionStatus | Queries the information about a scheduled execution that involves O\&M operations on Elastic Compute Service (ECS) instances. |
| ListSecretParameters | ListSecretParameters | Queries common parameters. Multiple types of queries are supported. |
| ListStateConfigurations | ListStateConfigurations | Queries desired-state configurations. |
| ListTagKeys | ListTagKeys | Queries the tags. |
| ListTagResources | ListTagResources | Queries the tags that are added to one or more resources. |
| ListTemplates | ListTemplates | Queries templates. Multiple methods are supported to filter templates. |
| RegisterDefaultPatchBaseline | RegisterDefaultPatchBaseline | Registers the default patch baseline. |
| TagResources | TagResources | Adds tags to one or more resources. |
| 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. |
| UntagResources | UntagResources | Removes tags from one or more resources. |
| 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. |
| UpdateExecution | UpdateExecution | Updates an execution in the Running or Waiting state. |
| UpdateParameter | UpdateParameter | Updates a common parameter. |
| UpdatePatchBaseline | UpdatePatchBaseline | Updates a patch baseline. |
| 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. |
| UpdateTemplate | UpdateTemplate | Updates the information about an existing template. |