实例接口

1. 获取实例列表

GET https://open.cn-east-1.163yun.com/nlb?Action=GetLoadBalancers[&Type=mix][&Limit=10][&Offset=20]&Version=2017-12-05

示例

请求：
GET https://open.cn-east-1.163yun.com/nlb?Action=GetLoadBalancers&Version=2017-12-05

HEADER:
    Content-type: application/json
    

响应：
[
    {
        "InstanceId": "a12b73b1-6345-4efa-a318-3b20a0bcd7aa",
        "TenantId": "34493fd33b874583ac7b24c1f60138fd",
        "Name": "lhb-openapi-10",
        "Network": "public",
        "Description": "test description",
        "Status": "WORKING",
        "SubStatus": "WORKING",
        "InstanceStatus": "UNKNOWN",
        "Createtime": 1524833715419,
        "Updatetime": 1524833738618,
        "Address": "60.191.87.46",
        "Type": "vpc_mix",
        "InstanceNum": 2,
        "VpcId": "753d3b80-4945-4a95-8821-dad1d320cf27",
        "Standard": {
            "ChargeMode": "bandwidth",
            "ChargeType": "RESERVED",
            "BandwidthLimit": 100,
            "AutoRenewPeriod": 0
        },
        "TopAzInfos": [
            {
                "TopAz": "cn-east-1b",
                "SubNetId": "3cc4df3d-525f-4626-a7a0-c3d8461ee126"
            }
        ]
    },
    {
        "InstanceId": "0f6010ed-f4e9-44ec-8619-249125453a5c",
        "TenantId": "34493fd33b874583ac7b24c1f60138fd",
        "Name": "lhb-openapi-9",
        "Network": "public",
        "Description": "test description",
        "Status": "WORKING",
        "SubStatus": "WORKING",
        "InstanceStatus": "UNKNOWN",
        "Createtime": 1524832983397,
        "Updatetime": 1524833016553,
        "Address": "60.191.87.21",
        "Type": "vpc_mix",
        "VpcId": "753d3b80-4945-4a95-8821-dad1d320cf27",
        "Standard": {
            "ChargeMode": "bandwidth",
            "ChargeType": "RESERVED",
            "BandwidthLimit": 100,
            "AutoRenewPeriod": 0
        },
        "TopAzInfos": [
            {
                "TopAz": "cn-east-1b",
                "SubNetId": "3cc4df3d-525f-4626-a7a0-c3d8461ee126"
            }
        ]
    },
]

参数说明

http url

参数	参数描述	是否必选	类型	范围	默认值	说明
Type	负载均衡类型	否	string	mix/vpc_mix/tcp/http	-	不填返回所有
Offset	偏移	否	number	非负整数	0	-
Limit	限制个数	否	number	1-200	50	-

-返回结果

字段	字段名称	取值特征	字段描述
InstanceId	实例ID	uuidV4	实例ID
TenantId	租户ID	uuidV4	租户ID
Name	实例名称	string	长度不超过100，由数字字母以及"-"和"_"组成
Type	实例类型	mix/vpc_mix/tcp/http	mix为经典网络负载均衡；vpc_mix为vpc网络负载均衡；tcp/http类型不提供创建，只支持老实例维护，新特性不会支持这两种类型
Network	网络类型	public/private/idc	分别公有网/私有网/机房网
Description	实例描述	string	长度不超过200
Address	负载均衡地址	-	访问LB服务的VIP地址，负载均衡实例入口地址，VPC内网返回域名，外网返回外网IP，机房网返回机房网IP
Status	实例状态	WORKING/DELETING/UPDATING/FAILED	LB实例总状态，分别为正常工作中/删除中/更新中/失败
SubStatus	实例子状态	CREATE_FAILED/DELETE_FAILED	失败时子状态信息
InstanceStatus	用户主机状态概览	DOWN/UP	后端服务只要有一个异常则为DOWN
Createtime	创建时间	number	单位毫秒
Updatetime	更新时间	number	单秒毫秒
InstanceNum	用户主机数量	number	统计用户主机数量，各个目标组里面云主机累加值
VpcId	Vpc Id	uuidV4	负载均衡所属VpcId
Standard	计费参数	json	计费相关参数
Standard->ChargeMode	计费模式	netflow/bandwidth	netflow按流量计费(默认值)；bandwidth 按带宽计费
Standard->ChargeType	计费类型	AMOUNT/RESERVED	AMOUNT 按小时收费(默认值) RESERVED按月计费
Standard->BandwidthLimit	带宽限制	1-1000	可以提工单调整上限值
Standard->AutoRenewPeriod	自动续费月数	1-9,12,24	取值为1至9个月,12个月,24个月
TopAzInfos	可用区信息	array of json	-
TopAzInfos->TopAz	可用区	string	可用区
TopAzInfos->SubNetId	子网Id	string	用户子网

返回码

200 成功
404 租户不存在
500 内部错误

2. 实例详情查询

GET https://open.cn-east-1.163yun.com/nlb?Action=GetLoadBalancer&InstanceId=&Version=2017-12-05

示例

请求：
GET https://open.cn-east-1.163yun.com/nlb?Action=GetLoadBalancer&InstanceId=1049cd9a-3122-4ec1-b484-dd9f6d80e46b&Version=2017-12-05

HEADER:
    Content-type: application/json
    

响应：
{
    "InstanceId": "1049cd9a-3122-4ec1-b484-dd9f6d80e46b",
    "TenantId": "34493fd33b874583ac7b24c1f60138fd",
    "Name": "openapi-testcase3",
    "Network": "public",
    "Description": "test description",
    "Status": "WORKING",
    "SubStatus": "WORKING",
    "InstanceStatus": "UP",
    "Createtime": 1524887229137,
    "Updatetime": 1524900575613,
    "Address": "60.191.87.41",
    "Type": "vpc_mix",
    "InstanceNum": 1,
    "VpcId": "753d3b80-4945-4a95-8821-dad1d320cf27",
    "VpcIps": [
        "192.168.1.53",
        "192.168.1.56",
        "192.168.1.55",
        "192.168.1.54"
    ],
    "Listeners": [
        {
            "ListenerId": "b96b7a16-6836-49a3-bb6b-a092bcbdb969",
            "Name": "openlisten",
            "ListenPort": 8088,
            "Protocol": "http",
            "TraceVip": 0,
            "Balance": "leastconn",
            "Gzip": 0,
            "Createtime": 1524900573054,
            "Updatetime": 1524900573054,
            "Status": "ON",
            "Clusters": [
                {
                    "TargetGroupId": cfd688c7-546e-4f08-8bf8-e70c906328d8,
                    "Name": "opengroup",
                    "ServerName": "1.com",
                    "Path": "/1",
                    "Createtime": 1524896726737,
                    "Updatetime": 1524900573057,
                    "Monitor": {
                        "Protocol": "tcp",
                        "Rise": 2,
                        "Fall": 5,
                        "Timeout": 2000,
                        "Period": 5000
                    },
                    "Policy": {
                        "Mode": "insert",
                        "CookieName": "route_insert_eb13e1ac-7566-44da-82ea-1acb264234f9",
                        "Expire": 30000
                    }
                }
            ]
        }
    ],
    "Standard": {
        "ChargeMode": "bandwidth",
        "ChargeType": "AMOUNT",
        "BandwidthLimit": 100,
        "Size": "high",
        "AutoRenewPeriod": 0
    },
    "Limit": {
        "ListenerLimit": 10,
        "TGroupLimit": 20,
        "TGroupInstanceLimit": 50,
        "DomainLimit": 5,
        "PathLimit": 30
    },
    "TargetGroups": [
        {
            "TargetGroupId": "eb13e1ac-7566-44da-82ea-1acb264234f9",
            "ListenerId": "b96b7a16-6836-49a3-bb6b-a092bcbdb969",
            "Name": "opengroup",
            "UseSamePort": 1,
            "Createtime": 1524896726737,
            "Updatetime": 1524900573057,
            "Instances": [
                {
                    "Id": "7ba2a391-5acb-4602-832c-14c808f1cde4",
                    "Name": "newvpc-5",
                    "Address": "10.177.1.7",
                    "Port": 8080,
                    "Status": "UP",
                    "TopAz": "",
                    "Weight": 100,
                    "Backup": 0
                }
            ]
        }
    ],
    "TopAzInfos": [
        {
            "TopAz": "cn-east-1b",
            "SubNetId": "3cc4df3d-525f-4626-a7a0-c3d8461ee126"
        }
    ],
    "SecurityGroups": [
        "6958c291-67ef-4b85-8aa5-d8262385d190",
        "a37d163a-2647-4ca0-bc6c-cad0f82646e3"
    ]
}

参数说明

http url

参数	参数描述	必选	类型	范围	默认值
InstanceId	实例ID	是	uuidV4	实例ID	无，必需

-返回结果

字段	字段名称	取值特征	补充描述
InstanceId	实例ID	uuidV4	实例Id
TenantId	租户ID	uuidV4	租户ID
Name	实例名称	string	长度不大于100，由数字字母以及"-"和"_"组成
Type	实例类型	mix/vpc_mix/tcp/http	mix为经典网络负载均衡；vpc_mix为vpc网络负载均衡；tcp/http类型不提供创建，只支持老实例维护，新特性不会支持这两种类型
Network	网络类型	public/private/idc	分别公有网/私有网/机房网
Description	实例描述	string	长度不超过200
Address	IP地址	-	负载均衡实例入口地址，VPC内网返回域名，外网返回外网IP，机房网返回机房网IP
Status	实例状态	WORKING/DELETING/UPDATING/FAILED	LB实例总状态，分别为正常工作中/删除中/更新中/失败
SubStatus	实例子状态	CREATE_FAILED/DELETE_FAILED	失败时子状态信息
InstanceStatus	用户主机状态概览	DOWN/UP	用户主机状态只要有一个异常则为DOWN
Createtime	创建时间	number	单位毫秒
Updatetime	更新时间	number	单位毫秒
InstanceNum	用户主机数量	number	统计用户主机数量，各个目标组里面云主机累加值
VpcId	Vpc Id	uuidV4	负载均衡实例所属vpc网络Id
Standard	计费参数	json	-
Standard->ChargeMode	计费模式	netflow/bandwidth	netflow按流量计费(默认值)；bandwidth 按带宽计费
Standard->ChargeType	计费类型	AMOUNT/RESERVED	AMOUNT 按小时收费(默认值) RESERVED按月计费
Standard->BandwidthLimit	带宽限制	1-1000	可以提工单调整上限值
Standard->AutoRenewPeriod	自动续费月数	number	取值为1至9个月,12个月,24个月，0表示关闭(默认值)
Standard->Period	订单时长	number	下订单月数，1至9月，12月，24月
TopAzInfos	可用区信息	array of josn	-
TopAzInfos->TopAz	可用区	string	可用区
TopAzInfos->SubNetId	子网Id	string	用户子网
Listeners	监听信息	josn	-
Listeners->ListenerId	监听ID	uuidV4	-
Listeners->Name	监听名字	string	长度不超过64
Listeners->Status	监听状态	ON、OFF	ON表示正常，OFF表示异常
Listeners->ListenPort	监听端口	number	tcp/tls:2-65535、http:80,1025-65535、https:443,1025-65535
Listeners->Protocol	监听协议	string	tcp/http/https/tls
Listeners->Createtime	监听创建时间	number	单位毫秒
Listeners->Updatetime	监听修改时间	number	时间戳，单位毫秒
Listeners->TraceVip	vip 跟踪	0/1	在HTTP HEARDER中带NLB-VIP头部，VALUE为Address，配合apm监控
Listeners->Balance	负载均衡算法	roundrobin/leastconn	roundrobin 加权轮询(默认值)；leastconn 加权最少连接数
Listeners->Gzip	http压缩	0/1	0代表关闭(默认值)；1代表打开gip功能
Listeners->ForwardPort	转发X-Forwarded-Port头部	0/1	0代表关闭(默认值)；1代表打开该功能
Listeners->CipherSuiteId	加密套件ID	-	https可以指定加密套件，https://www.163yun.com/help/documents/101493766532288512
Listeners->Clusters	后端集群	json	根据path/domain来分流的时候，允许有多个，对于tcp只有一个后端集群
Listeners->Clusters->Id	集群ID	uuidV4	-
Listeners->Clusters->CertId	https 证书id	uuidV4	https必须有
Listeners->Clusters->Name	集群名字	string	备注：字段删除
Listeners->Clusters->Path	路径	string	不超过128，支持多个url，每个url以空格分隔，普通url的格式为：满足以‘/’开头，并且由数字和字母开头的；支持pcre规则的正则表达式；匹配优先级为普通字符串>正则表达式类型相同时，长度优先
Listeners->Clusters->ServerName	域名	string	长度不超过512，支持多个serverName, 以空格分隔，普通域名由字母数字以及.组成，通配符域名.在最前面和.在最后面；支持pcrl正则表达式，优先级为普通域名> 通配符 > 正则表达式，类型相同时，长度最长先匹配; 整体优先级serverName > path
Listeners->Clusters->ClusterPort	集群端口	number	tcp:2-65535、http:80,1025-65535、https:443,1025-65535，备注：没有使用这个字段
Listeners->Clusters->Createime	集群创建时间	number	单位毫秒
Listeners->Clusters->Updatetime	集群修改时间	number	单位毫秒
Listeners->Clusters->TargetGroupId	目标组Id	uuidV4	创建监听指定目标组id
Listeners->Clusters->Monitor	健康检查	json	-
Listeners->Clusters->Monitor->Protocol	检查协议	http/tcp	目前仅支持http和tcp，其它协议后期开放
Listeners->Clusters->Monitor->Fall	失败阈值	2-10	默认值为：3
Listeners->Clusters->Monitor->Rise	健康阈值	2-10	默认值为： 2
Listeners->Clusters->Monitor->Url	健康检查url	string	以/开头，数字和字母结尾，最长127个字符，默认为/，仅仅在http检查协议时使用
Listeners->Clusters->Monitor->Period	健康检查间隔	5000-300000	默认5000，单位毫秒
Listeners->Clusters->Monitor->Rstatus	健康检查期望返回码	string	限制为'2xx', '3xx', '4xx'，以“，”分隔，仅仅在http时有效, 没有配置时，返回2xx和3xx代表健康
Listeners->Clusters->Monitor->Timeout	超时时间	2000-60000	默认2000，单位毫秒
Listeners->Clusters->Policy	会话保持策略	json	http监听有效
Listeners->Clusters->Policy->Mode	模式	string	insert或者rewrite模式
Listeners->Clusters->Policy->CookieName	cookie 名字	string，长度不超过1000	rewrite必选，insert没有使用，由数字字母以及"-"和"_"组成
Listeners->Clusters->Policy->Expire	失效时间	number，0-86400	默认30000，单位秒
SecurityGroups	安全组ID	array of string	-
VpcIps	负载均衡占用的ip 地址	array of string
Limit	配额信息	json	-
Limit->TGroupLimit	目标组个数限制	默认20	提工单修改
Limit->TGroupInstanceLimit	目标组的云主机个数限制	默认50	提工单修改
Limit->ListenerLimit	监听器个数限制	默认10	提工单修改
Limit->PathLimit	单个监听器Path限制	默认30	提工单修改
Limit->DomainLimit	单个监听器域名限制	默认5	提工单修改
TargetGroups	目标组	json	-
TargetGroups->Name	目标组名字	长度不大于32	只能由大小写字母和数字组成
TargetGroups->TargetGroupId	目标组Id	uuidV4	-
TargetGroups->Createtime	创建时间	-	单位毫秒
TargetGroups->Updatetime	修改时间	-	单位毫秒
TargetGroups->ListenerId	绑定监听器Id	-	-
TargetGroups->Instances	用户主机	array of json	-
TargetGroups->Instances->Id	云主机uuid	-	-
TargetGroups->Instances->Name	云主机名字	由数字字母以及"-"和"_"组成，长度超过64会被截断	-
TargetGroups->Instances->Address	Ip	-	主机地址
TargetGroups->Instances->Port	云主机端口	1-65535	-
TargetGroups->Instances->Status	云主机状态	UP/DOWN	健康检查实时状态
TargetGroups->Instances->Weight	云主机权重	1-100内整数	默认100
TargetGroups->Instances->TopAz	云主机可用区	-	可用区
TargetGroups->Instances->Backup	备用主机	0/1	1处于备用状态，只有其余非备用的机器都处于异常状态才会转发流量；0处于正常状态(默认值)
TargetGroups->UseSamePort	集群所有后端使用相同端口标志	0/1	1表示所有服务器是否使用相同端口

返回码

204 查询成功
404 实例不存在
403 权限错误
500 内部错误

3. 检查实例

POST https://open.cn-east-1.163yun.com/nlb?Action=CheckLoadBalancerParams&Version=2017-12-05

示例

请求：
POST https://open.cn-east-1.163yun.com/nlb?Action=CheckLoadBalancerParams&Version=2017-12-05

HEADER:
    Content-type: application/json
    
BODY:
    {
        "Name": "lb-1",
        "Description" : "test description",
        "Type": "vpc_mix",
        "Network": "public",
        "TopAzInfos": [
            {
                "TopAz":"cn-east-1b", 
                "SubNetId": "13f009c8-e661-41cd-bc58-1f4a79bb728c"
            }
        ],
        "SecurityGroups": [
            "92282f88-4940-4aea-8dfc-4774fe1d90df"
        ],
        "VpcId": "8d71d5e7-e621-46fa-9ab9-69844d698015",
        "Standard": {
            "ChargeType": "AMOUNT",
            "BandwidthLimit": 100,
            "ChargeMode": "netflow",
            "AutoRenewPeriod": 10
        }
    }

响应：
    无

参数说明

http body

参数	参数描述	是否必选	类型	范围	默认值	说明
Name	负载均衡名字	是	string	长度不大于100，由数字字母以及"-"和"_"组成	无	同一个租户下实例名唯一
Type	类型	是	string	mix/vpc_mix/tcp/http	http	备注：默认值修改为vpc_mix
Network	网络类型	否	string	public/private/idc	public	-
Description	用户描述信息	否	string	长度不大于200	空	-
Standard->BandwidthLimit	带宽限制	否	number	1-1000	100	单位Mbps, 默认值每个可用区不同
Standard->ChargeType	计费类型	否	string	AMOUNT/RESERVED	AMOUNT	AMOUNT 按小时收费(默认值) RESERVED按月计费
Standard->ChargeMode	计费方式	否	string	netflow/bandwidth	netflow	netflow按流量计费(默认值)；bandwidth 按带宽计费
Standard->AutoRenewPeriod	自动续费	否	number	1-9,12,24	-	自动续费月数、0表示关闭
Standard->Period	周期	否	number	1-9,12,24	-	下订单月数，1-9，12，24
TopAzInfos	指定可用区和子网信息	vpc_mix类型为必选	array of json	-	-
TopAzInfo->TopAz	可用区	vpc_mix类型为必选	string	-	-	-
TopAzInfo->SubNetId	子网ID	vpc_mix类型为必选	string	-	-	用户子网
SecurityGroups	指定安全组	vpc_mix类型为必选	array of string	-	-
VpcId	指定vpc Id	vpc_mix类型为必选	string	-	-

结果说明

无

返回码

200 检查成功
400 参数错误
403 权限错误
409 重复创建
500 内部错误

4. 创建实例

POST https://open.cn-east-1.163yun.com/nlb?Action=CreateLoadBalancer&Version=2017-12-05

示例

请求：
POST https://open.cn-east-1.163yun.com/nlb?Action=CreateLoadBalancer&Version=2017-12-05

HEADER:
    Content-type: application/json
    
BODY:
    {
        "Name": "lb-1",
        "Description" : "test description",
        "Type": "vpc_mix",
        "Network": "public"
        "TopAzInfos": [
            {
                "TopAz":"cn-east-1b", 
                "SubNetId": "13f009c8-e661-41cd-bc58-1f4a79bb728c"
            }
        ],
        "SecurityGroups": [
            "92282f88-4940-4aea-8dfc-4774fe1d90df"
        ],
        "VpcId": "8d71d5e7-e621-46fa-9ab9-69844d698015",
        "Standard": {
          "ChargeType": "AMOUNT",
          "BandwithLimit": 100,
          "ChargeMode": "netflow",
          "AutoRenewPeriod": 10
        }
    }

响应：
    {
        "InstanceId": "0213f923-fc3c-4337-ada6-9512c4ff5506",
        "TenantId": "06358fcd-7266-4bad-a664-ab697377a48e",
        "Address": "60.191.87.55",
        "Status": "CREATING",
        "Name": "lb-1",
        "Description" : "test description",
        "Type": "vpc_mix",
        "Network": "public"
        "TopAzInfos": [
            {
                "TopAz":"cn-east-1b", 
                "SubNetId": "13f009c8-e661-41cd-bc58-1f4a79bb728c"
            }
        ],
        "SecurityGroups": [
            "92282f88-4940-4aea-8dfc-4774fe1d90df"
        ],
        "VpcId": "8d71d5e7-e621-46fa-9ab9-69844d698015",
        "Standard": {
          "ChargeType": "AMOUNT",
          "BandwithLimit": 100,
          "ChargeMode": "netflow",
          "AutoRenewPeriod": 10
          "Period": 20,
          "OrderId": "112b8749-0fdb-4add-834a-220471a64f5d"
        }

    }

参数说明

http body

参数	参数描述	是否必选	类型	范围	默认值	说明
Name	负载均衡名字	是	string	长度不大于100，由数字字母以及"-"和"_"组成	无	同一个租户下实例名唯一
Type	类型	是	string	mix/vpc_mix/tcp/http	http	备注：默认值修改为vpc_mix
Network	网络类型	否	string	public/private/idc	public	-
Description	用户描述信息	否	string	长度不大于200	空	-
Standard->BandwidthLimit	带宽限制	否	number	1-1000	100	单位Mbps, 默认值每个可用区不同
Standard->ChargeType	计费类型	否	string	AMOUNT/RESERVED	AMOUNT	AMOUNT 按小时收费(默认值) RESERVED按月计费
Standard->ChargeMode	计费方式	否	string	netflow/bandwidth	netflow	netflow按流量计费(默认值)；bandwidth 按带宽计费
Standard->AutoRenewPeriod	自动续费	否	number	1-9,12,24	0	自动续费月数、0表示关闭
Standard->Period	周期	否	number	1-9,12,24	0	下订单月数，1-9，12，24
TopAzInfos	指定可用区和子网信息	vpc_mix类型为必选	array of json	-	-
TopAzInfo->TopAz	可用区	vpc_mix类型为必选	string	-	-	-
TopAzInfo->SubNetId	子网ID	vpc_mix类型为必选	string	-	-	用户子网
SecurityGroups	指定安全组	vpc_mix类型为必选	array of string	-	-
VpcId	指定vpc Id	vpc_mix类型为必选	string	-	-

-返回结果

字段	字段名称	取值特征	字段描述
InstanceId	实例ID	uuidV4	-
TenantId	租户ID	uuidV4	租户ID
Name	实例名称	长度不大于100，由数字字母以及"-"和"_"组成	-
Type	实例类型	mix/vpc_mix/tcp/http	mix为经典网络负载均衡；vpc_mix为vpc网络负载均衡；tcp/http类型不提供创建，只支持老实例维护，新特性不会支持这两种类型
Network	网络类型	public/private/idc	分别公有网/私有网/机房网
Description	实例描述	长度不超过200	-
Address	IP地址	访问LB服务的VIP地址	负载均衡实例入口地址，VPC内网返回域名，外网返回外网IP，机房网返回机房网IP
Status	实例状态	WORKING/DELETING/UPDATING/FAILED	LB实例总状态，分别为正常工作中/删除中/更新中/失败
SubStatus	实例子状态	CREATE_FAILED/DELETE_FAILED	失败时子状态信息
InstanceStatus	用户主机状态概览	DOWN/UP	用户主机状态只要有一个异常则为DOWN
Createtime	创建时间	number	单位毫秒
Updatetime	更新时间	number	单位毫秒
InstanceNum	用户主机数量	number	统计用户主机数量，各个目标组里面云主机累加值
VpcId	Vpc Id	uuidV4	负载均衡实例所属vpc网络Id
Standard	计费参数	json	-
Standard->ChargeMode	计费模式	netflow/bandwidth	AMOUNT 按小时收费(默认值) RESERVED按月计费
Standard->ChargeType	计费类型	AMOUNT/RESERVED	AMOUNT 按小时收费(默认值) RESERVED按月计费
Standard->BandwidthLimit	带宽限制	1-1000	可以提工单调整上限值
Standard->AutoRenewPeriod	自动续费月数	number	取值为1至9个月,12个月,24个月，0表示关闭(默认值)
Standard->Period	周期	number	下订单月数，1-9，12，24
TopAzInfos	可用区信息	array of json	-
TopAzInfos->TopAz	可用区	string	-
TopAzInfos->SubNetId	子网信息	string	-
VpcId	vpc Id	string	负载均衡实例所属vpc网络Id
SecurityGroups	安全组信息	array of string	-

返回码

204 创建成功
400 参数错误
403 权限错误
409 重复创建
500 内部错误

5. 删除实例

GET https://open.cn-east-1.163yun.com/nlb?Action=DeleteLoadBalancer&InstanceId=&Version=2017-12-05

示例

请求：
GET https://open.cn-east-1.163yun.com/nlb?Action=DeleteLoadBalancer&InstanceId=87fc274b-4d43-4648-a999-dc916a260246&Version=2017-12-05

HEADER:
    Content-type: application/json
    

响应：
    无

参数说明

http url

参数	参数描述	是否必选	类型	范围	默认值
InstanceId	实例Id	是	uuidV4	-	-

结果说明

返回码

204 删除成功
400 参数错误
403 权限错误
500 内部错误

6. 修改实例

POST https://open.cn-east-1.163yun.com/nlb?Action=UpdateLoadBalancer&Version=2017-12-05

示例

请求：
POST https://open.cn-east-1.163yun.com/nlb?Action=UpdateLoadBalancer&Version=2017-12-05

HEADER:
    Content-type: application/json
    

BODY:
    {
        "InstanceId": "01dfd813-3bf3-4199-ba97-39f59ab8e64c",
		"description": "update description"
    }
响应：
    无

参数说明

http body

参数	参数描述	是否必选	类型	范围	默认值
InstanceId	实例Id	是	uuidV4	-	-
Description	描述信息	是	string	不超过200	-

结果说明

返回码

200 修改成功
400 参数错误
403 权限错误
404 目标不存在
500 内部错误

7. 更改规格

POST https://open.cn-east-1.163yun.com/nlb?Action=UpdateLoadBalancerSpec&Version=2017-12-05

示例

请求：
POST https://open.cn-east-1.163yun.com/nlb?Action=UpdateLoadBalancerSpec&Version=2017-12-05

HEADER:
    Content-type: application/json
    

BODY:
    {
        "InstanceId": "01dfd813-3bf3-4199-ba97-39f59ab8e64c",
        "Standard": {
          "BandwidthLimit": 100
        }
    }
响应：
    无

参数说明

http body

参数	参数描述	是否必选	类型	范围	默认值	说明
InstanceId	实例ID	是	uuidV4	-	-	-
Standard->BandwidthLimit	带宽限制	是	number	1-1000内整数, 单位Mbps	-	最大带宽可配
Standard->ChargeType	计费类型	是	string	AMOUNT/RESERVED	-	AMOUNT按小时、RESERVED按月
Standard->ChargeMode	计费方式	是	string	netflow/bandwidth	-	netflow流量、bandwidth带宽
Standard->AutoRenewPeriod	自动续费	否	number	1-9,12,24	-	自动续费月数，0表示关闭改功能
Standard->OrderId	订单ID	否	string	由计费生成	-	订单支付，无则后台下单余额支付

结果说明

返回码

200 修改成功
400 参数错误
403 权限错误
500 内部错误

8. 订单续费

GET https://open.cn-east-1.163yun.com/nlb?Action=RenewOrder&Version=2017-12-05

示例

请求：
GET https://open.cn-east-1.163yun.com/nlb?Action=RenewOrder&InstanceId=0213f923-fc3c-4337-ada6-9512c4ff5506&Period=14&Version=2017-12-05

HEADER:
    Content-type: application/json
    

响应：
    {
        "OrderId": "074723ee-994c-43b1-a193-86403112390d",
		"Period": 2
    }

参数说明

http body

参数	参数描述	是否必选	类型	范围	默认值
InstanceId	实例ID	是	uuidV4	-	-
Period	时长月	是	number	1-9,12,24	-

结果说明

OrderId: 订单Id

返回码

200 修改成功
400 参数错误
403 权限错误
409 重复创建
500 内部错误

9. 获取负载均衡实例的总数

GET /nlb?Action=GetLoadBalancerCount&Version=2017-12-05

示例

请求：
GET /nlb?Action=GetLoadBalancerCount&Version=2017-12-05

HEADER:
    Content-type: application/json
    X-Product-Id: ${tenantId}

响应：
    {
    "Mix": 4,
    "Vpc_mix": 3,
    "Http": 1,
    "Tcp": 0,
    "Total": 8
    }

参数说明

http header

参数	参数描述	是否必选	类型	说明
X-Product-Id	租户ID	是	string定长32	租户ID

结果说明

字段	字段名称	取值特征	字段描述
Total	总计	正整数	所有实例的总数
Mix	Mix总计	正整数	Mix类型实例的总数
Vpc_mix	Vpc总计	正整数	Vpc类型实例的总数
Http	Http总计	正整数	Http类型实例的总数
Tcp	Tcp总计	正整数	Tcp类型实例的总数

返回码

200 成功
500 内部错误

10. 获取可用LB资源池ID列表

GET /nlb?Action=DescribeResourcePools&Version=2017-12-05

示例

请求：
GET /nlb?Action=DescribeResourcePools&Version=2017-12-05

HEADER:
    Content-type: application/json
    X-Product-Id: ${tenantId}
响应：
{
  "ResourcePoolList": [
    {
      "PoolId": "82e201ce-2868-40a0-a4d7-5be142b7ee65",
      "PoolName": "pool_1",
      "PoolType": "network",
      "DistributorName": "yiwu",
      "IsDec": 1,
      "Properties": {
        "DistributorUser": "yiwu",
        "Series": "n1"
      }
    }
  ],
  "Code": "Success",
  "Message": "调用成功"
}

参数说明

http header

参数	参数描述	是否必选	类型	范围	默认值	说明
TenantId	租户ID	是	uuid	-	-

结果说明

字段	字段名称	取值特征	字段描述
ResourcePoolList	资源池列表	array of json	资源池列表
PoolId	资源池ID	uuid	资源池ID
PoolName	资源池名称	string	资源池名称
PoolType	资源池类型	string	资源池类型, compute:计算型资源池、network:网络型资源池、storage:存储型资源池
DistributorName	资源池归属的用户组织	string	资源池归属的用户组织,如yiwu、public
IsDec	是否专属独占资源	整数	1:专属资源；0:公有云资源
Properties	自定义属性	json	所有业务方自定义的属性

返回码

200 成功
500 内部错误

热门搜索

数据分析及可视化

数据研发

数据治理

数据服务化

计算服务

网络服务

数据库

消息

存储与 CDN

管理与监控

其他

实例接口

1. 获取实例列表

示例

参数说明

返回码

2. 实例详情查询

示例

参数说明

返回码

3. 检查实例

示例

参数说明

结果说明

返回码

4. 创建实例

示例

参数说明

返回码

5. 删除实例

示例

参数说明

结果说明

返回码

6. 修改实例

示例

参数说明

结果说明

返回码

7. 更改规格

示例

参数说明

结果说明

返回码

8. 订单续费

示例

参数说明

结果说明

返回码

9. 获取负载均衡实例的总数

示例

参数说明

结果说明

返回码

10. 获取可用LB资源池ID列表

示例

参数说明

结果说明

返回码