Creating an Environment
Function
This API is used to create an environment.
URI
POST /v3/{project_id}/cas/environments
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
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 |
---|---|---|---|
config_mode |
No |
String |
Configuration mode.
|
name |
Yes |
String |
Environment 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. Letters are case sensitive. |
deploy_mode |
No |
String |
Environment type.
To use a custom server in the created environment, select virtualmachine or mixed. |
type |
No |
String |
Whether the Kubernetes environment is of the HA type.
|
resource_create_mode |
No |
String |
Resource configuration mode.
To use a custom server in the created environment, select none. |
resources |
No |
Array of objects |
Resource list. See Table 4. |
description |
No |
String |
Environment description. The value can contain up to 128 characters. |
enterprise_project_id |
No |
String |
Enterprise project ID. If this parameter is not set, the default enterprise project is default and the ID is 0. |
vpc_id |
Yes |
String |
VPC ID. |
labels |
No |
Array of objects |
Label. You can use TMS to filter resources by labels. See Table 5. Each environment can have a maximum of 20 labels. |
environment_azs |
No |
Array of objects |
List of AZs. When type is set to high, you need to set two AZs. |
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 |
Resource type.
|
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 1 to 43 characters, including digits, letters, underscores (_), periods (.), or hyphens (-). |
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 |
Environment creator. |
create_time |
Integer |
Environment creation time. |
update_time |
Integer |
Environment update time. |
labels |
Array of objects |
Label. You can use TMS to query resources by labels. See Table 7. |
type |
String |
Whether the Kubernetes environment is of the HA type.
|
resource_create_mode |
String |
Resource configuration mode.
|
config_mode |
String |
Configuration mode.
|
env_status |
String |
Non-real-time environment resource status.
|
Example Request
Create a VM environment env-test. The ID of the VPC where the environment is located is 0c72428b-cd6c-4283-a560-210d3edb49f7.
{ "name": "env-test", "description": "", "enterprise_project_id": "0", "vpc_id": "0c72428b-cd6c-4283-a560-210d3edb49f7", "labels": [ { "key": "aaaaa", "value": "a5" } ], "deploy_mode": "virtualmachine" }
Example Response
{ "id": "c93a5313-d141-4b9f-97ce-b4ce2b3988bd", "name": "test", "description": "", "project_id": "13ae26238d724e54947af3e0fcbef9c3", "enterprise_project_id": "0", "vpc_id": "0c72428b-cd6c-4283-a560-210d3edb49f7", "creator": "ss-test", "create_time": 1681384236023, "update_time": 1681384236023, "deploy_mode": "virtualmachine", "labels": [] }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Code
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