tencent cloud

Feedback

DescribeConfig

Last updated: 2022-06-01 18:41:27

1. API Description

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

This API is used to get the limits of data such as bandwidth and disk.

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: DescribeConfig.
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.

3. Output Parameters

Parameter Name Type Description
NetworkStorageRange NetworkStorageRange Range of the network bandwidth disk size.
ImageWhiteSet Array of String Image OS allowlist.
Note: this field may return null, indicating that no valid values can be obtained.
InstanceNetworkLimitConfigs Array of InstanceNetworkLimitConfig Network quota information.
Note: this field may return null, indicating that no valid values can be obtained.
ImageLimits ImageLimitConfig Image quota information.
Note: this field may return null, indicating that no valid values can be obtained.
DefaultIPDirect Boolean Default IP direct access, used in scenarios with direct access parameters such as module creation and virtual machine purchase.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting basic configuration

This example shows you how to get the basic configuration.

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeConfig
&<Common request parameters>

Output Example

{
  "Response": {
    "InstanceNetworkLimitConfigs": [
      {
        "CpuNum": 1,
        "NetworkInterfaceLimit": 2,
        "InnerIpPerNetworkInterface": 2,
        "PublicIpPerInstance": 1
      },
      {
        "CpuNum": 2,
        "NetworkInterfaceLimit": 2,
        "InnerIpPerNetworkInterface": 10,
        "PublicIpPerInstance": 1
      },
      {
        "CpuNum": 4,
        "NetworkInterfaceLimit": 3,
        "InnerIpPerNetworkInterface": 10,
        "PublicIpPerInstance": 3
      },
      {
        "CpuNum": 8,
        "NetworkInterfaceLimit": 4,
        "InnerIpPerNetworkInterface": 10,
        "PublicIpPerInstance": 3
      },
      {
        "CpuNum": 16,
        "NetworkInterfaceLimit": 6,
        "InnerIpPerNetworkInterface": 10,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 24,
        "NetworkInterfaceLimit": 6,
        "InnerIpPerNetworkInterface": 10,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 32,
        "NetworkInterfaceLimit": 8,
        "InnerIpPerNetworkInterface": 20,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 48,
        "NetworkInterfaceLimit": 8,
        "InnerIpPerNetworkInterface": 20,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 64,
        "NetworkInterfaceLimit": 8,
        "InnerIpPerNetworkInterface": 20,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 96,
        "NetworkInterfaceLimit": 8,
        "InnerIpPerNetworkInterface": 20,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 128,
        "NetworkInterfaceLimit": 8,
        "InnerIpPerNetworkInterface": 20,
        "PublicIpPerInstance": 4
      },
      {
        "CpuNum": 256,
        "NetworkInterfaceLimit": 8,
        "InnerIpPerNetworkInterface": 20,
        "PublicIpPerInstance": 4
      }
    ],
    "DefaultIPDirect": true,
    "NetworkStorageRange": {
      "PerBandwidth": 1,
      "MaxDataDiskSize": 1024,
      "SuggestSystemDiskSize": 50,
      "MinDataDiskSize": 50,
      "MaxVcpuPerReq": 100,
      "SuggestBandwidth": 25,
      "MaxModuleNum": 1000,
      "PerDataDisk": 10,
      "MinSystemDiskSize": 0,
      "SuggestDataDiskSize": 1024,
      "MaxVcpu": 100,
      "MinBandwidth": 25,
      "MaxSystemDiskSize": 100,
      "MinVcpu": 1,
      "MaxBandwidth": 1000
    },
    "ImageLimits": {
      "MaxImageSize": 0
    },
    "RequestId": "xx",
    "ImageWhiteSet": [
      "CentOS 6.2 64",
      "CentOS 6.3 64",
      "CentOS 6.8 64",
      "CentOS 6.9 32",
      "CentOS 6.9 64",
      "CentOS 7.2 64",
      "CentOS 7.3 64",
      "CentOS 7.4 64",
      "CentOS 7.5 64",
      "CentOS 7.6 64",
      "Debian 7.4 64",
      "Debian 8.2 32",
      "Debian 8.2 64",
      "Debian 9.0 64",
      "Tencent Linux Release 1.2 (tkernel2)",
      "Tencent Linux Release 2.2 (Final)",
      "Tencent Linux release 2.4 (Final)",
      "Ubuntu Server 14.04.1 LTS 32",
      "Ubuntu Server 14.04.1 LTS 64",
      "Ubuntu Server 16.04.1 LTS 32",
      "Ubuntu Server 16.04.1 LTS 64",
      "Ubuntu Server 18.04.1 LTS 64",
      "Ubuntu 16.0 64",
      "Windows Server 2012 R2",
      "Windows Server 2012 Datacenter 64-bit English",
      "Windows Server 2016 Datacenter 64-bit English",
      "Windows Server 2016 Datacenter 64-bit Chinese",
      "None 2.2 64",
      "CentOS 8.0 64",
      "CentOS 7.7 64",
      "Windows Server 2019",
      "Debian 10.2 64",
      "Tencent tlinux release 2.2",
      "Ubuntu Server 20.04",
      "Tencent Linux release 2.6"
    ]
  }
}

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.InvalidPublicParam The common parameter is invalid.
MissingParameter.MissingBaseConfigParameter The request parameters required to get the basic configuration are incomplete.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support