tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstancesProject

Last updated: 2024-10-22 19:33:06

    1. API Description

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

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

    • 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 the results.
    • You cannot modify the project of an instance that is bound to a load balancer. You need to unbind the load balancer from the instance by using the DeregisterInstancesFromLoadBalancer API before using this API.
    • Batch operations are supported. Up to 100 instances per request is allowed.
    • You can use the API DescribeInstances to query the operation result. If the LatestOperationState in the response is SUCCESS, the operation is successful.

    A maximum of 10 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: ModifyInstancesProject.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. 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 use the API AddProject to create projects, and obtain the projectId field in the response of the DescribeProject API. When using the DescribeInstances API to query instances later, you can filter the results by the project ID.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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.

    Input Example

    POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstancesProject
<Common request parameters>

{
    "ProjectId": "1045",
    "InstanceIds": [
        "ins-5d8a23rs",
        "ins-r8hr2upy"
    ]
}

    Output Example

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

    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
    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.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    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.
    UnsupportedOperation.InstanceStateIsolating Unable to isolate: the instance is isolated
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy