查询Kafka实例Topic详细信息
功能介绍
查询Kafka实例Topic详细信息。(单个实例调用不要超过1s一次)
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。获取方法如下:登录Kafka控制台,在Kafka实例详情页面查找实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
topic |
是 |
String |
参数解释: Topic名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
topic |
String |
参数解释: Topic名称。 取值范围: 不涉及 |
partitions |
Array of partitions objects |
参数解释: 分区列表。 |
group_subscribed |
Array of strings |
参数解释: 订阅该Topic的消费组名称列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
partition |
Integer |
参数解释: 分区ID。 取值范围: 不涉及 |
leader |
Integer |
参数解释: leader副本所在节点的id。 取值范围: 不涉及 |
leo |
Integer |
参数解释: 分区leader副本的LEO(Log End Offset)。 取值范围: 不涉及 |
hw |
Integer |
参数解释: 分区高水位(HW,High Watermark)。 取值范围: 不涉及 |
lso |
Integer |
参数解释: 分区leader副本的LSO(Log Start Offset)。 取值范围: 不涉及 |
last_update_timestamp |
Long |
参数解释: 分区上次写入消息的时间。 格式为Unix时间戳。 单位:毫秒。 取值范围: 不涉及 |
replicas |
Array of replicas objects |
参数解释: 副本列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
broker |
Integer |
参数解释: 副本所在的节点ID。 取值范围: 不涉及 |
leader |
Boolean |
参数解释: 该副本是否为leader。 取值范围:
|
in_sync |
Boolean |
参数解释: 该副本是否在ISR副本中。 取值范围:
|
size |
Integer |
参数解释: 该副本当前日志大小。单位:Byte。 取值范围: 不涉及 |
lag |
Long |
参数解释: 该副本当前落后hw的消息数。 取值范围: 不涉及 |
请求示例
查询指定Topic的详细信息。
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}
响应示例
状态码:200
查询成功。
{
"topic" : "test",
"partitions" : [ {
"partition" : 0,
"leader" : 2,
"replicas" : [ {
"broker" : 2,
"leader" : true,
"in_sync" : true,
"size" : 123971146,
"lag" : 0
}, {
"broker" : 1,
"leader" : false,
"in_sync" : true,
"size" : 123971146,
"lag" : 0
}, {
"broker" : 0,
"leader" : false,
"in_sync" : true,
"size" : 123971146,
"lag" : 0
} ],
"lso" : 0,
"leo" : 13598,
"hw" : 13598,
"last_update_timestamp" : 1571477180985
}, {
"partition" : 2,
"leader" : 1,
"replicas" : [ {
"broker" : 1,
"leader" : true,
"in_sync" : true,
"size" : 123889531,
"lag" : 0
}, {
"broker" : 0,
"leader" : false,
"in_sync" : true,
"size" : 123889531,
"lag" : 0
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true,
"size" : 123889531,
"lag" : 0
} ],
"lso" : 0,
"leo" : 13601,
"hw" : 13601,
"last_update_timestamp" : 1571477077146
}, {
"partition" : 1,
"leader" : 0,
"replicas" : [ {
"broker" : 0,
"leader" : true,
"in_sync" : true,
"size" : 127245604,
"lag" : 0
}, {
"broker" : 2,
"leader" : false,
"in_sync" : true,
"size" : 127245604,
"lag" : 0
}, {
"broker" : 1,
"leader" : false,
"in_sync" : true,
"size" : 127245604,
"lag" : 0
} ],
"lso" : 0,
"leo" : 13599,
"hw" : 13599,
"last_update_timestamp" : 1571477172959
} ],
"group_subscribed" : [ "test-consumer-group" ]
}
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;
public class ShowInstanceTopicDetailSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
KafkaClient client = KafkaClient.newBuilder()
.withCredential(auth)
.withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
.build();
ShowInstanceTopicDetailRequest request = new ShowInstanceTopicDetailRequest();
request.withInstanceId("{instance_id}");
request.withTopic("{topic}");
try {
ShowInstanceTopicDetailResponse response = client.showInstanceTopicDetail(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = KafkaClient.new_builder() \
.with_credentials(credentials) \
.with_region(KafkaRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowInstanceTopicDetailRequest()
request.instance_id = "{instance_id}"
request.topic = "{topic}"
response = client.show_instance_topic_detail(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := kafka.NewKafkaClient(
kafka.KafkaClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowInstanceTopicDetailRequest{}
request.InstanceId = "{instance_id}"
request.Topic = "{topic}"
response, err := client.ShowInstanceTopicDetail(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;
public class ShowInstanceTopicDetailSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
KafkaClient client = KafkaClient.newBuilder()
.withCredential(auth)
.withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
.build();
ShowInstanceTopicDetailRequest request = new ShowInstanceTopicDetailRequest();
request.withInstanceId("{instance_id}");
request.withTopic("{topic}");
try {
ShowInstanceTopicDetailResponse response = client.showInstanceTopicDetail(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = KafkaClient.new_builder() \
.with_credentials(credentials) \
.with_region(KafkaRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ShowInstanceTopicDetailRequest()
request.instance_id = "{instance_id}"
request.topic = "{topic}"
response = client.show_instance_topic_detail(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := kafka.NewKafkaClient(
kafka.KafkaClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ShowInstanceTopicDetailRequest{}
request.InstanceId = "{instance_id}"
request.Topic = "{topic}"
response, err := client.ShowInstanceTopicDetail(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询成功。 |
错误码
请参见错误码。