On this page

Show all

Help Center/ ServiceStage/ API Reference/ Historical APIs/ Application Management V2 APIs/ Application/ Modifying Application Configurations

Modifying Application Configurations

Updated on 2024-10-16 GMT+08:00

View PDF

Function

This API is used to modify application configurations.

Application configurations refer to common environment variables of an application. Components deployed in the application inherit these environment variables.

URI

PUT /v2/{project_id}/cas/applications/{application_id}/configuration

**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
environment_id	Yes	String	Environment ID, which can be obtained in the corresponding environment by referring to Obtaining All Environments.
configuration	Yes	Object	Application configurations, such as public environment variables. See Table 4.

**Table 4** configuration
Parameter	Mandatory	Type	Description
env	Yes	Array of objects	Environment variables of the application. See Table 5. If the names of multiple environment variables are the same, only the last environment variable takes effect.

**Table 5** env
Parameter	Mandatory	Type	Description
name	Yes	String	Name of the environment variable. The value contains 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and dots (.), and cannot start with a digit.
value	Yes	String	Value of the environment variable.

NOTICE:

The env variable in the request parameter configuration will overwrite the existing environment variable configuration of the application. Set this parameter based on the scenario where environment variables are added or replaced.

Response

**Table 6** Response parameters
Parameter	Type	Description
application_id	String	Application ID.
environment_id	String	Environment ID.
configuration	Object	Application configurations. See Table 7.

**Table 7** configuration
Parameter	Type	Description
env	Array of objects	Environment variables of the application. See Table 8.

**Table 8** env
Parameter	Type	Description
name	String	Name of the environment variable.
value	String	Value of the environment variable.

Example Request

Modify the environment whose ID is 0fa75dfe-0d32-4bc1-848b-8008cf3f2567 by changing the name to app-env and the value to env.

{
    "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", 
    "configuration": {
        "env": [
            {
                "name": "app-env", 
                "value": "env"
            }
        ]
    }
}

Example Response

{
    "application_id": "06cf2fda-af45-44b4-9e22-6294c4804515", 
    "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", 
    "configuration": {
        "env": [
            {
                "name": "app-env", 
                "value": "env"
            }
        ]
    }
}

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.

Parent topic: Application

Previous topic: Obtaining Application Details Based on the Application ID

Next topic: Deleting Application Configurations

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot