All Products
Search
Document Center

Serverless App Engine:UpdateApplicationDescription

Last Updated:Dec 17, 2025

Updates the description of an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:UpdateApplicationDescription
*All Resources
*
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application that you want to update.

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

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

newdesc

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

Request ID.

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

The message returned. The following limits are imposed on the ID:

  • If the request was successful, success is returned.
  • An error code is returned when a request failed.
success
TraceIdstring

The ID of the trace. The ID is used to query the details of a request.

ac1a0b2215622246421415014e****
ErrorCodestring

The error code returned if the call failed. Value values:

  • If the request was successful, ErrorCode is not returned.
  • If the request failed, ErrorCode is returned. For more information, see Error codes in this topic.
400
Codestring

The HTTP status code or the error code. Valid values:

  • 2xx: The request was successful.
  • 3xx: The request was redirected.
  • 4xx: The request failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the application was deployed. Valid values:

  • true: The application was deployed.
  • false: The application failed to be deployed.
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400InvalidParameter.NotEmptyYou must specify the parameter %s.
400InvalidApplication.NotFoundThe current application does not exist.
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s
404InvalidAppId.NotFoundThe specified AppId does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history