1. 接口描述
接口请求域名: batch.tencentcloudapi.com 。
此接口可将已存在实例添加到计算环境中。
实例需要满足如下条件:
1.实例不在批量计算系统中。
2.实例状态要求处于运行中。
3.支持预付费实例,按小时后付费实例,专享子机实例。不支持竞价实例。
此接口会将加入到计算环境中的实例重设UserData和重装操作系统。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AttachInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EnvId | 是 | String | 计算环境ID 示例值:env-nuydksjj |
Instances.N | 是 | Array of Instance | 加入计算环境实例列表 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加实例到计算环境
输入示例
https://batch.tencentcloudapi.com/?Action=AttachInstances
&EnvId=env-nuydksjj
&Instances.0.InstanceId=ins-dus5t7tu
&Instances.0.ImageId=img-8toqc6s3
&Instances.0.LoginSettings.Password=xxxxxxxxx
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "a402b86a-5b45-4edf-b64c-d233c2984fbd"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.CallCvm | 调用CVM API返回错误。 |
InvalidParameter.EnvIdMalformed | 非法的计算环境ID格式。 |
InvalidParameterValue.InstanceIdDuplicated | 实例ID重复。 |
ResourceNotFound.ComputeEnv | 指定计算环境不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.InstancesNotAllowToAttach | 不允许将该实例添加到计算环境中。 |