负载均衡相关接口
公共返回参数
每次请求的返回值必须包含下面三个字段。所有请求的数据都要放在data字段中,之后的接口返回参数说明和示例中不再包含此信息,只介绍data字段中的内容。
名称 | 必填 | 类型 | 说明 |
---|---|---|---|
code | Y | String | 返回码(正确时返回200,错误时返回相应错误码) |
message | Y | String | 返回信息(简要介绍错误详情) |
data | N | T | 返回数据主体(错误时,可返回空) |
负载均衡管理接口
1. CreateLoadBalancer
第三方调用,创建负载均衡实例。模式为:异步。 我们正在开发新型的负载均衡产品,所以这个接口有时会失效报错。但我们会第一时间进行修改。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值CreateLoadBalancer |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
Region | String | 是 | 区域信息 |
AvailabilityZone | String | 否 | 可用区信息,不传的话会取每个region的默认az |
SpecificationId | String | 是 | 负载均衡类型id,共享型(专有网络vxlan)internet-facing,主备型(独享,经典网络vlan)intranet-active-standby,新型多活(独享,专有网络vxlan)slb-multi-live,lvs型多活(独享,专有网络vxlan)slb-multi-live-lvs |
SkuCode | String | 否 | 套餐code,目前只有新型多活负载均衡按套餐售卖,如果选择新型多活负载均衡的类型创建,则该参数必传,取值可从bss接口获取,也可以先不传,返回信息会有该字段的详细说明 |
VpcId | String | 是 | VPC ID |
SubnetId | String | 是 | 子网ID |
SlbName | String | 是 | 负载均衡名称。输入规则为:输入以字母开头,字符长度小于60,并且以数字、字母、“_”、“-”组成的实例名称 |
EipId | String | 否 | 弹性IP的ID |
IsDualStack | String | 否 | 创建负载均衡是否支持双栈,0是不支持,1是支持(slb所在的vpc必须支持双栈才可填1) |
EipId | String | 否 | 要绑定的公网ID |
SecurityGroups.N | String | 否 | 独享型slb可以在创建的时候绑定安全组 |
示例
创建一台负载均衡
请求示例
https:请求域名?
Action=CreateLoadBalancer
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&Count=1
&AvailabilityZone=cn-north-3
&SpecificationId=internet-facing
&VpcId=1047391027095711744
&SubnetId=e7eb1ea4-aad2-46ef-acd2-1cd863d59f10
&SlbName=slb-001
&EipId=b15673a7-7006-45e2-907e-60ea98214baf
响应示例
<CreateLoadBalancerResponse>
<RequestId>ede57532-804d-4c04-8ce9-b334505ca451</RequestId>
<Code>202</Code>
<Message>Accept</Message>
</CreateLoadBalancerResponse>
错误码
请参考错误码
2. DeleteLoadBalancer
第三方调用,删除负载均衡实例。模式为:异步。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DeleteLoadBalancer |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡实例ID |
示例
删除一台负载均衡
请求示例
https:请求域名?
Action=DeleteLoadBalancer
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001125
响应示例
<DeleteLoadBalancerResponse>
<Code>202</Code>
<RequestId>5fa84cae-14e6-4e56-abb0-9b77923bcfa9</RequestId>
<Message>Accept</Message>
</DeleteLoadBalancerResponse>
错误码
请参考错误码
3. DescribeLoadBalancers
根据查询条件,查询当前租户的负载均衡实例列表信息。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeLoadBalancers |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 否 | 根据所给的Id查询 |
VpcId | String | 否 | 根据所给的Id查询 |
SlbName | String | 否 | 根据所给的Name查询 |
BusinessIp | String | 否 | 根据所给的内网Ip查询 |
Type | String | 否 | 类型,新型多活负载均衡传值multi,旧型(性能共享型和内网主备型)传值network |
V6FixedIp | String | 否 | 负载均衡ipv6 vip |
示例
根据查询条件,查询当前租户的负载均衡实例列表信息。
请求示例
https:请求域名?
Action=GetSlbList
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
响应示例
<DescribeLoadBalancers>
<Code>200</Code>
<Data>
<UpdatedTime>2020-01-13T01:26:27Z</UpdatedTime>
<State>active</State>
<IsShared>1</IsShared>
<SubnetName>UI-update_02</SubnetName>
<RegionId>cn-north-3</RegionId>
<SlbName>SLB-202001071804145</SlbName>
<ListenerCount>0</ListenerCount>
<SpecificationId>internet-facing</SpecificationId>
<SlbId>slb-1214488089926717440</SlbId>
<BusinessIp>100.111.16.63</BusinessIp>
<VpcName>test111</VpcName>
<VpcId>1177060901489553408</VpcId>
<SpecificationName>共享性能型</SpecificationName>
<IsRootUser>1</IsRootUser>
<UserName>sunmingyue</UserName>
<CreatedTime>2020-01-07T10:04:59Z</CreatedTime>
<SubnetId>83771ddc-f756-484b-9e61-ba065878deaa</SubnetId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
<Type>network</Type>
</Data>
<Data>
<UpdatedTime>2020-01-10T19:23:05Z</UpdatedTime>
<State>active</State>
<IsShared>1</IsShared>
<SubnetName>Default-subnet</SubnetName>
<RegionId>cn-north-3</RegionId>
<SlbName>UI测试-Own_EIP</SlbName>
<EipAddress>117.73.3.160</EipAddress>
<SpecificationId>internet-facing</SpecificationId>
<SlbId>slb-1212811424401395712</SlbId>
<BusinessIp>100.111.16.101</BusinessIp>
<VpcName>Default-vpc</VpcName>
<VpcId>1120501401377579008</VpcId>
<ListenerCount>1</ListenerCount>
<EipId>167644ab-729c-439f-be7c-3f018f7931ee</EipId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
<IsRootUser>1</IsRootUser>
<UserName>sunmingyue</UserName>
<CreatedTime>2020-01-02T19:02:31Z</CreatedTime>
<SpecificationName>共享性能型</SpecificationName>
<SubnetId>e5352384-fbca-4cf5-b1c5-977cf7e53562</SubnetId>
<Type>network</Type>
</Data>
<RequestId>2c802e98-9577-490a-947c-645ddba2e673</RequestId>
<Message>success</Message>
</DescribeLoadBalancers>
错误码
请参考错误码
4. DescribeLoadBalancersByPage
根据查询条件,查询当前租户的负载均衡实例列表信息。
请求参数
名称 | 类型 | 是否必须 | 描述 | |
---|---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeLoadBalancersByPage | |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 | |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 | |
Nonce | String | 是 | 公共参数:随机正整数 | |
PageNo | Integer | 是 | 分页,当前展示第几页 | |
PageSize | Integer | 是 | 响应中包含的最大记录数 | |
SlbId | String | 否 | 根据所给的Id查询 | |
VpcId | SlbId | String | 否 | 根据所给的Id查询 |
SlbName | String | 否 | 根据所给的Name查询 | |
BusinessIp | String | 否 | 根据所给的内网Ip查询 |
示例
根据查询条件,查询当前租户的负载均衡实例列表信息。
请求示例
https:请求域名?
Action=GetSlbList
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&PageNo=1
&PageSize=10
响应示例
<DescribeLoadBalancersByPageResponse>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<PageNo>1</PageNo>
<Data>
<UpdatedTime>2020-01-13T01:26:27Z</UpdatedTime>
<State>active</State>
<IsShared>1</IsShared>
<SubnetName>UI-update_02</SubnetName>
<RegionId>cn-north-3</RegionId>
<SlbName>SLB-202001071804145</SlbName>
<ListenerCount>0</ListenerCount>
<SpecificationId>internet-facing</SpecificationId>
<SlbId>slb-1214488089926717440</SlbId>
<BusinessIp>100.111.16.63</BusinessIp>
<VpcName>test111</VpcName>
<VpcId>1177060901489553408</VpcId>
<SpecificationName>共享性能型</SpecificationName>
<IsRootUser>1</IsRootUser>
<UserName>sunmingyue</UserName>
<CreatedTime>2020-01-07T10:04:59Z</CreatedTime>
<SubnetId>83771ddc-f756-484b-9e61-ba065878deaa</SubnetId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
<Type>network</Type>
</Data>
<Data>
<UpdatedTime>2020-01-10T19:23:05Z</UpdatedTime>
<State>active</State>
<IsShared>1</IsShared>
<SubnetName>Default-subnet</SubnetName>
<RegionId>cn-north-3</RegionId>
<SlbName>UI测试-Own_EIP</SlbName>
<EipAddress>117.73.3.160</EipAddress>
<SpecificationId>internet-facing</SpecificationId>
<SlbId>slb-1212811424401395712</SlbId>
<BusinessIp>100.111.16.101</BusinessIp>
<VpcName>Default-vpc</VpcName>
<VpcId>1120501401377579008</VpcId>
<ListenerCount>1</ListenerCount>
<EipId>167644ab-729c-439f-be7c-3f018f7931ee</EipId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
<IsRootUser>1</IsRootUser>
<UserName>sunmingyue</UserName>
<CreatedTime>2020-01-02T19:02:31Z</CreatedTime>
<SpecificationName>共享性能型</SpecificationName>
<SubnetId>e5352384-fbca-4cf5-b1c5-977cf7e53562</SubnetId>
<Type>network</Type>
</Data>
<RequestId>994875f9-0888-40e0-a105-96ebe25df305</RequestId>
</DescribeLoadBalancersByPageResponse>
错误码
请参考错误码
5. DescribeLoadBalancerAttribute
查询负载均衡详细信息
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeLoadBalancerAttribute |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡实例ID |
示例
查询负载均衡详细信息
请求示例
https:请求域名?
Action=DescribeLoadBalancerAttribute
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001125
响应示例
<DescribeLoadBalancerAttributeResponse>
<Code>200</Code>
<Data>
<Slb>
<Slb_name>SLB-test-fc-001</Slb_name>
<Availability_zone>cn-north-3</Availability_zone>
<Business_ip>192.168.11.27</Business_ip>
<Specification_id>internet-facing</Specification_id>
<Create_time>2019-03-13 10:11:31</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Vpc_id>1074912916039884800</Vpc_id>
<Is_shared>1</Is_shared>
<Subnet_id>08330005-e52d-4e9b-906e-be097c1872bb</Subnet_id>
<State>active</State>
<Slb_id>slb-0000001125</Slb_id>
<Type>network</Type>
</Slb>
</Data>
<RequestId>e4868fc4-a2a0-46f2-a974-994e7fe5a6fb</RequestId>
<Message>success</Message>
</DescribeLoadBalancerAttributeResponse>
错误码
请参考错误码
6. QueryLoadBalancerNum
获取SLB数量
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值QueryLoadBalancerNum |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
示例
查询SLB的数量。
请求示例
https:请求域名?
Action=QueryLoadBalancerNum
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
响应示例
<GetSlbNumResponse>
<Code>200</Code>
<Data>2</Data>
<RequestId>7712e632-9254-4028-be39-ea3d75772c44</RequestId>
<Message>success</Message>
</GetSlbNumResponse>
错误码
请参考错误码
7. ModifyLoadBalancer
修改负载均衡信息,目前只支持修改名称。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值ModifyLoadBalancer |
SlbId | String | 是 | 负载均衡标识ID |
SlbName | String | 是 | 负载均衡名称 |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
示例
修改slbId为slb-000000001的负载均衡名字为slb-name
请求示例
https:请求域名?
Action=ModifyLoadBalancer
&SlbId=slb-00000001
&SlbName=slb-name
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
响应示例
<ModifyLoadBalancerResponse>
<Code>200</Code>
<Data>
<Slb>
<Availability_zone>cn-north-3</Availability_zone>
<Business_ip>192.168.11.12</Business_ip>
<Create_time>2019-03-22 06:10:41</Create_time>
<Vpc_id>1108249417309569024</Vpc_id>
<Slb_id>slb-0000001152</Slb_id>
<Type>network</Type>
<Slb_name>slb-20190322-test</Slb_name>
<Update_time>2019-03-22 07:11:21</Update_time>
<Specification_id>internet-facing</Specification_id>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Is_shared>1</Is_shared>
<Subnet_id>ef9fb94d-cee0-4870-a1c1-6612bf37178a</Subnet_id>
<State>active</State>
</Slb>
</Data>
<RequestId>9a660355-4bff-4ac3-946f-244377f4e0a8</RequestId>
<Message>success</Message>
</ModifyLoadBalancerResponse>
错误码
请参考错误码
监听器管理接口
1. CreateListener
当前负载均衡实例创建监听器信息。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值CreateListener |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡Id |
ListenerName | String | 是 | 监听器名称 |
Protocol | String | 是 | 监听协议 |
Port | int | 是 | 监听端口 |
BackendServerGroupId | String | 是 | 后端服务器组Id |
ForwardRule | String | 是 | 调度算法 |
IsUnidirectionalAuth | String | 否 | 单双向认证。1:单向;0:双向。监听协议为HTTPS时必填 |
ServerCaId | String | 否 | 服务器证书 |
CertificateId | String | 否 | CA证书 |
IsHealthCheck | String | 是 | 是否开启健康检查。1:开启;0:关闭 |
TypeHealthCheck | String | 否 | 健康检查协议 |
PortHealthCheck | int | 否 | 健康检查端口0-65535,0:检查添加的后端服务器的端口 |
PeriodHealthCheck | int | 否 | 健康检查周期 |
TimeoutHealthCheck | int | 否 | 后端失效超时时间 |
MaxHealthCheck | int | 否 | 最大重试次数 |
DomainHealthCheck | String | 否 | 健康检查域名 |
PathHealthCheck | String | 否 | 健康检查路径 |
IsRealSrcIp | String | 是 | 是否开启ip透传,1:开启;0:关闭,4层默认为0 |
IsSessionSticky | String | 是 | 是否开启会话保持,1:开启,0:关闭,4层默认为0 |
CookieMode | String | 是 | 会话保持的session方式,0:植入,1:重写,默认为0 |
ExpiredTime | String | 否 | 会话保持植入时,选择植入session的最大时间 |
Cookie | String | 否 | 会话保持为重写时,重写的session内容 |
KeepaliveTimeout | int | 否 | 空闲连接超时时间,http或https的监听器取值范围1-3600,tcp的监听器取值范围10-3600,udp的监听器暂不支持 |
IsDualStack | String | 否 | 监听器类型,IPV4为0,IPV6为2,双栈为1(只有slb的isDualStack为1时才可选择) |
Http2 | String | 否 | 是否开启http2,1为开启 |
Sni | String | 否 | 是否开启SNI,1为开启 |
IsRewrite | String | 否 | 是否开启重定向,1为开启,只有http的监听器可以为重定向 |
RewriteListener | String | 否 | 开启重定向时,重定向的目的监听器id,该监听器必须时https的监听器 |
示例
负载均衡实例创建监听器信息
请求示例
https:请求域名?
Action=CreateListener
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231&ListenerName=listener-name
&Port=443
&Protocol=HTTPS
&ForwardRule=RR
&IsUnidirectional_auth=0
&ServerCaId=certificate-0000000224
&CertificateId=certificate-0000000225
&SlbId=slb-0000001195
&IsHealthCheck=1
&TypeHealthCheck=HTTP
&PortHealthCheck=8080
&PeriodHealthCheck=5
&TimeoutHealthCheck=3
&MaxHealthCheck=2
&DomainHealthCheck=localhost:8080
&PathHealthCheck=/
&IsRealSrcIp=0
&IsSessionSticky=1
&CookieMode=1
&Cookie=newCookie
响应示例
<CreateListenerResponse>
<Code>200</Code>
<Data>
<Listener>
<Is_unidirectional_auth>0</Is_unidirectional_auth>
<Server_ca_id>certificate-0000000224</Server_ca_id>
<Listener_name>listener-name</Listener_name>
<Period_health_check>5</Period_health_check>
<Create_time>2019-04-09 08:41:11</Create_time>
<Timeout_health_check>3</Timeout_health_check>
<Certificate_name>832c71acba7f4b3ab7b47e452f3b2920.crt</Certificate_name>
<Server_ca_name>976c792a0b75457e939df298ec9e69df.crt</Server_ca_name>
<Slb_id>slb-0000001195</Slb_id>
<Is_real_src_ip>0</Is_real_src_ip>
<Is_session_sticky>0</Is_session_sticky>
<Port_health_check>8080</Port_health_check>
<Certificate_id>certificate-0000000225</Certificate_id>
<Is_health_check>1</Is_health_check>
<Protocol>https</Protocol>
<Forward_rule>rr</Forward_rule>
<Port>444</Port>
<Cookie_mode>0</Cookie_mode>
<Cookie_timeout>0</Cookie_timeout>
<Listener_id>listener-0000001649</Listener_id>
<Domain_health_check>localhost:8080</Domain_health_check>
<Path_health_check>/</Path_health_check>
<Type_health_check>tcp</Type_health_check>
<Max_health_check>2</Max_health_check>
<Cookie>nihaohahaha</Cookie>
<Cookie_mode>1</Cookie_mode>
</Listener>
</Data>
<RequestId>da4b62d0-202a-4ae4-9537-d494b1340009</RequestId>
<Message>success</Message>
</CreateListenerResponse>
错误码
请参考错误码
2. DeleteListener
删除负载均衡监听器,指定ListenerId,只删除ListenerId值的监听器。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DeleteListener |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡实例ID |
ListenerId | String | 是 | 监听器ID |
示例
删除负载均衡监听器,不指定ListenerId,删除所有监听器。指定ListenerId,只删除是ListenerId值的监听器。
请求示例
https:请求域名?
Action=DeleteListener
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-00001
&ListenerId=listener-00001
响应示例
<DeleteListenerResponse>
<Code>204</Code>
<Data>2</Data>
<RequestId>7712e632-9254-4028-be39-ea3d75772c44</RequestId>
<Message>success</Message>
</DeleteListenerResponse>
错误码
请参考错误码
3. ModifyListener
修改监听器信息。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值ModifyListener |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
ListenerName | String | 否 | 监听器名称 |
ForwardRule | String | 否 | 调度算法 |
IsHealthCheck | String | 否 | 是否开启健康检查 |
TypeHealthCheck | String | 否 | 健康检查协议 |
PortHealthCheck | int | 否 | 健康检查端口,0:默认检查监听器端口 |
PeriodHealthCheck | int | 否 | 健康检查周期 |
TimeoutHealthCheck | int | 否 | 后端失效超时时间 |
MaxHealthCheck | int | 否 | 最大重试次数 |
DomainHealthCheck | String | 否 | 健康检查域名 |
PathHealthCheck | String | 否 | 健康检查路径 |
IsRealSrcIp | String | 是 | 是否开启ip透传,1:开启;0:关闭,4层默认为0 |
IsSessionSticky | String | 是 | 是否开启会话保持,1:开启,0:关闭,4层默认为0 |
CookieMode | String | 是 | 会话保持的session方式,0:植入,1:重写,默认为0 |
ExpiredTime | String | 否 | 会话保持植入时,选择植入session的最大时间 |
Cookie | String | 否 | 会话保持为重写时,重写的session内容 |
BackendServerGroupId | String | 是 | 后端服务器组Id |
KeepaliveTimeout | int | 否 | 空闲连接超时时间,http或https的监听器取值范围1-3600,tcp的监听器取值范围10-3600,udp的监听器暂不支持 |
Http2 | String | 否 | 是否开启http2.0,1为开启,0为关闭 |
RewriteListener | String | 否 | 重定向的监听器 |
示例
修改监听器信息
请求示例
https:请求域名?
Action=ModifyListener
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=123&SlbId=slb-0000001195
&ListenerId=listener-0000001649
&ListenerName=listener
&ForwardRule=WRR
&Protocol=HTTPS
&IsHealthCheck=1
&TypeHealthCheck=TCP
&PortHealthCheck=8080
&PeriodHealthCheck=5
&TimeoutHealthCheck=3
&MaxHealthCheck=2
&DomainHealthCheck=localhost:8080
&PathHealthCheck=/
&IsRealSrcIp=0
&IsSessionSticky=1
&CookieMode=1
&Cookie=newCookie
响应示例
<ModifyListenerResponse>
<Code>200</Code>
<Data>
<Listener>
<Server_ca_id>certificate-0000000224</Server_ca_id>
<Listener_name>listener</Listener_name>
<Period_health_check>5</Period_health_check>
<Server_ca_name>976c792a0b75457e939df298ec9e69df.crt</Server_ca_name>
<Certificate_id>certificate-0000000225</Certificate_id>
<Protocol>https</Protocol>
<Update_time>2019-04-09 08:51:18</Update_time>
<Forward_rule>wrr</Forward_rule>
<Cookie_mode>0</Cookie_mode>
<Cookie_timeout>0</Cookie_timeout>
<Path_health_check>/</Path_health_check>
<Max_health_check>2</Max_health_check>
<Is_unidirectional_auth>0</Is_unidirectional_auth>
<Create_time>2019-04-09 08:41:11</Create_time>
<Timeout_health_check>3</Timeout_health_check>
<Certificate_name>832c71acba7f4b3ab7b47e452f3b2920.crt</Certificate_name>
<Slb_id>slb-0000001195</Slb_id>
<Is_real_src_ip>0</Is_real_src_ip>
<Is_session_sticky>0</Is_session_sticky>
<Port_health_check>8080</Port_health_check>
<Is_health_check>1</Is_health_check>
<Port>444</Port>
<Listener_id>listener-0000001649</Listener_id>
<Domain_health_check>localhost:8080</Domain_health_check>
<Type_health_check>tcp</Type_health_check>
<cookie>newCookie</cookie>
<cookie_mode>1</cookie_mode>
</Listener>
</Data>
<RequestId>f14cc51c-6b64-4006-8052-3ad8ae34bd0c</RequestId>
<Message>success</Message>
</ModifyListenerResponse>
错误码
请参考错误码
4. DescribeListeners
查看监听器列表信息。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值GetListenerList |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡实例ID |
ListenerName | String | 否 | 按监听器的名称进行查询 |
示例
查看监听器列表详细信息。
请求示例
https:请求域名?
Action=GetListenerList
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001125
响应示例
<GetListenerListResponse>
<Code>200</Code>
<DataContainer>
<Data>
<ListenerBean>
<Listener_name>Listener-201903191015426</Listener_name>
<Create_time>2019-03-19 02:22:53</Create_time>
<Slb_id>slb-0000001125</Slb_id>
<Is_real_src_ip>0</Is_real_src_ip>
<Is_session_sticky>0</Is_session_sticky>
<Is_health_check>0</Is_health_check>
<Protocol>HTTP</Protocol>
<Update_time>2019-03-19 09:30:09</Update_time>
<Forward_rule>WRR</Forward_rule>
<Port>88</Port>
<Cookie_mode>1</Cookie_mode>
<Cookie_timeout>1</Cookie_timeout>
<Listener_id>listener-0000001397</Listener_id>
<cookie>nihaohahaha</cookie>
<cookie_mode>1</cookieMode>
</ListenerBean>
<MemberCount>0</MemberCount>
</Data>
<Data>
<ListenerBean>
<Listener_name>Listener-201903191112102</Listener_name>
<Period_health_check>5</Period_health_check>
<Create_time>2019-03-19 03:12:35</Create_time>
<Timeout_health_check>10</Timeout_health_check>
<Slb_id>slb-0000001125</Slb_id>
<Is_real_src_ip>0</Is_real_src_ip>
<Is_session_sticky>0</Is_session_sticky>
<Port_health_check>8080</Port_health_check>
<Is_health_check>1</Is_health_check>
<Protocol>HTTP</Protocol>
<Forward_rule>RR</Forward_rule>
<Port>23</Port>
<Cookie_mode>1</Cookie_mode>
<Cookie_timeout>1</Cookie_timeout>
<Listener_id>listener-0000001398</Listener_id>
<Domain_health_check>localhost:8080</Domain_health_check>
<Path_health_check>/slb</Path_health_check>
<Type_health_check>http</Type_health_check>
<Max_health_check>5</Max_health_check>
</ListenerBean>
<MemberCount>0</MemberCount>
</Data>
<Data>
<ListenerBean>
<Listener_name>Listener-201903191120319</Listener_name>
<Protocol>UDP</Protocol>
<Create_time>2019-03-19 03:20:59</Create_time>
<Forward_rule>SH</Forward_rule>
<Port>77</Port>
<Cookie_mode>1</Cookie_mode>
<Cookie_timeout>1</Cookie_timeout>
<Listener_id>listener-0000001399</Listener_id>
<Slb_id>slb-0000001125</Slb_id>
<Is_real_src_ip>1</Is_real_src_ip>
<Is_session_sticky>1</Is_session_sticky>
<cookie>nihaohahaha</cookie>
</ListenerBean>
<MemberCount>0</MemberCount>
</Data>
<Data>
<ListenerBean>
<Is_unidirectional_auth>1</Is_unidirectional_auth>
<Server_ca_id>certificate-0000000224</Server_ca_id>
<Listener_name>listener-fc-001</Listener_name>
<Create_time>2019-03-19 09:22:01</Create_time>
<Server_ca_name>ce02587e991a420f829e0dc05cef86bc.crt</Server_ca_name>
<Slb_id>slb-0000001125</Slb_id>
<Is_real_src_ip>0</Is_real_src_ip>
<Is_session_sticky>0</Is_session_sticky>
<Certificate_id>certificate-0000000225</Certificate_id>
<Protocol>HTTPS</Protocol>
<Update_time>2019-03-19 09:40:40</Update_time>
<Forward_rule>WRR</Forward_rule>
<Port>80</Port>
<Cookie_mode>1</Cookie_mode>
<Cookie_timeout>1</Cookie_timeout>
<Listener_id>listener-0000001400</Listener_id>
</ListenerBean>
<MemberCount>0</MemberCount>
</Data>
</DataContainer>
<RequestId>d4187dea-0a36-4d28-a86b-e34a7f9a2fb9</RequestId>
<Message>success</Message>
</GetListenerListResponse>
错误码
请参考错误码
5. DescribeListenersByPage
查看监听器列表信息。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值GetListenerList |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡实例ID |
PageNo | Integer | 否 | 分页,当前要展示的页数 |
PageSize | Integer | 否 | 响应中包含的最大记录数 |
ListenerName | String | 否 | 可按照监听器的名称进行查询 |
示例
查看监听器列表详细信息。
请求示例
https:请求域名?
Action=DescribeListenersByPage
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-1216558247515459584
&PageNo=1
&PageSize=10
响应示例
<DescribeListenersByPageResponse>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<PageNo>1</PageNo>
<Data>
<BackendServerGroupId>server-group-1216558326213922816</BackendServerGroupId>
<SlbId>slb-1216558247515459584</SlbId>
<Protocol>tcp</Protocol>
<IsSessionSticky>0</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>123</Port>
<IsRealSrcIp>0</IsRealSrcIp>
<ListenerName>Listener-202001131111046</ListenerName>
<BackendServerGroupName>Group-202001131110565</BackendServerGroupName>
<ListenerId>listener-1216558354709286912</ListenerId>
<CookieMode>0</CookieMode>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T03:11:29Z</CreatedTime>
<IsHealthCheck>0</IsHealthCheck>
<MemberCount>1</MemberCount>
</Data>
<RequestId>b018866f-6db7-43c8-92ba-c85c02901487</RequestId>
</DescribeListenersByPageResponse>
错误码
请参考错误码
6. DescribeListenerAttribute
查看监听器详细信息。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值GetListener |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡实例ID |
ListenerId | String | 是 | 监听器ID |
示例
查看监听器详细信息。
请求示例
https:请求域名?
Action=GetListener
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001125
&ListenerId=listener-0000001400
响应示例
<GetListenerResponse>
<Code>200</Code>
<Data>
<Listener>
<Is_unidirectional_auth>1</Is_unidirectional_auth>
<Server_ca_id>certificate-0000000224</Server_ca_id>
<Listener_name>listener-fc-001</Listener_name>
<Create_time>2019-03-19 09:22:01</Create_time>
<Certificate_name>certs-cy-ca</Certificate_name>
<Server_ca_name>certs-cy</Server_ca_name>
<Slb_id>slb-0000001125</Slb_id>
<Is_real_src_ip>0</Is_real_src_ip>
<Is_session_sticky>0</Is_session_sticky>
<Certificate_id>certificate-0000000225</Certificate_id>
<Protocol>HTTPS</Protocol>
<Update_time>2019-03-19 09:40:40</Update_time>
<Forward_rule>WRR</Forward_rule>
<Port>80</Port>
<Cookie_mode>1</Cookie_mode>
<Cookie>nihaohahaha</Cookie>
<CookieMode>1</CookieMode>
<Listener_id>listener-0000001400</Listener_id>
</Listener>
</Data>
<RequestId>8ad2f79d-3bfc-436c-aed8-3a659ef54bb1</RequestId>
<Message>success</Message>
</GetListenerResponse>
错误码
请参考错误码
后端服务器组管理接口
1. CreateBackendServerGroup
绑定一台或多台云服务器到负载均衡实例上。 这里引入了后端服务器组的概念,将一些后端服务器加入后端服务器组中,一个监听器只能关联一个后端服务器组,后端服务器组只有关联了监听器才有用
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值CreateBackendServerGroup |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
ServerGroupName | String | 是 | 后端服务器组Name |
ServerIp.N | String | 否 | 一个或多个后端服务器的Ip(这里包括下面几个参数可为否的意思是,这个后端服务器组可以是空的。但只要添加以后后端服务器,这些参数必须有) |
Ipv6Addr.N | String | 否 | 一个或多个后端服务器的v6Ip |
ServerName.N | String | 否 | 一个或多个后端服务器的Name。若添加多个,N由0开始依次递增 |
ResourceId.N | String | 否 | 一个或多个后端服务器组的ResourceId。若添加多个,N由0开始依次递增 |
Type.N | String | 是 | 一个或多个待添加的后端服务器类型。若添加多个,N由0开始依次递增 |
Weight.N | String | 是 | 一个或多个待添加的后端服务器权重。若添加多个,N由0开始依次递增,取值:1~100 |
Port.N | String | 是 | 一个或多个待添加的端口号。若添加多个,N由0开始依次递增,取值:1~65535 |
示例
负载均衡实例绑定后端服务器
请求示例
https:请求域名?
Action=CreateBackendServerGroup
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001130
&ServerGroupName=zhang123
&Port.0=22
&ResourceId.0=7f648566-4222-4fe2-b446-e1c67e3de48e
&ServerIp.0=20.20.20.3
&ServerName.0=ECS-001
&Type.0=ECS
&Weight.0=50
&Port.1=80
响应示例
<CreateBackendServerGroupResponse>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<BackendServers>
<ServerName>niusd测试-勿删</ServerName>
<ServerId>server-1216567287889678336</ServerId>
<ResourceId>21e2d4cc-da64-48c7-963b-39d109fb80eb</ResourceId>
<Port>67</Port>
<Weight>10</Weight>
<CreatedTime>2020-01-13T03:46:58Z</CreatedTime>
<ServerIp>192.168.0.8</ServerIp>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<Type>ECS</Type>
</BackendServers>
<RequestId>29787d84-d59b-493f-9d29-2b76bb8ca68b</RequestId>
<ServerGroupName>zhang123</ServerGroupName>
<CreatedTime>2020-01-13T03:46:57Z</CreatedTime>
</CreateBackendServerGroupResponse>
错误码
请参考错误码
2. DeleteBackendServerGroup
删除该后端服务器组,但如果这个后端服务器组已经被使用,则无法删除
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DeleteBackendServerGroup |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
BackendServerGroupId | String | 是 | 后端服务器组Id |
示例
删除后端服务器组
请求示例
https:请求域名?
Action=BackendServerGroupId
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-00001
&BackendServerGroupId=server-group-1214455431205113856
响应示例
<DeleteBackendServerGroupResponse>
<Code>204</Code>
<RequestId>b12e4cb6-705a-4580-b256-854ddecc73cf</RequestId>
<Message>success</Message>
</DeleteBackendServerGroupResponse>
错误码
请参考错误码
3. UpdateBackendServerGroup
修改指定后端服务器组的信息。这里可以修改后端服务器组的名字也可以修改里面的后端服务器,但是,这里会清空之前的后端服务器,以这次加入的后端服务器为准。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值UpdateBackendServerGroup |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
ServerGroupName | 是 | 后端服务器组Name | |
ServerIp.N | String | 否 | 一个或多个后端服务器的Ip(这里包括下面几个参数可为否的意思是,这个后端服务器组可以是空的。但只要添加以后后端服务器,这些参数必须有) |
Ipv6Addr.N | String | 否 | 一个或多个后端服务器的v6Ip |
ServerName.N | String | 否 | 一个或多个后端服务器的Name。若添加多个,N由0开始依次递增 |
ResourceId.N | String | 否 | 一个或多个后端服务器组的ResourceId。若添加多个,N由0开始依次递增 |
Type.N | String | 是 | 一个或多个待添加的后端服务器类型。若添加多个,N由0开始依次递增 |
Weight.N | String | 是 | 一个或多个待添加的后端服务器权重。若添加多个,N由0开始依次递增,取值:1~100 |
Port.N | String | 是 | 一个或多个待添加的端口号。若添加多个,N由0开始依次递增,取值:1~65535 |
示例
修改后端服务器参数
请求示例
https:请求域名?
Action=UpdateBackendServerGroup
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-00001
&ServerGroupName=1234aaaa
&Port.0=22
&ResourceId.0=7f648566-4222-4fe2-b446-e1c67e3de48e
&ServerIp.0=20.20.20.3
&ServerName.0=ECS-001
&Type.0=ECS
&Weight.0=50
&Port.1=80
响应示例
<UpdateBackendServerGroupResponse>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<UpdatedTime>2020-01-13T05:59:07Z</UpdatedTime>
<BackendServers>
<ServerName>niusd测试-勿删</ServerName>
<ServerId>server-1216600548199567360</ServerId>
<ResourceId>21e2d4cc-da64-48c7-963b-39d109fb80eb</ResourceId>
<Port>801</Port>
<Weight>10</Weight>
<CreatedTime>2020-01-13T05:59:08Z</CreatedTime>
<ServerIp>192.168.0.8</ServerIp>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<Type>ECS</Type>
</BackendServers>
<RequestId>98de43b5-73ba-49e4-be17-be68d4d566d9</RequestId>
<ServerGroupName>1234aaaa</ServerGroupName>
<CreatedTime>2020-01-13T03:46:58Z</CreatedTime>
</UpdateBackendServerGroupResponse>
错误码
请参考错误码
4. DescribeBackendServerGroupAttribute
查看后端服务器组详细信息
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeBackendServerGroupAttribute |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
BackendServerGroupId | String | 是 | 后端服务器组Id |
示例
查看转发后端服务器列表信息,展示他们所关联的监听器以及他们的信息
请求示例
https:请求域名?
Action=DescribeBackendServerGroupAttribute
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001125
&BackendServerGroupId=server-group-1216567283334664192
响应示例
<DescribeBackendServerGroupAttributeResponse>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<BackendServerCount>1</BackendServerCount>
<Listeners>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<UpdatedTime>2020-01-13T06:06:49Z</UpdatedTime>
<IsSessionSticky>0</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<SlbId>slb-1216558247515459584</SlbId>
<Protocol>tcp</Protocol>
<Port>123</Port>
<IsRealSrcIp>0</IsRealSrcIp>
<ListenerId>listener-1216558354709286912</ListenerId>
<ListenerName>Listener-202001131111046</ListenerName>
<ForwardRule>rr</ForwardRule>
<CookieMode>0</CookieMode>
<IsHealthCheck>0</IsHealthCheck>
<CreatedTime>2020-01-13T03:11:29Z</CreatedTime>
</Listeners>
<CreatedTime>2020-01-13T03:46:58Z</CreatedTime>
<RequestId>bb77d720-987f-4f23-b9d8-67ef37cc4039</RequestId>
<ServerGroupName>1234aaaa</ServerGroupName>
<UpdatedTime>2020-01-13T05:59:08Z</UpdatedTime>
</DescribeBackendServerGroupAttributeResponse>
错误码
请参考错误码
5. DescribeBackendServerGroupsByPage
分页查询后端服务器组
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeBackendServerGroupsByPage |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
PageNo | String | 是 | 当前展示第几页 |
PageSize | String | 是 | 每页最多展示的信息条数 |
ServerGroupName | String | 否 | 按后端服务器组的名字进行分页的查询 |
示例
查看这个负载均衡下的后端服务器组列表
请求示例
https:请求域名?
Action=DescribeBackendServerGroupsByPage
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-1216558247515459584
&PageNo=1
&PageSize=10
响应示例
<DescribeBackendServerGroupsByPageResponse>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<PageNo>1</PageNo>
<Data>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<UpdatedTime>2020-01-13T05:59:08Z</UpdatedTime>
<ServerGroupName>1234aaaa</ServerGroupName>
<CreatedTime>2020-01-13T03:46:58Z</CreatedTime>
<BackendServerCount>1</BackendServerCount>
<Listeners>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<UpdatedTime>2020-01-13T06:06:49Z</UpdatedTime>
<IsSessionSticky>0</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<SlbId>slb-1216558247515459584</SlbId>
<Protocol>tcp</Protocol>
<Port>123</Port>
<IsRealSrcIp>0</IsRealSrcIp>
<ListenerId>listener-1216558354709286912</ListenerId>
<ListenerName>Listener-202001131111046</ListenerName>
<ForwardRule>rr</ForwardRule>
<CookieMode>0</CookieMode>
<IsHealthCheck>0</IsHealthCheck>
<CreatedTime>2020-01-13T03:11:29Z</CreatedTime>
</Listeners>
</Data>
<Data>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216558326213922816</ServerGroupId>
<ServerGroupName>Group-202001131110565</ServerGroupName>
<CreatedTime>2020-01-13T03:11:22Z</CreatedTime>
<BackendServerCount>1</BackendServerCount>
</Data>
<RequestId>9366d11d-a7a3-4495-bb8c-78ce135309cd</RequestId>
</DescribeBackendServerGroupsByPageResponse>
错误码
请参考错误码
6. DescribeBackendServerGroups
查询后端服务器组列表
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeBackendServerGroups |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
示例
查看这个负载均衡下的后端服务器组列表
请求示例
https:请求域名?
Action=DescribeBackendServerGroupsByPage
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-1216558247515459584
响应示例
<DescribeBackendServerGroupsResponse>
<Data>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216567283334664192</ServerGroupId>
<UpdatedTime>2020-01-13T05:59:08Z</UpdatedTime>
<ServerGroupName>1234aaaa</ServerGroupName>
<CreatedTime>2020-01-13T03:46:58Z</CreatedTime>
<BackendServerCount>1</BackendServerCount>
<Listeners>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<UpdatedTime>2020-01-13T06:06:49Z</UpdatedTime>
<IsSessionSticky>0</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<SlbId>slb-1216558247515459584</SlbId>
<Protocol>tcp</Protocol>
<Port>123</Port>
<IsRealSrcIp>0</IsRealSrcIp>
<ListenerId>listener-1216558354709286912</ListenerId>
<ListenerName>Listener-202001131111046</ListenerName>
<ForwardRule>rr</ForwardRule>
<CookieMode>0</CookieMode>
<IsHealthCheck>0</IsHealthCheck>
<CreatedTime>2020-01-13T03:11:29Z</CreatedTime>
</Listeners>
</Data>
<Data>
<SlbId>slb-1216558247515459584</SlbId>
<ServerGroupId>server-group-1216558326213922816</ServerGroupId>
<ServerGroupName>Group-202001131110565</ServerGroupName>
<CreatedTime>2020-01-13T03:11:22Z</CreatedTime>
<BackendServerCount>1</BackendServerCount>
</Data>
<RequestId>9366d11d-a7a3-4495-bb8c-78ce647463da</RequestId>
</DescribeBackendServerGroupsResponse>
错误码
请参考错误码
网络管理接口
1. BindEIPwithLoadBalance
绑定EIP到内网负载均衡实例上
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值BindEIPwithLoadBalance |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
EipId | String | 是 | 弹性公网ID |
示例
在当前负载均衡实例上绑定EIP
请求示例
https:请求域名?
Action=BindEIPwithLoadBalance
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001125
&EipId=589e4336-313d-4313-9861-1a0c3cc86c3a
响应示例
<BindEIPwithLoadBalanceResponse>
<Code>200</Code>
<RequestId>bdc0490a-61da-40ca-9646-10a68221dba3</RequestId>
<Message>success</Message>
</BindEIPwithLoadBalanceResponse>
错误码
请参考错误码
2. RemoveEIPwithLoadBalance
解绑负载均衡实例EIP
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值RemoveEIPwithLoadBalance |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
SlbId | String | 是 | 负载均衡ID |
示例
解绑负载均衡实例上绑定的EIP
请求示例
https:请求域名?
Action=RemoveEIPwithLoadBalance
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&SlbId=slb-0000001130
响应示例
<RemoveEIPwithLoadBalanceResponse>
<Code>200</Code>
<RequestId>376ee122-7a35-470d-9738-dc831b95dbc0</RequestId>
<Message>success</Message>
</RemoveEIPwithLoadBalanceResponse>
错误码
请参考错误码
证书管理接口
1. CreateCertificate 创建证书
用户将已购买的证书上传到浪潮云。 注意:调用OpenApi接口时,请将证书的内容进行一次url编码!
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值CreateCertificate |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
CertificateName | String | 是 | 证书的名称 |
Type | String | 是 | 证书的类型(SERVER、CA) |
Content | String | 是 | 证书的内容 |
PrivateKey | String | 否 | 私钥 |
RegionId | String | 否 | 区域id |
示例
上传证书信息到浪潮云
请求示例
https:请求域名?
Action=CreateCertificate
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&CertificateName=cert-name
&Type=SERVER
&Content=-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
&PrivateKey=-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----
&RegionId
响应示例
<CreateCertificateResponse>
<Code>200</Code>
<Data>
<Certificate>
<Certificate_id>certificate-0000001006</Certificate_id>
<Start_time>2019-01-02 03:14:01</Start_time>
<Create_time>2019-03-20 02:20:17</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>server123</Certificate_name>
<Expired_time>2020-01-02 03:14:01</Expired_time>
<Private_key>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</Private_key>
<Type>SERVER</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certificate>
</Data>
<RequestId>2a6432a3-e007-48c5-b092-036b49c06989</RequestId>
<Message>success</Message>
</CreateCertificateResponse>
错误码
请参考错误码
2. DeleteCertificate 删除证书
删除租户的证书
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DeleteCertificate |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
CertificateId | String | 是 | 证书ID |
示例
删除证书
请求示例
https:请求域名?
Action=DeleteCertificate
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
&CertificateId=certificate-0000001004
响应示例
<DeleteCertificateResponse>
<Code>200</Code>
<RequestId>b12e4cb6-705a-4580-b256-854ddecc73cf</RequestId>
<Message>success</Message>
</DeleteCertificateResponse>
错误码
请参考错误码
3. DescribeCertificate 证书列表查询
获取租户的证书列表
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值GetCertificateList |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
marker | Integer | 否 | 分页。默认1 |
limit | Integer | 否 | 响应中包含的最大记录数。默认:100。与marker都不填时,不分页;两者填一个,另一个使用默认值 |
示例
获取租户的证书列表
请求示例
https:请求域名?
Action=GetCertificateList
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
响应示例
<GetCertificateListResponse>
<Code>200</Code>
<Data>
<CertsContainer>
<Certs>
<Certificate_id>certificate-0000000067</Certificate_id>
<Start_time>2019-01-07 09:15:47</Start_time>
<Update_time>2019-03-06 10:44:56</Update_time>
<Create_time>2019-01-10 08:03:33</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-test-server证书22</Certificate_name>
<Expired_time>2020-01-07 09:15:47</Expired_time>
<Private_key>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</Private_key>
<Type>SERVER</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000000215</Certificate_id>
<Start_time>2019-01-14 01:59:08</Start_time>
<Update_time>2019-01-15 09:28:52</Update_time>
<Create_time>2019-01-15 09:28:39</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-服务器证书</Certificate_name>
<Expired_time>2020-01-14 01:59:08</Expired_time>
<Private_key>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</Private_key>
<Type>SERVER</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000000216</Certificate_id>
<Start_time>2019-01-14 02:03:39</Start_time>
<Create_time>2019-01-15 09:29:27</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-CA证书</Certificate_name>
<Expired_time>2020-01-14 02:03:39</Expired_time>
<Type>CA</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000000217</Certificate_id>
<Start_time>2019-01-14 01:59:08</Start_time>
<Create_time>2019-01-16 00:48:02</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-JFW-001</Certificate_name>
<Expired_time>2020-01-14 01:59:08</Expired_time>
<Private_key>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</Private_key>
<Type>SERVER</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000000218</Certificate_id>
<Start_time>2019-01-14 02:03:39</Start_time>
<Create_time>2019-01-16 00:48:49</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-JFW-001</Certificate_name>
<Expired_time>2020-01-14 02:03:39</Expired_time>
<Type>CA</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000000224</Certificate_id>
<Start_time>2019-01-02 03:14:01</Start_time>
<Create_time>2019-01-16 03:04:58</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-cy</Certificate_name>
<Expired_time>2020-01-02 03:14:01</Expired_time>
<Private_key>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</Private_key>
<Type>SERVER</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000000225</Certificate_id>
<Start_time>2019-01-02 02:43:37</Start_time>
<Create_time>2019-01-16 03:05:21</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>certs-cy-ca</Certificate_name>
<Expired_time>2020-01-02 02:43:37</Expired_time>
<Type>CA</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
<Certs>
<Certificate_id>certificate-0000001003</Certificate_id>
<Start_time>2019-01-02 03:14:01</Start_time>
<Update_time>2019-03-19 10:43:24</Update_time>
<Create_time>2019-03-19 10:42:16</Create_time>
<User_id>05c215a7-88ba-4673-814d-d3114e761d94</User_id>
<Certificate_name>cert-name-0001</Certificate_name>
<Region_id/>
<Expired_time>2020-01-02 03:14:01</Expired_time>
<Private_key>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</Private_key>
<Type>SERVER</Type>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
</Certs>
</CertsContainer>
</Data>
<RequestId>d5bbda31-aa99-41e6-99cd-7a8d4f8f8787</RequestId>
<Message>success</Message>
</GetCertificateListResponse>
错误码
请参考错误码
4. DescribeCertificatesByPage 分页查询证书列表
分页获取租户的证书列表
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值GetCertificateList |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
PageNo | Integer | 否 | 分页当前展示的页数 |
PageSize | Integer | 否 | 分页展示的最大信息条数 |
示例
获取租户的证书列表
请求示例
https:请求域名?
Action=GetCertificateList
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1231
响应示例
<DescribeCertificatesByPageResponse>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<PageNo>1</PageNo>
<Data>
<UpdatedTime>2020-01-08T09:34:26Z</UpdatedTime>
<UserName>sunmingyue</UserName>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47sd212</UserId>
<Type>SERVER</Type>
<RegionId>cn-north-3</RegionId>
<CertificateId>certificate-12138960129807532444</CertificateId>
<StartedTime>2019-01-02T03:14:01Z</StartedTime>
<IsUsed>0</IsUsed>
<ExpiredTime>2020-01-02T03:14:01Z</ExpiredTime>
<PrivateKey>-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----</PrivateKey>
<CreatedTime>2020-01-05T18:52:17Z</CreatedTime>
<CertificateName>SERVER</CertificateName>
<IsRootUser>1</IsRootUser>
</Data>
<Data>
<UpdatedTime>2020-01-08T09:34:29Z</UpdatedTime>
<Content>-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----</Content>
<UserName>sunmingyue</UserName>
<UserId>84f4f37a-925c-42ef-8f60-fd43a47a7fcd</UserId>
<RegionId>cn-north-3</RegionId>
<CertificateId>certificate-1213895463465298304</CertificateId>
<Type>CA</Type>
<StartedTime>2019-01-02T02:43:37Z</StartedTime>
<ExpiredTime>2020-01-02T02:43:37Z</ExpiredTime>
<CreatedTime>2020-01-05T18:50:08Z</CreatedTime>
<IsUsed>0</IsUsed>
<CertificateName>CA</CertificateName>
<IsRootUser>1</IsRootUser>
</Data>
<RequestId>3d4cad3b-2b56-43f5-aa7e-ee59bc05751d</RequestId>
</DescribeCertificatesByPageResponse>
错误码
请参考错误码
转发策略管理接口
1. CreateStrategy 创建转发策略
在一个HTTP/HTTPS的监听器下创建转发策略。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值CreateStrategy |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
ListenerId | String | 是 | 监听器的Id |
SlbId | String | 是 | Slb的Id |
StrategyDomain.N | String | 否 | 转发策略的域名,若添加多个,N由0开始依次递增 |
StrategyRemark.N | String | 否 | 转发策略的名称,若添加多个,N由0开始依次递增 |
StrategyUrl.N | String | 否 | 转发策略的URL,若添加多个,N由0开始依次递增 |
BackendServerGroupId.N | String | 是 | 转发策略绑定的后端服务器组,若添加多个,N由0开始依次递增 |
ServerCaId.N | String | 否 | 开启sni后,转发策略可以选择server证书,并且开启sni后,转发策略证书不会随着监听器server证书的改变而改变 |
示例
创建一个转发策略
请求示例
https:请求域名?
Action=CreateStrategy
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&SlbId=slb-1216558247515459584
&ListenerId=listener-1216623663932395520
&StrategyDomain.1=www.zqq.com
&StrategyUrl.1=dem
&StrategyRemark.1=block
&BackendServerGroupId.1=server-group-1216567283334664192
响应示例
<CreateStrategyResponse>
<Code>200</Code>
<RequestId>d8bc3027-3595-4c6f-9c9f-c6a1d186a73e</RequestId>
<Data>
<CookieMode>0</CookieMode>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>block</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/dem</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>www.zqq.com</StrategyDomain>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216623922867015680</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T07:32:01Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</Data>
<Data>
<CookieMode>0</CookieMode>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>默认添加的转发策略</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>www.zqq.com</StrategyDomain>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216623928890036224</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T07:32:03Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</Data>
<Message>success</Message>
</CreateStrategyResponse>
错误码
请参考错误码
2. DeleteStrategy 删除转发策略
删除一个转发策略
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DeleteStrategy |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
ListenerId | String | 是 | 监听器的Id |
SlbId | String | 是 | Slb的Id |
StrategyId | String | 是 | 转发策略的Id |
ListenerId | String | 是 | 监听器的Id |
示例
删除一个转发策略
请求示例
https:请求域名?
Action=DeleteStrategy
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&SlbId=slb-1216558247515459584
&ListenerId=listener-1216623663932395520
&StrategyId=strategy-1278643209233432560
响应示例
<DeleteStrategyResponse>
<Code>204</Code>
<Data>2</Data>
<RequestId>7712e632-9254-4028-be39-ea3d75772c44</RequestId>
<Message>success</Message>
</DeleteStrategyResponse>
错误码
请参考错误码
3. ModifyStrategy 修改转发策略
在一个HTTP/HTTPS的监听器下创建转发策略。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值ModifyStrategy |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
ListenerId | String | 是 | 监听器的Id |
SlbId | String | 是 | Slb的Id |
StrategyId | String | 是 | 转发策略的Id |
StrategyRemark | String | 否 | 要给转发策略修改的名称 |
BackendServerGroupId | String | 否 | 转发策略修改的后端服务器组 |
serverCaId | String | 否 | 开启sni后,转发策略可以选择server证书,并且开启sni后,转发策略证书不会随着监听器server证书的改变而改变 |
示例
修改一个转发策略
请求示例
https:请求域名?
Action=CreateStrategy
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&SlbId=slb-1216558247515459584
&ListenerId=listener-1216623663932395520
&StrategyId=strategy-1216631995640467456
&StrategyRemark=qqqqqqqqqq
响应示例
<ModifyStrategyResponse>
<CookieMode>0</CookieMode>
<UpdatedTime>2020-01-13T08:05:40Z</UpdatedTime>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>qqqqqqq</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/bbb</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>aaa</StrategyDomain>
<RequestId>b6e725e2-3b19-4244-a2f3-76e055747b7f</RequestId>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216631995640467456</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T08:04:06Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</ModifyStrategyResponse>
错误码
请参考错误码
4. DescribeStrategies 查看转发策略列表
查看这个监听器下的所有转发策略
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeStrategies |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
ListenerId | String | 是 | 监听器的Id |
SlbId | String | 是 | Slb的Id |
示例
查看这个监听器下的所有转发策略
请求示例
https:请求域名?
Action=DescribeStrategies
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&SlbId=slb-1216558247515459584
&ListenerId=listener-1216623663932395520
响应示例
<DescribeStrategiesResponse>
<Data>
<CookieMode>0</CookieMode>
<UpdatedTime>2020-01-13T08:05:41Z</UpdatedTime>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>qqqqqqq</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/bbb</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>aaa</StrategyDomain>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216631995640467456</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T08:04:06Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</Data>
<Data>
<CookieMode>0</CookieMode>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>默认添加的转发策略</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>aaa</StrategyDomain>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216632001348915200</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T08:04:08Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</Data>
<Data>
<CookieMode>0</CookieMode>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>block</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/dem</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>www.zqq.com</StrategyDomain>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216623922867015680</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T07:32:02Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</Data>
<Data>
<CookieMode>0</CookieMode>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>默认添加的转发策略</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>www.zqq.com</StrategyDomain>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216623928890036224</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T07:32:03Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</Data>
<RequestId>73ffe230-7334-440d-94dc-a01332a2e915</RequestId>
</DescribeStrategiesResponse>
错误码
请参考错误码
5. DescribeStrategy 查看单个转发策略
查看单个转发策略
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值DescribeStrategy |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
ListenerId | String | 是 | 监听器的Id |
SlbId | String | 是 | Slb的Id |
StrategyId | String | 是 | 转发策略的Id |
示例
查看单个转发策略
请求示例
https:请求域名?
Action=DescribeStrategies
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&SlbId=slb-1216558247515459584
&ListenerId=listener-1216623663932395520
&StrategyId=strategy-1216623928890036224
响应示例
<DescribeStrategyResponse>
<CookieMode>0</CookieMode>
<IsSessionSticky>1</IsSessionSticky>
<CookieTimeout>0</CookieTimeout>
<Port>112</Port>
<StrategyRemark>默认添加的转发策略</StrategyRemark>
<StrategyListenerId>listener-1216623663932395520</StrategyListenerId>
<StrategyUrl>/</StrategyUrl>
<IsHealthCheck>0</IsHealthCheck>
<BackendServerGroupId>server-group-1216567283334664192</BackendServerGroupId>
<StrategyDomain>www.zqq.com</StrategyDomain>
<RequestId>7c661ba9-fb51-4d9b-8ec3-747b0a425e21</RequestId>
<IsRealSrcIp>1</IsRealSrcIp>
<ListenerId>strategy-1216623928890036224</ListenerId>
<ExpiredTime>1000</ExpiredTime>
<ForwardRule>rr</ForwardRule>
<CreatedTime>2020-01-13T07:32:03Z</CreatedTime>
<Protocol>http</Protocol>
<SlbId>slb-1216558247515459584</SlbId>
</DescribeStrategyResponse>
错误码
请参考错误码
其他接口
1. 获取token
获取用户token,用于鉴权
token认证
2. 操作日志
用于查询操作日志
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 公共参数:取值ListSlbLog |
Version | String | 是 | 公共参数:API版本号,取值:2019-01-31 |
Timestamp | String | 是 | 公共参数:当前UNIX时间戳 |
Nonce | String | 是 | 公共参数:随机正整数 |
PageNo | Integer | 是 | 分页,当前展示第几页 |
PageSize | Integer | 是 | 响应中包含的最大记录数 |
Result | String | 否 | 查询成功还是失败 |
Username | String | 否 | 根据用户的Name进行查询 |
Example | String | 否 | 根据实例id进行查询 |
action | String | 否 | 根据实例的类型进行查询 |
示例
请求示例
https:请求域名?
Action=ListSlbLog
&Version=2019-01-31
&Timestamp=1552879066338
&Nonce=1236
&PageNo=1
&PageSize=10
响应示例
<ListSlbLogResponse>
<TotalCount>3604</TotalCount>
<PageSize>10</PageSize>
<PageNo>1</PageNo>
<Data>
<InstanceName>Listener-202001131530341</InstanceName>
<InstanceName>qqqqqqq</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>修改转发策略</ActionName>
<CreatedTime>2020-01-13T08:05:41Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>listener-1216623663932395520</InstanceId>
<InstanceId>strategy-1216631995640467456</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<ActionStatus>成功</ActionStatus>
<UserName>sunmingyue</UserName>
<CreatedTime>2020-01-13T08:04:09Z</CreatedTime>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<ActionStatus>成功</ActionStatus>
<UserName>sunmingyue</UserName>
<CreatedTime>2020-01-13T07:32:05Z</CreatedTime>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>Listener-202001131530341</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>创建监听器</ActionName>
<CreatedTime>2020-01-13T07:31:01Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>listener-1216623663932395520</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>Listener-202001131111046</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>修改监听器</ActionName>
<CreatedTime>2020-01-13T06:06:51Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>listener-1216558354709286912</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>1234aaaa</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>修改后端服务器组</ActionName>
<CreatedTime>2020-01-13T05:59:09Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>server-group-1216567283334664192</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>1234aaaa</InstanceName>
<ActionStatus>失败</ActionStatus>
<ActionName>修改后端服务器组</ActionName>
<CreatedTime>2020-01-13T05:58:44Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>server-group-1214367918670417920</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>zhang123</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>修改后端服务器组</ActionName>
<CreatedTime>2020-01-13T05:54:06Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>server-group-1216567283334664192</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>zhang123</InstanceName>
<InstanceName>niusd测试-勿删</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>创建后端服务器组</ActionName>
<CreatedTime>2020-01-13T03:46:59Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>server-group-1216567283334664192</InstanceId>
<InstanceId>server-1216567287889678336</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<Data>
<InstanceName>Listener-202001131111046</InstanceName>
<ActionStatus>成功</ActionStatus>
<ActionName>创建监听器</ActionName>
<CreatedTime>2020-01-13T03:11:30Z</CreatedTime>
<UserName>sunmingyue</UserName>
<InstanceId>listener-1216558354709286912</InstanceId>
<UserId>84f4f37a-925c-42ef-8f60-fd48a47a7fcd</UserId>
</Data>
<RequestId>cd434dfb-082a-45fb-9350-8d876b774925</RequestId>
</ListSlbLogResponse>