DescribeInstances

下载PDF

最后更新时间：2025-11-21 20:32:41

DescribeInstances

最后更新时间： 2025-11-21 20:32:41

下载PDF

1. API Description

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

This API is used to search for a list of TDMQ CKafka instances under a user account.

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: DescribeInstances.
Version	Yes	String	Common Params. The value used for this API: 2019-08-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	No	String	(Query condition) filter by the ckafka cluster instance Id.
SearchWord	No	String	Search term. example: (query condition) filter by instance name. fuzzy query is supported.
Status.N	No	Array of Integer	Instance status (query condition). valid values: 0: creating, 1: running, 2: deleting, 5: isolated, 7: upgrading. default return: all.
Offset	No	Integer	Offset. If this parameter is left empty, 0 will be used by default
Limit	No	Integer	Number of results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 100.
VpcId	No	String	(Query condition) VPC Id.

3. Output Parameters

Parameter Name	Type	Description
Result	InstanceResponse	Returned result
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 Getting the instance list

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=DescribeInstances
&InstanceId=instance-will-s
&SearchWord=tre
&Offset=0
&Limit=10
&Status.0=0
&Status.1=1
&Status.2=2
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "InstanceList": [
                {
                    "InstanceId": "instance-will-s",
                    "InstanceName": "treTest",
                    "IfCommunity": true,
                    "Status": 1
                }
            ]
        },
        "RequestId": "31740399-5d06-404b-a4b5-3652e21c8a1d"
    }
}

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

Tencent Cloud CLI 3.0

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.
InvalidParameter	Invalid parameter.
InvalidParameterValue.InstanceNotExist	The instance does not exist.
InvalidParameterValue.RepetitionValue	The parameter already exists.
InvalidParameterValue.WrongAction	The value of the `Action` parameter is incorrect.
ResourceUnavailable	The resource is unavailable.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.BatchDelInstanceLimit	The batch instance deletion limit is reached.
UnsupportedOperation.OssReject	Oss rejected the operation.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud