tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Edge Computing Machine
    Documentation
    Download PDF

    CreateModule

    Last updated: 2023-08-18 15:47:45
    Download PDF

    1. API Description

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

    This API is used to create a module.

    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: CreateModule.
    Version Yes String Common Params. The value used for this API: 2019-07-19.
    Region No String Common Params. This parameter is not required for this API.
    ModuleName Yes String Module name, such as video live streaming module name. It cannot start with a space or exceed 60 characters.
    DefaultBandWidth Yes Integer Default bandwidth in Mbps. It cannot exceed the bandwidth range. For more information, see DescribeConfig.
    DefaultImageId Yes String Default image ID, such as img-qsdf3ff2.
    InstanceType Yes String Model ID.
    DefaultSystemDiskSize Yes Integer Default system disk size in GB. It is 50 GB by default and cannot exceed the system disk size range. For more information, see DescribeConfig.
    DefaultDataDiskSize Yes Integer Default data disk size in GB. It cannot exceed the system disk size range. For more information, see DescribeConfig.
    CloseIpDirect No Boolean Whether to disable IP direct access. Valid values:
    true: yes
    false: no
    TagSpecification.N No Array of TagSpecification List of tags.
    SecurityGroups.N No Array of String List of default module security groups
    DefaultBandWidthIn No Integer Default inbound bandwidth in Mbps. It cannot exceed the bandwidth range. For more information, see DescribeConfig.
    DisableWanIp No Boolean Whether to prohibit public IP assignment
    SystemDisk No SystemDisk System disk information.
    DataDisks.N No Array of DataDisk Data disk information.

    3. Output Parameters

    Parameter Name Type Description
    ModuleId String Module ID. It is the ID assigned to a module after it is created successfully.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating smart voice module

    Input Example

    https://ecm.tencentcloudapi.com/?Action=CreateModule
&ModuleName=Smart voice module
&DefaultBandWidth=50
&DefaultImageId=img-1tyt4apn
&InstanceType=SN3ne.2XLARGE16
&DefaultSystemDiskSize=50
&DefaultDataDiskSize=100
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "418150c2-ff9e-409c-a6b3-c1a59d4775e3",
        "ModuleId": "em-r8nkc81r"
    }
}

    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.InternalOperationFailure Internal error.
    InvalidParameter.InvalidDataFormat The data format is incorrect.
    InvalidParameterValue.InvaildModuleNum The number of modules is invalid.
    InvalidParameterValue.InvalidBandwidth The bandwidth size is invalid.
    InvalidParameterValue.InvalidBandwidthIn The inbound bandwidth size exceeds the limit.
    InvalidParameterValue.InvalidBandwidthInAndOut The inbound and outbound bandwidth must be the same.
    InvalidParameterValue.InvalidDataDiskSize The data disk size is invalid.
    InvalidParameterValue.InvalidEIPDirectService Windows images do not support IP direct access.
    InvalidParameterValue.InvalidImageArchitecture Models with a memory of 4 GB or above do not support 32-bit OS images.
    InvalidParameterValue.InvalidImageID The image ID is invalid.
    InvalidParameterValue.InvalidInstanceTypeConfigID The model ID is invalid.
    InvalidParameterValue.InvalidModuleName The module names conflict.
    InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
    InvalidParameterValue.InvalidSystemDiskSize The system disk size is invalid.
    InvalidParameterValue.ParameterValueTooLarge The parameter value exceeds the limit.
    InvalidParameterValue.UserNotSupportIPv6 IPv6 is not supported.
    LimitExceeded.ModuleSecurityGroupLimitExceeded The number of default module security groups exceeds the limit.
    LimitExceeded.SecurityGroupModuleLimitExceeded The number of modules that can be associated with the security group exceeds the limit.
    MissingParameter.MissingModuleParameter The module operation parameters are incomplete.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
    UnsupportedOperation.InstanceTypeNotSupportImage The current model does not support the selected image.
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy