Tenant Cloud Compute Cloud Virtual Machine Instance APIs CreateDisasterRecoverGroup

CreateDisasterRecoverGroup

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

1. Interface Description

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

Create a spread placement group. This feature poses a significant challenge to resources, so use it cautiously. You can specify a created spread placement group when creating an instance.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-04-29 02:47:53.

The interface only verifies the signature but does not authenticate.

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: CreateDisasterRecoverGroup
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
Name Yes No String Placement group name, with a length of 1-60 characters, supporting and English.
Example: Physical machine disaster recovery group
Type Yes No String Placement group type. Valid values: 
  • HOST: Physical machine 
  • SW: Switch 
  • RACK: Rack
    Example: HOST
    		•
    Strategy No No String Placement group policy. Valid values: 
  • SPREAD: Anti-affinity 
  • WEAK_SPREAD: Weak Anti-affinity 
  • AFFINITY: Affinity 
  • WEAK_AFFINITY: Weak Affinity
    Example: SPREAD
    		•

    3. Output Parameters

    Parameter name Type Description
    DisasterRecoverGroupId String Spread placement group ID.
    Example: ps-qajfd25h
    Type String Spread placement group type, consistent with the input parameter.
    Example: HOST
    Name String Spread placement group name, contains 1 character to 60 characters and supports English characters.
    Example: Physical machine disaster recovery group
    CvmQuotaTotal Int64 Number of cloud servers that can be accommodated in the placement group.
    Example: 50
    Strategy String Placement group policies
    Example: SPREAD
    CurrentNum Int64 Number of existed cloud servers in the placement group.
    Example: 0
    CreateTime Datetime_iso Placement group creation time.
    Example: 2018-06-08T07:26:38Z
    owner String AppId for Creating Placement Group
    Example: 122500001
    Affinity Int64 Placement group affinity. Instances in the placement group are distributed according to the affinity. Value range of affinity: 1-10. The default value is 1.
    Example: 1
    PartitionCount Int64 Number of partitions in partition placement groups. Value range: 2-10. The value is required when the placement group type is partition placement group.
    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

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.OutOfRange The parameter value is out of range.