代理请求

代理请求

方法 路径 描述
GET /v1/proxies 获取所有代理
GET /v1/proxies/{uid} 获取一个代理
PUT /v1/proxies/{uid} 更新一个代理
PUT /v1/proxies 更新所有代理

获取所有代理

GET /v1/proxies

获取集群中的所有代理。

权限

权限名称 角色
view_all_proxies_info 管理员
集群成员
集群查看者
数据库成员
数据库查看者
用户管理员

请求

示例HTTP请求

GET /proxies

头部

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

响应

返回一个代理对象的JSON数组。

示例 JSON 主体

[
    {
         "uid": 1,
         "client_keepintvl": 30,
         "max_worker_server_conns": 16384,
         "client_keepcnt": 6,
         "max_threads": 64,
         "ignore_bdb_cconn_output_buff_limits": false,
         "dynamic_threads_scaling": false,
         "max_worker_client_conns": 16384,
         "max_servers": 4096,
         "client_keepidle": 180,
         "duration_usage_threshold": 30,
         "max_worker_txns": 65536,
         "threads": 3,
         "max_listeners": 1024,
         "conns": 500000,
         "ignore_bdb_cconn_limit": false,
         "threads_usage_threshold": 80,
         "backlog": 1024
    },
    {
        "uid": 2,
        "threads": 3,
        // additional fields...
    }
]

状态码

代码 描述
200 OK 无错误

获取代理

GET /v1/proxies/{int: uid}

获取单个代理的信息。

权限

权限名称 角色
view_proxy_info 管理员
集群成员
集群查看者
数据库成员
数据库查看者
用户管理员

请求

示例HTTP请求

GET /proxies/1

头部

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型

URL 参数

字段 类型 描述
uid integer 代理的唯一节点ID

响应

返回一个代理对象。

示例 JSON 主体

{
     "uid": 1,
     "client_keepintvl": 30,
     "max_worker_server_conns": 16384,
     "client_keepcnt": 6,
     "max_threads": 64,
     "ignore_bdb_cconn_output_buff_limits": false,
     "dynamic_threads_scaling": false,
     "max_worker_client_conns": 16384,
     "max_servers": 4096,
     "client_keepidle": 180,
     "duration_usage_threshold": 30,
     "max_worker_txns": 65536,
     "threads": 3,
     "max_listeners": 1024,
     "conns": 500000,
     "ignore_bdb_cconn_limit": false,
     "threads_usage_threshold": 80,
     "backlog": 1024
}

状态码

代码 描述
200 OK 无错误
404 Not Found 代理UID不存在

更新代理

PUT /v1/proxies/{int: uid}

更新代理对象，通知代理，并等待确认（ACK），除非节点已失效。

如果allow_restart为true并且任何更新的参数需要重启才能使更改生效，则自动重启代理服务。例如，如果您将threads更改为较小的数字，则需要重启。

然而，如果allow_restart为false，此类更改仅在下次代理重启后生效。

权限

权限名称 角色
update_proxy 管理员
用户管理

请求

示例HTTP请求

PUT /proxies/1

示例 JSON 主体

{
  "allow_restart": true,
  "proxy": {
    "threads": 8
  }
}

头部

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型
Content-Type application/json 请求体媒体类型

URL 参数

字段 类型 描述
uid integer 更新后的代理的唯一ID。对应于节点ID。

请求体

在请求体中包含一个JSON对象。该JSON对象可以包含布尔字段allow_restart和一个带有更新字段的代理对象。

响应

返回一个状态码以指示代理更新的成功或失败。

状态码

代码 描述
200 OK 没有错误，请求已处理
400 Bad Request 提供了错误的内容
404 Not Found 代理不存在
500 Internal Server Error 等待代理确认时出错
504 Gateway Timeout 等待代理确认时超时

更新所有代理

PUT /v1/proxies

更新所有代理对象，通知代理，并等待确认（ACK），除非节点已失效。

如果allow_restart为true并且任何更新的参数需要重启以使更改生效，则自动重启相关的代理服务。

然而，如果allow_restart为false，此类更改仅在下次代理重启后生效。

权限

权限名称 角色
update_proxy 管理员
用户管理

请求

示例HTTP请求

PUT /proxies

示例 JSON 主体

{
  "allow_restart": true,
  "proxy": {
    "threads": 8,
    "max_threads": 12
  }
}

头部

键 值 描述
主机 cnm.cluster.fqdn 域名
Accept application/json 接受的媒体类型
Content-Type application/json 请求体媒体类型

请求体

在请求体中包含一个JSON对象。该JSON对象可以包含布尔字段allow_restart和一个带有更新字段的代理对象。

响应

返回一个状态码以指示代理更新的成功或失败。

状态码

代码 描述
200 OK 没有错误，请求已处理
400 Bad Request 提供了错误的内容
500 Internal Server Error 等待代理确认时出错
504 Gateway Timeout 等待代理确认时超时
RATE THIS PAGE
Back to top ↑