ModifyInstancesDisasterRecoverGroup

Last updated:2025-11-13 10:58:35

ModifyInstancesDisasterRecoverGroup

Last updated: 2025-11-13 10:58:35

1. API Description

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

This API is used to adjust the placement group of an instance.

Currently only basic networks or Virtual Private Cloud (VPC) instances are supported.

A maximum of 20 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: ModifyInstancesDisasterRecoverGroup.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceIds.N	Yes	Array of String	One or more instance ids to be operated. you can obtain the instance ID through the `InstanceId` in the return value from the api DescribeInstances. the maximum number of instances per request is 100.
DisasterRecoverGroupId	No	String	Spread placement group ID. obtain through the api DescribeDisasterRecoverGroups.
Force	No	Boolean	Whether to forcibly change instance hosts. value range: true: indicates that the instance is allowed to change hosts, allowing the instance to reboot. local disk machine does not support specifying this parameter. false: does not allow the instance to change hosts. instances can only be added to the placement group on the current host. this may result in a failure to change the placement group. default value: false.

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 Adjusting Instance Placement Groups

This example shows you how to adjust the instance location in an instance placement group.

Input Example

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

{
    "InstanceIds": [
        "ins-r8hr2upy"
    ],
    "DisasterRecoverGroupId": "ps-a66w6rlb"
}

Output Example

{
    "Response": {
        "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.AlreadyInDisasterRecoverGroup	The instance `ins-xxxxxxx` is already in the instance placement group `dgroup-xxxxxx`.
FailedOperation.DisasterRecoverGroupNotFound	The specified spread placement group does not exist.
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.DisasterRecoverGroupIdMalformed	Incorrect placement group ID format.
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.
InvalidParameterValue.NotSupported	Unsupported operation.
LimitExceeded.DisasterRecoverGroup	The quota of the specified placement group is insufficient.
MutexOperation.TaskRunning	An identical job is running.
OperationDenied.InstanceOperationInProgress	The instance has an operation in progress. Please try again later.
ResourceInsufficient.DisasterRecoverGroupCvmQuota	The number of instances exceeded the quota limit of spread placement groups.
UnsupportedOperation.CbsRemoteSsdNotSupport	The far end ssd disk does not support this operation.
UnsupportedOperation.InstanceChargeType	This instance billing mode does not support the operation.
UnsupportedOperation.InstanceStateBanning	This CVM is blocked. Please submit a ticket.
UnsupportedOperation.InstanceStateFreezing	The operation is not supported for the frozen instances.
UnsupportedOperation.InstanceStateRebooting	The instances are being restarted, and this operation is not supported.
UnsupportedOperation.InstanceStateRescueMode	Instances in the rescue mode are not available for this operation.
UnsupportedOperation.InstanceStateShutdown	Isolated instances do not support this operation.
UnsupportedOperation.InstanceStateStopping	The instance is being shut down, and this operation is not supported.
UnsupportedOperation.NoVpcNetwork	A physical network is not supported by this instance.
UnsupportedOperation.SpecialInstanceType	This special instance type does not support the operation.
UnsupportedOperation.StoppedModeStopCharging	The instance does not support the no charges when shut down feature.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud