GET-获取通道详情

接口介绍

获取通道详情接口用于获取某个类型通道的详细信息。

请求方式

GET

请求地址

https://<ucwi_endpoint>:5443/skg/v1/dlp/channel/<通道类型>

注：你可以使用获取通道接口查看当前支持的所有通道类型。

请求参数

参数名称	参数位置	是否必须	描述
`<通道类型>`	URL参数	是	指定一个通道类型，如web、email或者webserviceapp。你可以使用获取通道接口查看所有通道类型。

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

Python请求示例

以下示例为使用Pyhon代码调用接口，以请求获取WebService应用通道(webserviceapp)的详细信息。

注：在如下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)

# 可选择的通道值包括：“web”，“email”和“webserviceapp”。
channel = "webserviceapp"
api = "/skg/v1/dlp/channel/{}".format(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'))

返回结果

返回结果中包含以下参数：

名称	描述
<通道类型>	列表显示当前通道中所有的WebService应用程序。
<通道类型>.name	当前通道中WebService应用程序的名称。
<通道类型>.appid	当前通道中WebService应用程序的ID。
<通道类型>.description	当前通道中WebService应用程序的描述信息。

返回示例

{
    "webserviceapp": [
        {
            "name": "cloudstorage",
            "appid": "78217a43-542d-47e2-97a5-4435bf11521d", 
            "description": "Cloud storage application"
        }, 
        {
            "name": "cloudcrm",
            "appid": "1e99e55d-64c0-49ea-9e94-7df304e4580f", 
            "description": "Cloud CRM application"
        }
    ]
}

错误代码

若调用出现错误，将返回以下错误代码：


错误码	描述
400	无效参数
404	未知错误，例如请求了未触发的事件等。
500	无效参数