创建分散置放群组

最近更新时间:2018-08-17 17:02:43

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (CreateDisasterRecoverGroup)用于创建分散置放群组。创建好的置放群组,可在创建实例时指定。

接口请求频率限制:10次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDisasterRecoverGroup
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
Name String 分散置放群组名称,长度1-60个字符,支持中、英文。
Type String 分散置放群组类型,取值范围:
  • HOST:物理机
  • SW:交换机
  • RACK:机架
  • ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
    更多详细信息请参阅:如何保证幂等性。

    3. 输出参数

    参数名称 类型 描述
    DisasterRecoverGroupId String 分散置放群组ID列表。
    Type String 分散置放群组类型,取值范围:
  • HOST:物理机
  • SW:交换机
  • RACK:机架
  • Name String 分散置放群组名称,长度1-60个字符,支持中、英文。
    CvmQuotaTotal Integer 置放群组内可容纳的云主机数量。
    CurrentNum Integer 置放群组内已有的云主机数量。
    CreateTime Timestamp 置放群组创建时间。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidParameterValue.TooLong 无效参数值。参数值太长。

    5. 示例

    示例1 创建分散置放群组

    输入示例

    https://cvm.tencentcloudapi.com/?Action=CreateDisasterRecoverGroup
    &Name=物理机容灾组
    &Type=HOST
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "CreateTime": "2018-06-08T07:26:38Z",
        "CurrentNum": 0,
        "CvmQuotaTotal": 50,
        "DisasterRecoverGroupId": "ps-qajfd25h",
        "Name": "数据库业务",
        "RequestId": "21387009-9b9c-4b57-8fa2-8228f702ff6c",
        "Type": "HOST"
      }
    }

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。