All Products
Search
Document Center

Serverless App Engine:UpdateApplicationDescription

Last Updated:Oct 21, 2026

Updates the description of an application.

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

sae:UpdateApplicationDescription

*All Resource

*

None None

Request syntax

PUT /pop/v1/sam/app/updateAppDescription HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AppId

string

Yes

The ID of the application to update.

7171a6ca-d1cd-4928-8642-7d5cfe69****

AppDescription

string

Yes

The updated description of the application. The description can be up to 1,024 characters in length.

newdesc

Response elements

Element

Type

Description

Example

object

The response information.

RequestId

string

The ID of the request.

01CF26C7-00A3-4AA6-BA76-7E95F2A3***

Message

string

The additional information. Valid values:

  • success: The request is successful.

  • Specific error code: The request is abnormal.

success

TraceId

string

The trace ID used to query invocation details.

ac1a0b2215622246421415014e****

ErrorCode

string

The error code. Valid values:

  • Successful request: The ErrorCode parameter is not returned.

  • Failed request: The ErrorCode parameter is returned. For more information, see the Error codes section in this topic.

InvalidParameter.NotEmpty

Code

string

The API status code or POP error code. Valid values:

  • 2xx: Success.

  • 3xx: Redirection.

  • 4xx: Client error.

  • 5xx: Server error.

200

Success

boolean

Indicates whether the application is deployed successfully. Valid values:

  • true: The deployment is successful.

  • false: The deployment failed.

true

Examples

Success response

JSON format

{
  "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3***",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "ErrorCode": "InvalidParameter.NotEmpty",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter.NotEmpty You must specify the parameter %s. Invalid parameter: %s cannot be empty.
400 InvalidApplication.NotFound The current application does not exist. The current application cannot be found.
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s Invalid parameter {%s}: %s.
404 InvalidAppId.NotFound The specified AppId does not exist. The specified AppId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.