查询数据转发配置
功能介绍
根据转发配置的唯一ID（forwarding_config_id）查询数据转发配置
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/forwarding-configs/{forwarding_config_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见“API参考 > 附录 > 获取项目ID”。 取值范围：仅支持数字，a到f的小写字母组合，长度32。 |
|
forwarding_config_id |
是 |
String |
参数说明：转发配置的唯一ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
forwarding_type |
是 |
String |
参数说明：转发配置的类型。 取值范围：当前仅支持“kafka，mrskafka”。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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认证”。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
forwarding_type |
String |
参数说明：转发配置的类型。 取值范围：当前仅支持“kafka、mrskafka”。 |
|
kafka_config_id |
String |
参数说明：每一套Kafka配置的唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
kafka_topics |
Array of strings |
参数说明：kafka的主题列表。 取值范围：
|
|
brokers |
Array of strings |
参数说明：Kafka broker列表。 |
|
username |
String |
参数说明：kafka用户名。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
topic_prefix |
String |
参数说明：Topic前缀。 取值范围：只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
status |
String |
参数说明：一套kafka的连接状态。 取值范围：
|
|
authentication |
Boolean |
参数说明：是否开启kerberos安全认证的开关。若开启安全认证则需要先上传kerberos安全认证的凭证。 |
|
model_ids |
Array of strings |
参数说明：模型ID列表。 user_topics包含model-data时必选，仅支持非系统、分层为gdm的动态模型。 可通过 GET /{project_id}/models 查询模型列表接口获取。 取值范围：仅支持字母，数字以及中划线（-）的组合，长度为36。 |
|
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/{forwarding_config_id}?forwarding_type={forwarding_type}
Content-Type:application/json
X-Auth-Token:********
Instance-Id:********
响应示例
状态码： 200
OK
{
"forwarding_type" : "kafka",
"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", "realtime-traffic", "junction-realtime-traffic", "forecast-traffic", "recommended-strategies", "executed-strategies", "strategy-evaluations", "confirmed-event", "traffic-event", "compositive-tracks", "model-data", "request-strategies", "congestion-event", "congestion-prediction-event" ],
"topic_prefix" : "prefix",
"brokers" : [ "127.0.0.1:10000" ],
"username" : "1234567890",
"status" : "OFFLINE",
"authentication" : false,
"model_ids" : [ "40f96952-ea2f-4a10-8a92-e641aa1c6e49" ],
"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 |
错误码
请参见错误码。
