Help Center> ServiceStage> API Reference> Application Management V3 APIs> Environment> Obtaining Environment Details Based on the Environment ID
Updated on 2023-10-18 GMT+08:00

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}

Table 1 Path parameters

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

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type or format.

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.

Response

Table 3 Response parameters

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

Creator.

create_time

Integer

Creation time.

update_time

Integer

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.

Table 4 labels parameters

Parameter

Type

Description

key

String

Label name.

value

String

Label value.

Table 5 resources parameters

Parameter

Type

Description

id

String

Resource ID.

name

String

Resource name.

type

String

Resource type.

  • vpc
  • eip
  • elb
  • cce
  • ecs
  • as
  • cse
  • dcs
  • rds

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

Table 6 Status codes

HTTP 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.