ListEnvironments-阿里云帮助中心

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

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

apig:ListEnvironments

list

*Environment

acs:apig:{#regionId}:{#accountId}:environment/*

None

Request syntax

GET /v1/environments HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
nameLike	string	No	The environment name. Fuzzy match is supported.	test
aliasLike	string	No	The environment alias. Fuzzy match is supported.	测试
gatewayId	string	No	The gateway ID. Exact match is supported.	gw-cptv6ktlhtgnqr73h8d1
gatewayNameLike	string	No	The gateway name. Fuzzy match is supported.	test-gw
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10
resourceGroupId	string	No	The resource group ID.	rg-aek2nqpppkzplmq
gatewayType	string	No	The gateway type.	APIGateway

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID for tracing.	CE857A85-251D-5018-8103-A38957D71E20
code	string	The response code.	Ok
message	string	The response message.	success
data	object	The paginated response data.
pageNumber	integer	The page number.	1
pageSize	integer	The number of entries per page.	10
totalSize	integer	The total number of entries.	25
items	array	The environment entries.
	EnvironmentInfo	The environment details.

Examples

Success response

JSON format

{
  "requestId": "CE857A85-251D-5018-8103-A38957D71E20",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 25,
    "items": [
      {
        "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
        "name": "test",
        "alias": "测试环境",
        "description": "这是xxx的xx项目测试环境",
        "gatewayInfo": {
          "gatewayId": "gw-cq7og15lhtgi6qasrj60",
          "name": "apitest-gw",
          "vpcInfo": {
            "vpcId": "vpc-uf664nyle5kh***",
            "name": "商品中心预发环境专有网络"
          },
          "engineVersion": "2.0.7",
          "gatewayEdition": "MultiTenantServerless"
        },
        "subDomainInfos": [
          {
            "domainId": "d-cpudb0llhtgl2djvq2sg",
            "name": "abc.com",
            "protocol": "HTTP",
            "networkType": "Intranet"
          }
        ],
        "default": false,
        "createTimestamp": 1721116090326,
        "updateTimestamp": 1721116090326,
        "resourceGroupId": "rg-xxxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.