tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeECMInstances

Last updated: 2023-09-18 16:00:15

1. API Description

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

This API is used to obtain the ECM instance information.

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: DescribeECMInstances.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterID Yes String Cluster ID
Filters.N No Array of Filter Filter condition
Only filtering by an ECM ID is supported

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of instances matched the condition
InstanceInfoSet Array of String List of the returned instance information
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the information of instances in a cluster

This example shows you how to obtain the information of instances in a cluster.

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeECMInstances
&ClusterID=cls-xxxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "187c16d5-1f53-4e88-b684-077f0c7369b2",
        "TotalCount": 2,
        "InstanceInfoSet": [
            "info1",
            "info2"
        ]
    }
}

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 Operation failed.
InternalError Internal error.
InternalError.CamNoAuth You do not have permissions.
InvalidParameter Parameter error.
LimitExceeded Quota limit is exceeded.
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy