tencent cloud

Feedback

CreateECMInstances

Last updated: 2023-09-18 16:00:17

1. API Description

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

This API is used to create an ECM instance.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateECMInstances.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterID Yes String Cluster ID
ModuleId Yes String Module ID
ZoneInstanceCountISPSet.N Yes Array of ECMZoneInstanceCountISP Instance AZ, number of instances and ISP
Password No String Password
InternetMaxBandwidthOut No Integer Public network bandwidth
ImageId No String Image ID
InstanceName No String Instance name
HostName No String Host name
EnhancedService No ECMEnhancedService Enhanced service (including CWP and Cloud Monitoring)
UserData No String Custom script
External No String Instance extension information
SecurityGroupIds.N No Array of String Security group of the instance

3. Output Parameters

Parameter Name Type Description
EcmIdSet Array of String ECM ID list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an ECM instance

This example shows you how to create an ECM instance.

Input Example

https://tke.tencentcloudapi.com/?Action=CreateECMInstances
&ClusterID=cls-xxxxx
&ZoneInstanceCountISPSet.0.Zone=ap-zhengzhou-1
&ZoneInstanceCountISPSet.0.InstanceCount=2
&ZoneInstanceCountISPSet.0.ISP=CMCC
&ImageId=img-q9fy0if9
&HostName=oldhen_4986

&ModuleId=em-0vag13d1
&InstanceName=On-screen comments
&EnhancedService.SecurityService.Enabled=false
&EnhancedService.MonitorService.Enabled=false
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "d40cdb72-7bc0-4b48-b3aa-25e8401f6999",
        "EcmIdSet": [
            "ecm-197252sp",
            "ecm-19725win",
            "ecm-19623ash"
        ]
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InternalError.CamNoAuth You do not have permissions.
InvalidParameter Parameter error.
LimitExceeded Quota limit is exceeded.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support