Updated on 2023-11-23 GMT+08:00

Updating an Application Template

Function

This API is used to update an application template.

URI

PUT /v2/{project_id}/edgemgr/apps/{app_id}

Table 1 Path parameters

Parameter

Mandatory

Description

project_id

Yes

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

app_id

Yes

Application template ID.

Request

Request parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

The default value application/json is recommended.

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

alias

No

String

Application template alias. The value contains a maximum of 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

description

No

String

Application template description. The value contains a maximum of 255 characters. The following characters are not allowed: ^~#$%&*<>()[]{}'"\

Example request

{
    "app": {
        "alias": "Optical character recognition",
        "description": "This is a test."
    }
}

Response

Response parameters

Table 4 Parameters in the response body

Parameter

Type

Description

app

Table 5 object

Application template details.

Table 5 app

Parameter

Type

Description

id

String

Application template ID.

name

String

Application template name.

description

String

Application template description.

created_at

String

Time when the application is created.

updated_at

String

Time when the application is updated.

visibility

String

Template type.

app_versions

Table 17 object

Application version information.

alias

String

Application template alias.

project_id

String

Project ID.

icon_url

String

URL of the application icon. The value contains a maximum of 2,083 characters.

Example response

{
    "app":{
        "name":"test",
        "created_at":"2018-05-25T03:26:33",
        "updated_at":"2018-05-25T03:29:48",
        "visibility":"private",
        "alias":"Optical character recognition",
        "project_id":"{project_id}",
        "id":"2873e595-a55c-4d55-aa8f-eefcbd2b5027",
        "description":"This is a test.",
        "app_versions":[
            {
                "envs":[

                ],
                "created_at":"2018-05-23T03:58:41",
                "args":[

                ],
                "updated_at":null,
                "cpu":0.01,
                "version":"1.0.0",
                "image_url":"",
                "volumes":[

                ],
                "memory":1,
                "configs":{
                    "host_network":true,
                    "privileged":false
                },
                "project_id":"{project_id}",
                "id":"6670f491-72d9-46e8-85f3-3a480b636205"
            }
        ]
    }
}

Error Codes

For details, see Error Codes.