tencent cloud

TencentDB for TcaplusDB

Release Notes
Product Introduction
Product Overview
Benefits
Use Cases
Architecture
Regions
Purchase Guide
Product Pricing
Payment Overdue
Getting Started
Basic Concepts
Creating Cluster
Creating Table Group
Creating Table
Get Connection Information
Accessing TcaplusDB
Operation Guide
Managing Cluster and Table Group
Managing Table
Monitoring and Alarming
Access Management
Tag
Task List
TcaplusDB Client
Accessing by Client Tool
Client Tool Commands
TcaplusDB SDK
Release History
SDK Download
C++ SDK API
TcaplusDB Error Codes
SDK Installation
Directions for Protobuf Table SDK for C++
Directions for TDR Table SDK for C++
TcaplusDB RESTful APIs
Description
Go
Java
PHP
Python
Downloading RESTful API Samples in Multiple Languages
Practical Tutorial
Best Practice for Table Structure Design
Best Practice for Database Interaction
FAQs
Database Features
Database Use
Database Principles
API Documentation
History
Introduction
API Category
Making API Requests
Table Group APIs
Other APIs
Table APIs
Cluster APIs
Data Types
Error Codes
Service Agreement
Service Level Agreement
Terms of Service
Glossary
Contact Us

DescribeMachine

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-28 22:23:45

1. API Description

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

This API is used to query the available machines in a dedicated cluster.

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: DescribeMachine.
Version Yes String Common Params. The value used for this API: 2019-08-23.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Ipv6Enable No Integer If this parameter is not 0, machines supporting IPv6 will be queried.

3. Output Parameters

Parameter Name Type Description
PoolList Array of PoolInfo The list of dedicated machine resources
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the machines in a dedicated cluster

This example shows you how to query the available machine resources for a dedicated cluster.

Input Example

https://tcaplusdb.intl.tencentcloudapi.com/?Action=DescribeMachine
&<Common request parameters>

Output Example

{
    "Response": {
        "PoolList": [
            {
                "PoolUid": 1,
                "Ipv6Enable": 0,
                "AvailableAppCount": 100,
                "ServerList": [
                    {
                        "ServerUid": "svr1",
                        "MachineType": "T1"
                    },
                    {
                        "ServerUid": "svr2",
                        "MachineType": "T2"
                    }
                ],
                "ProxyList": [
                    {
                        "ProxyUid": "proxy1",
                        "MachineType": "T1"
                    },
                    {
                        "ProxyUid": "proxy1",
                        "MachineType": "T2"
                    }
                ]
            },
            {
                "PoolUid": 2,
                "Ipv6Enable": 0,
                "AvailableAppCount": 100,
                "ServerList": [
                    {
                        "ServerUid": "svr1",
                        "MachineType": "T1"
                    },
                    {
                        "ServerUid": "svr2",
                        "MachineType": "T2"
                    }
                ],
                "ProxyList": [
                    {
                        "ProxyUid": "proxy1",
                        "MachineType": "T1"
                    },
                    {
                        "ProxyUid": "proxy1",
                        "MachineType": "T2"
                    }
                ]
            }
        ],
        "RequestId": "34680b61-9836-44d9-bae9-e231f4b61a48"
    }
}

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 API operation authentication error.
FailedOperation.RegionMismatch The requested region does not match.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
ResourceUnavailable The resource is unavailable.

ヘルプとサポート

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

フィードバック