ModifyComputeEnv

Last updated: 2019-07-08 20:38:14

1. API Description

API request domain name: batch.tencentcloudapi.com.

This API is used to modify the number of nodes in the compute environment.

Default API request frequency limit: 2 times/second.

2. Input Parameters

The following list of request parameters lists only the API request parameters and some common parameters. For the complete list of common parameters, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the value for this API: ModifyComputeEnv
Version Yes String Common parameter; the value for this API: 2017-03-12
Region Yes String Common parameters; for details, see the Region List supported by the product.
EnvId Yes String Compute environment ID
DesiredComputeNodeCount Yes Integer Number of desired compute nodes

3. Output Parameters

Parameter name Type Description
RequestId String The unique request ID which is returned for each request. The RequestId for the current request needs to be provided when troubleshooting.

4. Examples

Example 1. Changing the Number of Nodes in the Compute Environment to 2

Input

https://batch.tencentcloudapi.com/?Action=ModifyComputeEnv
&EnvId=env-lcpcej85
&DesiredComputeNodeCount=2
&<Common request parameter>

Output

{
  "Response": {
    "RequestId": "147fbf83-f817-4528-a547-f5f313b673d2"
  }
}

5. Developer Resources

It is recommended to use API 3.0 Explorer. This tool provides various capabilities such as online debugging, signature verification, SDK code generation and quick API retrieval that significantly reduce the difficulty of using cloud APIs.

Cloud API 3.0 comes with a set of complementary development tools that make it easier to call the API.

6. Error Codes

Only the error codes related to this API are listed below. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
InvalidParameterValue.Negative Invalid negative parameter.
LimitExceeded.CpuQuota Insufficient CPU quota.
ResourceNotFound.ComputeEnv The specified compute environment does not exist.
UnsupportedOperation.AcceptOtherRequest Another request is being processed and deletion is prohibited.
UnsupportedOperation.ComputeNodeForbidTerminate It is prohibited to terminate the compute node.
UnsupportedOperation.NotEnoughComputeNodesToTerminate When scaling down, the scaled-down number is greater than the number of existing compute nodes.