tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDeployGroup

Last updated: 2022-01-19 11:36:35

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API is used to create a placement group for placing instances.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateDeployGroup.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DeployGroupName Yes String Name of a placement group, which can contain up to 60 characters.
Description No String Description of a placement group, which can contain up to 200 characters.
Affinity.N No Array of Integer Affinity policy of placement group. Currently, the value of this parameter can only be 1. Policy 1 indicates the upper limit of instances on one physical machine.
LimitNum No Integer Upper limit of instances on one physical machine as defined in affinity policy 1 of placement group.
DevClass.N No Array of String Model attribute of placement group. Valid values: SH12+SH02, TS85.

3. Output Parameters

Parameter Name Type Description
DeployGroupId String Placement group ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a placement group

This example shows you how to create a placement group.

Input Example

https://cdb.tencentcloudapi.com/?Action=CreateDeployGroup
&DeployGroupName=cdb-ezq1vzem
&Description=test
&<Common request parameters>

Output Example

{
  "Response": {
    "DeployGroupId": "213123",
    "RequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb"
  }
}

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

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
InternalError.CdbError System error.
InvalidParameter Parameter error.
InvalidParameter.DeployGroupNotEmpty There are resources in the placement group.
InvalidParameter.OverDeployGroupQuota The quota of placement group resources has been exceeded.
InvalidParameter.ResourceExists The resource already exists.
InvalidParameter.ResourceNotFound The resource is not found.
OperationDenied.ActionNotSupport Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy