全部产品
云市场

动态配置

更新时间:2019-09-20 20:47:29

添加动态资源

功能描述

添加一条动态资源元数据。

接口定义

接口
/sofa/ms/ddcs/resources
Method
POST
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
region
String
Y
机构名称
app_name
String
Y
资源app名字
resource_id
String
Y
配置类id
desc
String
资源描述
attributes
String
resource的属性信息,以json格式传入
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
resource
Resource

请求示例

  1. POST /sofa/ms/ddcs/resources
  2. {
  3. "instance_id":"someInstanceId",
  4. "regison":"Alipay",
  5. "app_name":"someAppName",
  6. "resource_id":"com.alipay.test.resource",
  7. "desc":"this is test resource",
  8. "attributes": "[ //json 格式字符串
  9. {
  10. "attribute_name":"attName",
  11. "desc":"some attribute comment",
  12. },
  13. ...
  14. ]"
  15. }

响应示例

  1. {
  2. "result_code" : "OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId",
  5. "resource": {
  6. "id":"1",
  7. "instance_id":"someInstanceId",
  8. "regison":"Alipay",
  9. "app_name":"someAppName",
  10. "resource_id":"com.alipay.test.resource",
  11. "desc":"this is test resource",
  12. "attributes": [
  13. {
  14. "id":111,
  15. "instanceId":"someInstanceId",
  16. "attribute_name":"attName",
  17. "desc":"some attribute comment",
  18. },
  19. ...
  20. ]
  21. }
  22. }

删除动态资源

功能描述

删除动态配置的资源信息。

接口定义

接口
/sofa/ms/ddcs/resources/{id}
Method
DELETE
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
id
Long
Y
配置资源id
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

请求示例

  1. DELETE /sofa/ms/ddcs/resources/111?instance_id=1234abcd

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId"
  5. }

更新动态资源

功能描述

更新动态配置的资源信息。

接口定义

接口
/sofa/ms/ddcs/resources/{id}
Method
PUT
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
region
String
Y
机构名称
app_name
String
Y
资源app名字
resource_id
String
Y
配置类id
desc
String
资源描述
update_attribute
Boolean
Y
是否需要更新属性,如需全量更新属性,请设置为 true,如果只是更新资源的元信息则设置为false
attributes
String
resource的属性信息,以json格式传入
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

请求示例

  1. PUT /sofa/ms/ddcs/resources/11
  2. {
  3. "instance_id":"someInstanceId",
  4. "regison":"Alipay",
  5. "app_name":"someAppName",
  6. "resource_id":"com.alipay.test.resource",
  7. "desc":"this is test resource",
  8. "update_attribute":true,
  9. "attributes": "[ //json 格式字符串
  10. {
  11. "attribute_name":"attName",
  12. "desc":"some attribute comment",
  13. },
  14. ...
  15. ]"
  16. }

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId"
  5. }

获取单个动态配置资源信息

功能描述

获取某个动态配置的资源元信息。

接口定义

接口
/sofa/ms/ddcs/resources/{id}
Method
GET
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
id
Long
Y
配置资源id
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
resource
Resource
资源信息

请求示例

  1. GET /sofa/ms/ddcs/resources/111?instance_id=1234abcd

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId",
  5. "resource" : {
  6. "id":"12345678",
  7. "instance_id":"1234abcd",
  8. "region":"someRegion",
  9. "app_name":"someAppName",
  10. "resource_id":"com.test.resource",
  11. "desc":"some comment",
  12. "attributes":[
  13. {
  14. "id":1,
  15. "attribute_name":"attName",
  16. "desc":"some attribute comment",
  17. "instance_id":"someInstanceId"
  18. },
  19. ...
  20. ]
  21. }
  22. }

条件查询动态资源

功能描述

根据条件分页查询动态配置资源信息。

接口定义

接口
/sofa/ms/ddcs/resources
Method
GET
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
app_name
String
应用名称
keyword
String
resource_id模糊匹配
page_num
Integer
分页页码
page_size
Integer
每页显示数量
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
resources
List<Resource>
资源信息

请求示例

  1. GET /sofa/ms/ddcs/resources/?
  2. instance_id=1234abcd
  3. &app_name=xxx
  4. &keyword=xxx
  5. &page_num=1
  6. &page_size=10

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId",
  5. "resources":
  6. [
  7. {
  8. "id":"12345678",
  9. "instance_id":"someInstanceId",
  10. "region":"someRegion",
  11. "app_name":"someAppName",
  12. "resource_id":"com.test.resource",
  13. "desc":"some comment",
  14. "attributes":[
  15. {
  16. "id":1,
  17. "attribute_name":"attName",
  18. "desc":"some attribute comment",
  19. "instance_id":"someInstanceId"
  20. },
  21. ...
  22. ]
  23. },
  24. ...
  25. ],
  26. "page_num": 1,
  27. "page_size": 10,
  28. "total_count": 29
  29. }

添加动态配置属性

功能描述

添加动态配置资源的属性信息。

接口定义

接口
/sofa/ms/ddcs/attributes
Method
POST
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
resource_id
String
Y
资源类ID
attribute_name
String
​Y
属性名称
desc
String
属性描述
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
attribute
Attribute
资源信息

请求示例

  1. POST /sofa/ms/ddcs/attributes
  2. {
  3. "resource_id":1,
  4. "instance_id":"someInstanceId",
  5. "attribute_name":"attName",
  6. "desc":"some attribute comment"
  7. }

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId",
  5. "attribute":{
  6. "id":1,
  7. "attribute_name":"attName",
  8. "desc":"some attribute comment",
  9. "instance_id":"someInstanceId"
  10. }
  11. }

删除属性

功能描述

删除配置资源的某个属性。

接口定义

接口
/sofa/ms/ddcs/attributes/{id}
Method
DELETE
type
application/json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
id
Long
Y
属性ID
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

注:attribute_id 可以通过精确查找属性信息 获取

请求示例

  1. DELETE /sofa/ms/ddcs/attributes/111?instance_id=abcd1234

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId"
  5. }

更新属性

功能描述

更新配置资源的属性信息。

接口定义

接口
/sofa/ms/ddcs/attributes/{id}
Method
PUT
type
application/json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
id
Long
Y
属性ID
attribute_name
String
​Y
属性名称
desc
String
属性描述
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

请求示例

  1. PUT /sofa/ms/ddcs/attributes/111
  2. {
  3. "instance_id":"someInstanceId",
  4. "attribute_name":"newAttName",
  5. "desc":"new attribute desc"
  6. }

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId"
  5. }

查找指定动态配置属性

功能描述

获取资源配置的某个属性信息。

接口定义

接口
/sofa/ms/ddcs/attributes/{id}
Method
GET
type
application/json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
id
Long
Y
属性ID
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

请求示例

  1. GET /sofa/ms/ddcs/attributes/1111

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId",
  5. "attribute":{
  6. "id":1,
  7. "attribute_name":"attName",
  8. "desc":"some attribute comment",
  9. "instance_id":"someInstanceId"
  10. }
  11. }

获取动态配置属性列表

功能描述

根据查询条件查询精确查找某个属性信息。

接口定义

接口
/sofa/ms/ddcs/attributes
Method
GET
type
application/json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
region
String
Y
机构名称
app_name
String
Y
应用名称
resource_id
String
Y
资源id
attribute_name
String
Y
属性名称
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

请求示例

  1. GET /sofa/ms/ddcs/attributes
  2. instance_id=xxxx
  3. &region=xxx
  4. &app_name=xx
  5. &resource_id=xxx
  6. &attribute_name=xxx

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId",
  5. "attribute":{
  6. "id":1,
  7. "attribute_name":"attName",
  8. "desc":"some attribute comment",
  9. "instance_id":"someInstanceId"
  10. }
  11. }

持久化推送数据

功能描述

将某个属性的值推送到客户端。

接口定义

接口
/sofa/ms/ddcs/data
Method
POST
type
application/json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
attribute_id
String
Y
属性Id
data
String
推送值
operator
String
操作人
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID

请求示例

  1. POST /sofa/ms/ddcs/data
  2. {
  3. "instance_id":"someInstanceId",
  4. "attribute_id":1,
  5. "operator":"user",
  6. "data":"push data"
  7. }

响应示例

  1. {
  2. "result_code":"OK",
  3. "result_msg":"SUCCESS",
  4. "req_msg_id":"someReqMsgId"
  5. }

查询客户端信息

功能描述

查询订阅动态配置的客户端信息。

接口定义

接口
/sofa/ms/ddcs/clients
Method
GET
type
application/json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
attribute_id
Integer
Y
属性Id
page_num
Integer
​Y
分页页码
page_size
Integer
Y​
每页显示数量
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
clients
List<String>
客户端信息

请求示例

  1. GET /sofa/ms/ddcs/clients
  2. instance_id=xxx
  3. &attribute_id=xxx
  4. &page_num=1
  5. &page_size=2

响应示例

  1. {
  2. "clients": [
  3. {
  4. "data": "DJ9P4BRNBL0S", //客户端内存里的值
  5. "ip": "10.15.232.101",
  6. "push_data": "DJ9P4BRNBL0S" //推送的值
  7. }
  8. ... ...
  9. ],
  10. "page_num": 1,
  11. "page_size": 10,
  12. "result_code": "OK",
  13. "result_msg": "SUCCESS",
  14. "total_count": 4
  15. }