Domain name for API request: ckafka.intl.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.
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 | (Filtering Conditions) Filter by instance ID |
| SearchWord | No | String | (Filtering Conditions) Filter by instance name, instance Id, availability zone, VPC Id, or subnet Id. Fuzzy query is supported. |
| Status.N | No | Array of Integer | (Filtering Conditions) Instance status. Return all by default if left blank. Enumeration values:
|
| Offset | No | Integer | Offset, which is 0 by default. |
| Limit | No | Integer | Number of returned results. Default value: 10. Maximum value: 20. |
| TagKey | No | String | Match the tag key. |
| Filters.N | No | Array of Filter | Filter. filter.Name supports ('Ip', 'VpcId', 'SubNetId', 'InstanceType', 'InstanceId'). filter.Values can transmit up to 10 values. |
| InstanceIdList.N | No | Array of String | Filter by instance ID |
| TagList.N | No | Array of Tag | Filter instances based on tag list (take the intersection) |
| Parameter Name | Type | Description |
|---|---|---|
| Result | InstanceDetailResponse | Returned instance detail result object |
| 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. |
1
https://ckafka.intl.tencentcloudapi.com/?Action=DescribeInstancesDetail
&<Common request parameters>
{
"Response": {
"RequestId": "84b84177-c5aa-4fa9-aae0-14618af7d251",
"Result": {
"InstanceList": [
{
"Bandwidth": 800,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1732245392,
"Cvm": 1,
"DiskSize": 1000,
"DiskType": "CLOUD_SSD",
"ExpireTime": 1734837392,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-wdvgwwx2",
"InstanceName": "test-public-network",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 1200,
"MaxTopicNumber": 600,
"PartitionNumber": 60,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 6,
"Version": "2.8.1",
"Vip": "10.0.1.17",
"VipList": [
{
"Vip": "10.0.1.17",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 19200,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1732086196,
"Cvm": 1,
"DiskSize": -1,
"DiskType": "CLOUD_SSD",
"ExpireTime": 0,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-vv7wpp93",
"InstanceName": "wenbingshen-test"
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 5000,
"MaxTopicNumber": 2500,
"PartitionNumber": 46,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 3,
"Version": "2.8.1",
"Vip": "10.0.1.31",
"VipList": [
{
"Vip": "10.0.1.31",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 160,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1731479434,
"Cvm": 1,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"ExpireTime": 1734071434,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-bzmjpp4z",
"InstanceName": "Reserved_hdq_0.6_2.8",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 400,
"MaxTopicNumber": 200,
"PartitionNumber": 18,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 3,
"Version": "2.8.1",
"Vip": "10.0.1.3",
"VipList": [
{
"Vip": "10.0.1.3",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": []
},
{
"Bandwidth": 160,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1724071025,
"Cvm": 1,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"ExpireTime": 1734611825,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-mon24787",
"InstanceName": "carwyn-test Do not delete"
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 400,
"MaxTopicNumber": 200,
"PartitionNumber": 26,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 1,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 5,
"Version": "1.1.1",
"Vip": "10.0.1.29",
"VipList": [
{
"Vip": "10.0.1.29",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 1600,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1722481364,
"Cvm": 1,
"DiskSize": 1000,
"DiskType": "CLOUD_SSD",
"ExpireTime": 0,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-5k7va2bv",
"InstanceName": "shilinlu-test-Do not modify",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 1400,
"MaxTopicNumber": 700,
"PartitionNumber": 72,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 5,
"Version": "2.8.1",
"Vip": "10.0.1.40",
"VipList": [
{
"Vip": "10.0.1.40",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 3200,
"ClusterType": "CLOUD_CVM",
"CreateTime": 1716451701,
"Cvm": 1,
"DiskSize": 3000,
"DiskType": "CLOUD_SSD",
"ExpireTime": 0,
"Features": [
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "healthy",
"InstanceId": "ckafka-na37x9qa",
"InstanceName": "shilinlu-exporter test",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 2000,
"MaxTopicNumber": 1000,
"PartitionNumber": 22,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 2,
"Version": "2.4.1",
"Vip": "10.0.1.25",
"VipList": [
{
"Vip": "10.0.1.25",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": []
},
{
"Bandwidth": 1200,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1667461825,
"Cvm": 1,
"DiskSize": 1000,
"DiskType": "CLOUD_BASIC",
"ExpireTime": 1735890625,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "healthy",
"InstanceId": "ckafka-pkwxedpq",
"InstanceName": "[Do not delete - Do not create public network domains, security tickets may occur] spock-test."
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 1200,
"MaxTopicNumber": 600,
"PartitionNumber": 1026,
"PublicNetwork": 6,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "2023-07-04 10:30:58",
"RenewFlag": 1,
"Status": 1,
"SubnetId": "subnet-kg07707y",
"Tags": [
{
"TagKey": "Application",
"TagValue": "underlay-domain"
},
{
"TagKey": "tagkey",
"TagValue": "555555"
}
],
"TopicNum": 61,
"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
]
}
],
"TotalCount": 7
}
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan