1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口 (CreateDisasterRecoverGroup)用于创建分散置放群组。创建好的置放群组,可在创建实例时指定。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDisasterRecoverGroup。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Name | 是 | String | 分散置放群组名称,长度1-60个字符,支持中、英文。 示例值:物理机容灾组 |
Type | 是 | String | 分散置放群组类型,取值范围: 示例值:HOST |
ClientToken | 否 | String | 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 更多详细信息请参阅:如何保证幂等性。 示例值:a521b4e4-c903-4d37-9de6-8906e3ad8eb7 |
Affinity | 否 | Integer | 置放群组的亲和度,在置放群组的实例会按该亲和度分布,亲和度的取值范围是:1-10,默认为1 示例值:3 |
TagSpecification.N | 否 | Array of TagSpecification | 标签描述列表。通过指定该参数可以绑定标签到置放群组。 示例值:[ { "ResourceType": "ps", "Tags": [ { "Key": "myTag", "Value": "cloud" } ] } ] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DisasterRecoverGroupId | String | 分散置放群组ID列表。 示例值:ps-qajfd25h |
Type | String | 分散置放群组类型,取值范围: 示例值:HOST |
Name | String | 分散置放群组名称,长度1-60个字符,支持中、英文。 示例值:物理机容灾组 |
CvmQuotaTotal | Integer | 置放群组内可容纳的云服务器数量。 示例值:50 |
CurrentNum | Integer | 置放群组内已有的云服务器数量。 示例值:0 |
CreateTime | Timestamp | 置放群组创建时间。 示例值:2018-06-08T07:26:38Z |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建分散置放群组
创建分散置放群组
输入示例
GET https://cvm.tencentcloudapi.com/?Action=CreateDisasterRecoverGroup
&Name=物理机容灾组
&Type=HOST
&<公共请求参数>
输出示例
{
"Response": {
"Type": "HOST",
"DisasterRecoverGroupId": "ps-qajfd25h",
"Name": "物理机容灾组",
"CvmQuotaTotal": 50,
"CurrentNum": 0,
"CreateTime": "2020-09-22 00:00:00",
"RequestId": "21387009-9b9c-4b57-8fa2-8228f702ff6c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.InvalidAppIdFormat | 无效的appid。 |
InvalidParameterValue.Range | 无效参数值。参数值取值范围不合法。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
ResourceInsufficient.InsufficientGroupQuota | 安全组资源配额不足。 |