Updating an Application

Function

This API is used to update an application.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/instances/{instance_id}/apps/{app_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application ID.
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Application name. Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses. Constraints: The value must be unique in an instance.
remark	No	String	Application description.
favorite	No	Boolean	Whether the application is favorited.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Application ID.
name	String	Application name. Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses. Constraints: The value must be unique in an instance.
remark	String	Application description.
roles	Array of strings	Application permissions. read: permission to read resources of an application, including API debugging. This permission must be included. access: permission to access resources of an application. delete: permission to delete resources of an application. modify: permission to modify resources of an application, including API release and removal. admin: all permissions on an application and its resources. When only the user admin is provided, all other permissions are automatically applied. The read permission is automatically applied when it is not provided.
create_time	String	Creation time.
update_time	String	Update time.
created_user	created_user object	Information about the user who created the application.
last_updated_user	last_updated_user object	Information about the user who last updated the application.
owner	Boolean	Whether the user is the owner of the application.
key	String	Application authentication access key. If no key is specified, a random value is generated. Characters allowed: letters, digits, hyphens (-), underscores (_), at signs (@), and periods (.); The value must start with a letter or digit. Constraints: The value must be unique in an instance.
favorite	Boolean	Whether to favorite the application. Favorited applications will be displayed preferentially in the list.

**Table 5** created_user
Parameter	Type	Description
user_id	String	ID of the user who created the application.
user_name	String	Name of the user who created the application.

**Table 6** last_updated_user
Parameter	Type	Description
user_id	String	ID of the user who last updated the application.
user_name	String	Name of the user who last updated the application.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_details	String	Error information.
request_id	String	Request ID.

Example Requests

Modify the name and description of a specified integration application.

{
  "name" : "AppName",
  "remark" : "example",
  "favorite" : false
}

Example Responses

Status code: 200

{
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "name" : "AppName",
  "remark" : "example",
  "roles" : [ "read, access, delete, modify, admin" ],
  "create_time" : "2019-12-06T06:49:04.000Z",
  "update_time" : "2019-12-06T06:49:04.000Z",
  "created_user" : {
    "user_id" : "string",
    "user_name" : "string"
  },
  "last_updated_user" : {
    "user_id" : "string",
    "user_name" : "string"
  },
  "owner" : true,
  "key" : "TEI9****8UM",
  "favorite" : true
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}