1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口 (ModifyInstancesProject) 用于修改实例所属项目。
- 项目为一个虚拟概念,用户可以在一个账户下面建立多个项目,每个项目中管理不同的资源;将多个不同实例分属到不同项目中,后续使用 DescribeInstances接口查询实例,项目ID可用于过滤结果。
- 绑定负载均衡的实例不支持修改实例所属项目,请先使用DeregisterInstancesFromLoadBalancer接口解绑负载均衡。
- 支持批量操作。每次请求批量实例的上限为100。
- 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyInstancesProject。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 一个或多个待操作的实例ID。可通过 DescribeInstances API返回值中的InstanceId 获取。每次请求允许操作的实例数量上限是100。示例值:["ins-r8hr2upy","ins-5d8a23rs"] |
ProjectId | 是 | Integer | 项目ID。项目可以使用AddProject接口创建。可通过DescribeProject API返回值中的projectId 获取。后续使用DescribeInstances接口查询实例时,项目ID可用于过滤结果。示例值:1045 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改两个实例所属的项目
本示例用于修改两个实例所属的项目为指定的项目。
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstancesProject
<公共请求参数>
{
"ProjectId": 1045,
"InstanceIds": [
"ins-5d8a23rs",
"ins-r8hr2upy"
]
}
输出示例
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalServerError | 操作内部错误。 |
InvalidInstance.NotSupported | 不被支持的实例。 |
InvalidInstanceId.Malformed | 无效实例ID 。指定的实例ID 格式错误。例如实例ID 长度错误ins-1122 。 |
InvalidInstanceId.NotFound | 没有找到相应实例。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
InvalidProjectId.NotFound | 无效的项目ID,指定的项目ID不存在。 |
MissingParameter | 缺少参数错误。 |
MutexOperation.TaskRunning | 同样的任务正在运行。 |
OperationDenied.InstanceOperationInProgress | 实例正在执行其他操作,请稍后再试。 |
UnsupportedOperation.InstanceStateIsolating | 请求不支持正在隔离状态的实例。 |