tencent cloud

Batch Compute

Product Introduction
What's Batch?
Scenarios
Strengths
Glossary
Quota & Limits
Data Security
Purchase Guide
Getting Started
Preparation
Using CLI - Submit a Job
Using CLI - Compute Environment
Configuring a Job
Using Console
Console User Guide
Task Template Management
Job Management
User Guide
How to create images usable by BatchCompute
Windows Custom Images
Environment Variables
Entering COS & CFS Paths
Event Notice & Callback
Cloud Access Management
Command Line Interface
Preparation
Quick Start
Running Remote Package
Mapping Remote Storage
Use Cases
Building Cluster Using Compute Environment
Example: 3ds Max 2018 Rendering
Example: Deep Learning
API Documentation
History
Introduction
API Category
Making API Requests
Compute Environment APIs
Configuration Viewing-related APIs
Task Template-related APIs
Job-related APIs
Data Types
Error Codes
SDK Documentation
Instructions
FAQs
Contact Us
Glossary
ドキュメントBatch Compute API Documentation Configuration Viewing-related APIsDescribeAvailableCvmInstanceTypes

DescribeAvailableCvmInstanceTypes

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-30 21:28:49

1. API Description

Domain name for API request: batch.intl.tencentcloudapi.com.

This API is used to view the information of available CVM model configurations.

A maximum of 2 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: DescribeAvailableCvmInstanceTypes.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
Filters.N No Array of Filter Filter.
  • zone - String - Required: No - (Filter) Filter by availability zone.
  • instance-family - String - Required: No - (Filter) Filter by model family such as S1, I1, and M1.
    		•

    3. Output Parameters

    Parameter Name Type Description
    InstanceTypeConfigSet Array of InstanceTypeConfig Array of model configurations
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying GN2 instances in Guangzhou Zone 3

    Input Example

    https://batch.intl.tencentcloudapi.com/?Action=DescribeAvailableCvmInstanceTypes
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-3
&Filters.1.Name=instance-family
&Filters.1.Values.0=GN2
&<Common request parameters>

    Output Example

    {
    "Response": {
        "InstanceTypeConfigSet": [
            {
                "Mem": 56,
                "Cpu": 28,
                "InstanceType": "GN2.7XLARGE56",
                "Zone": "ap-guangzhou-3",
                "InstanceFamily": "GN2"
            },
            {
                "Mem": 112,
                "Cpu": 56,
                "InstanceType": "GN2.14XLARGE112",
                "Zone": "ap-guangzhou-3",
                "InstanceFamily": "GN2"
            }
        ],
        "RequestId": "59f5b671-c492-4536-bbed-e5fbf78619dd"
    }
}

    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
    InternalError Internal error.
    InternalError.CallCvm An error is returned for the CVM API call.
    InvalidFilter The specified filter is not supported.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidFilter Incorrect Filter parameter.
    InvalidParameterValue.InvalidZoneMismatchRegion The availability zone and the region do not match.
    InvalidParameterValue.LimitExceeded The number of filter parameter values exceeds the limit.
    InvalidZone.MismatchRegion The specified zone does not exist.
    前の記事へ: TerminateComputeNodes次の記事へ: DescribeCvmZoneInstanceConfigInfos

    ヘルプとサポート

    この記事はお役に立ちましたか？

    フィードバック