Modifying an Environment Based on the Environment ID
Function
This API is used to modify an environment based on the environment ID.
URI
PUT /v3/{project_id}/cas/environments/{environment_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
environment_id |
Yes |
String |
Environment ID. See Obtaining All Environments. |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type or format. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Environment name. The value contains 2 to 64 characters consisting of letters, digits, hyphens (-), and underscores (_). It starts with a letter and ends with a letter or digit. Letters are case insensitive. |
description |
No |
String |
Environment description. The value can contain up to 128 characters. |
labels |
No |
Array of objects |
Label. You can use TMS to filter resources by labels. See Table 4. |
Response
Parameter |
Type |
Description |
---|---|---|
id |
String |
Environment ID. |
name |
String |
Environment name. |
description |
String |
Environment description. |
project_id |
String |
Project ID. |
enterprise_project_id |
String |
Enterprise project ID. |
deploy_mode |
String |
Environment type. |
vpc_id |
String |
VPC ID. |
creator |
String |
Creator. |
create_time |
Integer |
Creation time. |
update_time |
Integer |
Update time. |
labels |
Array of objects |
Label. You can use TMS to filter resources by labels. See Table 6. |
resources |
Array of objects |
Resource. See Table 7. |
Example Request
Modify the environment name to development-env, leave the description blank, and add a label whose key-value pair is "test": "value" to the environment.
{ "name": "development-env", "description": "", "labels": [ { "key": "test", "value": "value" } ] }
Example Response
{ "id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "name": "development-env", "description": "", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "deploy_mode": "virtualmachine", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610418873730, "resources": [ { "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80", "type": "ecs", "name": "ecs-test" } ], "labels": [ { "key": "test", "value": "value" } ] }
Status Code
HTTP 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot