All Products
Search
Document Center

API Gateway:UpdateEnvironment

Last Updated:Dec 17, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Modifies an environment.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:UpdateEnvironmentnone
*Environment
acs:apig:{#regionId}:{#accountId}:environment/{#EnvironmentId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

Request Body.

aliasstringYes

Environment alias.

测试环境
descriptionstringNo

Description of the environment, which can include information such as the purpose of the environment and its users.

这是xx的xx项目测试环境
environmentIdstringYes

Environment ID.

env-cq7l5s5lhtgi6qasrdc0

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

Request ID, used for tracing the API call chain.

52FB803B-3CD8-5FF8-AAE9-C2B841F6A483
codestring

Response code.

Ok
messagestring

Response message.

success

Examples

Sample success responses

JSONformat

{
  "requestId": "52FB803B-3CD8-5FF8-AAE9-C2B841F6A483",
  "code": "Ok",
  "message": "success"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-01-23The API operation is deprecatedView Change Details