Help Center> ServiceStage> API Reference> Application Management APIs> Environments> Obtaining Environment Details Based on the Environment ID
View PDF

Obtaining Environment Details Based on the Environment ID

Function

This API is used to obtain environment details based on the environment ID.

URI

GET /v2/{project_id}/cas/environments/{environment_id}

Table 1 Path parameters

Parameter

Type

Mandatory

Description

project_id

String

Yes

Tenant's project ID.

environment_id

String

Yes

Environment ID.

Request Parameters

Request parameters

None

Response Parameters

Response parameters

Table 2 Response parameters

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.

vpc_id

String

Virtual Private Cloud (VPC) ID.

base_resources

Array of objects

Basic resources. See Table 3.

optional_resources

Array of objects

Optional resources. See Table 3.

creator

String

Creator.

create_time

Integer

Creation time.

update_time

Integer

Update time.
Table 3 resources parameters

Parameter

Type

Description

id

String

Resource ID.

type

String

Basic resources: Cloud Container Engine (CCE), Cloud Container Instance (CCI), Elastic Cloud Server (ECS), and Auto Scaling (AS).

Optional resources: Relational Database Service (RDS), Distributed Cache Service (DCS), Elastic Load Balance (ELB), and other services.

Example

Example request

None

Example response

{
    "id": "ea011e01-2eb5-453f-87bf-874e4a855abe", 
    "name": "dev-env", 
    "alias": null, 
    "description": "develop environment", 
    "project_id": "bf8523d898b64e4eb956e3be3555ca16", 
    "enterprise_project_id": "0", 
    "charge_mode": "provided", 
    "vpc_id": "234241234124xxvasf2342xxxxxxxxxxx", 
    "base_resources": [
        {
            "id": "211112333sd332w23322332", 
            "type": "cce"
        }
    ], 
    "optional_resources": null, 
    "creator": "string", 
    "create_time": 1578984198394, 
    "update_time": 1578984198394
}

Status Code

Table 4 Status codes

HTTP Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error code must be in the format of SVCSTG.00100.[Error_ID]. Example: SVCSTG.00100400. See Error Codes of Application Management APIs.

Parent topic: Environments