Domain name for API request: tem.tencentcloudapi.com.
This API is used to edit an environment.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ModifyEnvironment. |
Version | Yes | String | Common Params. The value used for this API: 2021-07-01. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
EnvironmentId | Yes | String | Environment ID |
EnvironmentName | No | String | Environment name |
Description | No | String | Environment description |
Vpc | No | String | VPC name |
SubnetIds.N | No | Array of String | Subnets |
SourceChannel | No | Integer | Source channel |
EnvType | No | String | Environment type. Values: test , pre , prod |
Parameter Name | Type | Description |
---|---|---|
Result | Boolean | Environment ID in case of success and null in case of failureNote: this field may return null , indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to edit a namespace.
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyEnvironment
<Common request parameters>
{
"EnvironmentName": "xx",
"Description": "xx",
"EnvironmentId": "xx",
"SubnetIds": [
"xx"
],
"SourceChannel": 0,
"Vpc": "xx"
}
{
"Response": {
"Result": true,
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError.AddNewNodeError | Exception occurs while adding the subnet/virtual node |
InternalError.DefaultInternalError | The server is busy. Retry later. |
InvalidParameterValue.EnvironmentNameImmutable | The environment name cannot be changed. |
InvalidParameterValue.TemIdInvalid | The TEM ID is incorrect. |
OperationDenied.ResourceIsolated | There’re overdue payments under your account. Please make the payment first. |
ResourceNotFound.VersionNamespaceNotFound | The environment corresponding to this version is not found. |
UnauthorizedOperation.UnauthorizedOperation | Not authorized |
Was this page helpful?