Function
This API is used to obtain all created environments.
URI
GET /v2/{project_id}/cas/environments
Parameter | Type | Mandatory | Description |
---|---|---|---|
project_id | String | Yes | Tenant's project ID. |
Parameter | Type | Mandatory | Description |
---|---|---|---|
limit | Integer | No | Number of records to be displayed. The value is 1000 or ranges from 0 to 100. If the specified value is not within the range, value 10 is assigned. In the non-pagination scenario, the value is 1000. In the pagination scenario, the value ranges from 0 to 100. |
offset | Integer | No | Offset, which indicates the result after the Nth data record is queried. |
order_by | String | No | Sorting field. By default, query results are sorted by creation time. The following enumerated values are supported: create_time, name, and update_time. If the transferred value is not within the supported enumerated value range, the default sorting field is used. |
order | String | No | Descending or ascending order. Default value: desc. |
Request
None
Response
Parameter | Type | Description |
---|---|---|
count | Integer | Total number of environments. |
environments | Array of objects | Environment parameters. See Table 4. |
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 | Fixed value: provided. |
deploy_mode | String | Environment type. |
vpc_id | String | VPC ID. |
base_resources | Array of objects | Basic resources. See Table 5. |
optional_resources | Array of objects | Optional resources. See Table 5. |
creator | String | Creator. |
create_time | Integer | Creation time. |
update_time | Integer | Update time. |
Parameter | Type | Description |
---|---|---|
id | String | Resource ID. |
name | String | Resource name. |
type | String | Basic resources: cce. Optional resources: rds, dcs, elb, and other services. |
Example Request
None
Example Response
{"environments": [{"id": "00078e9d-a61c-476e-ac63-a10c9cb2638e","name": "development-env","alias": null,"description": "","project_id": "e7d2e9c589e5445e808a8ff0d1235aca","enterprise_project_id": "0","charge_mode": "provided","deploy_mode": "container","vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd","base_resources": [{"id": "523498f1-36c4-11eb-ae36-0255ac1000c2","type": "cce","name": "cce-test"}],"optional_resources": [{"id": "9963306a-791e-468c-9306-cf80a9d00298","type": "elb","name": "elb-2dd2"}],"creator": "ss-test","create_time": 1610418873730,"update_time": 1610418873730}],"count": 1}
Status Code
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.
- Function
- URI
- Request
- Response
- Example Request
- Example Response
- Status Code
- Error Code