GetEnvironment - API Gateway - Alibaba Cloud Documentation Center

Queries an environment.

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:GetEnvironment

none

*Environment

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

None

Request syntax

GET /v1/environments/{environmentId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
environmentId	string	Yes	The environment ID.	env-cq7l5s5lhtgi6qasrdc0

Request parameters

Parameter	Type	Required	Description	Example
withVpcInfo	boolean	No	Specifies whether to include VPC information.	true
withStatistics	boolean	No	Specifies whether to return online resource information.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID, which is used to trace the API call chain.	3F8EE674-BB08-5E92-BE6F-E4756A748B0F
code	string	The response code.	Ok
message	string	The response message.	success
data	object	The response data.
environmentId	string	The environment ID.	env-cq7l5s5lhtgi6qasrdc0
name	string	The environment name.	test
alias	string	The environment alias.	测试环境
description	string	The environment description.	这是xxx的xx项目测试环境
gatewayInfo	GatewayInfo	The gateway information.
subDomainInfos	array	The list of subdomains.
	SubDomainInfo	The subdomain information.
default	boolean	Indicates whether this is the default environment.	true
createTimestamp	integer	The creation timestamp.	1719386834548
updateTimestamp	integer	The update timestamp.	1719386834548
resourceGroupId	string	The resource group ID.	rg-aekz4us4iruleja
statisticsInfo	object	The online resource information.
totalCount	integer	The total count.	1
resourceStatistics	array	The online resource count.
	ResourceStatistic	The resource statistics.

Examples

Success response

JSON format

{
  "requestId": "3F8EE674-BB08-5E92-BE6F-E4756A748B0F",
  "code": "Ok",
  "message": "success",
  "data": {
    "environmentId": "env-cq7l5s5lhtgi6qasrdc0\n",
    "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": true,
    "createTimestamp": 1719386834548,
    "updateTimestamp": 1719386834548,
    "resourceGroupId": "rg-aekz4us4iruleja",
    "statisticsInfo": {
      "totalCount": 1,
      "resourceStatistics": [
        {
          "resourceType": "HttpApi",
          "resourceCount": 10
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.