1. 接口描述
接口请求域名： ecm.tencentcloudapi.com 。
展示模块详细信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeModuleDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ModuleId | 是 | String | 模块ID，如em-qn46snq8。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Module | Module | 模块的详细信息，详细见数据结构中的ModuleInfo。 注意：此字段可能返回 null，表示取不到有效值。 |
| ModuleCounter | ModuleCounter | 模块的统计信息，详细见数据结构中的ModuleCounterInfo。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看模块详情
查看模块详情
输入示例
https://ecm.tencentcloudapi.com/?Action=DescribeModuleDetail
&ModuleId=em-eedttqfb
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "187c16d5-1f53-4e88-b684-077f0c7369b2",
"Module": {
"ModuleId": "em-eedttqfb",
"ModuleName": "test1",
"ModuleState": "NORMAL",
"DefaultBandwidth": 106,
"DefaultImage": {
"ImageId": "img-oikl1tzv",
"ImageName": "CentOS 7.5 64位",
"ImageState": "NORMAL",
"ImageType": "PUBLIC_IMAGE",
"ImageOwner": 0,
"ImageOsName": "CentOS 7.5 64位",
"ImageDescription": "CentOS 7.5 64位",
"Architecture": "x86_64",
"OsType": "linux",
"Platform": "CentOS",
"OsVersion": "7.5.0",
"ImageCreateTime": "",
"ImageSize": 50
},
"InstanceTypeConfig": {
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准网络优化型",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyType": "S",
"InstanceFamilyTypeName": "标准型"
},
"InstanceType": "SN3ne.2XLARGE16",
"Vcpu": 8,
"Memory": 16,
"Frequency": "2.5 GHz",
"CpuModelName": "Intel Xeon Skylake 6133",
"ExtInfo": ""
},
"DefaultSystemDiskSize": 50,
"DefaultDataDiskSize": 48,
"CreateTime": "2020-03-09 17:03:44"
},
"ModuleCounter": {
"ISPCounterSet": [
{
"ProviderName": "CTCC",
"ProviderNodeNum": 1,
"ProvederInstanceNum": 1,
"ZoneInstanceInfoSet": [
{
"ZoneName": "北京三区（电信）",
"InstanceNum": 1
}
]
},
{
"ProviderName": "CMCC",
"ProviderNodeNum": 2,
"ProvederInstanceNum": 2,
"ZoneInstanceInfoSet": [
{
"ZoneName": "北京一区（移动）",
"InstanceNum": 1
},
{
"ZoneName": "成都二区（移动）",
"InstanceNum": 1
}
]
}
],
"NodeNum": 3,
"InstanceNum": 3,
"ProvinceNum": 2,
"CityNum": 2
}
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue.InvalidModuleID | 模块ID不合法。 |
| InvalidParameterValue.InvalidPublicParam | 公共参数不合法。 |
| MissingParameter.MissingModuleParameter | 模块操作参数不全。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |