UpdateApplicationDescription - Serverless App Engine - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request and response headers.

Request syntax

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

Request parameters

Parameter	Type	Position	Required	Example	Description
AppId	String	Query	Yes	7171a6ca-d1cd-4928-8642-7d5cfe69****	The ID of the application that you want to update.
AppDescription	String	Query	Yes	newdesc	The new description of the application. The description cannot exceed 1,024 characters in length.

Response parameters

Parameter	Type	Example	Description
RequestId	String	01CF26C7-00A3-4AA6-BA76-7E95F2A3***	The request ID.
Message	String	success	The returned message. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.
TraceId	String	ac1a0b2215622246421415014e****	The trace ID that is used to query the details of the request.
ErrorCode	String	Null	The error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section in this topic.
Code	String	200	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.
Success	Boolean	true	Indicates whether the application was deployed. Valid values: true: The application was deployed. false: The application failed to be deployed.

Examples

Sample requests

PUT /pop/v1/sam/app/updateAppDescription?AppId=7171a6ca-d1cd-4928-8642-7d5cfe69****&AppDescription=newdesc HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateApplicationDescriptionResponse>
    <RequestId>01CF26C7-00A3-4AA6-BA76-7E95F2A3***</RequestId>
    <Message>success</Message>
    <TraceId>ac1a0b2215622246421415014e****</TraceId>
    <Code>200</Code>
    <Success>true</Success>
</UpdateApplicationDescriptionResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	The value of the %s parameter is invalid. This parameter cannot be left empty.
400	InvalidApplication.NotFound	The current application does not exist.	The specified application is not found.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	The value %s of the {%s} parameter is invalid.
404	InvalidAppId.NotFound	The specified AppId does not exist.	The specified application ID does not exist.

For a list of error codes, see Service error codes.