CreateClusterAsGroup

Last updated: 2020-06-24 11:17:31

    1. API Description

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

    Create a scaling group for an existing cluster

    A maximum of 20 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: tke.ap-shanghai-fsi.tencentcloudapi.com

    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.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: CreateClusterAsGroup.
    Version Yes String Common parameter. The value used for this API: 2018-05-25.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    ClusterId Yes String Cluster ID
    AutoScalingGroupPara Yes String The pass-through parameters for scaling group creation, in the format of a JSON string. For more information, see the CreateAutoScalingGroup API. The LaunchConfigurationId is created with the LaunchConfigurePara parameter, which does not support data entry.
    LaunchConfigurePara Yes String The pass-through parameters for launch configuration creation, in the format of a JSON string. For more information, see the CreateLaunchConfiguration API. ImageId is not required as it is already included in the cluster dimension. UserData is not required as it’s set through the UserScript.
    InstanceAdvancedSettings No InstanceAdvancedSettings Advanced configuration information of the node
    Labels.N No Array of Label Node label array

    3. Output Parameters

    Parameter Name Type Description
    LaunchConfigurationId String Launch configuration ID
    AutoScalingGroupId String Scaling 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 cluster’s scaling group

    This example shows you how to create cluster’s scaling group.

    Input Example

    https://tke.tencentcloudapi.com/?Action=CreateClusterAsGroup
    &ClusterId=cls-xxxxxx
    &AutoScalingGroupPara="{"AutoScalingGroupName":"001","MaxSize":5,"MinSize":0,"VpcId":"vpc-xxxxxxx","SubnetIds":["subnet-xxxxxxx"],"RetryPolicy":"IMMEDIATE_RETRY"}"
    &LaunchConfigurePara="{"LaunchConfigurationName":"","InstanceType":"S4.SMALL1","SystemDisk":{"DiskType":"CLOUD_PREMIUM","DiskSize":50},"InternetAccessible":{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":1,"PublicIpAssigned":true},"LoginSettings":{"Password":"YourPassword"},"SecurityGroupIds":["sg-xxxxxxx"],"EnhancedService":{"SecurityService":{"Enabled":true},"MonitorService":{"Enabled":true}},"InstanceChargeType":"POSTPAID_BY_HOUR"}"
    &<common request parameters>

    Output Example

    {
      "Response": {
        "AutoScalingGroupId": "asg-xxxxxxx",
        "LaunchConfigurationId": "asc-xxxxxxxx",
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
      }
    }

    5. 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
    FailedOperation Operation failed
    InternalError Internal error
    InternalError.AccountUserNotAuthenticated Account not verified.
    InternalError.AsCommon Error creating scaling group resource.
    InternalError.CvmCommon Error in node creation.
    InternalError.CvmNotFound CVM does not exist.
    InternalError.Db DB error.
    InternalError.DbAffectivedRows DB error
    InternalError.ImageIdNotFound Image not found.
    InternalError.OsNotSupport Image OS not supported.
    InternalError.Param Parameter error.
    InvalidParameter Parameter error
    InvalidParameter.AsCommonError Auto scaling group creation parameter error.
    LimitExceeded Quota limit exceeded
    MissingParameter Parameter is missing
    UnsupportedOperation Operation is not supported

    Was this page helpful?

    Was this page helpful?

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