Obtaining Environment Details Based on the Environment ID
Function
This API is used to obtain environment details based on the environment ID.
URI
GET /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 (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 the token, see Authentication. |
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 filter resources by labels. See Table 4. |
resources |
Array of objects |
Resource. See Table 5. |
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 |
Environment resource status (non-real-time status).
|
configuration |
Object |
Environment variable of the environment. See Table 6. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
name |
String |
Resource name. |
type |
String |
Resource type.
|
core |
String |
Number of cores of the custom server. This parameter is returned when the resource type is customServer. |
gib |
String |
Memory of the custom server, in Gib. This parameter is returned when the resource type is customServer. |
Parameter |
Type |
Description |
---|---|---|
resource_envs |
Array of objects |
Resource variable bound to the environment. See Table 7. |
envs |
Array of objects |
Environment variable of the environment. See Table 8. |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
ID of the resource associated with the resource variable bound to the environment. |
resource_name |
String |
Name of the resource associated with the resource variable bound to the environment. |
resource_type |
String |
Type of the resource associated with the resource variable bound to the environment. |
envs |
Array of objects |
Resource variable bound to the environment. See Table 8. |
Example Request
None
Example Response
{ "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", "name": "dev-env", "description": "develop environment", "project_id": "bf8523d898b64e4eb956e3be3555ca16", "enterprise_project_id": "0", "deploy_mode": "virtualmachine", "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", "resources": [ { "id": "329b135e-7b31-4ea6-afb9-b69017bd0a80", "type": "ecs", "name": "ecs-test" } ], "creator": "ss-test", "create_time": 1578984198394, "update_time": 1578984198394, "labels": null }
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