AllocateHosts

Last updated: 2020-06-15 09:58:19

    1. API Description

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

    This API is used to create CDH instances with specified configuration.

    • When HostChargeType is PREPAID, the HostChargePrepaid parameter must be specified.

    A maximum of 10 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

    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.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: AllocateHosts.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Placement Yes Placement Instance location. This parameter is used to specify the attributes of an instance, such as its availability zone and project.
    ClientToken No String A string used to ensure the idempotency of the request.
    HostChargePrepaid No ChargePrepaid Configuration of prepaid instances. You can use the parameter to specify the attributes of prepaid instances, such as the subscription period and the auto-renewal plan. This parameter is required for prepaid instances.
    HostChargeType No String Instance billing model, only monthly or yearly subscription supported. Default value: `PREPAID'.
    HostType No String CDH instance model. Default value: HS1.
    HostCount No Integer Quantity of CDH instances purchased. Default value: 1.
    TagSpecification.N No Array of TagSpecification Tag description. You can specify the parameter to associate a tag with an instance.

    3. Output Parameters

    Parameter Name Type Description
    HostIdSet Array of String The ID list of the CVM instances newly created on the CDH.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    InvalidPeriod Invalid period. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36]; unit: month.
    InvalidProjectId.NotFound Invalid project ID: the specified project ID does not exist.
    InvalidRegion.NotFound The region cannot be found.
    InvalidZone.MismatchRegion The specified zone does not exist.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help