文档首页/ 云客服/ API参考/ CC-Gateway 配置接口参考/ 系统配置接口说明/ OBS/ 查询
更新时间：2025-12-01 GMT+08:00
查看PDF
分享

查询

场景描述

调用该接口查询OBS配置。

接口方法

该接口仅支持GET方法，不支持PUT、POST和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/config/sys/obs?ids=1,2

其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。

URI中携带的参数说明如表1所示。

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

ids

string

False
  1. 需要查询的一组OBS编号
  2. 编号为空时，表示查询所有数据源数据
  3. 取值类型为整数，根据实际编号填写。每个id用“,”分割，一次最多不超过100个。

日志中的方法名

queryOBS

请求消息

  • 消息头
    表2 消息头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式，缺省值：application/json; charset=UTF-8

    2

    Guid

    string

    True

    Guid的取值为C5 智能辅助类接口鉴权方式接口返回的guid。

响应消息

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

返回消息。

2

retcode

string

操作的结果原因码。

取值类型为整数。

3

result

array

返回结果。该对象参数说明请参见表4。
表4 result数组对象参数说明

序号

名称

参数类型

说明

3.1

Obsid

number

Obs编号。

3.2

obs1ipAddress

string

主用obsip。

3.3

obs2ipAddress

string

备用obsip。

3.4

Obs1hbip

string

主用obs心跳ip。

3.5

Obs2hbip

string

备用obs心跳ip。

3.6

Obs1NetId

number

主用网元ID。

3.7

Obs2Netid

number

备用网元ID。

3.8

poolNodeId

number

主用CTI节点编号。

3.9

Obs2poolNodeid

number

备用CTI节点编号。

3.10

obshbport

number

Obs心跳端口号。

3.11

obsRefreshCycle

number

任务刷新周期。

3.12

obsProgid

number

Progid。

报文样例

  • 消息头 
    Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

    无

  • 响应参数 
    {
    "result": [
        {
            "obs1hbip": "",
            "obs1ipAddress": "10.10.10.1",
            "obs1NetId": 1201,
            "obs2hbip": "",
            "obs2ipAddress": "",
            "obs2Netid": 1401,
            "obs2poolNodeid": 1,
            "obshbport": 10004,
            "obsid": 1,
            "obsProgid": 1201,
            "obsRefreshCycle": 30,
            "poolNodeId": 1
        }
    ],
    "message": "success",
    "retcode": "0"
}
父主题： OBS

相关文档