DescribeInstanceAttributes

Last updated: 2025-11-21 20:32:42

DescribeInstanceAttributes

Last updated: 2025-11-21 20:32:42

1. API Description

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

This API is used to obtain instance attributes.

A maximum of 100 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: DescribeInstanceAttributes.
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	Yes	String	ckafka cluster instance Id. obtain through the API DescribeInstances.

3. Output Parameters

Parameter Name	Type	Description
Result	InstanceAttributesResponse	Returned result object of instance attributes
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 Obtaining Instance Attributes

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=DescribeInstanceAttributes
&InstanceId=ckafka-pkwxedpq
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "dc67ed1b-3ada-4dad-9c5e-dc2a3619558e",
        "Result": {
            "Bandwidth": 1200,
            "ClusterType": "CLOUD_EKS_TSE",
            "Config": {
                "AutoCreateTopicsEnable": true,
                "DefaultNumPartitions": 10,
                "DefaultReplicationFactor": 2
            },
            "CreateTime": 1667461825,
            "CreatedPartitions": 1026,
            "CreatedTopics": 61,
            "CustomCertId": "certid",
            "Cvm": 1,
            "DeleteRouteTimestamp": "",
            "DiskSize": 1000,
            "DynamicDiskConfig": {
                "DiskQuotaPercentage": 75,
                "Enable": 1,
                "MaxDiskSpace": 500000,
                "StepForwardPercentage": 10
            },
            "ElasticFloatBandwidth": 480,
            "ExpireTime": 1735890625,
            "Features": [
                "FEATURE_SUBNET_ACL",
                "FEATURE_SASL_SSL",
                "FEATURE_MULIT_SASL_PLAINTEXT",
                "FEATURE_TOPIC_QUOTA",
                "FEATURE_SASL_SCRAM_512",
                "CLOUD_EKS_TSE",
                "CLOUD_EKS_CROS_ZONE",
                "FEATURE_SASL_SCRAM"
            ],
            "FreePartitionNumber": 1200,
            "Healthy": 1,
            "HealthyMessage": "healthy",
            "InstanceChargeType": "PREPAID",
            "InstanceId": "ckafka-pkwxedpq",
"InstanceName": "[Do not delete - Do not create public network domains, security tickets may occur] spock-test."
            "InstanceType": "profession",
            "MaxConnection": 10000,
            "MaxGroupNum": 200,
            "MsgRetentionTime": 2880,
            "PublicNetwork": 6,
            "RemainderPartitions": 174,
            "RemainderTopics": 539,
            "RemainingPartitions": 174,
            "RemainingTopics": 539,
            "RetentionTimeConfig": {
                "BottomRetention": 360,
                "DiskQuotaPercentage": 75,
                "Enable": 0,
                "StepForwardPercentage": 10
            },
            "Status": 1,
            "SubnetId": "subnet-kg07707y",
            "Tags": [
                {
                    "TagKey": "Application",
                    "TagValue": "underlay-domain"
                },
                {
                    "TagKey": "key",
                    "TagValue": "555555"
                }
            ],
            "Version": "2.4.1",
            "Vip": "172.16.0.17",
            "VipList": [
                {
                    "Vip": "172.16.0.17",
                    "Vport": "9092"
                }
            ],
            "VpcId": "vpc-apwrtw01",
            "Vport": "9092",
            "ZoneId": 100006,
            "ZoneIds": [
                100006,
                100007
            ]
        }
    }
}

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.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.
ResourceNotFound	The resource does not exist.
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud