负载均衡 公开API目录

API概览

负载均衡HaProxy(以下简称Ha)产品提供以下相关API接口

API 描述
1. DescribeZones 获取负载均衡Ha支持的区域。
2. DescribeLoadBalancersSpec 获取某个站点支持的Haproxy产品类型以及规格。
3. CreateLoadBalancer 创建Ha实例。
4. DescribeLoadBalancers 获取Ha实例列表。
5. DescribeLoadBalancersModifySpec 获取实例Ha的配置变更所支持的规格。
6. ModifyLoadBalancerInstanceSpec 修改实例规格。
7. DeleteLoadBalancer 删除Ha实例。
8. DescribeCACertificates 获取用户的证书列表。
9. DescribeCACertificate 获取用户的证书详情。
10. DeleteCACertificate 删除证书。
11. UploadCACertificate 添加证书。
12. DescribeLoadBalancerStrategys 获取Ha实例的当前监听的策略配置列表。
13. ModifyLoadBalancerStrategys 修改(删除、修改、添加)Ha实例的当前监听的策略配置列表。
14. DescribeLBInstancePerformance 获取Ha实例的监控值。
15. ModifyLoadBalancerName 修改Ha实例的名称。

错误码

HttpCode 错误码 描述
400 ArgMissing 缺少参数错误
400 InvalidParameter 参数错误
400 BadArgs 参数错误
400 UnsupportedOperation 操作不支持
404 ResourceNotFound 资源不存在
409 ResourceInUse 资源正在被其他任务占用,操作冲突
500 InternalError 内部错误
500 CreateOrderExcept 创建订单异常

访问地址

地区 访问地址
中国大陆 cdsapi.capitalonline.net
亚太地区 cdsapi-asia.capitalonline.net
欧美地区 cdsapi-us.capitalonline.net

1.DescribeZones

Action: DescribeZones

描述: 获取负载均衡Ha支持的区域

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

请求示例

  1. def get_haproxy_zones():
  2. """
  3. 获取haproxy支持的站点区域
  4. """
  5. action = "DescribeZones"
  6. method = "GET"
  7. param = {
  8. }
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  10. res = requests.get(url)
  11. result = json.loads(res.content)
  12. result = json.dumps(result) # json格式化

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": [{
  4. "CityId": "3082f45e-306e-11e7-9796-0050569b4d9c",
  5. "CityName": "洛杉矶",
  6. "IsSaling": 1,
  7. "RegionId": "US_LosAngeles_A",
  8. "RegionName": "北美地区",
  9. "SiteName": "洛杉矶1"
  10. }, {
  11. "CityId": "7b98a5d1-306e-11e7-9796-0050569b4d9c",
  12. "CityName": "法兰克福",
  13. "IsSaling": 1,
  14. "RegionId": "EUR_Germany_A",
  15. "RegionName": "欧洲地区",
  16. "SiteName": "德国1"
  17. }, {
  18. "CityId": "8737606f-306d-11e7-9796-0050569b4d9c",
  19. "CityName": "东京",
  20. "IsSaling": 1,
  21. "RegionId": "APAC_Tokyo_A",
  22. "RegionName": "亚太地区",
  23. "SiteName": "东京1"
  24. }, {
  25. "CityId": "27b57297-306d-11e7-9796-0050569b4d9c",
  26. "CityName": "香港",
  27. "IsSaling": 1,
  28. "RegionId": "CN_Hongkong_A",
  29. "RegionName": "亚太地区",
  30. "SiteName": "香港1"
  31. }, {
  32. "CityId": "a8937b00-306d-11e7-9796-0050569b4d9c",
  33. "CityName": "新加坡",
  34. "IsSaling": 1,
  35. "RegionId": "APAC_Singapore_A",
  36. "RegionName": "亚太地区",
  37. "SiteName": "新加坡1"
  38. }, {
  39. "CityId": "5c432e0e-306e-11e7-9796-0050569b4d9c",
  40. "CityName": "阿姆斯特丹",
  41. "IsSaling": 1,
  42. "RegionId": "EUR_Netherlands_A",
  43. "RegionName": "欧洲地区",
  44. "SiteName": "荷兰1"
  45. }, {
  46. "CityId": "154ed19e-306e-11e7-9796-0050569b4d9c",
  47. "CityName": "纽约",
  48. "IsSaling": 1,
  49. "RegionId": "US_NewYork_A",
  50. "RegionName": "北美地区",
  51. "SiteName": "纽约1"
  52. }, {
  53. "CityId": "ea3ca775-306c-11e7-9796-0050569b4d9c",
  54. "CityName": "北京",
  55. "IsSaling": 1,
  56. "RegionId": "CN_Beijing_B",
  57. "RegionName": "中国大陆",
  58. "SiteName": "北京2"
  59. }, {
  60. "CityId": "ea3ca775-306c-11e7-9796-0050569b4d9c",
  61. "CityName": "北京",
  62. "IsSaling": 1,
  63. "RegionId": "CN_Beijing_E",
  64. "RegionName": "中国大陆",
  65. "SiteName": "北京5"
  66. }, {
  67. "CityId": "ea3ca775-306c-11e7-9796-0050569b4d9c",
  68. "CityName": "北京",
  69. "IsSaling": 1,
  70. "RegionId": "CN_Beijing_A",
  71. "RegionName": "中国大陆",
  72. "SiteName": "北京1"
  73. }, {
  74. "CityId": "e48e2312-306d-11e7-9796-0050569b4d9c",
  75. "CityName": "达拉斯",
  76. "IsSaling": 1,
  77. "RegionId": "US_Dallas_A",
  78. "RegionName": "北美地区",
  79. "SiteName": "达拉斯1"
  80. }, {
  81. "CityId": "713d3745-306d-11e7-9796-0050569b4d9c",
  82. "CityName": "台北",
  83. "IsSaling": 1,
  84. "RegionId": "CN_Taipei_A",
  85. "RegionName": "亚太地区",
  86. "SiteName": "台北1"
  87. }, {
  88. "CityId": "123d0d01-306d-11e7-9796-0050569b4d9c",
  89. "CityName": "无锡",
  90. "IsSaling": 1,
  91. "RegionId": "CN_Wuxi_A",
  92. "RegionName": "中国大陆",
  93. "SiteName": "无锡1"
  94. }, {
  95. "CityId": "87fcbbd6-be0a-11e7-9d6b-0242ac110004",
  96. "CityName": "首尔",
  97. "IsSaling": 1,
  98. "RegionId": "APAC_Seoul_A",
  99. "RegionName": "亚太地区",
  100. "SiteName": "首尔1"
  101. }, {
  102. "CityId": "ea3ca775-306c-11e7-9796-0050569b4d9c",
  103. "CityName": "北京",
  104. "IsSaling": 1,
  105. "RegionId": "CN_Beijing_C",
  106. "RegionName": "中国大陆",
  107. "SiteName": "北京3"
  108. }, {
  109. "CityId": "c11a5abe-3f7e-11e7-86b1-0242ac11000e",
  110. "CityName": "广州",
  111. "IsSaling": 1,
  112. "RegionId": "CN_Guangzhou_A",
  113. "RegionName": "中国大陆",
  114. "SiteName": "广州1"
  115. }, {
  116. "CityId": "b44355d0-65e7-11e7-8ea9-0050569b651c",
  117. "CityName": "上海",
  118. "IsSaling": 1,
  119. "RegionId": "CN_Shanghai_A",
  120. "RegionName": "中国大陆",
  121. "SiteName": "上海1"
  122. }, {
  123. "CityId": "ea3ca775-306c-11e7-9796-0050569b4d9c",
  124. "CityName": "北京",
  125. "IsSaling": 1,
  126. "RegionId": "CN_Beijing_H",
  127. "RegionName": "中国大陆",
  128. "SiteName": "北京8"
  129. }],
  130. "Message": "Success."
  131. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
Data string 数据
RegionId string 站点编号
RegionName string 区域名称
CityId string 城市编号
CityName string 城市名称
SiteName string 站点名称
IsSaling Int 站点是否能购买服务,1:支持购买;0:已下线

2.DescribeLoadBalancersSpec

Action: DescribeLoadBalancersSpec

描述: 获取某个站点支持的Haproxy产品类型以及规格

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

参数名 必选 类型 说明
RegionId string 站点编号

请求示例

  1. def get_haproxy_specInfo():
  2. """
  3. 获取某个站点支持的haproxy产品类型以及规格
  4. """
  5. action = "DescribeLoadBalancersSpec"
  6. method = "GET"
  7. param = {
  8. "RegionId": "CN_Hongkong_A"
  9. }
  10. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  11. res = requests.get(url)
  12. result = json.loads(res.content)
  13. result = json.dumps(result) # json格式化

返回参数说明

参数名 类型 说明
Code string 状态码
Data DataObj 可购买的HaProxy产品类型以及规格数据对象
Message string 返回调用接口状态信息和code相对应,比如:Success, Error
TaskId string 任务Id, 暂时不支持根据任务查询任务状态

DataObj

参数名 类型 说明
ProductName string 产品名称,比如haproxy
Products list of ProductObj 该类产品支持的产品列表
RegionId string 站点编号

ProductObj

参数名 类型 说明
Architectures list of ArchitectureObj 产品支持的架构列表
Version string 产品支持的版本

ArchitectureObj

参数名 类型 说明
ArchitectureName string 架构名称
ArchitectureType int 架构类型:
1-主从版
ComputeRoles list of ComputeRoleObj 支持的计算类型,不同的计算类型支持不同规格,并支持添加不同类型的硬盘
EnginesType string 引擎类型
SubProductName string 子产品名称,比如:haproxy 主从版

ComputeRoleObj

参数名 类型 说明
ComputeName string 计算类型名称, 比如:通用型
ComputeType int 支持的计算类型(目前仅支持通用型计算类型):
0-通用型
Standards StandardObj 该类型支持的规格

StandardObj

参数名 类型 说明
AttachDisk list of AttachDiskObj 该类型规格能够添加的磁盘类型列表
CpuRam list of CpuRamObj 支持的规格列表

AttachDiskObj

参数名 类型 说明
BasicIops string 基础的磁盘的iops
DiskMax int 单次支持扩容到最大磁盘容量为2000
DiskMaxExpand string 磁盘最大可扩容大小
DiskMin string 磁盘容量支持的最小值,起步为100
DiskName string 磁盘类型名称,包含SSD和性能型
SSD:SSD磁盘,磁盘IOPS默认为5000,可购买IOPS性能包
性能型:普通SSD盘,磁盘IOPS限定在3000
DiskStep string 磁盘扩容步长,步长大小=100
DiskUnit string 磁盘容量单位:GB
DiskValue string 磁盘类型,用于创建服务实例指定磁盘类型 (创建服务时候使用)

CpuRamObj

参数名 类型 说明
CPU int 核心数量,单位:个
Name string 规格名称
PaasGoodsId int 具体的产品编号,根据产品编号确定购买哪一种规格
RAM int 内存大小,单位:GB

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {
  4. "ProductName": "haproxy",
  5. "Products": [{
  6. "Architectures": [{
  7. "ArchitectureName": "主从",
  8. "ComputeRoles": [{
  9. "ComputeName": "通用型",
  10. "Standards": {
  11. "AttachDisk": [{
  12. "BasicIops": "",
  13. "DiskMax": 2000,
  14. "DiskMaxExpand": 2000,
  15. "DiskMin": 100,
  16. "DiskName": "SSD",
  17. "DiskStep": 100,
  18. "DiskUnit": "G",
  19. "DiskValue": "ssd_disk"
  20. }],
  21. "CpuRam": [{
  22. "CPU": 1,
  23. "Name": "1C2G",
  24. "PaasGoodsId": 13565,
  25. "RAM": 2
  26. }]
  27. }
  28. }],
  29. "EnginesType": [],
  30. "NetworkLinks": null,
  31. "SubProductName": "haproxy 主从版"
  32. }],
  33. "Version": "2.4"
  34. }],
  35. "RegionId": "*******"
  36. },
  37. "Message": "success",
  38. "TaskId": ""
  39. }

3.CreateLoadBalancer

Action: CreateLoadBalancer

描述: 创建Ha实例

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
RegionId string 站点编号
VdcId string 数据中心的编号
BasePipeId string 数据中心的私网编号,创建服务将按这个私网分配id
InstanceName string 实例名称
PaasGoodsId int 产品的规格编号
Ips list ha使用的网络,根据所传不通网络,创建不同网络机器
IsVip int 是否开启内网,此参数只适用于公网SLB,内网SLB无需配置,默认值 : 1
1: 表示开启内网Vip
0:表示不开启内网VIp
PipeType list ha使用的网络 [“pipe_type”,”public”]
PipeId string 内网网络id,或者公网的网络id
SegmentId string 占用的公网网段的编号,会占用3个公网
Amount int 购买的数量一次最多购买三个

请求示例**

  1. def create_haproxy():
  2. """
  3. 创建haproxy实例
  4. """
  5. action = "CreateLoadBalancer"
  6. method = "POST"
  7. param = {}
  8. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  9. body = {
  10. "RegionId": "******",
  11. "VdcId": "******",
  12. "BasePipeId": "******",
  13. "InstanceName": "test-haproxy",
  14. "PaasGoodsId": "5072",
  15. "Ips": [
  16. {
  17. "PipeType": "private",
  18. "PipeId": "******",
  19. "IsVip": 1},
  20. {
  21. "PipeType": "public", # 如创建公网,则需要
  22. "PipeId": "******",
  23. "SegmentId": "******"
  24. }
  25. ],
  26. "Amount": 1
  27. }
  28. res = requests.post(url, json=body)
  29. result = json.loads(res.content)

返回示例

  1. {
  2. "Message": "Success.",
  3. "Code": "Success",
  4. "Data": {
  5. "InstancesUuid":["5d74bb81-0473-464d-b15b-0ae418619248",]
  6. },
  7. "TaskId": "********"
  8. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
Data dict 包含任务编码和实例编码列表
InstancesUuid list 实例编码
TaskId string 任务id

4.DescribeLoadBalancers

Action: DescribeLoadBalancers

描述: 获取Ha实例列表(支持常见字段过滤、instance_uuid/instance_name/ip)

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

参数名 必选 类型 说明
IP string 要过滤的服务IP
InstanceUuid string 要过滤的实例编号
InstanceName string 要过滤的实例名称
StartTime string 选取创建时间大于该时间的实例,时间格式为2021-03-10 14:00:00
EndTime string 选取创建时间小于该时间的实例,时间格式为2021-03-10 15:00:00

请求示例

  1. def get_haproxyInstances_list():
  2. """
  3. 获取haproxy实例列表(支持常见字段过滤、instance_uuid/instance_name/ip)
  4. """
  5. action = "DescribeLoadBalancers"
  6. method = "GET"
  7. param = {
  8. "IP": "66.66", # 可选字段
  9. "InstanceName": "haproxy" # 可选字段
  10. }
  11. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  12. res = requests.get(url)
  13. result = json.loads(res.content)
  14. print(result)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": [{
  4. "CloneServices": null,
  5. "Cpu": 1,
  6. "CreatedTime": "2020-05-05 00:13:53",
  7. "DisplayName": "亚太地区-香港-可用区A",
  8. "IP": "66.66.0.52",
  9. "InstanceName": "*******",
  10. "InstanceUuid": "*************",
  11. "LinkType": "",
  12. "LinkTypeStr": "",
  13. "MasterInfo": "",
  14. "Port": 0,
  15. "ProjectName": "默认项目"
  16. "Ram": 2048,
  17. "RegionId": "CN_Hongkong_A",
  18. "RelationService": null,
  19. "ResourceId": "71bf731e-7cc8-4307-8408-4952e4dcd470",
  20. "RoGroups": null,
  21. "Status": "RUNNING",
  22. "StatusStr": "运行中",
  23. "SubProductName": "haproxy 主从版",
  24. "VdcId": "********",
  25. "VdcName": "香港PaaS1",
  26. "Version": "1.8.3"
  27. "Vips": [{
  28. "IP": "xx.xx.xx.xx",
  29. "Type": "private"
  30. },{
  31. "IP": "xx.xx.xx.xx",
  32. "Type": "public"
  33. }]
  34. }],
  35. "Message": "Success."
  36. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
Data dict 数据
RelationService dict 相关联的服务实例 (该服务这里为空)
CloneServices list 克隆的临时实例列表(该服务这里为空)
DisplayName string 站点名称
IP string 负载均衡实例的连接的IP,当有公网vip时,返回公网vip,没有公网vip时,返回内网vip
Port int 连接的端口
ProjectName string 项目名称
Cpu int cpu大小
Ram int 内存 单位M
RegionId string 站点编号
VdcId string 数据中心的编号
VdcName string 数据中心名称
MasterInfo dict 从属集群,只读服务会有值
LinkTypeStr string 链路类型名称
ro_groups list 只读实例列表(该服务这里为空)
SubProductName string 子产品的名字
Version string 服务版本
LinkType string 单次支持最大规格的磁盘
Status stringstring 实例状态
StatusStr string 状态对应的中文
InstanceUuid string 实例编号
InstanceName string 实例名称
CreatedTime string 实例创建时间
vips list 负载均衡多个vip地址信息
ip string 其中一个vip地址
type string 网络类型 内网/公网

5.DescribeLoadBalancersModifySpec

Action: DescribeLoadBalancersModifySpec

描述: 获取实例Ha的配置变更所支持的规格

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

参数名 必选 类型 说明
InstanceUuid string 实例编号

请求示例

  1. def get_haproxy_modify_spec(instance_uuid):
  2. """
  3. 获取实例Ha的配置变更所支持的规格
  4. :param instance_uuid: 实例编号
  5. :return:
  6. """
  7. action = "DescribeLoadBalancersModifySpec"
  8. method = "GET"
  9. param = {
  10. "InstanceUuid": instance_uuid
  11. }
  12. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  13. res = requests.get(url)
  14. result = json.loads(res.content)
  15. print(result)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {
  4. "AttachDisk": [{
  5. "BasicIops": "3000",
  6. "DiskMax": 2000,
  7. "DiskMaxExpand": 2000,
  8. "DiskMin": 100,
  9. "DiskName": "性能型",
  10. "DiskStep": 100,
  11. "DiskUnit": "G",
  12. "DiskValue": "high_disk"
  13. }],
  14. "CpuRam": [{
  15. "CPU": 1,
  16. "N": "1C2G",
  17. "PaasGoodsId": 5072,
  18. "RAM": 2
  19. }, {
  20. "CPU": 2,
  21. "Name": "2C4G",
  22. "PaasGoodsId": 5075,
  23. "RAM": 4
  24. }, {
  25. "CPU": 4,
  26. "Name": "4C8G",
  27. "PaasGoodsId": 5078,
  28. "RAM": 8
  29. }, {
  30. "CPU": 8,
  31. "Name": "8C16G",
  32. "PaasGoodsId": 5081,
  33. "RAM": 16
  34. }],
  35. "ProductName": "haproxy 主从版",
  36. "RegionId": "CN_Hongkong_A"
  37. },
  38. "Message": "Success.",
  39. "TaskId": ""
  40. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
TaskId string 任务编号
Data dict 数据
ProductName string 产品名称
RegionId string 站点编号
CpuRam list 支持的规格列表
CPU int 购买产吕CPU数量
Name string 购买产品名称
PaasGoodsId int 可购买的产品规格编号
RAM int 购买产品内存大小
AttachDisk list 该类型规格能够添加的磁盘类型
BasicIops string 基础IOPS大小
DiskMax int 最大磁盘大小
DiskMaxExpand int 最大可扩展磁盘大小
DiskMin int 最小磁盘大小
DiskName string 磁盘类型
DiskStep int 磁盘增大步长
DiskUnit string 磁盘单位
DiskValue string 磁盘类型key

6.ModifyLoadBalancerInstanceSpec

Action: ModifyLoadBalancerInstanceSpec

描述: 修改实例规格

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
InstanceUuid string 要修改的实例id
PaasGoodsId int 要修改成为的规格产品编号

请求示例

  1. def modify_haproxy_spec(instance_uuid):
  2. """
  3. 修改haproxy实例规格
  4. :param instance_uuid: 实例编号
  5. """
  6. action = "ModifyLoadBalancerInstanceSpec"
  7. method = "POST"
  8. param = {}
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  10. body = {
  11. "InstanceUuid": instance_uuid,
  12. "PaasGoodsId": 5078, # 此处必须传int类型且goodsid存在,否则报错
  13. }
  14. res = requests.post(url, json=body)
  15. result = json.loads(res.content)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {},
  4. "Message": "Success.",
  5. "TaskId": "******"
  6. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
TaskId string 任务状态
Data string 数据

7.DeleteLoadBalancer

Action: DeleteLoadBalancer

描述: 删除Ha实例

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
InstanceUuid string 实例编号

请求示例

  1. def delete_haproxy(instance_uuid, ):
  2. """
  3. 删除haproxy实例
  4. :param instance_uuid: 实例编号
  5. """
  6. action = "DeleteLoadBalancer"
  7. method = "POST"
  8. param = {}
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  10. body = {
  11. "InstanceUuid": instance_uuid,
  12. }
  13. res = requests.post(url, json=body)
  14. result = json.loads(res.content)

返回示例**

  1. {
  2. "Code": "Success",
  3. "Data": {},
  4. "Message": "Success.",
  5. "TaskId": "******"
  6. }

返回参数说明

参数名 类型 说明
Code string 状态码
Data dict 数据
Message string 信息描述
TaskId string 任务编号

8.DescribeCACertificates

Action: DescribeCACertificates

描述: 获取用户的证书列表

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

请求示例

  1. def get_user_ca_lists():
  2. """
  3. 获取用户的证书列表
  4. """
  5. action = "DescribeCACertificates"
  6. method = "GET"
  7. param = {
  8. }
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  10. res = requests.get(url)
  11. result = json.loads(res.content)
  12. result = json.dumps(result) # json格式化
  13. print(result)

返回示例**

  1. {
  2. "Code": "Success",
  3. "Data": [{
  4. "Brand": "Encryption Everywhere DV TLS CA - G1",
  5. "CertificateId": "******",
  6. "CertificateName": "******",
  7. "CertificateType": "DV",
  8. "Domain": "******",
  9. "EndTime": "2021-02-25 12:00:00",
  10. "Organization": "DigiCert Inc",
  11. "StartTime": "2020-02-26 00:00:00",
  12. "Valid": 1
  13. }],
  14. "Message": "Success."
  15. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
Data dict 数据
Domain string 域名
CertificateName string 证书名称,用户自定义名称
CertificateType string 证书类型
Brand string 证书品牌
CertificateId string 证书编号
Organization string 颁发机构
StartTime string 证书有效开始时间
EndTime string 证书有效结束时间
Valid int 证书是否有效,0过期的,1有效的 ,2即将过期的(30天内)

9.DescribeCACertificate

Action: DescribeCACertificate

描述: 获取用户的证书详情

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

参数名 必选 类型 说明
CertificateId string 证书编号

请求示例

  1. def get_user_caId(caId):
  2. """
  3. 获取单个证书详情
  4. """
  5. action = "DescribeCACertificate"
  6. method = "GET"
  7. param = {
  8. "CertificateId": caId
  9. }
  10. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  11. res = requests.get(url)
  12. result = json.loads(res.content)
  13. result = json.dumps(result) # json格式化
  14. print(result)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {
  4. "Brand": "Encryption Everywhere DV TLS CA - G1",
  5. "Certificate": "-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----\n",
  6. "CertificateId": "******",
  7. "CertificateName": "******",
  8. "CertificateType": "DV",
  9. "Domain": "******",
  10. "EndTime": "2021-02-25 12:00:00",
  11. "Organization": "DigiCert Inc",
  12. "PirvateKey": "-----BEGIN RSA PRIVATE KEY-----\n******=\n-----END RSA PRIVATE KEY-----\n",
  13. "PublicKey": "-----BEGIN PUBLIC KEY-----\n******\n-----END PUBLIC KEY-----\n",
  14. "StartTime": "2020-02-26 00:00:00",
  15. "Valid": 1
  16. },
  17. "Message": "Success.",
  18. "TaskId": ""
  19. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码
TaskId string 任务编号
Data dict 数据
Certificate string 证书信息
PublicKey string 公钥
PirvateKey string 私钥
Domain string 域名
CertificateName string 证书名称,用户自定义名称
CertificateType string 证书类型
Brand string 证书品牌
CertificateId string 证书编号
Organization string 颁发机构
StartTime string 证书有效开始时间
EndTime string 证书有效结束时间
Valid int 是否有效,0:过期的 1:有效的 2:即将过期的(30天内)

10.DeleteCACertificate

Action: DeleteCACertificate

描述: 删除证书

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
CertificateId string 证书编号

请求示例

  1. def delete_ca(caId):
  2. """
  3. 删除证书
  4. :param caId:
  5. """
  6. action = "DeleteCACertificate"
  7. method = "POST"
  8. param = {}
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  10. body = {
  11. "CertificateId": caId,
  12. }
  13. res = requests.post(url, json=body)
  14. result = json.loads(res.content)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {},
  4. "Message": "Success.",
  5. "TaskId": ""
  6. }

返回参数说明

参数名 类型 说明
Code string 状态码
Data dict 数据
Message string 信息描述
TaskId string 任务编号

11.UploadCACertificate

Action: UploadCACertificate

描述: 添加证书

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
Certificate string 证书 (——-BEGIN CERTIFICATE——-\n ——-END CERTIFICATE——-\n必须有标准的换行”\n”)
PrivateKey string 私钥
CertificateName string 自定义证书名称

请求示例

  1. def add_ca():
  2. """
  3. 添加证书
  4. """
  5. action = "UploadCACertificate"
  6. method = "POST"
  7. param = {}
  8. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  9. body = {
  10. "Certificate": "-----BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----\n----- BEGIN CERTIFICATE-----\n******\n-----END CERTIFICATE-----\n",
  11. "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\n******\n-----END RSA PRIVATE KEY-----\n", #此处证书必须符合规范,且有相应的换行符\n
  12. "CertificateName": "******"
  13. }
  14. res = requests.post(url, json=body)
  15. result = json.loads(res.content)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {},
  4. "Message": "Success.",
  5. "TaskId": ""
  6. }

返回参数说明

参数名 类型 说明
Code string 状态码
Data dict 数据
Message string 信息描述
TaskId string 任务编号

12.DescribeLoadBalancerStrategys

Action: DescribeLoadBalancerStrategys

描述: 获取Ha实例的当前监听的策略配置列表

请求地址: cdsapi.capitalonline.net/lb

请求方法: GET

请求参数:

参数名 必选 类型 说明
InstanceUuid string 实例编号

请求示例

  1. def get_strategy_list(instance_uuid):
  2. """
  3. 获取单个实例所有的策略配置
  4. """
  5. action = "DescribeLoadBalancerStrategys"
  6. method = "GET"
  7. param = {
  8. "InstanceUuid": "***************"
  9. }
  10. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param)
  11. res = requests.get(url)
  12. result = json.loads(res.content)
  13. result = json.dumps(result) # json格式化
  14. print(result)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {
  4. "HttpListeners": [{
  5. "AclWhiteList": ["192.168.1.2"],
  6. "BackendServer": [{
  7. "IP": "88.88.0.9",
  8. "MaxConn": 2222,
  9. "Port": 22221,
  10. "Weight": "29"
  11. }],
  12. "CertificateIds": [{
  13. "CertificateId": "*****************",
  14. "CertificateName": "证书oXDYdSgK"
  15. }],
  16. "ClientTimeout": "1000",
  17. "ClientTimeoutUnit": "ms",
  18. "ConnectTimeout": "1000",
  19. "ConnectTimeoutUnit": "ms",
  20. "ListenerMode": "http",
  21. "ListenerName": "http34",
  22. "ListenerPort": 23425,
  23. "MaxConn": 100000,
  24. "Option": {
  25. "Httpchk": {
  26. "Method": "GET",
  27. "Uri": "/index.htm"
  28. }
  29. },
  30. "Scheduler": "roundrobin",
  31. "ServerTimeout": "1002",
  32. "ServerTimeoutUnit": "ms",
  33. "SessionPersistence": {
  34. "Key": "test123",
  35. "Mode": 2,
  36. "Timer": {
  37. "MaxIdle": 3333,
  38. "MaxLife": 3444
  39. }
  40. },
  41. "StickySession": "on"
  42. }],
  43. "TcpListeners": [{
  44. "AclWhiteList": [],
  45. "BackendServer": [{
  46. "IP": "88.88.0.9",
  47. "MaxConn": 2000,
  48. "Port": 2341,
  49. "Weight": "256"
  50. }],
  51. "ClientTimeout": "1010",
  52. "ClientTimeoutUnit": "ms",
  53. "ConnectTimeout": "22",
  54. "ConnectTimeoutUnit": "s",
  55. "EnableRepeaterMode": "on",
  56. "EnableSourceIp": "on",
  57. "ListenerMode": "tcp",
  58. "ListenerName": "http343",
  59. "ListenerPort": 2343,
  60. "MaxConn": 2323,
  61. "Scheduler": "leastconn",
  62. "ServerTimeout": "10000",
  63. "ServerTimeoutUnit": "ms"
  64. }]
  65. },
  66. "Message": "success",
  67. "TaskId": ""
  68. }

返回参数:

参数名 类型 说明
Code string 状态码
Data dict of Data 数据
Message string 信息描述

查询策略DataObj

参数名 类型 说明
HttpListeners list of HttpListeners http 监听策略配置列表
TcpListeners list of TcpListeners tcp 的监听策略列表

查询策略HttpListenersObj

参数名 类型 说明
AclWhiteList list 设置白名单,例如【”129.12.12.1”,”192.168.1.1/20”】
BackendServer list of BackendServer 后端服务器配置
CertificateIds list of CertificateIds http 监听可以绑定证书,不绑定传空列表
ClientTimeout string 设置客户端连接超时的时间
ClientTimeoutUnit string 设置客户端连接超时的时间单位【”ms”,”s”】
ConnectTimeout string 设置请求连接超时时间
ConnectTimeoutUnit string 设置请求连接超时时间的时间单位
ListenerMode string 监听模式
ListenerName string 监听策略的名称,用于生成配置文件,名称不能相同
ListenerPort int 策略监听端口
MaxConn int 代理端的最大连接数
Option object of OptionObj 高级配置
Scheduler string 调度算法【”roundrobin”, “leastconn”, “static-rr”, “source”】
ServerTimeout string 设置服务端超时时间
ServerTimeoutUnit string 设置服务端超时时间单位 【”ms”,”s”】
SessionPersistence object of SessionPersistence 设置会话保持功能
StickySession string 是否开启长连接(Keep Alive) 【”on”,”off”】

查询策略TcpListenersObj

参数名 类型 说明
AclWhiteList list 设置白名单,例如【”129.12.12.1”,”192.168.1.1/20”】
BackendServer list of BackendServer 后端服务器配置
ClientTimeout string 设置客户端连接超时的时间
ClientTimeoutUnit string 设置客户端连接超时的时间单位【”ms”,”s”】
ConnectTimeout string 设置请求连接超时时间
ConnectTimeoutUnit string 设置请求连接超时时间的时间单位
EnableSourceIp string 是否开启获取源IP 【”on”,”off”】
EnableRepeaterMode string 是否当前Haproxy为中继默认且支持源IP透传 【”on”,”off”】
ListenerMode string 监听模式
ListenerName string 监听策略的名称,用于生成配置文件,名称不能相同
ListenerPort int 策略监听端口
MaxConn int 代理端的最大连接数
Scheduler string 调度算法【”roundrobin”, “leastconn”, “static-rr”, “source”】
ServerTimeout string 设置服务端超时时间
ServerTimeoutUnit string 设置服务端超时时间单位 【”ms”,”s”】

查询策略BackendServerObj

参数名 类型 说明
IP string 后端服务器Ip地址
MaxConn int 后端服务器最大连接数
Port int 后端服务器端口
Weight string 后端服务器权重

查询策略CertificateIdsObj

参数名 类型 说明
CertificateId string 证书编号
CertificateName string 证书名称

查询策略OptionObj

参数名 类型 说明
Httpchk object of Httpchk HTTP开启健康检查

查询策略HttpchkObj

参数名 类型 说明
Method string 默认值为:”GET”
参数范围:[“GET”,”HEAD”,”OPTIONS”]
Uri string 健康检查uri

查询策略SessionPersistenceObj

参数名 必选 类型 说明
Key string 在http的reponse设置Cookie的Key的值。字符长度为2~15,以字母开头,以字母或数字结尾,由小写字母、数字或下划线组成, key要求唯一。
Mode int 默认值为1。
0. 表示在缓存中 ( 例如:CDN ) 保留Cookie的内容
1. 表示不在缓存中 ( 例如:CDN ) 保留Cookie的内容, 负载均衡设置的cookie在后端服务可见。
2. 表示不在缓存中 ( 例如:CDN ) 保留Cookie的内容, 负载均衡设置的cookie在后端服务是不可见,即透明模式只能看到客户自己设置的Cookie。
Timer object of Timer 设置会话保持的时间参数,单位: 秒。

查询策略TimerObj

参数名 必选 类型 说明
MaxIdle int 默认值为0, 表示不设置,即空闲也会会话保持。
单位: 秒。支持范围:0-7200。
设置会话保持的最大空闲时长,当连接在该时长内无新的请求,则会话保持结束。
MaxLife int 默认值为0,表示不设置,即会话会一直保持。
单位: 秒。支持范围:0-7200。
设置会话保持的最大时长,超过该时长则会话保持结束, 且要求maxlife 大于maxidle。

13.ModifyLoadBalancerStrategys

Action: ModifyLoadBalancerStrategys

描述: 修改(删除、修改、添加)Ha实例的当前监听的策略配置列表

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
InstanceUuid string 要修改的实例编号
HttpListeners list of HttpListeners http 监听策略配置列表
TcpListeners list of TcpListeners tcp 的监听策略列表

修改策略HttpListenersObj

参数名 必选 类型 说明
ServerTimeoutUnit string 设置服务端超时时间单位 【”ms”,”s”】
ServerTimeout string 设置服务端超时时间
StickySession string 是否开启长连接(Keep Alive) 【”on”,”off”】
AclWhiteList list 设置白名单 例如【”129.12.12.1”,”192.168.1.1/20”】
CertificateIds list of CertificateIdsObj http 监听可以绑定证书,不绑定传空列表
ListenerMode string 监听模式
MaxConn int 代理端的最大连接数
ConnectTimeoutUnit string 设置请求连接超时的时间单位【”ms”,”s”】
Scheduler string 调度算法【”roundrobin”, “leastconn”, “static-rr”, “source”】
SessionPersistence object of SessionPersistence 设置会话保持功能
BackendServer list of BackendServer 后端服务器配置
ConnectTimeout string 设置请求连接超时时间
ClientTimeout string 设置客户端连接超时的时间
ListenerName string 监听策略的名称。
字符长度为1~15,以字母开头,以字母或数字结尾,由小写字母、数字或下划线组成, 名字要求唯一。
ClientTimeoutUnit string 设置客户端连接超时的时间单位【”ms”,”s”】
ListenerPort int 策略监听端口。
取值范围1-65535,其中22、1080、9100、9101端口不在取值范围已被禁用。
Option object of OptionObj 高级配置

修改策略TcpListenersObj

参数名 必选 类型 说明
ServerTimeoutUnit string 设置服务端超时时间单位 【”ms”,”s”】
AclWhiteList list 设置白名单 例如【”129.12.12.1”,”192.168.1.1/20”】
ListenerMode string 监听模式
ListenerName string 监听策略的名称。
字符长度为1~15,以字母开头,以字母或数字结尾,由小写字母、数字或下划线组成, 名字要求唯一。
Scheduler string 调度算法【”roundrobin”, “leastconn”, “static-rr”, “source”】
MaxConn int 代理端的最大连接数
ClientTimeoutUnit string 设置客户端连接超时的时间单位【”ms”,”s”】
ListenerPort int 策略监听端口。
取值范围1-65535,其中22、1080、9100、9101端口不在取值范围已被禁用。
ServerTimeout string 设置服务端超时时间
ConnectTimeoutUnit string 设置请求连接超时的时间单位【”ms”,”s”】
BackendServer list of BackendServer 后端服务器配置
ConnectTimeout string 设置请求连接超时时间
ClientTimeout string 设置客户端连接超时的时间
EnableSourceIp string 设置获取源IP。取值范围【”on”,”off”】,默认为off
EnableRepeaterMode string 设置当前Haproxy为中继默认且支持源IP透传。取值范围 【”on”,”off”】,默认为off,注意:如果设置了EnableRepeaterMode为on,则EnableSourceIp参数也必须为on

修改策略CertificateIdsObj

参数名 必选 类型 说明
CertificateId string 证书编号
CertificateName string 证书名称

修改策略SessionPersistenceObj

参数名 必选 类型 说明
Key string 在http的reponse设置Cookie的Key的值。字符长度为2~15,以字母开头,以字母或数字结尾,由小写字母、数字或下划线组成, key要求唯一。
Mode int 默认值为1。
0. 表示在缓存中 ( 例如:CDN ) 保留Cookie的内容
1. 表示不在缓存中 ( 例如:CDN ) 保留Cookie的内容, 负载均衡设置的cookie在后端服务可见。
2. 表示不在缓存中 ( 例如:CDN ) 保留Cookie的内容, 负载均衡设置的cookie在后端服务是不可见,即透明模式只能看到客户自己设置的Cookie。
Timer object of Timer 设置会话保持的时间参数,单位: 秒。

修改策略TimerObj

参数名 必选 类型 说明
MaxIdle int 默认值为0, 表示不设置,即空闲也会会话保持。
单位: 秒。支持范围:0-7200。
设置会话保持的最大空闲时长,当连接在该时长内无新的请求,则会话保持结束。
MaxLife int 默认值为0,表示不设置,即会话会一直保持。
单位: 秒。支持范围:0-7200。
设置会话保持的最大时长,超过该时长则会话保持结束, 且要求maxlife 大于maxidle。

修改策略BackendServerObj

参数名 必选 类型 说明
IP string 后端服务器Ip地址(公网下支持域名)
Port int 后端服务器端口
Weight string 后端服务器权重,权重范围为1-256
MaxConn int 后端服务器最大连接数

修改策略OptionObj

参数名 必选 类型 说明
Httpchk object of Httpchk HTTP开启健康检查

修改策略HttpchkObj

参数名 必选 类型 说明
Method string 默认值为:”GET”
参数范围:[“GET”,”HEAD”,”OPTIONS”]
Uri string 健康检查uri

请求示例

  1. def modify_strategy(instance_uuid):
  2. """
  3. 修改(删除、修改、添加)Ha实例的当前监听的策略配置列表
  4. :param instance_uuid: 实例id
  5. """
  6. action = "ModifyLoadBalancerStrategys"
  7. method = "POST"
  8. param = {}
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  10. body = {
  11. "InstanceUuid": instance_uuid,
  12. # "HttpListeners": [],
  13. "HttpListeners": [
  14. {
  15. "ServerTimeoutUnit": "ms",
  16. "ServerTimeout": "1000",
  17. "StickySession": "on",
  18. "AclWhiteList": [
  19. "192.168.1.2"
  20. ],
  21. "Option": {
  22. "Httpchk": {
  23. "Method": "GET",
  24. "Uri": "/index.htm"
  25. }
  26. },
  27. "SessionPersistence": {
  28. "Key": "test123",
  29. "Mode": 2,
  30. "Timer": {
  31. "MaxIdle": 3333,
  32. "MaxLife": 3444
  33. }
  34. },
  35. "CertificateIds": [
  36. {
  37. "CertificateId": "******",
  38. "CertificateName": "******"
  39. }
  40. ],
  41. "ListenerMode": "http",
  42. "MaxConn": 100000,
  43. "ConnectTimeoutUnit": "ms",
  44. "Scheduler": "roundrobin",
  45. "BackendServer": [
  46. {
  47. "IP": "66.66.0.8",
  48. "Port": 22222,
  49. "Weight": "1",
  50. "MaxConn": 2222
  51. }
  52. ],
  53. "ConnectTimeout": "1000",
  54. "ClientTimeout": "1000",
  55. "ListenerName": "http-test",
  56. "ClientTimeoutUnit": "ms",
  57. "ListenerPort": 23425
  58. }
  59. ],
  60. "TcpListeners": [
  61. {
  62. "EnableSourceIp":"on",
  63. "EnableRepeaterMode":"on",
  64. "ServerTimeoutUnit": "ms",
  65. "AclWhiteList": [],
  66. "ListenerMode": "tcp",
  67. "ListenerName": "tcp-test",
  68. "Scheduler": "leastconn",
  69. "MaxConn": 2323,
  70. "ClientTimeoutUnit": "ms",
  71. "ListenerPort": 2342,
  72. "ServerTimeout": "10000",
  73. "ConnectTimeoutUnit": "s",
  74. "BackendServer": [
  75. {
  76. "IP": "66.66.0.8",
  77. "MaxConn": 2000,
  78. "Port": 2342,
  79. "Weight": "1"
  80. }
  81. ],
  82. "ConnectTimeout": "22",
  83. "ClientTimeout": "10000",
  84. }
  85. ]
  86. }
  87. res = requests.post(url, json=body)
  88. result = json.loads(res.content)

返回示例

  1. {
  2. "Code": "Success",
  3. "Data": {},
  4. "Message": "Success.",
  5. "TaskId": "******"
  6. }

返回参数说明

参数名 必选 类型 说明
Message string 信息描述
Code string 状态码
Data dict 数据
TaskId string 任务

14.DescribeLBInstancePerformance

Action: DescribeLBInstancePerformance

描述: 获取负载均衡指标的监控数据

请求地址: http://cdsapi.capitalonline.net/paas/monitor

请求方法: POST

请求参数:

参数名 必选 类型 说明
InstanceUuid string 实例编号
MetricKey string 可选指标参数(见下表)
StartTime string 开始时间
EndTime string 结束时间

性能参数表:

API参数名 类别 类型 单位 含义
ha_cpu_usage resources gauge 百分比 cpu使用率
ha_mem_usage resources gauge 百分比 内存使用率
ha_outpackage resources gauge 个/s 负载均衡实例每秒出包量
ha_inpackage resources gauge 个/s 负载均衡实例每秒入包量
ha_outflow resources gauge MB/s 负载均衡实例每秒出流量
ha_inflow resources gauge MB/s 负载均衡实例每秒入流量

时间粒度:

监控粒度自适应方法如下:

时间跨度 监控粒度 自适应说明 保留时长
(0h, 4h] 30s 时间跨度在4小时内,监控粒度为5秒 1天
(4h, 2d] 1min 时间跨度超过4小时,但在2天内,监控粒度调整为1分钟 15天
(2d, 10d] 5min 时间跨度超过2天,但在10天内,监控粒度调整为5分钟 31天
(10d, 30d] 1h 时间跨度超过10天,但在30天内,监控粒度调整为1小时 62天

请求示例:

  1. def get_haproxy_monitor(instance_uuid):
  2. """
  3. 获取haproxy监控
  4. """
  5. action = "DescribeLBInstancePerformance"
  6. method = "POST"
  7. url = get_signature(action, AK, AccessKeySecret, method, MONITOR_URL)
  8. body = {
  9. "InstanceUuid": instance_uuid,
  10. "MetricKey": "ha_mem_usage",
  11. "StartTime": "2021-10-21 13:25:00",
  12. "EndTime": "2021-10-21 13:28:00"
  13. }
  14. res = requests.post(url, json=body)
  15. result = json.loads(res.content)
  16. result = json.dumps(result)
  17. print(result)

返回参数

参数名 类型 说明
Code string 状态码
Data MonitorDataObj 负载均衡监控数据集合以及监控参数
Message string 返回调用接口状态信息和code相对应,比如:Success, Error
TaskId string 任务Id

MonitorDataObj

参数名 类型 说明
DataPoints list of DataPointObj 监控数据集合
EndTime string 结束时间
InstanceUuid str 实例编号
MetricKey string 性能指标参数
Period int 监控粒度(根据时间跨度自适应监控粒度,单位为秒)
ProductType str 产品类型
StartTime string 开始时间

DataPointObj

参数名 类型 说明
MetricName string 性能指标名称
MetricType string 指标类型(gauge,counter)
MonitorType list 监控类型(resources,engine, engine_extension, deploy)
Unit string 单位
Values list of ValueObj 监控数据列表

ValueObj

参数名 类型 说明
DateTime string 监控时间点
Value float 监控数值

返回示例:

  1. {
  2. "Code": "Success",
  3. "Data": {
  4. "DataPoints": [{
  5. "MetricName": "lb_current_memory",
  6. "MetricType": "gauge",
  7. "MonitorType": "mem_usage",
  8. "Unit": "%",
  9. "Values": [{
  10. "DateTime": "2021-10-21 13:25:08",
  11. "Value": 9.29
  12. }, {
  13. "DateTime": "2021-10-21 13:25:38",
  14. "Value": 9.29
  15. }, {
  16. "DateTime": "2021-10-21 13:26:08",
  17. "Value": 9.29
  18. }, {
  19. "DateTime": "2021-10-21 13:26:38",
  20. "Value": 9.29
  21. }, {
  22. "DateTime": "2021-10-21 13:27:08",
  23. "Value": 9.3
  24. }, {
  25. "DateTime": "2021-10-21 13:27:38",
  26. "Value": 9.32
  27. }]
  28. }],
  29. "EndTime": "2021-10-21 13:28:00",
  30. "InstanceUuid": "********************",
  31. "MetricKey": "ha_mem_usage",
  32. "Period": 30,
  33. "ProductType": "haproxy",
  34. "StartTime": "2021-10-21 13:25:00"
  35. },
  36. "Message": "success",
  37. "TaskId": ""
  38. }

15.ModifyLoadBalancerName

Action: ModifyLoadBalancerName

描述: 修改负载均衡实例名称

请求地址: cdsapi.capitalonline.net/lb

请求方法: POST

请求参数:

参数名 必选 类型 说明
InstanceUuid string 实例ID
InstanceName string 修改后实例名称

请求示例

  1. def modify_haproxy_name(instance_uuid):
  2. """
  3. 修改haproxy实例名称
  4. :param instance_uuid: 实例编号
  5. """
  6. action = "ModifyLoadBalancerName"
  7. method = "POST"
  8. param = {}
  9. url = get_signature(action, AK, AccessKeySecret, method, HAPROXY_URL, param=param)
  10. body = {
  11. "InstanceUuid": instance_uuid,
  12. "InstanceName": "HaProxy"
  13. }
  14. res = requests.post(url, json=body)
  15. result = json.loads(res.content)

返回示例

  1. {
  2. "Code": "Success",
  3. "Message": "Success."
  4. }

返回参数说明

参数名 类型 说明
Message string 信息描述
Code string 状态码