Automate App Updates with UpdateApplication API - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Updates an application. The service region for application management supports only Hangzhou. Use the Hangzhou endpoint.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:UpdateApplication

update

*Application

acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Only cn-hangzhou is supported.	cn-hangzhou
Name	string	Yes	The application name.	My-Application
Description	string	No	The description to update for the application.	test application
Tags	object	No	The tags.	{"k1":"v1","k2":"v2"}
AlarmConfig	object	No	The alert configuration for the application.
ContactGroups	array	No	The alert contact groups.
	string	No	The name of the alert contact group.	Cloud account alert contact
TemplateIds	array	No	The alert template group.
	string	No	The alert template ID. For information about how to obtain an alert template ID, see DescribeMetricRuleTemplateList.	d8d1153c517f4971a37350ba8c021c26
HealthCheckUrl	string	No	The health check URL of the application.	/healthcheck/tcp50122
DeleteAlarmRulesBeforeUpdate	boolean	No	Specifies whether to delete existing alert rules before applying the alert template. Default value: false.	false
ApplicationSource	string	No	The application source.	{"Platform":"github","Owner":"githubUser","RepoName":"githubUser/repoName"}

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F1F00F41-D24C-5377-831B-C97F739CE1AB
Application	object	The application information.
Description	string	The application description.	test application
UpdatedDate	string	The update time, in ISO 8601 format, in UTC.	2021-09-07T10:17:46Z
ResourceGroupId	string	The resource group ID.	rg-acfmxsn4m*****
CreatedDate	string	The creation time, in ISO 8601 format, in UTC.	2021-09-07T09:17:46Z
Tags	object	The tags.	{"k1":"v1","k2":"v2"}
Name	string	The application name.	My-Application

Examples

Success response

JSON format

{
  "RequestId": "F1F00F41-D24C-5377-831B-C97F739CE1AB",
  "Application": {
    "Description": "test application",
    "UpdatedDate": "2021-09-07T10:17:46Z",
    "ResourceGroupId": "rg-acfmxsn4m*****",
    "CreatedDate": "2021-09-07T09:17:46Z",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Name": "My-Application"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.