边缘计算机器
有奖：腾讯混元大模型征文大赛邀您参加！> HOT
文档中心>边缘计算机器>API 文档>模块相关接口>获取模块列表

获取模块列表

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

我的收藏

本页目录：

1. 接口描述

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

获取模块列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeModule。
Version 是 String 公共参数，本接口取值：2019-07-19。
Region 否 String 公共参数，本接口不需要传递此参数。
Filters.N 否 Array of Filter 过滤条件。
module-name - string - 是否必填：否 - （过滤条件）按照模块名称过滤。
module-id - string - 是否必填：否 - （过滤条件）按照模块ID过滤。
image-id String 是否必填：否 （过滤条件）按照镜像ID过滤。
instance-family String 是否必填：否 （过滤条件）按照机型family过滤。
security-group-id - string 是否必填：否 - （过滤条件）按照模块绑定的安全组id过滤。
每次请求的Filters的上限为10，Filter.Values的上限为5。
Offset 否 Integer 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
示例值：0
Limit 否 Integer 返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
示例值：10
OrderByField 否 String 指定排序字段。目前支持的可选值如下
instance-num 按实例数量排序。
node-num 按节点数量排序。
timestamp 按实例创建时间排序。
如果不传，默认按实例创建时间排序
示例值：timestamp
OrderDirection 否 Integer 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序
示例值：0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的模块数量。
注意：此字段可能返回 null，表示取不到有效值。
示例值：17
ModuleItemSet Array of ModuleItem 模块详情信息的列表。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看模块列表

查看模块列表

输入示例

https://ecm.tencentcloudapi.com/?Action=DescribeModule
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "ModuleItemSet": [
            {
                "Module": {
                    "CloseIpDirect": 0,
                    "CreateTime": "2024-01-25 19:35:00",
                    "DataDisks": [
                        {
                            "DiskSize": 0,
                            "DiskType": "LOCAL_BASIC"
                        }
                    ],
                    "DefaultBandwidth": 1024,
                    "DefaultBandwidthIn": 1024,
                    "DefaultDataDiskSize": 0,
                    "DefaultImage": {
                        "Architecture": "x86_64",
                        "ImageCreateTime": "2024-01-24 19:21:08",
                        "ImageDescription": "t1版本测试",
                        "ImageId": "img-im4w1234",
                        "ImageName": "d-v21-new",
                        "ImageOsName": "Ubuntu 16.0 64位",
                        "ImageOwner": 123456,
                        "ImageSize": 50,
                        "ImageSource": "EXTERNAL_IMPORT",
                        "ImageState": "NORMAL",
                        "ImageType": "PRIVATE_IMAGE",
                        "IsSupportCloudInit": true,
                        "OsType": "linux",
                        "OsVersion": "16.0",
                        "Platform": "Ubuntu",
                        "SrcImage": {
                            "ImageDescription": "",
                            "ImageId": "img-im4s1234",
                            "ImageName": "tsImg",
                            "ImageOsName": "Ubuntu 16.0 64位",
                            "ImageType": "PRIVATE_IMAGE",
                            "InstanceId": "ein-123345",
                            "InstanceName": "ts",
                            "Region": "gz",
                            "RegionID": 0,
                            "RegionName": ""
                        },
                        "TaskId": "3281"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DisableWanIp": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "Intel Xeon Skylake 6133",
                        "ExtInfo": "",
                        "Frequency": "2.5 GHz",
                        "GpuModelName": null,
                        "InstanceFamilyConfig": {
                            "InstanceFamily": "S5",
                            "InstanceFamilyName": "标准型S5"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "S",
                            "InstanceFamilyTypeName": "标准型"
                        },
                        "InstanceType": "S5.2XLARGE16",
                        "Memory": 16,
                        "Vcpu": 8,
                        "Vgpu": null
                    },
                    "ModuleId": "em-n2e2345",
                    "ModuleName": "t1_u22",
                    "ModuleState": "NORMAL",
                    "SecurityGroupIds": [
                        "esg-g4k23455"
                    ],
                    "SystemDisk": {
                        "DiskId": "ldisk-1ly4f53h",
                        "DiskSize": 50,
                        "DiskType": "LOCAL_BASIC"
                    },
                    "TagSet": null,
                    "UserData": ""
                },
                "NodeInstanceNum": {
                    "InstanceNum": 8,
                    "NodeNum": 3
                }
            }
        ],
        "RequestId": "565a466c-cb44-4fd1-bbff-92f88986ab56",
        "TotalCount": 87
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 鉴权失败。
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue.InvaildPageParam 分页参数不合法。
InvalidParameterValue.InvalidFilter 无效过滤器。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
MissingParameter.MissingModuleParameter 模块操作参数不全。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
中国站
文档反馈
文档活动
message-icon联系我们
目录