tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeModuleDetail

Last updated: 2023-08-18 14:28:06

1. API Description

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

This API is used to display the details of 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: DescribeModuleDetail.
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.
ModuleId Yes String Module ID, such as em-qn46snq8.

3. Output Parameters

Parameter Name Type Description
Module Module Module details. For more information, see ModuleInfo in the data structure.
Note: this field may return null, indicating that no valid values can be obtained.
ModuleCounter ModuleCounter Module statistics. For more information, see ModuleCounterInfo in the data structure.
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 details

This example shows you how to view the module details.

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeModuleDetail
&ModuleId=em-eedttqfb
&<Common request parameters>

Output Example

{
    "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-bit",
                "ImageState": "NORMAL",
                "ImageType": "PUBLIC_IMAGE",
                "ImageOwner": 0,
                "ImageOsName": "CentOS 7.5 64-bit",
                "ImageDescription": "CentOS 7.5 64-bit",
                "Architecture": "x86_64",
                "OsType": "linux",
                "Platform": "CentOS",
                "OsVersion": "7.5.0",
                "ImageCreateTime": "",
                "ImageSize": 50
            },
            "InstanceTypeConfig": {
                "InstanceFamilyConfig": {
                    "InstanceFamilyName": "Standard Network Optimized",
                    "InstanceFamily": "SN3ne"
                },
                "InstanceFamilyTypeConfig": {
                    "InstanceFamilyType": "S",
                    "InstanceFamilyTypeName": "Standard"
                },
                "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": "Beijing Zone 3 (China Telecom)",
                            "InstanceNum": 1
                        }
                    ]
                },
                {
                    "ProviderName": "CMCC",
                    "ProviderNodeNum": 2,
                    "ProvederInstanceNum": 2,
                    "ZoneInstanceInfoSet": [
                        {
                            "ZoneName": "Beijing Zone 1 (China Mobile)",
                            "InstanceNum": 1
                        },
                        {
                            "ZoneName": "Chengdu Zone 2 (China Mobile)",
                            "InstanceNum": 1
                        }
                    ]
                }
            ],
            "NodeNum": 3,
            "InstanceNum": 3,
            "ProvinceNum": 2,
            "CityNum": 2
        }
    }
}

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.InvalidModuleID The module ID 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