tencent cloud



Last updated: 2023-03-22 17:06:22

1. API Description

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

This API is used to get instance list details 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: DescribeInstancesDetail.
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 (Filter) filter by instance ID
SearchWord No String Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.
Status.N No Array of Integer (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default
Offset No Integer Offset. If this parameter is left empty, 0 will be used by default.
Limit No Integer Number of returned results. If this parameter is left empty, 10 will be used by default. The maximum value is 20.
TagKey No String Tag key match.
Filters.N No Array of Filter Filter. Valid values of filter.Name include Ip, VpcId, SubNetId, InstanceType, and InstanceId. Up to 10 values can be passed for filter.Values.
InstanceIds No String This parameter has been deprecated and replaced with InstanceIdList.
InstanceIdList.N No Array of String Filter by instance ID.
TagList.N No Array of Tag Filter instances by a set of tags

3. Output Parameters

Parameter Name Type Description
Result InstanceDetailResponse Returned result object of instance details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining instance list details


Input Example

&<Common request parameters>

Output Example

    "Response": {
        "Result": {
            "TotalCount": 0,
            "InstanceList": [
                    "InstanceId": "xx",
                    "InstanceName": "xx",
                    "Vip": "xx",
                    "Vport": "xx",
                    "VipList": [
                            "Vip": "xx",
                            "Vport": "xx"
                    "Status": 0,
                    "Bandwidth": 0,
                    "DiskSize": 0,
                    "ZoneId": 0,
                    "VpcId": "xx",
                    "SubnetId": "xx",
                    "RenewFlag": 0,
                    "Healthy": 0,
                    "HealthyMessage": "xx",
                    "CreateTime": 0,
                    "ExpireTime": 0,
                    "IsInternal": 0,
                    "TopicNum": 0,
                    "Tags": [
                            "TagKey": "xx",
                            "TagValue": "xx"
                    "Version": "xx",
                    "ZoneIds": [
                    "Cvm": 0,
                    "InstanceType": "xx",
                    "DiskType": "xx",
                    "MaxTopicNumber": 0,
                    "MaxPartitionNumber": 0,
                    "RebalanceTime": "xx",
                    "PartitionNumber": 1,
                    "PublicNetworkChargeType": "xx",
                    "PublicNetwork": 0,
                    "ClusterType": "xx",
                    "Features": [
        "RequestId": "xx"

5. Developer Resources


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.
InvalidParameter Invalid parameter.
InvalidParameterValue.InstanceNotExist The instance does not exist.
InvalidParameterValue.RepetitionValue The parameter already exists.
InvalidParameterValue.SubnetIdInvalid Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone The subnet is not in the zone.
InvalidParameterValue.VpcIdInvalid Invalid VPC ID.
InvalidParameterValue.WrongAction The value of the Action parameter is incorrect.
InvalidParameterValue.ZoneNotSupport The zone is not supported.
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.
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