Modifying Environment Information
Function
This API is used to modify environment information based on the environment ID.
URI
PUT /v2/{project_id}/cas/environments/{environment_id}
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Tenant's project ID. |
environment_id |
String |
Yes |
Environment ID. |
Request
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
name |
String |
No |
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. |
alias |
String |
No |
Environment alias. The value can contain up to 64 characters. |
description |
String |
No |
Environment description. The value can contain up to 128 characters. |
Response
Parameter |
Type |
Description |
---|---|---|
id |
String |
Environment ID. |
name |
String |
Environment name. |
alias |
String |
Environment alias. |
description |
String |
Environment description. |
project_id |
String |
Project ID. |
enterprise_project_id |
String |
Enterprise project ID. |
charge_mode |
String |
Fixed value: provided. |
vpc_id |
String |
VPC ID. |
base_resources |
Array of objects |
Basic resources. See Table 4. |
optional_resources |
Array of objects |
Optional resources. See Table 4. |
creator |
String |
Creator. |
create_time |
Integer |
Creation time. |
update_time |
Integer |
Update time. |
Example
Example request
{ "name": "development-env2", "description": "here is description" }
Example response
{ "id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "name": "development-env2", "alias": null, "description": "here is description", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "charge_mode": "provided", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "type": "cce", "name": "cce-test" } ], "optional_resources": [ { "id": "9963306a-791e-468c-9306-cf80a9d00298", "type": "elb", "name": "elb-2dd2" } ], "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610420992462 }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Code
Error code must be in the format of SVCSTG.00100.[Error_ID]. Example: SVCSTG.00100400. See Error Codes of Application Management APIs.
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