GET-获取通道列表

介绍获取通道列表接口的接口调用方式。

接口介绍

获取通道列表接口用于获取通道类型。

获取通道类型列表后，后续可以通过获取通道详细信息接口查询某个通道类型的详细信息。具体查阅获取通道详细信息。

请求方式

GET

请求参数

参数名称 参数位置 是否必须 描述
authorization header 是 请求中的认证信息。查阅章节获取详细信息认证。
x-skg-timestamp header 是 当前的Timestamp。查阅章节获取详细信息认证。

请求地址

https://<ucwi_endpoint>:5443/skg/v1/dlp/channel

请求示例

按照以下示例调用接口，请求获取通道信息。 
GET /skg/v1/dlp/channel/

Python请求示例

按照以下示例为使用Python代码调用接口，以请求获取通道信息。
注： 在如下Python代码示例中，导入的Header文件ucwi_config 和 ucwi_auth的需事先创建，如需详细参考示例，请参阅Header文件示例。
from requests.packages.urllib3.exceptions import InsecureRequestWarning
from ucwi_config import UCWIConfig
from ucwi_auth import get_headers
import requests
import json

requests.packages.urllib3.disable_warnings(InsecureRequestWarning)


api = "/skg/v1/dlp/channel"
url = "{0}{1}".format(UCWIConfig.base_url, api)

headers = get_headers()
response = requests.get(url, headers=headers, verify=False)
if response.status_code != 200:
    print("Bad request, response code:", response.status_code)
    print(response.text)
else:
    print(json.dumps(response.json(), indent=4).encode('utf-8').decode('raw_unicode_escape'))

返回结果

成功调用该接口，系统将返回以下参数。
参数 描述
channels 列表显示当前连接的所有通道
channels.name 通道名称：
  • web - 网络通道
  • email - 邮件通道
  • webserviceapp - WebService应用通道
channels.description 通道描述 - 自定义的对于该通道的描述信息

返回示例

{
	"channels": [{
		"name": "web",
		"description": "Web channel"
	}, {
		"name": "email",
		"description": "Email channel"
	}, {
		"name": "webserviceapp",
		"description": "WebService Application channel"
	}]
}

错误代码

若调用出现错误，将返回以下错误代码：
错误码 描述
400 无效参数
404 未知错误，例如请求了未触发的事件等。
500 无效参数