ListEnvironments-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

devs:ListEnvironments

list

*All Resource

*

None

Request syntax

GET /2023-07-14/projects/{projectName}/environments/ HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	The name of the project.	demo-project

Request parameters

Parameter	Type	Required	Description	Example
labelSelector	array	No	Selectors used to filter environments by their `labels`. Only environments that match all selectors are returned. The selectors are combined by using AND logic.	demo-project
	string	No	A filter condition in the `labelSelector` array, in the format `key=value`.	branch=main
pageNumber	integer	No	The page number to retrieve, starting from 1. Defaults to 1 if not specified.	1
pageSize	integer	No	The number of entries to return on each page. Defaults to 100. Valid values: 1 to 100.	10
keyword	string	No	The keyword for a case-insensitive fuzzy search on the `name` field of the entity.	dev

Response elements

Element	Type	Description	Example
	object	The paginated results of the query.
pageNumber	integer	The current page number. This value starts from 1.	1
pageSize	integer	The number of entries returned on the current page.	50
totalCount	integer	The total number of entries that match the query.	100
data	array	An array of environment objects.
	Environment	An environment object.

Examples

Success response

JSON format

{
  "pageNumber": 1,
  "pageSize": 50,
  "totalCount": 100,
  "data": [
    {
      "name": "demo-env",
      "kind": "Environment",
      "uid": "1455541096***548",
      "createdTime": "2021-11-19T09:34:38Z",
      "description": "test env",
      "spec": {
        "type": "Testing",
        "roleArn": "acs:ram::*******:role/aliyundevsdefaultrole",
        "stagedConfigs": {
          "services": {
            "key": {
              "props": {
                "test": "test",
                "test2": 1
              },
              "source": {
                "template": {
                  "downloadUrl": "https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6",
                  "name": "start-springboot-cap"
                },
                "repository": {
                  "repositoryName": "my-repository",
                  "codeVersion": {
                    "branch": "main",
                    "commitID": "12721ec262d03a93809ba2bbc717963cb298ceca"
                  },
                  "filter": {
                    "branch": {
                      "name": "master"
                    }
                  }
                },
                "oss": {
                  "bucket": "demo-bucket",
                  "object": "demo-object"
                }
              },
              "build": {
                "default": {
                  "cache": {
                    "driver": "",
                    "paths": [
                      "~/.npm"
                    ],
                    "keyPath": {
                      "3C75C832-0EAD-40D6-8FA1-2BA9171C926B": "~/.npm",
                      "D256BB7A-1886-4A19-A75B-A1FDC23D5A00": "~/.cache"
                    }
                  },
                  "languages": [
                    "Python3.9"
                  ],
                  "rootPath": "./src",
                  "steps": [
                    "{\"run\": \"npm build\"}"
                  ]
                }
              },
              "variables": {
                "key": {
                  "value": "object_value",
                  "sensitive": false,
                  "encrypted": false
                }
              },
              "initialize": {
                "steps": [
                  "{\"run\": \"npm build\"}"
                ]
              },
              "type": "Function",
              "finalize": {
                "steps": [
                  "{\"run\": \"echo 'deleted'\"}"
                ]
              },
              "token": "9D72DE01-C732-49C0-8E85-FFD9D695436B",
              "component": "fc3@1.0.0",
              "artifact": {
                "name": "my-artifact",
                "checksum": "CRC-64 code"
              }
            }
          },
          "variables": {
            "key": {
              "value": "object_value",
              "sensitive": false,
              "encrypted": false
            }
          }
        }
      },
      "labels": {
        "key": "value to the label key."
      },
      "status": {
        "servicesInstances": {
          "key": {
            "config": {
              "props": {
                "test": "test",
                "test2": 1
              },
              "source": {
                "template": {
                  "downloadUrl": "https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6",
                  "name": "start-springboot-cap"
                },
                "repository": {
                  "repositoryName": "my-repository",
                  "codeVersion": {
                    "branch": "main",
                    "commitID": "12721ec262d03a93809ba2bbc717963cb298ceca"
                  },
                  "filter": {
                    "branch": {
                      "name": "master"
                    }
                  }
                },
                "oss": {
                  "bucket": "demo-bucket",
                  "object": "demo-object"
                }
              },
              "build": {
                "default": {
                  "cache": {
                    "driver": "",
                    "paths": [
                      "~/.npm"
                    ],
                    "keyPath": {
                      "3C75C832-0EAD-40D6-8FA1-2BA9171C926B": "~/.npm",
                      "D256BB7A-1886-4A19-A75B-A1FDC23D5A00": "~/.cache"
                    }
                  },
                  "languages": [
                    "Python3.9"
                  ],
                  "rootPath": "./src",
                  "steps": [
                    "{\"run\": \"npm build\"}"
                  ]
                }
              },
              "variables": {
                "key": {
                  "value": "object_value",
                  "sensitive": false,
                  "encrypted": false
                }
              },
              "initialize": {
                "steps": [
                  "{\"run\": \"npm build\"}"
                ]
              },
              "type": "Function",
              "finalize": {
                "steps": [
                  "{\"run\": \"echo 'deleted'\"}"
                ]
              },
              "token": "9D72DE01-C732-49C0-8E85-FFD9D695436B",
              "component": "fc3@1.0.0",
              "artifact": {
                "name": "my-artifact",
                "checksum": "CRC-64 code"
              }
            },
            "variables": {},
            "outputs": {
              "key": ""
            },
            "latestDeployment": {
              "name": "",
              "startTime": "",
              "finishedTime": "",
              "phase": "Running"
            },
            "status": "\"RUNNING\"",
            "message": "\"OK\""
          }
        },
        "latestEnvironmentDeploymentName": "",
        "servicesWithPendingChanges": [
          "服务名称"
        ],
        "observedGeneration": 1,
        "observedTime": "2021-11-19T09:34:38Z"
      },
      "projectName": "demo-project",
      "generation": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.