ModifyInstancesProject

Last updated: 2020-10-16 18:38:29

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. You can create multiple projects under one account, manage different resources in each project, and assign different instances to different projects. You may use the DescribeInstances API to query instances and use the project ID to filter results.
  • You cannot modify the project of an instance that is bound to a load balancer. You need to firstly unbind the load balancer from the instance by using the DeregisterInstancesFromLoadBalancer API.
    [^_^]: # (If you modify the project of an instance, security groups associated with the instance will be automatically disassociated. You can use the ModifyInstancesAttribute API to associate the instance with the security groups again.
  • Batch operations are supported. You can operate up to 100 instances in each request.
  • You can call the DescribeInstances API and find the result of the operation in the response parameter LatestOperationState. If the value is SUCCESS, the operation is successful.

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

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 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 IDs. To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. You can operate up to 100 instances in each request.
ProjectId Yes Integer Project ID. You can create a project by using the AddProject API and obtain its ID from the response parameter projectId of the DescribeProject API. Subsequently, the project ID can be used to filter results when you query instances by calling the DescribeInstances API.

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 change 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 Incorrect parameter value.
InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
InvalidProjectId.NotFound Invalid project ID: the specified project ID does not exist.
MissingParameter Missing parameter.
MutexOperation.TaskRunning An identical job is running.
OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help