Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Application/ Modifying Application Information Based on the Application ID
Updated on 2024-10-16 GMT+08:00

Modifying Application Information Based on the Application ID

Function

This API is used to modify application information based on the application ID.

URI

PUT /v3/{project_id}/cas/applications/{application_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

application_id

Yes

String

Application ID. See Obtaining All Applications.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain a token, see Obtaining a User Token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Application name.

The value contains 2 to 64 characters consisting of letters, digits, hyphens (-), or underscores (_). It starts with a letter and ends with a letter or digit.

description

No

String

Application description.

The value can contain up to 128 characters.

enterprise_project_id

No

String

Enterprise project ID.

labels

No

Array of objects

Label. You can use TMS to filter resources by labels. See Table 4.

Each application can have a maximum of 20 labels.

Table 4 labels

Parameter

Mandatory

Type

Description

key

Yes

String

Label name.

Labels are used to identify cloud resources. When you have multiple cloud resources of the same type, you can use labels to classify them based on usage, owner, or environment.

The value contains 1 to 36 characters, including digits, letters, underscores (_), or hyphens (-).

value

Yes

String

Label value.

The value contains 2 to 43 characters, including digits, letters, underscores (_), periods (.), or hyphens (-).

Response

Table 5 Response parameters

Parameter

Type

Description

id

String

Application ID.

name

String

Application name.

description

String

Application description.

creator

String

Application creator.

project_id

String

Project ID.

enterprise_project_id

String

Enterprise project ID.

create_time

Integer

Application creation time.

update_time

Integer

Application update time.

component_count

Integer

Number of components deployed in an application.

labels

Array of objects

Label. You can use TMS to filter resources by labels. See Table 6.

Table 6 labels

Parameter

Type

Description

key

String

Label name.

value

String

Label value.

Example Request

Modify the application name to app-xpmtii2, description to test2, and label key-value pair to "key":"var".

{
    "name": "app-xpmtii2",
    "description": "test2",
    "labels": [
        {
            "key": "key",
            "value": "var"
        }
    ]
}

Example Response

{
    "id": "dae29983-c1e9-437d-a6be-5256076fe605",
    "name": "app-xpmtii2",
    "description": "test2",
    "project_id": "063a3158b1a34710b36ad208b9497d00",
    "creator": "ss-test",
    "create_time": 1679468852302,
    "update_time": 1679470928765,
    "component_count": 0,
    "labels": [
        {
            "key": "key",
            "value": "var"
        }
    ]
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.