查询
场景描述
调用该接口查询数据源
接口方法
该接口仅支持GET方法,不支持PUT、POST和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/config/sys/dbsource?ids=5,4
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。
URI中携带的参数说明如表1所示。
日志中的方法名
queryDbSource
请求消息
- 消息头
表2 消息头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
2
Guid
string
True
Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。
响应消息
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
1 |
message |
string |
返回消息。 |
|
2 |
retcode |
string |
操作的结果原因码。 取值类型为整数。
|
|
3 |
result |
array |
返回结果。该对象参数说明请参见表4。 |
|
序号 |
名称 |
参数类型 |
说明 |
|---|---|---|---|
|
3.1 |
accessModel |
number |
数据库类型。 1:ORACLE 2:ODBC 7:MYSQL 8:GAUSS |
|
3.2 |
alias |
string |
数据源别名。 最大长度49字节。 |
|
3.3 |
backUpDbName |
string |
备用数据源名称。 最大长度49字节。 |
|
3.4 |
callInterval |
number |
调用间隔。 取值范围0~60。 |
|
3.5 |
connectNum |
number |
最大连接数。 取值范围1~255。 |
|
3.6 |
dbName |
string |
数据库名称。 最大长度49字节。 |
|
3.7 |
dbServerInfo |
string |
数据库服务器信息。 最大长度100字节。 |
|
3.8 |
dbSourceStyle |
number |
数据源类型。 0:平台数据源 1:第三方数据源 2:呼叫中心业务数据源 |
|
3.9 |
dbId |
number |
数据源id。 取值范围1~15000。 |
|
3.10 |
isImportant |
number |
关键数据源。 0:非关键数据源 1:关键数据源 |
|
3.11 |
procedureName |
string |
延时检测存储过程。 最大长度50字节。 |
|
3.12 |
szConnect |
string |
连接字符串。 最大长度127字节。 |
|
3.13 |
timeOutCount |
number |
连续超时次数阈值。 取值范围1~30。 |
|
3.14 |
timeOutValue |
number |
超时时间阈值。 取值范围1~30。 |
|
3.15 |
userName |
string |
用户名称。 最大长度49字节。 |
|
3.16 |
userPassword |
string |
用户密码。 默认为空。 最大长度49字节。 |
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- 请求参数
- 响应参数
{ "result": [ { "accessModel": 7, "alias": "shujuyuan", "backUpDbName": "", "callInterval": 10, "connectNum": 14, "dbId": 1, "dbName": "dbname", "dbServerInfo": "shujukufuwuxinxi", "dbSourceStyle": 0, "isImportant": 0, "procedureName": "yanshijiancecunchuguocheng", "szConnect": "lianjiezifuchuan", "timeOutCount": 8, "timeOutValue": 6, "userName": "dbuser", "userPassword":null } ], "message": "success", "retcode": "0" }