Help & DocumentationAPIsBatch ComputeCompute Environment APIsAttachInstances

AttachInstances

Last updated: 2020-03-13 17:46:55

1. API Description

Domain name for API request: batch.tencentcloudapi.com.

This API is used to add existing instances to the compute environment.
Considerations:

  1. The instance should not be in the batch compute system.
  2. The instance status should be “running”.
  3. It supports dedicated CVMs and pay-as-you-go instances that billed on an hourly basis. Spot instances are not supported.

For instances added to the compute environment, their UserData will be reset and the operating systems will be reinstalled.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

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 parameter. The value used for this API: AttachInstances.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
EnvId Yes String Compute environment ID
Instances.N Yes Array of Instance List of instances that added to the compute environment

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adds instances to the compute environment

Input Example

https://batch.tencentcloudapi.com/?Action=AttachInstances
&EnvId=env-nuydksjj
&Instances.0.InstanceId=ins-dus5t7tu
&Instances.0.ImageId=img-8toqc6s3
&Instances.0.LoginSettings.Password=xxxxxxxxx
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "a402b86a-5b45-4edf-b64c-d233c2984fbd"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 Internal error
InternalError.CallCvm An error is returned for the CVM API call.
InvalidParameter.EnvIdMalformed Invalid compute environment ID format.
InvalidParameterValue.InstanceIdDuplicated Instance IDs duplicate.
ResourceNotFound.ComputeEnv The specified compute environment does not exist.
UnsupportedOperation This operation is prohibited.
UnsupportedOperation.InstancesNotAllowToAttach This instance cannot be added to the compute environment.