tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeModule

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

1. API Description

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

This API is used to get the list of modules.

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: DescribeModule.
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.
Filters.N No Array of Filter Filter.
module-name - string - Required: no - (Filter) Filter by module name.
module-id - string - Required: no - (Filter) Filter by module ID.
image-id String Required: no (Filter) Filter by image ID.
instance-family String Required: no (Filter) Filter by model family.
security-group-id - string Required: no - (Filter) Filter by ID of the security group bound to the module.
Each request can contain up to 10 Filters and 5 Filter.Values.
Offset No Integer Offset. Default value: 0. For more information on Offset, see the relevant section of the API overview.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant section of the API overview.
OrderByField No String Specified sort by field. Currently, valid values are as follows:
instance-num: sort by the number of instances.
node-num: sort by the number of nodes.
timestamp: sort by instance creation time.
If this parameter is not specified, instances will be sorted by creation time by default.
OrderDirection No Integer Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible modules.
Note: this field may return null, indicating that no valid values can be obtained.
ModuleItemSet Array of ModuleItem List of module details.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Viewing module list

This example shows you how to view the list of modules.

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeModule
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 17,
        "ModuleItemSet": [
            {
                "NodeInstanceNum": {
                    "InstanceNum": 3,
                    "NodeNum": 3
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 48,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 8,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 16,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "RegionName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "ImageOsName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "ImageSource": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "OsVersion": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 106,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Value": "xx",
                            "Key": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 1,
                    "NodeNum": 1
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 50,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 4,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 8,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 100,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 0,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 24,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 48,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 25,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 0,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 1,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 2,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 35,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 1,
                    "NodeNum": 1
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 49,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 8,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 16,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 534,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 0,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 1,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 2,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 25,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 0,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 1,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 2,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 25,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 0,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 16,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 32,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 25,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 0,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 1,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 2,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 25,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            },
            {
                "NodeInstanceNum": {
                    "InstanceNum": 0,
                    "NodeNum": 0
                },
                "Module": {
                    "ModuleName": "xx",
                    "DefaultDataDiskSize": 100,
                    "DefaultBandwidthIn": 0,
                    "InstanceTypeConfig": {
                        "CpuModelName": "xx",
                        "Vcpu": 32,
                        "InstanceFamilyConfig": {
                            "InstanceFamilyName": "xx",
                            "InstanceFamily": "xx"
                        },
                        "InstanceFamilyTypeConfig": {
                            "InstanceFamilyType": "xx",
                            "InstanceFamilyTypeName": "xx"
                        },
                        "Memory": 64,
                        "ExtInfo": "xx",
                        "Frequency": "xx",
                        "InstanceType": "xx"
                    },
                    "DefaultImage": {
                        "SrcImage": {
                            "ImageDescription": "xx",
                            "InstanceId": "xx",
                            "Region": "xx",
                            "RegionID": 0,
                            "ImageId": "xx",
                            "ImageName": "xx",
                            "ImageOsName": "xx",
                            "InstanceName": "xx",
                            "ImageType": "xx",
                            "RegionName": "xx"
                        },
                        "ImageCreateTime": "xx",
                        "ImageSize": 50,
                        "OsVersion": "xx",
                        "ImageDescription": "xx",
                        "ImageOwner": 0,
                        "ImageId": "xx",
                        "ImageState": "xx",
                        "Platform": "xx",
                        "ImageName": "xx",
                        "Architecture": "xx",
                        "OsType": "xx",
                        "ImageSource": "xx",
                        "ImageType": "xx",
                        "ImageOsName": "xx"
                    },
                    "DefaultSystemDiskSize": 50,
                    "DefaultBandwidth": 5000,
                    "SecurityGroupIds": [
                        "xx"
                    ],
                    "TagSet": [
                        {
                            "Key": "xx",
                            "Value": "xx"
                        }
                    ],
                    "CloseIpDirect": 0,
                    "ModuleState": "xx",
                    "CreateTime": "xx",
                    "ModuleId": "xx"
                }
            }
        ],
        "RequestId": "xx"
    }
}

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
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvaildPageParam The pagination parameter is invalid.
InvalidParameterValue.InvalidFilter The filter is invalid.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
MissingParameter.MissingModuleParameter The module operation parameters are incomplete.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy