ModifyInstancesProject

Last updated: 2020-03-16 18:27:23

PDF

1. API Description

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

This API is used to change the project to which an instance belongs.

  • Project is a virtual concept. Users can create multiple projects under one account, manage different resources in each project, and assign different instances to different projects. You may use DescribeInstances to query instances and use the project ID to filter results.
  • You cannot modify the project of an instance which is bound to a load balancer. You need to unbind the load balancer from the instance with DeregisterInstancesFromLoadBalancer before using this API.
  • If you modify the project of an instance, security groups associated with the instance will be automatically disassociated. You can use ModifySecurityGroupsOfInstance to associate the instance with certian security groups again.
  • Batch operations are supported. The maximum number of instances in each request is 100.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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: ModifyInstancesProject.
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.
InstanceIds.N Yes Array of String Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The maximum number of instances in each request is 100.
ProjectId Yes Integer Project ID. You can create a project by calling AddProject. When calling DescribeInstances to query instances, the project IDs can be used to filter the results.

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 Modifying the projects of two instances

This example shows you how to modify the projects of two instances to a specified one.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=ModifyInstancesProject
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&ProjectId=1045
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
  }
}

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
InternalServerError Internal error.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
InvalidInstanceId.NotFound No instance found.
InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
MissingParameter Missing parameter: a required parameter is missing.