Tenant Cloud Compute Cloud Virtual Machine Instance APIs ModifyInstancesDisasterRecoverGroup

ModifyInstancesDisasterRecoverGroup

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ModifyInstancesDisasterRecoverGroup) is used to adjust the placement group where an instance is located.

  • Currently, only instances that is of the basic network or the VPC and whose system disk and data disk types are CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD are supported for modifying the placement group through this API.

Default interface request rate limit: 20 times per second.

Interface update time: 2024-09-26 08:17:39.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: ModifyInstancesDisasterRecoverGroup
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds Yes No Array of String One or more instance IDs to be operated. You can obtain the instance ID through the InstanceId in the returned value from the API DescribeInstances. A maximum of 1 batch instance per request is allowed.
Example: ["ins-r8hr2upy\r\n"]
DisasterRecoverGroupId Yes No String Spread placement group ID, can be obtained through the API DescribeDisasterRecoverGroups.
Example: ps-a66w6rlb
Force No No Bool Whether to forcibly change instance hosts. Value range:
  • TRUE: Indicates that the instance is allowed to change hosts, allowing the instance to reboot
  • 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 replacement group

    Default value: FALSE.
    Example: false
    		•

    3. Output Parameters

    Parameter name Type Description
    TaskId String Task ID
    Example: 643244
    FlowId Int64 Task Flow ID
    Example: 3
    flowId Int64 Task Flow ID
    Example: 3
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.