tencent cloud

Feedback

DescribeInstanceFamilyConfigs

Last updated: 2022-04-25 10:12:31

1. API Description

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

This API is used to query a list of model families available to the current user in the current region.

A maximum of 10 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: DescribeInstanceFamilyConfigs.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
InstanceFamilyConfigSet Array of InstanceFamilyConfig List of instance model families
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying supported instance families

This example shows you how to query the supported instance families in the Guangzhou region.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeInstanceFamilyConfigs
&Region=ap-guangzhou
&<Common request parameters>

Output Example

{
  "Response": {
    "InstanceFamilyConfigSet": [
      {
        "InstanceFamilyName": "Standard S1",
        "InstanceFamily": "S1"
      },
      {
        "InstanceFamilyName": "Network-optimized N1",
        "InstanceFamily": "N1"
      },
      {
        "InstanceFamilyName": "High IO I1",
        "InstanceFamily": "I1"
      },
      {
        "InstanceFamilyName": "MEM optimized M1",
        "InstanceFamily": "M1"
      },
      {
        "InstanceFamilyName": "Standard S2",
        "InstanceFamily": "S2"
      },
      {
        "InstanceFamilyName": "Standard network enhanced SN2",
        "InstanceFamily": "SN2"
      },
      {
        "InstanceFamilyName": "High IO I2",
        "InstanceFamily": "I2"
      },
      {
        "InstanceFamilyName": "MEM optimized M2",
        "InstanceFamily": "M2"
      },
      {
        "InstanceFamilyName": "Compute C2",
        "InstanceFamily": "C2"
      },
      {
        "InstanceFamilyName": "Compute Network-optimized CN2",
        "InstanceFamily": "CN2"
      },
      {
        "InstanceFamilyName": "Standard S3",
        "InstanceFamily": "S3"
      },
      {
        "InstanceFamilyName": "Compute C3",
        "InstanceFamily": "C3"
      },
      {
        "InstanceFamilyName": "FPGA FX2",
        "InstanceFamily": "FX2"
      },
      {
        "InstanceFamilyName": "GPU compute GN2",
        "InstanceFamily": "GN2"
      },
      {
        "InstanceFamilyName": "GPU rendering GA2",
        "InstanceFamily": "GA2"
      },
      {
        "InstanceFamilyName": "GPU compute GN8",
        "InstanceFamily": "GN8"
      },
      {
        "InstanceFamilyName": "Dedicated",
        "InstanceFamily": "CDH"
      },
      {
        "InstanceFamilyName": "Shared core",
        "InstanceFamily": "SHARED"
      },
      {
        "InstanceFamilyName": "Special models",
        "InstanceFamily": "SPECIAL"
      },
      {
        "InstanceFamilyName": "Others",
        "InstanceFamily": "OTHER"
      }
    ],
    "RequestId": "b061782b-934a-4e53-b1eb-d5f2fed8130e"
  }
}

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
InternalServerError Internal error.
InvalidParameterValue Incorrect parameter value.
InvalidRegion.NotFound The region cannot be found.
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