Updated on 2025-07-10 GMT+08:00

Obtaining All Environments

Function

This API is used to obtain all created environments.

URI

GET /v3/{project_id}/cas/environments

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records to be queried. Value range: 0–100.

offset

No

Integer

Query offset, which indicates the result after the Nth data record is queried.

order_by

No

String

Sorting field.

Numerated values:

  • create_time (default)
  • name
  • update_time

If the transferred value is not within the supported enumerated value range, the default sorting field is used.

order

No

String

Sorting order.

  • desc (default)
  • asc

name

No

String

Environment name.

environment_id

No

String

Environment ID.

enterprise_project_id

No

String

Enterprise project ID.

Request

Table 3 Request header parameters

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

Table 4 Response parameters

Parameter

Type

Description

count

Integer

Total number of environments.

environments

Array of objects

Environment parameters. See Table 5.

Table 5 environments

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.

  • virtualmachine
  • container: Kubernetes
  • mixed: VM and Kubernetes.

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

type

String

Whether the Kubernetes environment is of the HA type.

  • normal: non-HA environment.
  • high: HA environment.

resource_create_mode

String

Resource configuration mode.

  • none: resource management.

config_mode

String

Configuration mode.

  • ui

env_status

String

Non-real-time environment resource status.

  • REFRESHING
  • UNKNOWN
  • NORMAL
  • PARTIALLY_NORMAL
Table 6 labels

Parameter

Type

Description

key

String

Label name.

value

String

Label value.

Example Request

None

Example Response

{
	"environments": [
		{
			"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e",
			"name": "development-env",
			"description": "",
			"project_id": "e7d2e9c589e5445e808a8ff0d1235aca",
			"enterprise_project_id": "0",
                        "deploy_mode": "virtualmachine",
			"vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd",
			"creator": "ss-test",
			"create_time": 1610418873730,
			"update_time": 1610418873730,
                        "labels": null
		}
	],
	"count": 1
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.