查询数据转发配置列表
功能介绍
查询数据转发配置列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/forwarding-configs
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。 取值范围：仅支持数字，a到f的小写字母组合，长度32。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
forwarding_type |
是 |
String |
参数说明：转发配置的类型。 取值范围：当前仅支持“kafka，mrskafka”。 最小长度：1 最大长度：255 |
offset |
否 |
Integer |
参数说明：查询配置列表的偏移量。 最小值：0 最大值：5000 缺省值：0 |
limit |
否 |
Integer |
参数说明：查询时每页显示的记录数。 最小值：1 最大值：50 缺省值：10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Instance-Id |
否 |
String |
参数说明：实例ID。DRIS物理实例的唯一标识，获取方法请参见“API参考 > 附录 > 获取Instance-Id”。 取值范围：仅支持数字，小写字母和连接符（-）的组合，长度36。 |
X-Auth-Token |
否 |
String |
参数说明：用户Token，Token认证鉴权时必选。通过调用IAM服务 “获取IAM用户Token”接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见“API参考 > API > 应用侧API参考 > 如何调用API > 认证鉴权 > Token认证”。 最小长度：1 最大长度：20000 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
count |
Integer |
参数说明：满足查询条件的记录总数。 最小值：0 最大值：10000 |
forwarding_configs |
Array of ForwardingConfig objects |
参数说明：转发配置的列表。 数组长度：0 - 50 |
参数 |
参数类型 |
描述 |
|---|---|---|
forwarding_type |
String |
参数说明：转发配置的类型。 取值范围：当前仅支持“kafka、mrskafka”。 |
kafka_config |
KafkaConfigResponseDTO object |
参数说明：Kafka配置信息。 |
mrs_kafka_config |
MrsKafkaConfigResponseDTO object |
参数说明：mrsKafka配置信息。 |
参数 |
参数类型 |
描述 |
|---|---|---|
kafka_config_id |
String |
参数说明：每一套Kafka配置的唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 |
kafka_topics |
Array of strings |
参数说明：kafka的主题列表。 取值范围：
数组长度：0 - 7 |
brokers |
Array of strings |
参数说明：Kafka broker列表。 最小长度：1 最大长度：255 数组长度：1 - 255 |
username |
String |
参数说明：kafka用户名。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 |
topic_prefix |
String |
参数说明：Topic前缀。 取值范围：长度不超过255，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
status |
String |
参数说明：一套kafka的连接状态。 取值范围：
枚举值：
|
cert_info |
CertificateInfo object |
|
created_time |
String |
参数说明：创建时间。 格式为yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2015-12-12T12:12:12Z |
last_modified_time |
String |
参数说明：修改时间。 格式为yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2015-12-12T12:12:12Z |
参数 |
参数类型 |
描述 |
|---|---|---|
kafka_config_id |
String |
参数说明：每一套Kafka配置的唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：1 最大长度：255 |
kafka_topics |
Array of strings |
参数说明：kafka的主题列表。 取值范围：
数组长度：0 - 7 |
brokers |
Array of strings |
参数说明：Kafka broker列表。 最小长度：1 最大长度：255 数组长度：1 - 255 |
username |
String |
参数说明：mrskafka用户名，若开启安全认证该参数必填。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 最小长度：0 最大长度：255 |
status |
String |
参数说明：一套kafka的连接状态。 取值范围：
枚举值：
|
authentication |
Boolean |
参数说明：是否开启kerberos安全认证的开关。若开启安全认证则需要先上传kerberos安全认证的凭证。 缺省值：false |
created_time |
String |
参数说明：创建时间。 格式为yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2015-12-12T12:12:12Z |
last_modified_time |
String |
参数说明：修改时间。 格式为yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2015-12-12T12:12:12Z |
请求示例
GET https://{endpoint}/v1/{project_id}/forwarding-configs?offset={offset}&limit={limit}&forwarding_type={forwarding_type}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********
响应示例
状态码： 200
OK
{
"count" : 1,
"forwarding_configs" : [ {
"forwarding_type" : "kafka",
"kafka_config" : {
"kafka_config_id" : "1234567890",
"kafka_topics" : [ "v2x-v1-tracks", "v2x-v1-bsm", "v2x-v1-rsi", "v2x-v1-rsm", "v2x-v1-spat", "v2x-v1-edge-flow" ],
"brokers" : [ "127.0.0.1:10000" ],
"username" : "1234567890",
"topic_prefix" : "abc",
"status" : "ONLINE",
"created_time" : "2015-12-12T12:12:12Z",
"last_modified_time" : "2015-12-13T12:12:12Z"
},
"mrs_kafka_config" : {
"kafka_config_id" : null,
"kafka_topics" : [ "v2x-v1-tracks", "v2x-v1-bsm", "v2x-v1-rsi", "v2x-v1-rsm", "v2x-v1-spat", "v2x-v1-edge-flow" ],
"brokers" : [ "127.0.0.1:10000" ],
"username" : null,
"status" : null,
"authentication" : false,
"created_time" : "2015-12-12T12:12:12Z",
"last_modified_time" : "2015-12-12T12:12:12Z"
}
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
405 |
Method Not Allowed |
409 |
Conflict |
429 |
Too Many Requests |
500 |
Internal Server Error |
错误码
请参见错误码。
