Updates the description of an application.
Try it now
Test
RAM authorization
|
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 |
| TraceId |
string |
The trace ID used to query invocation details. |
ac1a0b2215622246421415014e**** |
| ErrorCode |
string |
The error code. Valid values:
|
InvalidParameter.NotEmpty |
| Code |
string |
The API status code or POP error code. Valid values:
|
200 |
| Success |
boolean |
Indicates whether the application is deployed successfully. Valid values:
|
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.