tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AttachInstances

Last updated: 2023-05-04 15:47:12

1. API Description

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

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

  1. The instance is not in the batch compute system.
  2. The instance is in “Running” status.
  3. 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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: AttachInstances.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
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 Adding an instance 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

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 Unsupported operation.
UnsupportedOperation.InstancesNotAllowToAttach This instance cannot be added to the compute environment.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy