创建模块

最近更新时间:2024-03-12 01:29:11

我的收藏

1. 接口描述

接口请求域名: ecm.tencentcloudapi.com 。

创建模块

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateModule。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
ModuleName String 模块名称,如视频直播模块。限制:模块名称不得以空格开头,长度不得超过60个字符。
示例值:智能语音模块
DefaultBandWidth Integer 默认带宽,单位:Mbps。范围不得超过带宽上下限,详看DescribeConfig
示例值:50
DefaultImageId String 默认镜像。
示例值:img-1tyt4apn
InstanceType String 机型ID。
示例值:SN3ne.2XLARGE16
DefaultSystemDiskSize Integer 默认系统盘大小,单位:GB,默认大小为50GB。范围不得超过系统盘上下限制,详看DescribeConfig
示例值:50
DefaultDataDiskSize Integer 默认数据盘大小,单位:GB。范围不得超过数据盘范围大小,详看DescribeConfig
示例值:100
CloseIpDirect Boolean 是否关闭IP直通。取值范围:
true:表示关闭IP直通
false:表示开通IP直通
示例值:true
TagSpecification.N Array of TagSpecification 标签列表。
SecurityGroups.N Array of String 模块默认安全组列表
示例值:["esg-ggdr123","esg-15fd123","esg-mt9b9123"]
DefaultBandWidthIn Integer 默认入带宽,单位:Mbps。范围不得超过带宽上下限,详看DescribeConfig
示例值:25
DisableWanIp Boolean 是否禁止分配外网IP
示例值:true
SystemDisk SystemDisk 系统盘信息。
DataDisks.N Array of DataDisk 数据盘信息。

3. 输出参数

参数名称 类型 描述
ModuleId String 模块ID,创建模块成功后分配给该模块的ID。
示例值:em-r8nkc81r
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建智能语音模块

输入示例

https://ecm.tencentcloudapi.com/?Action=CreateModule
&ModuleName=智能语音模块
&DefaultBandWidth=50
&DefaultImageId=img-1tyt4apn
&InstanceType=SN3ne.2XLARGE16
&DefaultSystemDiskSize=50
&DefaultDataDiskSize=100
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue.InvaildModuleNum 模块数量不合法。
InvalidParameterValue.InvalidBandwidth 带宽大小不合法。
InvalidParameterValue.InvalidBandwidthIn 入带宽大小超过限额。
InvalidParameterValue.InvalidBandwidthInAndOut 出入带宽必须一致。
InvalidParameterValue.InvalidDataDiskSize 数据盘大小不合法。
InvalidParameterValue.InvalidEIPDirectService windows镜像不支持IP直通。
InvalidParameterValue.InvalidImageArchitecture 内存4G以上机型不支持32位操作系统镜像。
InvalidParameterValue.InvalidImageID 镜像ID不合法。
InvalidParameterValue.InvalidInstanceTypeConfigID 机型ID不合法。
InvalidParameterValue.InvalidModuleName 模块名称冲突。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
InvalidParameterValue.InvalidSystemDiskSize 系统盘大小不合法。
InvalidParameterValue.ParameterValueTooLarge 参数值超出限制。
InvalidParameterValue.UserNotSupportIPv6 用户不支持ipv6。
LimitExceeded.ModuleSecurityGroupLimitExceeded 模块默认安全组数目限制。
LimitExceeded.SecurityGroupModuleLimitExceeded 安全组可关联模块数目限制。
MissingParameter.MissingModuleParameter 模块操作参数不全。
ResourceNotFound 资源不存在。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
UnsupportedOperation.InstanceTypeNotSupportImage 当前机型不支持所选镜像。