API overview-CloudOps Orchestration Service(OOS)-阿里云帮助中心

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
GetGitRepository	Query a git repository	Queries the details of a Git repository.
DescribeRegions	Query supported regions	Queries the regions that are currently supported.

Template

API	Title	Description
CreateTemplate	Create a template	Creates a template.
DeleteTemplates	Delete multiple templates	Deletes multiple templates.
DeleteTemplate	Delete a template	Deletes a template.
UpdateTemplate	Update an existing template	Updates an existing template.
ListTemplateVersions	Query multiple version objects of a template	Queries multiple version objects of a template.
ListTemplates	Query templates	Queries templates. Supports multiple filtering methods.
GetTemplate	Retrieve a template	Retrieves a template, including its content.
ListExecutionRiskyTasks	Retrieve high-risk tasks in a template	Retrieves high-risk tasks in a template.
ValidateTemplateContent	Validate whether a template is valid	Validates whether a template is valid.
UpdateTemplateAttributes	Update template properties	Updates template properties.
GetTemplateParameterConstraints	Get available values for template parameters	Retrieves the available values for template parameters.

Execution

API	Title	Description
DeleteExecutions	Delete an execution	Deletes an execution.
StartExecution	Start a task execution	Starts a task execution.
UpdateExecution	Update an unfinished execution	Updates an execution that has not ended (in Running or Waiting status).
GetExecutionTemplate	Retrieve the template used by a task execution	Retrieves the template used by a task execution, including its content.
ListExecutions	Query task executions	Queries task executions with support for multiple filtering methods.
ListExecutionLogs	Retrieve detailed exec logs	Retrieves the detailed logs of an exec.
ListTaskExecutions	Query task executions	Queries task executions with support for multiple filtering methods.
ListResourceExecutionStatus	Query scheduled O&M execution information that includes ECS instances	Queries the scheduled O&M execution information that includes ECS instances.
CancelExecution	Cancel a task execution	Cancels a task execution.
GenerateExecutionPolicy	Retrieve RAM policy required for execution	Retrieves the RAM policy required for template execution.
NotifyExecution	Notify an execution how to proceed	Notifies a waiting execution of how to proceed.
TriggerExecution	Trigger event execution	Sends a message body to an event trigger, alarm trigger, or timer trigger task execution, which causes the event, alarm, or timer task to create a new child execution.
StartDebugExecution	Test execute a task	Starts a task execution.
ListTaskExecutionInvocations	Retrieve the Cloud assistant command invocation ID within a task execution	Retrieves the Cloud Assistant command invocation ID within a task execution.

Action

API	Title	Description
ListActions	Query available actions	Queries available actions, including atomic actions and cloud product actions.

Parameter

API	Title	Description
Common parameter	Common parameter
CreateParameter	Create a common parameter	Creates a common parameter.
DeleteParameter	Delete a common parameter	Deletes a common parameter.
UpdateParameter	Update an existing common parameter	Updates an existing common parameter.
GetParameter	Retrieve a common parameter	Retrieves a common parameter or a public parameter, including the parameter value.
ListParameters	Query parameters	Queries parameters and common parameters. Multiple query methods are supported.
ListParameterVersions	Query multiple version objects of a common parameter	Queries multiple version objects of a common parameter.
GetParametersByPath	Retrieve common parameters by path	Retrieves parameters by path.
GetParameters	Retrieve the details of one or more common parameters	Retrieves the details of one or more parameters.
Encrypted parameter	Encrypted parameter
CreateSecretParameter	Create an encrypted parameter	Creates an encrypted parameter. Make sure you have the permission to call the KMS CreateSecret API operation before calling this operation.
DeleteSecretParameter	Delete an encrypted parameter	Deletes an encrypted parameter. Ensure that you have the permission to call the KMS DeleteSecret API operation before calling this operation.
UpdateSecretParameter	Update an encryption parameter	Updates an encryption parameter. Make sure you have the permission to call the KMS UpdateSecretValue API operation before calling this operation.
GetSecretParameter	Retrieve an encrypted parameter and its value	Retrieves an encrypted parameter, including its value. Ensure that you have the permission to call the KMS GetSecretValue API operation before calling this operation.
ListSecretParameters	List encrypted parameters	Queries common parameters. Multiple query methods are supported.
ListSecretParameterVersions	Query multiple versions of an encryption parameter	Queries multiple versions of an encryption parameter.
GetSecretParametersByPath	Retrieve encryption parameters by path	Retrieves encryption parameters by path. Make sure you have the permission to call the KMS GetSecretValue API operation before calling this operation.
GetSecretParameters	Retrieve the details of one or more encryption parameters	Retrieves the details of one or more encryption parameters. Make sure that you have the permission to call the KMS GetSecretValue API operation before calling this operation.

Patch management

API	Title	Description
Patch baseline	Patch baseline
CreatePatchBaseline	Create a patch baseline	Creates a patch baseline.
DeletePatchBaseline	Delete a patch baseline	Deletes a patch baseline.
UpdatePatchBaseline	Update a patch baseline	Updates a patch baseline.
GetPatchBaseline	Get patch baseline	Retrieves the details of a patch baseline.
ListPatchBaselines	List patch baselines	Retrieves a list of patch baselines.
RegisterDefaultPatchBaseline	Register a default patch baseline	Registers a default patch baseline.
Patch status	Patch status
ListInstancePatchStates	List instance patch states	Retrieves patch information for instances.
ListInstancePatches	List instance hotfixes	Retrieves patch information for an instance.

Configuration inventory

API	Title	Description
ListInventoryEntries	Query configuration checklist records of an instance	Queries the configuration checklist records of an instance.
GetInventorySchema	GetInventorySchema	Queries the properties of a configuration list.
SearchInventory	Query configuration checklist details or aggregate information	Queries the details or aggregate information of a configuration checklist.

Desired state configuration

API	Title	Description
CreateStateConfiguration	Create a desired state configuration	Creates a desired state configuration.
DeleteStateConfigurations	Delete multiple desired state configurations	Deletes multiple desired state configurations in a batch.
UpdateStateConfiguration	Update a desired state configuration	Updates a desired state configuration.
ListStateConfigurations	Query desired state configurations	Queries desired state configurations.

O&M item

API	Title	Description
CreateOpsItem	Create an opsItem	Creates an OpsItem.
GetOpsItem	Retrieve O&M item details	Retrieves the details of an O&M item.
ListOpsItems	Query opsItems	Queries OpsItems.
UpdateOpsItem	Update an opsItem	Modifies an OpsItem.
DeleteOpsItems	Batch delete O&M items	Deletes O&M items.
GenerateOpsItem	Generate O&M items	Generates O&M items.

Service configuration

API	Title	Description
SetServiceSettings	Set service configurations	Enables or disables the delivery of template execution records, specifies the delivery storage location, and associates a China DevOps enterprise ID.
GetServiceSettings	Retrieve service configuration information	Retrieves the configuration information of a service, including the configuration of the task execution record delivery feature and the associated Apsara Devops enterprise.

Application management

API	Title	Description
Application	Application
CreateApplication	Create an application	Creates an application. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
DeleteApplication	Delete an application	Deletes an application. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
UpdateApplication	Update an application	Updates an application. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
GetApplication	Retrieve the details of an application	Retrieves the details of an application. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
ListApplications	Query application list	Queries the list of applications. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
ListDeployRevisions	ListDeployRevisions	Lists the revisions for an application.
CreateDeployRevision	Create a deployment artifact	Creates a deployment artifact.
GetDeployRevision	GetDeployRevision	Retrieves the details of an application revision.
Application group	Application group
CreateApplicationGroup	Create an application group	Creates an application group. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
DeleteApplicationGroup	Delete an application group	Deletes an application group. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
UpdateApplicationGroup	Update the information of an application group	Updates the information of an application group. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
GetApplicationGroup	Retrieve the details of an application group	Retrieves the details of an application group. The application management service is available only in the China (Hangzhou) region. Use the Hangzhou endpoint.
ListApplicationGroups	Query application groups	Queries the list of application groups. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.
DeployApplicationGroup	Deploy an application group	Deploys an application group. Application management is supported only in the Hangzhou region. Use the Hangzhou endpoint.
ContinueDeployApplicationGroup	Continue deploying an application group	Continues deploying an application group when the deployment fails. Application management is supported only in the Hangzhou region. Use the Hangzhou endpoint.
DescribeApplicationGroupBill	Query application group resource costs	Queries the resource costs of an application group.

Git

API	Title	Description
CheckGitRepoFileExists	Check whether a file exists in a specified repository	Checks whether a file exists in a repository.
ListGitOrganizations	Query organizations of a logon account	Retrieves the organizations of an authorized user.
ListGitRepositories	List repositories	Queries the list of Git repositories.
CreateGitRepository	Create a git repository	Creates a repository.
ListGitAccounts	List bound git accounts	Retrieves the managed platform accounts that the current Alibaba Cloud user has authorized in application management.
ListGitBranches	Query branches of a specified repository	Retrieves all branches of a specified Git repository.
CheckGitRepositoryExists	Check whether a repository exists	Checks whether a repository exists.
GetGitBranch	Get branch details	Queries the details of a Git branch. Supports querying public repositories without authorization.
ListGitRepositoryContents	Get repository file and directory content	Retrieves file and directory information from a repository.

Tag

API	Title	Description
ListTagKeys	Query created labels	Queries created labels.
ListTagValues	Query created label values	Queries the created label values.
ListTagResources	Query resource-label relationships	Queries visible resource-label relationships.
UntagResources	Delete user tag-resource relationships	Deletes user tag-resource relationships to remove user tags from resources.
TagResources	Create tag-resource relationships	Creates tag-resource relationships to add user tags to resources.

Resource group

API	Title	Description
ChangeResourceGroup	Change resource group	Modifies the resource group to which a cloud resource belongs.

Extension

API	Title	Description
UpdateInstancePackageState	Update an extension installed on an instance	Updates an extension installed on an instance.
ListInstancePackageStates	Query extensions installed on an instance	Lists the software package states of an instance.

AI assistant configuration

API	Title	Description
CreateChatConfiguration	Create a chat configuration	Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk.
UpdateChatConfiguration	Update chat configuration	Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk.
GetChatConfiguration	View chat configuration	Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk.
ListChatConfigurations	List chat configurations	Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk.
DeleteChatConfiguration	Delete a conversation configuration	Creates, updates, queries, and deletes chat configurations for platforms such as DingTalk.