文档

QueryMsConfigClients

更新时间:

查询一个属性所有订阅的客户端信息。动态配置客户端在启动的时候,会与服务端建立长连接,并告知动态配置服务端自身关联的属性信息,通过此长连接可以查询到所有订阅属性的客户端信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryMsConfigClients

系统规定参数。取值:QueryMsConfigClients

AttributeId Long 1

属性自增长 ID,通过查询属性方式获取 ID

InstanceId String abcdEFGH1234

系统字段:环境实例 ID

PageNum Long 1

分页参数,页数

PageSize String 10

分页参数,分页大小

返回数据

名称

类型

示例值

描述

PageNum Long 1

分页参数,第几页

RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

请求ID

ResultMessage String OK

结果描述

ResultCode String OK

结果码

PageSize Long 10

分页参数,分页大小

TotalCount Long 100

客户端总数量

Clients Array of Clients

客户端信息

PushData String switch

推送的值

Ip String 127.0.0.1

客户端 IP

Data String switch

客户端内存里的值

Cell String DEFAULT

所属的 cell

示例

请求示例

{
  "instanceId": "DAOPHUXCZ",
  "attributeId": "sex",
  "pageNum": 1,
  "pageSize": 10
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<clients>
    <data>DJ9P4BRNBL0S</data>
    <ip>10.15.232.101</ip>
    <push_data>DJ9P4BRNBL0S</push_data>
    <cell>shanghai-et15</cell>
</clients>
<page_num>1</page_num>
<page_size>10</page_size>
<result_code>OK</result_code>
<result_msg>SUCCESS</result_msg>
<total_count>4</total_count>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "clients" : [ {
    "data" : "DJ9P4BRNBL0S",
    "ip" : "10.15.232.101",
    "push_data" : "DJ9P4BRNBL0S",
    "cell" : "shanghai-et15"
  } ],
  "page_num" : 1,
  "page_size" : 10,
  "result_code" : "OK",
  "result_msg" : "SUCCESS",
  "total_count" : 4
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。