Modifying Environment Resources
Function
This API is used to modify environment resources.
URI
PATCH /v2/{project_id}/cas/environments/{environment_id}/resources
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 (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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
add_base_resources |
No |
Array of objects |
Basic resources to be added. See Table 4. |
add_optional_resources |
No |
Array of objects |
Optional resources to be added. See Table 5. |
remove_resources |
No |
Array of objects |
Resources to be removed. See Table 6. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Resource ID. (To ensure that the API can be called properly, enter the correct resource ID.) |
name |
No |
String |
Resource name. |
type |
Yes |
String |
Basic resources: cce, as, and ecs. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Resource ID. (To ensure that the API can be called properly, enter the correct resource ID.) |
name |
No |
String |
Resource name. |
type |
Yes |
String |
Optional resources: rds, dcs, elb, cse, and other services. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Resource ID. (To ensure that the API can be called properly, enter the correct resource ID.) |
name |
No |
String |
Resource name. |
type |
Yes |
String |
Basic resources: cce, as, and ecs. When deploy_mode is set to virtualmachine, you can add ecs and as. When deploy_mode is set to container, you can add cce. Optional resources: rds, dcs, elb, cse, and other services. |
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 |
Billing mode. |
deploy_mode |
String |
Environment type.
|
vpc_id |
String |
VPC ID. |
base_resources |
Array of objects |
Basic resources. See Table 8. |
optional_resources |
Array of objects |
Optional resources. See Table 8. |
creator |
String |
Creator. |
create_time |
Integer |
Creation time. |
update_time |
Integer |
Update time. |
Example Request
Add ECS basic resource ecs-9876 and CSE optional resource Cloud Service Engine, and remove ECS resource test.
{ "add_base_resources": [ { "id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e", "type": "ecs", "name": "ecs-9876" } ], "add_optional_resources": [ { "id": "default", "type": "cse", "name": "Cloud Service Engine" } ], "remove_resources": [ { "id": "523498f1-36c4-11eb-ae36-0255ac1000c2", "name": "test", "type": "ecs" } ] }
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", "deploy_mode": "virtualmachine", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e", "type": "ecs", "name": "ecs-9876" } ], "optional_resources": [ { "id": "9963306a-791e-468c-9306-cf80a9d00298", "type": "elb", "name": "elb-2dd2" }, { "id": "default", "type": "cse", "name": "Cloud Service Engine" } ], "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
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