Updated on 2026-04-10 GMT+08:00

Obtaining All Environments

Function

This API is used to obtain all created environments.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:environment:list

    list

    -

    -

    servicestage:app:list

    -

URI

GET /v3/{project_id}/cas/environments

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Number of query results.

Constraints

N/A

Range

1~100

Default Value

10

offset

No

Integer

Definition

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

Constraints

N/A

Range

N/A

Default Value

0

order_by

No

String

Definition

Sorting field.

Constraints

N/A

Range

Numerated values:

  • create_time: environment creation time.
  • name: environment name.
  • update_time: environment modification time.

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

Default Value

create_time

order

No

String

Definition

Sorting order.

Constraints

N/A

Range

  • desc: descending order
  • asc: ascending order

Default Value

desc

name

No

String

Definition

Environment name.

Range

N/A

Default Value

N/A

environment_id

No

String

Definition

Environment ID.

Range

N/A

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID.

Range

N/A

Default Value

N/A

Request

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Message body type (or format).

Constraints

N/A

Range

application/json;charset=utf8

Default Value

N/A

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Response

Table 4 Response parameters

Parameter

Type

Description

count

Integer

Definition

Total number of environments.

Range

N/A

environments

Array of objects

Definition

Environment parameters. See Table 5.

Table 5 environments

Parameter

Type

Description

id

String

Definition

Environment ID.

Range

N/A

name

String

Definition

Environment name.

Range

N/A

description

String

Definition

Environment description.

Range

N/A

project_id

String

Definition

Project ID.

Range

N/A

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

deploy_mode

String

Definition

Environment type.

Range

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

vpc_id

String

Definition

VPC ID.

Range

N/A

creator

String

Definition

Environment creator.

Range

N/A

create_time

Integer

Definition

Environment creation time.

Range

N/A

update_time

Integer

Definition

Environment update time.

Range

N/A

labels

Array of objects

Definition

Label. You can use TMS to filter resources by labels. See Table 6.

type

String

Definition

Whether the Kubernetes environment is of the HA type.

Range

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

resource_create_mode

String

Definition

Resource configuration mode.

Range

  • none: resource management.

config_mode

String

Definition

Configuration mode.

Range

  • ui

env_status

String

Definition

Non-real-time environment resource status.

Range

  • REFRESHING
  • UNKNOWN
  • NORMAL
  • PARTIALLY_NORMAL
Table 6 labels

Parameter

Type

Description

key

String

Definition

Label name.

Range

N/A

value

String

Definition

Label value.

Range

N/A

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.